Class ConfigurationClientBuilder
- All Implemented Interfaces:
ConfigurationTrait<ConfigurationClientBuilder>
,ConnectionStringTrait<ConfigurationClientBuilder>
,EndpointTrait<ConfigurationClientBuilder>
,HttpTrait<ConfigurationClientBuilder>
,TokenCredentialTrait<ConfigurationClientBuilder>
ConfigurationClients
and ConfigurationAsyncClients
, call buildClient
and buildAsyncClient
respectively to construct an instance of
the desired client.
The client needs the service endpoint of the Azure App Configuration store and access credential.
connectionString(String)
gives the builder the service endpoint and access
credential.
Instantiating an asynchronous Configuration Client
ConfigurationAsyncClient configurationAsyncClient = new ConfigurationClientBuilder() .connectionString(connectionString) .buildAsyncClient();
Instantiating a synchronous Configuration Client
ConfigurationClient configurationClient = new ConfigurationClientBuilder() .connectionString(connectionString) .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 ConfigurationClient
and ConfigurationAsyncClient
is built.
HttpPipeline pipeline = new HttpPipelineBuilder() .policies(/* add policies */) .build(); ConfigurationClient configurationClient = new ConfigurationClientBuilder() .pipeline(pipeline) .endpoint("https://myconfig.azure.net/") .connectionString(connectionString) .buildClient();
- See Also:
-
Constructor Summary
ConstructorDescriptionConstructs a new builder used to configure and buildConfigurationClients
andConfigurationAsyncClients
. -
Method Summary
Modifier and TypeMethodDescriptionaddPolicy
(HttpPipelinePolicy policy) Adds apipeline policy
to apply on each request sent.Creates aConfigurationAsyncClient
based on options set in the Builder.Creates aConfigurationClient
based on options set in the Builder.clientOptions
(ClientOptions clientOptions) Allows for setting common properties such as application ID, headers, proxy configuration, etc.configuration
(Configuration configuration) Sets the configuration store that is used during construction of the service client.connectionString
(String connectionString) Sets the credential to use when authenticating HTTP requests.credential
(TokenCredential tokenCredential) Sets theTokenCredential
used to authorize requests sent to the service.Sets the service endpoint for the Azure App Configuration instance.httpClient
(HttpClient client) Sets theHttpClient
to use for sending and receiving requests to and from the service.httpLogOptions
(HttpLogOptions logOptions) Sets thelogging configuration
to use when sending and receiving requests to and from the service.pipeline
(HttpPipeline pipeline) Sets theHttpPipeline
to use for the service client.retryOptions
(RetryOptions retryOptions) Sets theRetryOptions
for all the requests made through the client.retryPolicy
(HttpPipelinePolicy retryPolicy) Sets theHttpPipelinePolicy
that is used to retry requests.Sets theConfigurationServiceVersion
that is used when making API requests.
-
Constructor Details
-
ConfigurationClientBuilder
public ConfigurationClientBuilder()Constructs a new builder used to configure and buildConfigurationClients
andConfigurationAsyncClients
.
-
-
Method Details
-
buildClient
Creates aConfigurationClient
based on options set in the Builder. Every timebuildClient()
is called a new instance ofConfigurationClient
is created.If
pipeline
is set, then thepipeline
andendpoint
are used to create theclient
. All other builder settings are ignored.- Returns:
- A ConfigurationClient with the options set from the builder.
- Throws:
NullPointerException
- Ifendpoint
has not been set. This setting is automatically set whenconnectionString
is called. Or can be set explicitly by callingendpoint(String)
.IllegalStateException
- IfconnectionString
has not been set.IllegalStateException
- If bothretryOptions(RetryOptions)
andretryPolicy(HttpPipelinePolicy)
have been set.
-
buildAsyncClient
Creates aConfigurationAsyncClient
based on options set in the Builder. Every timebuildAsyncClient()
is called a new instance ofConfigurationAsyncClient
is created.If
pipeline
is set, then thepipeline
andendpoint
are used to create theclient
. All other builder settings are ignored.- Returns:
- A ConfigurationAsyncClient with the options set from the builder.
- Throws:
NullPointerException
- Ifendpoint
has not been set. This setting is automatically set whenconnectionString
is called. Or can be set explicitly by callingendpoint(String)
.IllegalStateException
- IfconnectionString
has not been set.IllegalStateException
- If bothretryOptions(RetryOptions)
andretryPolicy(HttpPipelinePolicy)
have been set.
-
endpoint
Sets the service endpoint for the Azure App Configuration instance.- Specified by:
endpoint
in interfaceEndpointTrait<ConfigurationClientBuilder>
- Parameters:
endpoint
- The URL of the Azure App Configuration instance.- Returns:
- The updated ConfigurationClientBuilder object.
- Throws:
IllegalArgumentException
- Ifendpoint
is null, or it cannot be parsed into a valid URL.
-
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 interfaceHttpTrait<ConfigurationClientBuilder>
- Parameters:
clientOptions
- A configured instance ofHttpClientOptions
.- Returns:
- the updated ConfigurationClientBuilder object
- See Also:
-
connectionString
Sets the credential to use when authenticating HTTP requests. Also, sets theendpoint
for this ConfigurationClientBuilder.- Specified by:
connectionString
in interfaceConnectionStringTrait<ConfigurationClientBuilder>
- Parameters:
connectionString
- Connection string in the format "endpoint={endpoint_value};id={id_value}; secret={secret_value}"- Returns:
- The updated ConfigurationClientBuilder object.
- Throws:
NullPointerException
- IfconnectionString
is null.IllegalArgumentException
- IfconnectionString
is an empty string, theconnectionString
secret is invalid, or the HMAC-SHA256 MAC algorithm cannot be instantiated.
-
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 interfaceTokenCredentialTrait<ConfigurationClientBuilder>
- Parameters:
tokenCredential
-TokenCredential
used to authorize requests sent to the service.- Returns:
- The updated ConfigurationClientBuilder object.
- Throws:
NullPointerException
- Ifcredential
is null.
-
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 interfaceHttpTrait<ConfigurationClientBuilder>
- Parameters:
logOptions
- Thelogging configuration
to use when sending and receiving requests to and from the service.- Returns:
- The updated ConfigurationClientBuilder object.
-
addPolicy
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 interfaceHttpTrait<ConfigurationClientBuilder>
- Parameters:
policy
- Apipeline policy
.- Returns:
- The updated ConfigurationClientBuilder object.
- Throws:
NullPointerException
- Ifpolicy
is null.
-
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 interfaceHttpTrait<ConfigurationClientBuilder>
- Parameters:
client
- TheHttpClient
to use for requests.- Returns:
- The updated ConfigurationClientBuilder object.
-
pipeline
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.The
endpoint
is not ignored whenpipeline
is set.- Specified by:
pipeline
in interfaceHttpTrait<ConfigurationClientBuilder>
- Parameters:
pipeline
-HttpPipeline
to use for sending service requests and receiving responses.- Returns:
- The updated ConfigurationClientBuilder object.
-
configuration
Sets the configuration store that is used during construction of the service client. The default configuration store is a clone of theglobal configuration store
, useConfiguration.NONE
to bypass using configuration settings during construction.- Specified by:
configuration
in interfaceConfigurationTrait<ConfigurationClientBuilder>
- Parameters:
configuration
- The configuration store used to- Returns:
- The updated ConfigurationClientBuilder object.
-
retryPolicy
Sets theHttpPipelinePolicy
that is used to retry requests.The default retry policy will be used if not provided
buildAsyncClient()
to buildConfigurationAsyncClient
orConfigurationClient
.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 ConfigurationClientBuilder object.
-
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(HttpPipelinePolicy)
.- Specified by:
retryOptions
in interfaceHttpTrait<ConfigurationClientBuilder>
- Parameters:
retryOptions
- TheRetryOptions
to use for all the requests made through the client.- Returns:
- The updated
ConfigurationClientBuilder
object.
-
serviceVersion
Sets theConfigurationServiceVersion
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 based on the version of the client library being used. If no service version is specified, updating to a newer version the client library will have the result of potentially moving to a newer service version.
- Parameters:
version
-ConfigurationServiceVersion
of the service to be used when making requests.- Returns:
- The updated ConfigurationClientBuilder object.
-