com.azure.keyvault

Class SecretAsyncClientBuilder

java.lang.Object

com.azure.keyvault.SecretAsyncClientBuilder

public final class SecretAsyncClientBuilder
extends Object

This class provides a fluent builder API to help aid the configuration and instantiation of the secret async client, calling build constructs an instance of the client.

The minimal configuration options required by secretClientBuilder to build SecretAsyncClient are endpoint and credential.

 SecretAsyncClient.builder()
   .endpoint("https://myvault.vault.azure.net/")
   .credential(keyVaultAsyncCredential)
   .build();
 

The log detail level, multiple custom policies and custom http client can be optionally configured in the SecretAsyncClientBuilder.

 SecretAsyncClient secretAsyncClient = SecretAsyncClient.builder()
   .endpoint("https://myvault.vault.azure.net/")
   .credential(keyVaultAsyncCredential)
   .httpLogDetailLevel(HttpLogDetailLevel.BODY_AND_HEADERS)
   .addPolicy(customPolicyOne)
   .addPolicy(customPolicyTwo)
   .httpClient(client)
   .build();
 

Alternatively, custom http pipeline with custom HttpPipelinePolicy policies and endpoint can be specified. It provides finer control over the construction of client

 SecretAsyncClient.builder()
   .pipeline(new HttpPipeline(customPoliciesList))
   .endpoint("https://myvault.vault.azure.net/")
   .build()
 

See Also:

SecretAsyncClient

Method Summary

Modifier and Type	Method and Description
SecretAsyncClientBuilder	addPolicy(HttpPipelinePolicy policy) Adds a policy to the set of existing policies that are executed after SecretAsyncClient required policies.
SecretAsyncClient	build() Creates a SecretAsyncClient based on options set in the builder.
SecretAsyncClientBuilder	credential(TokenCredential credential) Sets the credential to use when authenticating HTTP requests.
SecretAsyncClientBuilder	endpoint(String endPoint) Sets the vault endpoint url to send HTTP requests to.
SecretAsyncClientBuilder	httpClient(HttpClient client) Sets the HTTP client to use for sending and receiving requests to and from the service.
SecretAsyncClientBuilder	httpLogDetailLevel(HttpLogDetailLevel logLevel) Sets the logging level for HTTP requests and responses.
SecretAsyncClientBuilder	pipeline(HttpPipeline pipeline) Sets the HTTP pipeline to use for the service client.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

public SecretAsyncClient build()

Creates a SecretAsyncClient based on options set in the builder. Every time build() is called, a new instance of SecretAsyncClient is created.

If pipeline is set, then the pipeline and serviceEndpoint are used to create the client. All other builder settings are ignored. If pipeline is not set, then key vault credential and {@link SecretAsyncClientBuilder#endpoint(String)} key vault endpoint are required to build the {@link SecretAsyncClient client}.

Returns:

A SecretAsyncClient with the options set from the builder.

Throws:

IllegalStateException - If SecretAsyncClientBuilder.credential(TokenCredential) or SecretAsyncClientBuilder.endpoint(String) have not been set.

endpoint

public SecretAsyncClientBuilder endpoint(String endPoint)

Sets the vault endpoint url to send HTTP requests to.

Parameters:

endPoint - The vault endpoint url is used as destination on Azure to send requests to.

Returns:

the updated Builder object.

Throws:

IllegalArgumentException - if endpoint is null or it cannot be parsed into a valid URL.

credential

public SecretAsyncClientBuilder credential(TokenCredential credential)

Sets the credential to use when authenticating HTTP requests.

Parameters:

credential - The credential to use for authenticating HTTP requests.

Returns:

the updated Builder object.

Throws:

NullPointerException - if credential is null.

httpLogDetailLevel

public SecretAsyncClientBuilder httpLogDetailLevel(HttpLogDetailLevel logLevel)

Sets the logging level for HTTP requests and responses.

logLevel is optional. If not provided, default value of HttpLogDetailLevel.NONE is set.

Parameters:

logLevel - The amount of logging output when sending and receiving HTTP requests/responses.

Returns:

the updated Builder object.

Throws:

NullPointerException - if logLevel is null.

addPolicy

public SecretAsyncClientBuilder addPolicy(HttpPipelinePolicy policy)

Adds a policy to the set of existing policies that are executed after SecretAsyncClient required policies.

Parameters:

policy - The policy to be added.

Returns:

the updated Builder object.

Throws:

NullPointerException - if policy is null.

httpClient

public SecretAsyncClientBuilder httpClient(HttpClient client)

Sets the HTTP client to use for sending and receiving requests to and from the service.

Parameters:

client - The HTTP client to use for requests.

Returns:

the updated Builder object.

Throws:

NullPointerException - If client is null.

pipeline

public SecretAsyncClientBuilder pipeline(HttpPipeline pipeline)

Sets the HTTP pipeline to use for the service client. If pipeline is set, all other settings are ignored, aside from endpoint to build SecretAsyncClient.

Parameters:

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

Returns:

the updated SecretAsyncClientBuilder object.