Package com.azure.security.keyvault.administration

Class KeyVaultAccessControlClientBuilder

java.lang.Object

com.azure.security.keyvault.administration.KeyVaultAccessControlClientBuilder

public final class KeyVaultAccessControlClientBuilder
extends Object

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

The minimal configuration options required by KeyVaultAccessControlClientBuilder to build an an KeyVaultAccessControlAsyncClient are vaultUrl and credential.

Samples to construct a sync client

 KeyVaultAccessControlClient keyVaultAccessControlClient = new KeyVaultAccessControlClientBuilder()
     .vaultUrl("https://myaccount.managedhsm.azure.net/")
     .credential(new DefaultAzureCredentialBuilder().build())
     .buildClient();
 

Samples to construct an async client

 KeyVaultAccessControlAsyncClient keyVaultAccessControlAsyncClient = new KeyVaultAccessControlClientBuilder()
     .vaultUrl("https://myaccount.managedhsm.azure.net/")
     .credential(new DefaultAzureCredentialBuilder().build())
     .buildAsyncClient();
 

See Also:

KeyVaultAccessControlClient, KeyVaultAccessControlAsyncClient

Constructor Summary

Constructors

Constructor	Description
KeyVaultAccessControlClientBuilder()	Creates a KeyVaultAccessControlClientBuilder instance that is able to configure and construct instances of KeyVaultAccessControlClient and KeyVaultAccessControlAsyncClient.

Method Summary

Modifier and Type	Method	Description
KeyVaultAccessControlClientBuilder	addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy)	Adds a policy to the set of existing policies that are executed after and KeyVaultAccessControlClient KeyVaultAccessControlAsyncClient required policies.
KeyVaultAccessControlAsyncClient	buildAsyncClient()	Creates a KeyVaultAccessControlAsyncClient based on options set in the Builder.
KeyVaultAccessControlClient	buildClient()	Creates an KeyVaultAccessControlClient based on options set in the Builder.
KeyVaultAccessControlClientBuilder	clientOptions(com.azure.core.util.ClientOptions clientOptions)	Sets the ClientOptions which enables various options to be set on the client.
KeyVaultAccessControlClientBuilder	configuration(com.azure.core.util.Configuration configuration)	Sets the configuration store that is used during construction of the service client.
KeyVaultAccessControlClientBuilder	credential(com.azure.core.credential.TokenCredential credential)	Sets the credential to use when authenticating HTTP requests.
KeyVaultAccessControlClientBuilder	httpClient(com.azure.core.http.HttpClient client)	Sets the HTTP client to use for sending and receiving requests to and from the service.
KeyVaultAccessControlClientBuilder	httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)	Sets the logging configuration for HTTP requests and responses.
KeyVaultAccessControlClientBuilder	pipeline(com.azure.core.http.HttpPipeline pipeline)	Sets the HTTP pipeline to use for the service client.
KeyVaultAccessControlClientBuilder	retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy)	Sets the RetryPolicy that is used when each request is sent.
KeyVaultAccessControlClientBuilder	serviceVersion(KeyVaultAdministrationServiceVersion serviceVersion)	Sets the KeyVaultAdministrationServiceVersion that is used when making API requests.
KeyVaultAccessControlClientBuilder	vaultUrl(String vaultUrl)	Sets the URL to the Key Vault on which the client operates.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyVaultAccessControlClientBuilder

public KeyVaultAccessControlClientBuilder()

Creates a KeyVaultAccessControlClientBuilder instance that is able to configure and construct instances of KeyVaultAccessControlClient and KeyVaultAccessControlAsyncClient.

Method Detail

buildClient

public KeyVaultAccessControlClient buildClient()

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

If pipeline is set, then only the pipeline and vaultUrl are used to create the client. All other builder settings are ignored.

Returns:

An KeyVaultAccessControlClient with the options set from the builder.

Throws:

NullPointerException - If vaultUrl is null.

buildAsyncClient

public KeyVaultAccessControlAsyncClient buildAsyncClient()

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

If pipeline is set, then only the pipeline and endpoint are used to create the client. All other builder settings are ignored.

Returns:

An KeyVaultAccessControlAsyncClient with the options set from the builder.

Throws:

NullPointerException - If vaultUrl is null.

vaultUrl

public KeyVaultAccessControlClientBuilder vaultUrl(String vaultUrl)

Sets the URL to the Key Vault on which the client operates. Appears as "DNS Name" in the Azure portal.

Parameters:

vaultUrl - The vault URL is used as destination on Azure to send requests to.

Returns:

The updated KeyVaultAccessControlClientBuilder object.

Throws:

IllegalArgumentException - If vaultUrl cannot be parsed into a valid URL.

NullPointerException - If credential is null.

credential

public KeyVaultAccessControlClientBuilder credential(com.azure.core.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 KeyVaultAccessControlClientBuilder object.

Throws:

NullPointerException - If credential is null.

httpLogOptions

public KeyVaultAccessControlClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)

Sets the logging configuration for HTTP requests and responses.

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

Parameters:

logOptions - The logging configuration to use when sending and receiving HTTP requests/responses.

Returns:

The updated KeyVaultAccessControlClientBuilder object.

addPolicy

public KeyVaultAccessControlClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy)

Adds a policy to the set of existing policies that are executed after and KeyVaultAccessControlClient KeyVaultAccessControlAsyncClient required policies.

Parameters:

policy - The policy to be added.

Returns:

The updated KeyVaultAccessControlClientBuilder object.

Throws:

NullPointerException - If policy is null.

httpClient

public KeyVaultAccessControlClientBuilder httpClient(com.azure.core.http.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 KeyVaultAccessControlClientBuilder object.

pipeline

public KeyVaultAccessControlClientBuilder pipeline(com.azure.core.http.HttpPipeline pipeline)

Sets the HTTP pipeline to use for the service client.

If pipeline is set, all other settings are ignored, aside from vaultUrl to build KeyVaultAccessControlClient or KeyVaultAccessControlAsyncClient.

Parameters:

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

Returns:

The updated KeyVaultAccessControlClientBuilder object.

configuration

public KeyVaultAccessControlClientBuilder configuration(com.azure.core.util.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 Configuration.NONE to bypass using configuration settings during construction.

Parameters:

configuration - The configuration store used to get configuration details.

Returns:

The updated KeyVaultAccessControlClientBuilder object.

retryPolicy

public KeyVaultAccessControlClientBuilder retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy)

Sets the RetryPolicy that is used when each request is sent.

The default retry policy will be used in the pipeline, if not provided.

Parameters:

retryPolicy - User's retry policy applied to each request.

Returns:

The updated KeyVaultAccessControlClientBuilder object.

clientOptions

public KeyVaultAccessControlClientBuilder clientOptions(com.azure.core.util.ClientOptions clientOptions)

Sets the ClientOptions which enables various options to be set on the client. For example setting an applicationId using ClientOptions.setApplicationId(String) to configure the UserAgentPolicy for telemetry/monitoring purposes.

More About Azure Core: Telemetry policy

Parameters:

clientOptions - the ClientOptions to be set on the client.

Returns:

The updated KeyVaultAccessControlClientBuilder object.

serviceVersion

public KeyVaultAccessControlClientBuilder serviceVersion(KeyVaultAdministrationServiceVersion serviceVersion)

Sets the KeyVaultAdministrationServiceVersion 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:

serviceVersion - KeyVaultAdministrationServiceVersion of the service API used when making requests.

Returns:

The updated KeyVaultAccessControlClientBuilder object.