Package com.azure.data.appconfiguration

Class ConfigurationClientBuilder

java.lang.Object
com.azure.data.appconfiguration.ConfigurationClientBuilder
All Implemented Interfaces:
ConfigurationTrait<ConfigurationClientBuilder>, ConnectionStringTrait<ConfigurationClientBuilder>, EndpointTrait<ConfigurationClientBuilder>, HttpTrait<ConfigurationClientBuilder>, TokenCredentialTrait<ConfigurationClientBuilder>
public final class ConfigurationClientBuilder extends Object 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 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: