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 ofContainerRegistryClients
andContainerRegistryAsyncClients
, callbuildClient
andbuildAsyncClient
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) .audience(ContainerRegistryAudience.AZURE_RESOURCE_MANAGER_PUBLIC_CLOUD) .buildAsyncClient();
Instantiating a synchronous Container Registry client
ContainerRegistryClient registryAsyncClient = new ContainerRegistryClientBuilder() .endpoint(endpoint) .audience(ContainerRegistryAudience.AZURE_RESOURCE_MANAGER_PUBLIC_CLOUD) .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 withthis
and set the service endpoint withthis
. Using a pipeline requires additional setup but allows for finer control on how theContainerRegistryClient
andContainerRegistryAsyncClient
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) .audience(ContainerRegistryAudience.AZURE_RESOURCE_MANAGER_PUBLIC_CLOUD) .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) .audience(ContainerRegistryAudience.AZURE_RESOURCE_MANAGER_PUBLIC_CLOUD) .credential(credential) .buildClient();
-
-
Constructor Summary
Constructors Constructor Description ContainerRegistryClientBuilder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ContainerRegistryClientBuilder
addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy)
Adds apipeline policy
to apply on each request sent.ContainerRegistryClientBuilder
audience(ContainerRegistryAudience audience)
Sets the audience for the Azure Container Registry service.ContainerRegistryAsyncClient
buildAsyncClient()
Creates aContainerRegistryAsyncClient
based on options set in the Builder.ContainerRegistryClient
buildClient()
Creates aContainerRegistryClient
based on options set in the Builder.ContainerRegistryClientBuilder
clientOptions(com.azure.core.util.ClientOptions clientOptions)
Allows for setting common properties such as application ID, headers, proxy configuration, etc.ContainerRegistryClientBuilder
configuration(com.azure.core.util.Configuration configuration)
Sets the configuration store that is used during construction of the service client.ContainerRegistryClientBuilder
credential(com.azure.core.credential.TokenCredential credential)
Sets theTokenCredential
used to authorize requests sent to the service.ContainerRegistryClientBuilder
endpoint(String endpoint)
Sets the service endpoint for the Azure Container Registry instance.ContainerRegistryClientBuilder
httpClient(com.azure.core.http.HttpClient httpClient)
Sets theHttpClient
to use for sending and receiving requests to and from the service.ContainerRegistryClientBuilder
httpLogOptions(com.azure.core.http.policy.HttpLogOptions httpLogOptions)
Sets thelogging configuration
to use when sending and receiving requests to and from the service.ContainerRegistryClientBuilder
pipeline(com.azure.core.http.HttpPipeline httpPipeline)
Sets theHttpPipeline
to use for the service client.ContainerRegistryClientBuilder
retryOptions(com.azure.core.http.policy.RetryOptions retryOptions)
Sets theRetryOptions
for all the requests made through the client.ContainerRegistryClientBuilder
retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy)
Sets theHttpPipelinePolicy
that is used to retry requests.ContainerRegistryClientBuilder
serviceVersion(ContainerRegistryServiceVersion version)
Sets theContainerRegistryServiceVersion
that is used when making API requests.
-
-
-
Method Detail
-
endpoint
public ContainerRegistryClientBuilder endpoint(String endpoint)
Sets the service endpoint for the Azure Container Registry instance.- Specified by:
endpoint
in interfacecom.azure.core.client.traits.EndpointTrait<ContainerRegistryClientBuilder>
- Parameters:
endpoint
- The URL of the Container Registry instance.- Returns:
- The updated
ContainerRegistryClientBuilder
object. - Throws:
IllegalArgumentException
- Ifendpoint
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 theTokenCredential
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 theTokenCredential
type.- Specified by:
credential
in interfacecom.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 theHttpPipeline
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 noHttpPipeline
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 anHttpPipeline
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
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.pipeline
is set, all settings other thanendpoint
are ignored to buildContainerRegistryAsyncClient
orContainerRegistryClient
.
{For more information please see Azure Container Registry Authentication }.- Specified by:
pipeline
in interfacecom.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 theContainerRegistryServiceVersion
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 theHttpClient
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 noHttpPipeline
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 anHttpPipeline
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 interfacecom.azure.core.client.traits.HttpTrait<ContainerRegistryClientBuilder>
- Parameters:
httpClient
- TheHttpClient
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 theHttpClientOptions
class (a subclass of theClientOptions
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 noHttpPipeline
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 anHttpPipeline
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 interfacecom.azure.core.client.traits.HttpTrait<ContainerRegistryClientBuilder>
- Parameters:
clientOptions
- A configured instance ofHttpClientOptions
.- 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
, useConfiguration.NONE
to bypass using configuration settings during construction.- Specified by:
configuration
in interfacecom.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 thelogging configuration
to use when sending and receiving requests to and from the service. If alogLevel
is not provided, default value ofHttpLogDetailLevel.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 noHttpPipeline
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 anHttpPipeline
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 interfacecom.azure.core.client.traits.HttpTrait<ContainerRegistryClientBuilder>
- Parameters:
httpLogOptions
- Thelogging 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 theHttpPipelinePolicy
that is used to retry requests.The default retry policy will be used if not provided
buildAsyncClient()
to buildContainerRegistryClient
orContainerRegistryAsyncClient
.Setting this is mutually exclusive with using
retryOptions(RetryOptions)
.- Parameters:
retryPolicy
- TheHttpPipelinePolicy
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 theRetryOptions
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 noHttpPipeline
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 anHttpPipeline
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 interfacecom.azure.core.client.traits.HttpTrait<ContainerRegistryClientBuilder>
- Parameters:
retryOptions
- TheRetryOptions
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 apipeline 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 noHttpPipeline
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 anHttpPipeline
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 interfacecom.azure.core.client.traits.HttpTrait<ContainerRegistryClientBuilder>
- Parameters:
policy
- Apipeline policy
.- Returns:
- The updated ContainerRegistryClientBuilder object.
- Throws:
NullPointerException
- Ifpolicy
is null.
-
buildAsyncClient
public ContainerRegistryAsyncClient buildAsyncClient()
Creates aContainerRegistryAsyncClient
based on options set in the Builder. Every timebuildAsyncClient()
is called a new instance ofContainerRegistryAsyncClient
is created.If
pipeline(HttpPipeline)
pipeline} is set, then thepipeline
andendpoint
are used to create theclient
. All other builder settings are ignored.- Returns:
- A
ContainerRegistryAsyncClient
with the options set from the builder. - Throws:
NullPointerException
- Ifendpoint
is null. You can set the values by callingendpoint(String)
andaudience(ContainerRegistryAudience)
respectively.IllegalStateException
- If bothretryOptions(RetryOptions)
andretryPolicy(RetryPolicy)
have been set.
-
buildClient
public ContainerRegistryClient buildClient()
Creates aContainerRegistryClient
based on options set in the Builder. Every timebuildAsyncClient()
is called a new instance ofContainerRegistryClient
is created.If
pipeline(HttpPipeline)
pipeline} is set, then thepipeline
andendpoint
are used to create theclient
. All other builder settings are ignored.- Returns:
- A
ContainerRegistryClient
with the options set from the builder. - Throws:
NullPointerException
- Ifendpoint
has not been set. You can set it by callingendpoint(String)
.NullPointerException
- Ifaudience
has not been set. You can set it by callingaudience(ContainerRegistryAudience)
.IllegalStateException
- If bothretryOptions(RetryOptions)
andretryPolicy(RetryPolicy)
have been set.
-
-