public final class KeyVaultAccessControlClientBuilder extends Object
KeyVaultAccessControlAsyncClient
and KeyVaultAccessControlClient
, by calling
KeyVaultAccessControlClientBuilder.buildAsyncClient()
and
KeyVaultAccessControlClientBuilder.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
.
The HttpLogDetailLevel
, multiple custom policies
and custom
HttpClient
can be optionally configured in the KeyVaultAccessControlClientBuilder
.
Alternatively, a custom HttpPipeline
with custom HttpPipelinePolicy
policies and vaultUrl
can be specified. It provides finer control over the construction of
KeyVaultAccessControlAsyncClient
and KeyVaultAccessControlClient
instances.
The minimal configuration options required by KeyVaultAccessControlClientBuilder
to build an
KeyVaultAccessControlClient
are vaultUrl
and credential
.
Constructor and Description |
---|
KeyVaultAccessControlClientBuilder()
Creates a
KeyVaultAccessControlClientBuilder instance that is able to configure and construct
instances of KeyVaultAccessControlClient and KeyVaultAccessControlAsyncClient . |
Modifier and Type | Method and 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.
|
public KeyVaultAccessControlClientBuilder()
KeyVaultAccessControlClientBuilder
instance that is able to configure and construct
instances of KeyVaultAccessControlClient
and KeyVaultAccessControlAsyncClient
.public KeyVaultAccessControlClient buildClient()
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.
KeyVaultAccessControlClient
with the options set from the builder.NullPointerException
- If vaultUrl
is null
.public KeyVaultAccessControlAsyncClient buildAsyncClient()
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.
KeyVaultAccessControlAsyncClient
with the options set from the builder.NullPointerException
- If vaultUrl
is null
.public KeyVaultAccessControlClientBuilder vaultUrl(String vaultUrl)
vaultUrl
- The vault URL is used as destination on Azure to send requests to.KeyVaultAccessControlClientBuilder
object.IllegalArgumentException
- If vaultUrl
cannot be parsed into a valid URL.NullPointerException
- If credential
is null
.public KeyVaultAccessControlClientBuilder credential(com.azure.core.credential.TokenCredential credential)
credential
- The credential to use for authenticating HTTP requests.KeyVaultAccessControlClientBuilder
object.NullPointerException
- If credential
is null
.public KeyVaultAccessControlClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
If logLevel is not provided, default value of HttpLogDetailLevel.NONE
is set.
logOptions
- The logging configuration to use when sending and receiving HTTP requests/responses.KeyVaultAccessControlClientBuilder
object.public KeyVaultAccessControlClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy)
KeyVaultAccessControlClient
KeyVaultAccessControlAsyncClient
required policies.policy
- The policy
to be added.KeyVaultAccessControlClientBuilder
object.NullPointerException
- If policy
is null
.public KeyVaultAccessControlClientBuilder httpClient(com.azure.core.http.HttpClient client)
client
- The HTTP client to use for requests.KeyVaultAccessControlClientBuilder
object.public KeyVaultAccessControlClientBuilder pipeline(com.azure.core.http.HttpPipeline pipeline)
If pipeline
is set, all other settings are ignored, aside from
vaultUrl
to build KeyVaultAccessControlClient
or KeyVaultAccessControlAsyncClient
.
pipeline
- The HTTP pipeline to use for sending service requests and receiving responses.KeyVaultAccessControlClientBuilder
object.public KeyVaultAccessControlClientBuilder configuration(com.azure.core.util.Configuration configuration)
The default configuration store is a clone of the global
configuration store
, use Configuration.NONE
to bypass using configuration settings during construction.
configuration
- The configuration store used to get configuration details.KeyVaultAccessControlClientBuilder
object.public KeyVaultAccessControlClientBuilder retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy)
RetryPolicy
that is used when each request is sent.
The default retry policy will be used in the pipeline, if not provided.
retryPolicy
- User's retry policy applied to each request.KeyVaultAccessControlClientBuilder
object.public KeyVaultAccessControlClientBuilder clientOptions(com.azure.core.util.ClientOptions clientOptions)
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
clientOptions
- the ClientOptions
to be set on the client.KeyVaultAccessControlClientBuilder
object.public KeyVaultAccessControlClientBuilder serviceVersion(KeyVaultAdministrationServiceVersion serviceVersion)
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.serviceVersion
- KeyVaultAdministrationServiceVersion
of the service API used when making requests.KeyVaultAccessControlClientBuilder
object.Copyright © 2021 Microsoft Corporation. All rights reserved.