Class ConfidentialLedgerCertificateClientBuilder
- All Implemented Interfaces:
ConfigurationTrait<ConfidentialLedgerCertificateClientBuilder>
,HttpTrait<ConfidentialLedgerCertificateClientBuilder>
,TokenCredentialTrait<ConfidentialLedgerCertificateClientBuilder>
-
Constructor Summary
ConstructorDescriptionCreate an instance of the ConfidentialLedgerCertificateClientBuilder. -
Method Summary
Modifier and TypeMethodDescriptionaddPolicy
(HttpPipelinePolicy customPolicy) Adds apipeline policy
to apply on each request sent.Builds an instance of ConfidentialLedgerCertificateAsyncClient class.Builds an instance of ConfidentialLedgerCertificateClient class.certificateEndpoint
(String certificateEndpoint) Sets The certificate endpoint (or "Identity Service Endpoint" in the Azure portal), for example https://identity.confidential-ledger.core.azure.com.clientOptions
(ClientOptions clientOptions) Allows for setting common properties such as application ID, headers, proxy configuration, etc.configuration
(Configuration configuration) Sets the client-specific configuration used to retrieve client or global configuration properties when building a client.credential
(TokenCredential tokenCredential) Sets theTokenCredential
used to authorize requests sent to the service.httpClient
(HttpClient httpClient) Sets theHttpClient
to use for sending and receiving requests to and from the service.httpLogOptions
(HttpLogOptions httpLogOptions) Sets thelogging configuration
to use when sending and receiving requests to and from the service.pipeline
(HttpPipeline pipeline) Sets theHttpPipeline
to use for the service client.retryOptions
(RetryOptions retryOptions) Sets theRetryOptions
for all the requests made through the client.retryPolicy
(RetryPolicy retryPolicy) Sets The retry policy that will attempt to retry failed requests, if applicable.serviceVersion
(ConfidentialLedgerCertificateServiceVersion serviceVersion) Sets Service version.
-
Constructor Details
-
ConfidentialLedgerCertificateClientBuilder
public ConfidentialLedgerCertificateClientBuilder()Create an instance of the ConfidentialLedgerCertificateClientBuilder.
-
-
Method Details
-
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.- Specified by:
pipeline
in interfaceHttpTrait<ConfidentialLedgerCertificateClientBuilder>
- Parameters:
pipeline
-HttpPipeline
to use for sending service requests and receiving responses.- Returns:
- Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of operations.
-
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 interfaceHttpTrait<ConfidentialLedgerCertificateClientBuilder>
- Parameters:
httpClient
- TheHttpClient
to use for requests.- Returns:
- Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of operations.
-
httpLogOptions
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 interfaceHttpTrait<ConfidentialLedgerCertificateClientBuilder>
- Parameters:
httpLogOptions
- Thelogging configuration
to use when sending and receiving requests to and from the service.- Returns:
- Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of operations.
-
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 interfaceHttpTrait<ConfidentialLedgerCertificateClientBuilder>
- Parameters:
clientOptions
- A configured instance ofHttpClientOptions
.- Returns:
- Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of operations.
- See Also:
-
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.- Specified by:
retryOptions
in interfaceHttpTrait<ConfidentialLedgerCertificateClientBuilder>
- Parameters:
retryOptions
- TheRetryOptions
to use for all the requests made through the client.- Returns:
- Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of operations.
-
addPolicy
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 interfaceHttpTrait<ConfidentialLedgerCertificateClientBuilder>
- Parameters:
customPolicy
- Apipeline policy
.- Returns:
- Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of operations.
-
configuration
Sets the client-specific configuration used to retrieve client or global configuration properties when building a client..- Specified by:
configuration
in interfaceConfigurationTrait<ConfidentialLedgerCertificateClientBuilder>
- Parameters:
configuration
- Configuration store used to retrieve client configurations.- Returns:
- Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of operations.
-
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 interfaceTokenCredentialTrait<ConfidentialLedgerCertificateClientBuilder>
- Parameters:
tokenCredential
-TokenCredential
used to authorize requests sent to the service.- Returns:
- Returns the same concrete type with the appropriate properties updated, to allow for fluent chaining of operations.
-
certificateEndpoint
Sets The certificate endpoint (or "Identity Service Endpoint" in the Azure portal), for example https://identity.confidential-ledger.core.azure.com.- Parameters:
certificateEndpoint
- the certificateEndpoint value.- Returns:
- the ConfidentialLedgerCertificateClientBuilder.
-
serviceVersion
public ConfidentialLedgerCertificateClientBuilder serviceVersion(ConfidentialLedgerCertificateServiceVersion serviceVersion) Sets Service version.- Parameters:
serviceVersion
- the serviceVersion value.- Returns:
- the ConfidentialLedgerCertificateClientBuilder.
-
retryPolicy
Sets The retry policy that will attempt to retry failed requests, if applicable.- Parameters:
retryPolicy
- the retryPolicy value.- Returns:
- the ConfidentialLedgerCertificateClientBuilder.
-
buildAsyncClient
Builds an instance of ConfidentialLedgerCertificateAsyncClient class.- Returns:
- an instance of ConfidentialLedgerCertificateAsyncClient.
-
buildClient
Builds an instance of ConfidentialLedgerCertificateClient class.- Returns:
- an instance of ConfidentialLedgerCertificateClient.
-