ConfigurationClientBuilder Class

  • Reference
Package:
com.azure.data.appconfiguration
Maven Artifact:
com.azure:azure-data-appconfiguration:1.7.2
  • java.lang.Object
    • com.azure.data.appconfiguration.ConfigurationClientBuilder

Implements

ConfigurationTrait<ConfigurationClientBuilder> ConnectionStringTrait<ConfigurationClientBuilder> EndpointTrait<ConfigurationClientBuilder> HttpTrait<ConfigurationClientBuilder> TokenCredentialTrait<ConfigurationClientBuilder>

public final class ConfigurationClientBuilder
implements TokenCredentialTrait<ConfigurationClientBuilder>, ConnectionStringTrait<ConfigurationClientBuilder>, HttpTrait<ConfigurationClientBuilder>, ConfigurationTrait<ConfigurationClientBuilder>, EndpointTrait<ConfigurationClientBuilder>

This class provides a fluent builder API to help aid the configuration and instantiation of ConfigurationClient and ConfigurationAsyncClient, 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 connectionString) 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 pipeline(HttpPipeline pipeline) and set the service endpoint with endpoint(String endpoint). 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://dummy.azure.net/")
     .connectionString(connectionString)
     .buildClient();

Constructor Summary

Constructor Description
ConfigurationClientBuilder()

Constructs a new builder used to configure and build ConfigurationClient and ConfigurationAsyncClient.

Method Summary

Modifier and Type Method and Description
ConfigurationClientBuilder addPolicy(HttpPipelinePolicy policy)

Adds a HttpPipelinePolicy to apply on each request sent.
ConfigurationAsyncClient buildAsyncClient()

Creates a ConfigurationAsyncClient based on options set in the Builder.
ConfigurationClient buildClient()

Creates a ConfigurationClient based on options set in the Builder.
ConfigurationClientBuilder clientOptions(ClientOptions clientOptions)

Allows for setting common properties such as application ID, headers, proxy configuration, etc.
ConfigurationClientBuilder configuration(Configuration configuration)

Sets the configuration store that is used during construction of the service client.
ConfigurationClientBuilder connectionString(String connectionString)

Sets the credential to use when authenticating HTTP requests.
ConfigurationClientBuilder credential(TokenCredential tokenCredential)

Sets the TokenCredential used to authorize requests sent to the service.
ConfigurationClientBuilder endpoint(String endpoint)

Sets the service endpoint for the Azure App Configuration instance.
ConfigurationClientBuilder httpClient(HttpClient client)

Sets the HttpClient to use for sending and receiving requests to and from the service.
ConfigurationClientBuilder httpLogOptions(HttpLogOptions logOptions)

Sets the HttpLogOptions to use when sending and receiving requests to and from the service.
ConfigurationClientBuilder pipeline(HttpPipeline pipeline)

Sets the HttpPipeline to use for the service client.
ConfigurationClientBuilder retryOptions(RetryOptions retryOptions)

Sets the RetryOptions for all the requests made through the client.
ConfigurationClientBuilder retryPolicy(HttpPipelinePolicy retryPolicy)

Sets the HttpPipelinePolicy that is used to retry requests.
ConfigurationClientBuilder serviceVersion(ConfigurationServiceVersion version)

Sets the ConfigurationServiceVersion that is used when making API requests.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ConfigurationClientBuilder

public ConfigurationClientBuilder()

Constructs a new builder used to configure and build ConfigurationClient and ConfigurationAsyncClient.

Method Details

addPolicy

public ConfigurationClientBuilder addPolicy(HttpPipelinePolicy policy)

Adds a HttpPipelinePolicy 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.

Parameters:

policy - A HttpPipelinePolicy.

Returns:

The updated ConfigurationClientBuilder object.

buildAsyncClient

public ConfigurationAsyncClient buildAsyncClient()

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

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

Returns:

A ConfigurationAsyncClient with the options set from the builder.

buildClient

public ConfigurationClient buildClient()

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

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

Returns:

A ConfigurationClient with the options set from the builder.

clientOptions

public ConfigurationClientBuilder clientOptions(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.

Parameters:

clientOptions - A configured instance of HttpClientOptions.

Returns:

the updated ConfigurationClientBuilder object

configuration

public ConfigurationClientBuilder configuration(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 NONE to bypass using configuration settings during construction.

Parameters:

configuration - The configuration store used to

Returns:

The updated ConfigurationClientBuilder object.

connectionString

public ConfigurationClientBuilder connectionString(String connectionString)

Sets the credential to use when authenticating HTTP requests. Also, sets the endpoint(String endpoint) for this ConfigurationClientBuilder.

Parameters:

connectionString - Connection string in the format "endpoint={endpoint_value};id={id_value}; secret={secret_value}"

Returns:

The updated ConfigurationClientBuilder object.

credential

public ConfigurationClientBuilder credential(TokenCredential tokenCredential)

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.

Parameters:

tokenCredential - TokenCredential used to authorize requests sent to the service.

Returns:

The updated ConfigurationClientBuilder object.

endpoint

public ConfigurationClientBuilder endpoint(String endpoint)

Sets the service endpoint for the Azure App Configuration instance.

Parameters:

endpoint - The URL of the Azure App Configuration instance.

Returns:

The updated ConfigurationClientBuilder object.

httpClient

public ConfigurationClientBuilder httpClient(HttpClient client)

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.

Parameters:

client - The HttpClient to use for requests.

Returns:

The updated ConfigurationClientBuilder object.

httpLogOptions

public ConfigurationClientBuilder httpLogOptions(HttpLogOptions logOptions)

Sets the HttpLogOptions 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.

Parameters:

logOptions - The HttpLogOptions to use when sending and receiving requests to and from the service.

Returns:

The updated ConfigurationClientBuilder object.

pipeline

public ConfigurationClientBuilder pipeline(HttpPipeline pipeline)

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.

The endpoint(String endpoint) is not ignored when pipeline is set.

Parameters:

pipeline - HttpPipeline to use for sending service requests and receiving responses.

Returns:

The updated ConfigurationClientBuilder object.

retryOptions

public ConfigurationClientBuilder retryOptions(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(HttpPipelinePolicy retryPolicy).

Parameters:

retryOptions - The RetryOptions to use for all the requests made through the client.

Returns:

The updated ConfigurationClientBuilder object.

retryPolicy

public ConfigurationClientBuilder retryPolicy(HttpPipelinePolicy retryPolicy)

Sets the HttpPipelinePolicy that is used to retry requests.

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

Setting this is mutually exclusive with using retryOptions(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 ConfigurationClientBuilder object.

serviceVersion

public ConfigurationClientBuilder serviceVersion(ConfigurationServiceVersion version)

Sets the ConfigurationServiceVersion 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.

Applies to