SecretClientBuilder Class

Definition

Package:

com.azure.security.keyvault.secrets

Maven Artifact:

com.azure:azure-security-keyvault-secrets:4.4.1

• java.lang.Object
• • com.azure.security.keyvault.secrets.SecretClientBuilder

This class provides a fluent builder API to help aid the configuration and instantiation of the SecretAsyncClient and SecretClient, by calling buildAsyncClient() and buildClient() respectively. It constructs an instance of the desired client.

The minimal configuration options required by SecretClientBuilder to build SecretAsyncClient are vaultUrl and TokenCredential.

SecretAsyncClient secretAsyncClient = new SecretClientBuilder()
     .credential(new DefaultAzureCredentialBuilder().build())
     .vaultUrl("https://myvault.vault.azure.net/")
     .httpLogOptions(new HttpLogOptions().setLogLevel(HttpLogDetailLevel.BODY_AND_HEADERS))
     .buildAsyncClient();

Samples to construct the sync client

SecretClient secretClient = new SecretClientBuilder()
     .credential(new DefaultAzureCredentialBuilder().build())
     .vaultUrl("https://myvault.vault.azure.net/")
     .httpLogOptions(new HttpLogOptions().setLogLevel(HttpLogDetailLevel.BODY_AND_HEADERS))
     .buildClient();

The log detail level, multiple custom policies and custom HttpClient can be optionally configured in the SecretClientBuilder.

SecretAsyncClient secretAsyncClient = new SecretClientBuilder()
     .httpLogOptions(new HttpLogOptions().setLogLevel(HttpLogDetailLevel.BODY_AND_HEADERS))
     .vaultUrl("https://myvault.azure.net/")
     .credential(new DefaultAzureCredentialBuilder().build())
     .httpClient(HttpClient.createDefault())
     .buildAsyncClient();

Alternatively, custom HttpPipeline with custom HttpPipelinePolicy policies and vaultUrl can be specified. It provides finer control over the construction of SecretAsyncClient

HttpPipeline pipeline = new HttpPipelineBuilder()
     .policies(new KeyVaultCredentialPolicy(credential), new RetryPolicy())
     .build();
 SecretAsyncClient secretAsyncClient = new SecretClientBuilder()
     .pipeline(pipeline)
     .vaultUrl("https://myvault.azure.net/")
     .buildAsyncClient();

public final class SecretClientBuilder implements TokenCredentialTrait<SecretClientBuilder>, HttpTrait<SecretClientBuilder>, ConfigurationTrait<SecretClientBuilder>

Implements

ConfigurationTrait<SecretClientBuilder> HttpTrait<SecretClientBuilder> TokenCredentialTrait<SecretClientBuilder>

Constructors

SecretClientBuilder()

The constructor with defaults.

Methods

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.
buildAsyncClient()	Creates a SecretAsyncClient based on options set in the builder. Every time buildAsyncClient() is called, a new instance of SecretAsyncClient is created. If pipeline(HttpPipeline pipeline) is set, then the pipeline and vaultUrl(String vaultUrl) are used to create the SecretClientBuilder. All other builder settings are ignored. If pipeline is not set, then credential(TokenCredential credential), and vaultUrl(String vaultUrl) key vault url are required to build the SecretAsyncClient.
buildClient()	Creates a SecretClient based on options set in the builder. Every time buildClient() is called, a new instance of SecretClient is created. If pipeline(HttpPipeline pipeline) is set, then the pipeline and vaultUrl(String vaultUrl) are used to create the SecretClientBuilder. All other builder settings are ignored. If pipeline is not set, then credential(TokenCredential credential), and vaultUrl(String vaultUrl) key vault url are required to build the SecretClient.
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.
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.
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.
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.
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.
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 vaultUrl(String vaultUrl) is not ignored when pipeline is set.
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(RetryPolicy retryPolicy).
retryPolicy(RetryPolicy retryPolicy)	Sets the RetryPolicy that is used when each request is sent. Setting this is mutually exclusive with using retryOptions(RetryOptions retryOptions). The default retry policy will be used in the pipeline, if not provided.
serviceVersion(SecretServiceVersion version)	Sets the SecretServiceVersion 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.
vaultUrl(String vaultUrl)	Sets the vault URL to send HTTP requests to.

Inherited Members

java.lang.Object.clone() java.lang.Object.equals(java.lang.Object) java.lang.Object.finalize() java.lang.Object.getClass() java.lang.Object.hashCode() java.lang.Object.notify() java.lang.Object.notifyAll() java.lang.Object.toString() java.lang.Object.wait() java.lang.Object.wait(long) java.lang.Object.wait(long,int)