Package com.azure.containers.containerregistry

Class ContainerRegistryClientBuilder

java.lang.Object
com.azure.containers.containerregistry.ContainerRegistryClientBuilder
All Implemented Interfaces:
com.azure.core.client.traits.ConfigurationTrait<ContainerRegistryClientBuilder>, com.azure.core.client.traits.EndpointTrait<ContainerRegistryClientBuilder>, com.azure.core.client.traits.HttpTrait<ContainerRegistryClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<ContainerRegistryClientBuilder>
public final class ContainerRegistryClientBuilder extends Object implements com.azure.core.client.traits.ConfigurationTrait<ContainerRegistryClientBuilder>, com.azure.core.client.traits.EndpointTrait<ContainerRegistryClientBuilder>, com.azure.core.client.traits.HttpTrait<ContainerRegistryClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<ContainerRegistryClientBuilder>
This class provides a fluent builder API to help aid the configuration and instantiation of ContainerRegistryClients and ContainerRegistryAsyncClients, call buildClient and buildAsyncClient respectively to construct an instance of the desired client.

The client needs the service endpoint of the Azure Container Registry, Audience for ACR that you want to target and Azure access credentials to use for authentication.

Instantiating an asynchronous Container Registry client

 ContainerRegistryAsyncClient registryAsyncClient = new ContainerRegistryClientBuilder()
     .endpoint(endpoint)
     .credential(credential)
     .buildAsyncClient();

Instantiating a synchronous Container Registry client

 ContainerRegistryClient registryAsyncClient = new ContainerRegistryClientBuilder()
     .endpoint(endpoint)
     .credential(credential)
     .buildClient();

Another way to construct the client is using a HttpPipeline. The pipeline gives the client an authenticated way to communicate with the service but it doesn't contain the service endpoint. Set the pipeline with this and set the service endpoint with this. Using a pipeline requires additional setup but allows for finer control on how the ContainerRegistryClient and ContainerRegistryAsyncClient is built.

The service does not directly support AAD credentials and as a result the clients internally depend on a policy that converts the AAD credentials to the Azure Container Registry specific service credentials. In case you use your own pipeline, you would need to provide implementation for this policy as well. For more information please see Azure Container Registry Authentication .

Instantiating an asynchronous Container Registry client using a custom pipeline

 HttpPipeline pipeline = new HttpPipelineBuilder()
     .policies(/* add policies */)
     .build();

 ContainerRegistryAsyncClient registryAsyncClient = new ContainerRegistryClientBuilder()
     .pipeline(pipeline)
     .endpoint(endpoint)
     .credential(credential)
     .buildAsyncClient();

Instantiating a synchronous Container Registry client with custom pipeline

 HttpPipeline pipeline = new HttpPipelineBuilder()
     .policies(/* add policies */)
     .build();

 ContainerRegistryClient registryAsyncClient = new ContainerRegistryClientBuilder()
     .pipeline(pipeline)
     .endpoint(endpoint)
     .credential(credential)
     .buildClient();
See Also:

  • Constructor Details

    • ContainerRegistryClientBuilder

      public ContainerRegistryClientBuilder()

  • Method Details

    • endpoint

      public ContainerRegistryClientBuilder endpoint(String endpoint)
      Sets the service endpoint for the Azure Container Registry instance.
      Specified by:
      endpoint in interface com.azure.core.client.traits.EndpointTrait<ContainerRegistryClientBuilder>
      Parameters:
      endpoint - The URL of the Container Registry instance.
      Returns:
      The updated ContainerRegistryClientBuilder object.
      Throws:
      IllegalArgumentException - If endpoint is null or it cannot be parsed into a valid URL.

    • audience

      public ContainerRegistryClientBuilder audience(ContainerRegistryAudience audience)
      Sets the audience for the Azure Container Registry service.
      Parameters:
      audience - ARM management scope associated with the given registry.
      Returns:
      The updated ContainerRegistryClientBuilder object.

    • credential

      public ContainerRegistryClientBuilder credential(com.azure.core.credential.TokenCredential credential)
      Sets the TokenCredential used to authorize requests sent to the service. Refer to the Azure SDK for Java identity and authentication documentation for more details on proper usage of the TokenCredential type.
      Specified by:
      credential in interface com.azure.core.client.traits.TokenCredentialTrait<ContainerRegistryClientBuilder>
      Parameters:
      credential - TokenCredential used to authorize requests sent to the service.
      Returns:
      The updated ContainerRegistryClientBuilder object.

    • pipeline

      public ContainerRegistryClientBuilder pipeline(com.azure.core.http.HttpPipeline httpPipeline)
      Sets the HttpPipeline to use for the service client.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      If pipeline is set, all settings other than endpoint are ignored to build ContainerRegistryAsyncClient or ContainerRegistryClient.

      This service takes dependency on an internal policy which converts Azure token credentials into Azure Container Registry specific service credentials. In case you use your own pipeline you will have to create your own credential policy.
      {For more information please see Azure Container Registry Authentication }.
      Specified by:
      pipeline in interface com.azure.core.client.traits.HttpTrait<ContainerRegistryClientBuilder>
      Parameters:
      httpPipeline - HttpPipeline to use for sending service requests and receiving responses.
      Returns:
      The updated ContainerRegistryClientBuilder object.

    • serviceVersion

      public ContainerRegistryClientBuilder serviceVersion(ContainerRegistryServiceVersion version)
      Sets the ContainerRegistryServiceVersion that is used when making API requests.

      If a service version is not provided, the service version that will be used will be the latest known service version and so newer version of the client library may result in moving to a newer service version.

      Parameters:
      version - ContainerRegistryServiceVersion of the service to be used when making requests.
      Returns:
      The updated ContainerRegistryClientBuilder object.

    • httpClient

      public ContainerRegistryClientBuilder httpClient(com.azure.core.http.HttpClient httpClient)
      Sets the HttpClient to use for sending and receiving requests to and from the service.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      Specified by:
      httpClient in interface com.azure.core.client.traits.HttpTrait<ContainerRegistryClientBuilder>
      Parameters:
      httpClient - The HttpClient to use for requests.
      Returns:
      The updated ContainerRegistryClientBuilder object.

    • clientOptions

      public ContainerRegistryClientBuilder clientOptions(com.azure.core.util.ClientOptions clientOptions)
      Allows for setting common properties such as application ID, headers, proxy configuration, etc. Note that it is recommended that this method be called with an instance of the HttpClientOptions class (a subclass of the ClientOptions base class). The HttpClientOptions subclass provides more configuration options suitable for HTTP clients, which is applicable for any class that implements this HttpTrait interface.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      Specified by:
      clientOptions in interface com.azure.core.client.traits.HttpTrait<ContainerRegistryClientBuilder>
      Parameters:
      clientOptions - A configured instance of HttpClientOptions.
      Returns:
      the updated ContainerRegistryClientBuilder object
      See Also:
      • HttpClientOptions

    • configuration

      public ContainerRegistryClientBuilder configuration(com.azure.core.util.Configuration configuration)
      Sets the configuration store that is used during construction of the service client.

      The default configuration store is a clone of the global configuration store, use Configuration.NONE to bypass using configuration settings during construction.

      Specified by:
      configuration in interface com.azure.core.client.traits.ConfigurationTrait<ContainerRegistryClientBuilder>
      Parameters:
      configuration - The configuration store to be used.
      Returns:
      The updated ContainerRegistryClientBuilder object.

    • httpLogOptions

      public ContainerRegistryClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions httpLogOptions)
      Sets the logging configuration to use when sending and receiving requests to and from the service. If a logLevel is not provided, default value of HttpLogDetailLevel.NONE is set.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      Specified by:
      httpLogOptions in interface com.azure.core.client.traits.HttpTrait<ContainerRegistryClientBuilder>
      Parameters:
      httpLogOptions - The logging configuration to use when sending and receiving requests to and from the service.
      Returns:
      The updated ContainerRegistryClientBuilder object.

    • retryPolicy

      public ContainerRegistryClientBuilder retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy)
      Sets the HttpPipelinePolicy that is used to retry requests.

      The default retry policy will be used if not provided buildAsyncClient() to build ContainerRegistryClient or ContainerRegistryAsyncClient.

      Setting this is mutually exclusive with using retryOptions(RetryOptions).

      Parameters:
      retryPolicy - The HttpPipelinePolicy that will be used to retry requests. For example, RetryPolicy can be used to retry requests.
      Returns:
      The updated ContainerRegistryClientBuilder object.

    • retryOptions

      public ContainerRegistryClientBuilder retryOptions(com.azure.core.http.policy.RetryOptions retryOptions)
      Sets the RetryOptions for all the requests made through the client.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      Setting this is mutually exclusive with using retryPolicy(RetryPolicy).

      Specified by:
      retryOptions in interface com.azure.core.client.traits.HttpTrait<ContainerRegistryClientBuilder>
      Parameters:
      retryOptions - The RetryOptions to use for all the requests made through the client.
      Returns:
      The updated ContainerRegistryClientBuilder object.

    • addPolicy

      public ContainerRegistryClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy)
      Adds a pipeline policy to apply on each request sent.

      Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

      Specified by:
      addPolicy in interface com.azure.core.client.traits.HttpTrait<ContainerRegistryClientBuilder>
      Parameters:
      policy - A pipeline policy.
      Returns:
      The updated ContainerRegistryClientBuilder object.
      Throws:
      NullPointerException - If policy is null.

    • buildAsyncClient

      public ContainerRegistryAsyncClient buildAsyncClient()
      Creates a ContainerRegistryAsyncClient based on options set in the Builder. Every time buildAsyncClient() is called a new instance of ContainerRegistryAsyncClient is created.

      If pipeline(HttpPipeline) pipeline} is set, then the pipeline and endpoint are used to create the client. All other builder settings are ignored.

      Returns:
      A ContainerRegistryAsyncClient with the options set from the builder.
      Throws:
      NullPointerException - If endpoint is null. You can set the values by calling endpoint(String) and audience(ContainerRegistryAudience) respectively.
      IllegalStateException - If both retryOptions(RetryOptions) and retryPolicy(RetryPolicy) have been set.

    • buildClient

      public ContainerRegistryClient buildClient()
      Creates a ContainerRegistryClient based on options set in the Builder. Every time buildAsyncClient() is called a new instance of ContainerRegistryClient is created.

      If pipeline(HttpPipeline) pipeline} is set, then the pipeline and endpoint are used to create the client. All other builder settings are ignored.

      Returns:
      A ContainerRegistryClient with the options set from the builder.
      Throws:
      NullPointerException - If endpoint has not been set. You can set it by calling endpoint(String).
      NullPointerException - If audience has not been set. You can set it by calling audience(ContainerRegistryAudience).
      IllegalStateException - If both retryOptions(RetryOptions) and retryPolicy(RetryPolicy) have been set.