Class KeyVaultSettingsClientBuilder
- All Implemented Interfaces:
com.azure.core.client.traits.ConfigurationTrait<KeyVaultSettingsClientBuilder>
,com.azure.core.client.traits.HttpTrait<KeyVaultSettingsClientBuilder>
,com.azure.core.client.traits.TokenCredentialTrait<KeyVaultSettingsClientBuilder>
KeyVaultSettingsAsyncClient
and KeyVaultSettingsClient
, by calling
buildAsyncClient()
and buildImplClient()
respectively. It constructs an instance of the desired client.
The minimal configuration options required by KeyVaultSettingsClientBuilder
to build a client are
vaultUrl
and credential
.
-
Constructor Summary
ConstructorDescriptionCreate an instance of the KeyVaultSettingsClientBuilder. -
Method Summary
Modifier and TypeMethodDescriptionaddPolicy
(com.azure.core.http.policy.HttpPipelinePolicy policy) Adds apipeline policy
to apply on each request sent.Builds an instance of KeyVaultSettingsAsyncClient class.Builds an instance of KeyVaultSettingsClient class.clientOptions
(com.azure.core.util.ClientOptions clientOptions) Allows for setting common properties such as application ID, headers, proxy configuration, etc.configuration
(com.azure.core.util.Configuration configuration) Sets the configuration store that is used during construction of the service client.credential
(com.azure.core.credential.TokenCredential credential) Sets theTokenCredential
used to authorize requests sent to the service.Disables verifying if the authentication challenge resource matches the Key Vault or Managed HSM domain.httpClient
(com.azure.core.http.HttpClient client) Sets theHttpClient
to use for sending and receiving requests to and from the service.httpLogOptions
(com.azure.core.http.policy.HttpLogOptions logOptions) Sets thelogging configuration
to use when sending and receiving requests to and from the service.pipeline
(com.azure.core.http.HttpPipeline pipeline) Sets theHttpPipeline
to use for the service client.retryOptions
(com.azure.core.http.policy.RetryOptions retryOptions) Sets theRetryOptions
for all the requests made through the client.retryPolicy
(com.azure.core.http.policy.RetryPolicy retryPolicy) Sets theRetryPolicy
that is used when each request is sent.serviceVersion
(KeyVaultAdministrationServiceVersion serviceVersion) Sets theKeyVaultAdministrationServiceVersion
that is used when making API requests.Sets the URL to the Key Vault on which the client operates.
-
Constructor Details
-
KeyVaultSettingsClientBuilder
public KeyVaultSettingsClientBuilder()Create an instance of the KeyVaultSettingsClientBuilder.
-
-
Method Details
-
vaultUrl
Sets the URL to the Key Vault on which the client operates. Appears as "DNS Name" in the Azure portal. You should validate that this URL references a valid Key Vault or Managed HSM resource. Refer to the following documentation for details.- Parameters:
vaultUrl
- The vault URL is used as destination on Azure to send requests to.- Returns:
- The updated
KeyVaultSettingsClientBuilder
object. - Throws:
IllegalArgumentException
- IfvaultUrl
is null or it cannot be parsed into a valid URL.NullPointerException
- Ifcredential
isnull
.
-
credential
public KeyVaultSettingsClientBuilder credential(com.azure.core.credential.TokenCredential credential) Sets theTokenCredential
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 theTokenCredential
type.- Specified by:
credential
in interfacecom.azure.core.client.traits.TokenCredentialTrait<KeyVaultSettingsClientBuilder>
- Parameters:
credential
-TokenCredential
used to authorize requests sent to the service.- Returns:
- The updated
KeyVaultAccessControlClientBuilder
object. - Throws:
NullPointerException
- Ifcredential
isnull
.
-
pipeline
Sets theHttpPipeline
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 noHttpPipeline
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 anHttpPipeline
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
is not ignored whenpipeline
is set.- Specified by:
pipeline
in interfacecom.azure.core.client.traits.HttpTrait<KeyVaultSettingsClientBuilder>
- Parameters:
pipeline
-HttpPipeline
to use for sending service requests and receiving responses.- Returns:
- The updated
KeyVaultSettingsClientBuilder
object.
-
httpClient
Sets theHttpClient
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 noHttpPipeline
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 anHttpPipeline
is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.- Specified by:
httpClient
in interfacecom.azure.core.client.traits.HttpTrait<KeyVaultSettingsClientBuilder>
- Parameters:
client
- TheHttpClient
to use for requests.- Returns:
- The updated
KeyVaultSettingsClientBuilder
object.
-
httpLogOptions
public KeyVaultSettingsClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions) Sets thelogging configuration
to use when sending and receiving requests to and from the service. If alogLevel
is not provided, default value ofHttpLogDetailLevel.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 noHttpPipeline
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 anHttpPipeline
is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.- Specified by:
httpLogOptions
in interfacecom.azure.core.client.traits.HttpTrait<KeyVaultSettingsClientBuilder>
- Parameters:
logOptions
- Thelogging configuration
to use when sending and receiving requests to and from the service.- Returns:
- The updated
KeyVaultSettingsClientBuilder
object.
-
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 theHttpClientOptions
class (a subclass of theClientOptions
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 noHttpPipeline
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 anHttpPipeline
is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.- Specified by:
clientOptions
in interfacecom.azure.core.client.traits.HttpTrait<KeyVaultSettingsClientBuilder>
- Parameters:
clientOptions
- A configured instance ofHttpClientOptions
.- Returns:
- The updated
KeyVaultSettingsClientBuilder
object. - See Also:
-
HttpClientOptions
-
retryOptions
public KeyVaultSettingsClientBuilder retryOptions(com.azure.core.http.policy.RetryOptions retryOptions) Sets theRetryOptions
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 noHttpPipeline
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 anHttpPipeline
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)
.- Specified by:
retryOptions
in interfacecom.azure.core.client.traits.HttpTrait<KeyVaultSettingsClientBuilder>
- Parameters:
retryOptions
- TheRetryOptions
to use for all the requests made through the client.- Returns:
- The updated
KeyVaultSettingsClientBuilder
object.
-
addPolicy
public KeyVaultSettingsClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy) Adds apipeline policy
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 noHttpPipeline
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 anHttpPipeline
is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.- Specified by:
addPolicy
in interfacecom.azure.core.client.traits.HttpTrait<KeyVaultSettingsClientBuilder>
- Parameters:
policy
- Apipeline policy
.- Returns:
- The updated
KeyVaultSettingsClientBuilder
object. - Throws:
NullPointerException
- Ifpolicy
isnull
.
-
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
, useConfiguration.NONE
to bypass using configuration settings during construction.- Specified by:
configuration
in interfacecom.azure.core.client.traits.ConfigurationTrait<KeyVaultSettingsClientBuilder>
- Parameters:
configuration
- The configuration store used to get configuration details.- Returns:
- The updated
KeyVaultSettingsClientBuilder
object.
-
serviceVersion
public KeyVaultSettingsClientBuilder serviceVersion(KeyVaultAdministrationServiceVersion serviceVersion) Sets theKeyVaultAdministrationServiceVersion
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
KeyVaultSettingsClientBuilder
object.
-
retryPolicy
public KeyVaultSettingsClientBuilder retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy) Sets theRetryPolicy
that is used when each request is sent.The default retry policy will be used in the pipeline, if not provided.
Setting this is mutually exclusive with using
retryOptions(RetryOptions)
.- Parameters:
retryPolicy
- User's retry policy applied to each request.- Returns:
- The updated
KeyVaultSettingsClientBuilder
object.
-
disableChallengeResourceVerification
Disables verifying if the authentication challenge resource matches the Key Vault or Managed HSM domain. This verification is performed by default.- Returns:
- The updated
KeyVaultSettingsClientBuilder
object.
-
buildAsyncClient
Builds an instance of KeyVaultSettingsAsyncClient class.- Returns:
- an instance of KeyVaultSettingsAsyncClient.
-
buildClient
Builds an instance of KeyVaultSettingsClient class.- Returns:
- an instance of KeyVaultSettingsClient.
-