Package org.azd.core.projects

Class PropertiesRequestBuilder

java.lang.Object
org.azd.abstractions.BaseRequestBuilder
org.azd.core.projects.PropertiesRequestBuilder
public class PropertiesRequestBuilder extends BaseRequestBuilder
Provides functionality to manage project properties Api.

  • Constructor Details

    • PropertiesRequestBuilder

      public PropertiesRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)
      Instantiates a new RequestBuilder instance and sets the default values.
      Parameters:
      organizationUrl - Represents organization location request url.
      accessTokenCredential - Access token credential object.

  • Method Details

    • getAsync

      public CompletableFuture<ProjectProperties> getAsync(String projectId) throws AzDException
      Get a collection of team project properties.
      Parameters:
      projectId - provide the project guid not the project name
      Returns:
      ProjectProperties ProjectProperties
      Throws:
      AzDException - Default Api Exception handler.

    • getAsync

      public CompletableFuture<ProjectProperties> getAsync(String projectId, String... keys) throws AzDException
      Get a collection of team project properties.
      Parameters:
      projectId - provide the project guid not the project name
      keys - A comma-delimited string of team project property names. Wildcard characters ("?" and "*") are supported. If no key is specified, all properties will be returned.
      Returns:
      ProjectProperties ProjectProperties
      Throws:
      AzDException - Default Api Exception handler.

    • setAsync

      public CompletableFuture<Void> setAsync(String projectId, JsonPatchDocument projectProperty) throws AzDException
      Create, update, and delete team project properties.
      Parameters:
      projectId - provide the project guid not the project name
      Throws:
      AzDException - Default Api Exception handler.

    • get

      public ProjectProperties get(String projectId) throws AzDException
      Get a collection of team project properties.
      Parameters:
      projectId - provide the project guid not the project name
      Returns:
      ProjectProperties ProjectProperties
      Throws:
      AzDException - Default Api Exception handler.

    • get

      public ProjectProperties get(String projectId, String... keys) throws AzDException
      Get a collection of team project properties.
      Parameters:
      projectId - provide the project guid not the project name
      keys - A comma-delimited string of team project property names. Wildcard characters ("?" and "*") are supported. If no key is specified, all properties will be returned.
      Returns:
      ProjectProperties ProjectProperties
      Throws:
      AzDException - Default Api Exception handler.

    • set

      public Void set(String projectId, JsonPatchDocument projectProperty) throws AzDException
      Create, update, and delete team project properties.
      Parameters:
      projectId - provide the project guid not the project name
      Throws:
      AzDException - Default Api Exception handler.