Package org.azd.git.policyconfigurations

Class PolicyConfigurationsRequestBuilder

java.lang.Object
org.azd.abstractions.BaseRequestBuilder
org.azd.git.policyconfigurations.PolicyConfigurationsRequestBuilder
public class PolicyConfigurationsRequestBuilder extends BaseRequestBuilder
Request builder to manage Apis associated with policy configurations.

  • Constructor Details

    • PolicyConfigurationsRequestBuilder

      public PolicyConfigurationsRequestBuilder(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<PolicyConfigurations> getAsync(String repositoryId, Consumer<PolicyConfigurationsRequestBuilder.RequestConfiguration> requestConfiguration) throws AzDException
      Retrieve a list of policy configurations by a given set of scope/filtering criteria. Below is a short description of how all the query parameters interact with each other: repositoryId set, refName set: returns all policy configurations that apply to a particular branch in a repository repositoryId set, refName unset: returns all policy configurations that apply to a particular repository repositoryId unset, refName unset: returns all policy configurations that are defined at the project level repositoryId unset, refName set: returns all project-level branch policies, plus the project level configurations For all the examples above, when policyType is set, it'll restrict results to the given policy type
      Parameters:
      repositoryId - Project ID or project name
      Returns:
      Collection of PolicyConfiguration Object PolicyConfigurations
      Throws:
      AzDException - Default Api Exception handler.

    • get

      public PolicyConfigurations get(String repositoryId, Consumer<PolicyConfigurationsRequestBuilder.RequestConfiguration> requestConfiguration) throws AzDException
      Retrieve a list of policy configurations by a given set of scope/filtering criteria. Below is a short description of how all the query parameters interact with each other: repositoryId set, refName set: returns all policy configurations that apply to a particular branch in a repository repositoryId set, refName unset: returns all policy configurations that apply to a particular repository repositoryId unset, refName unset: returns all policy configurations that are defined at the project level repositoryId unset, refName set: returns all project-level branch policies, plus the project level configurations For all the examples above, when policyType is set, it'll restrict results to the given policy type
      Parameters:
      repositoryId - Project ID or project name
      Returns:
      Collection of PolicyConfiguration Object PolicyConfigurations
      Throws:
      AzDException - Default Api Exception handler.