DigitalTwinsClientBuilder Class

Package:

com.azure.digitaltwins.core

Maven Artifact:

com.azure:azure-digitaltwins-core:1.5.5

• java.lang.Object
• • com.azure.digitaltwins.core.DigitalTwinsClientBuilder

Implements

ConfigurationTrait<DigitalTwinsClientBuilder> EndpointTrait<DigitalTwinsClientBuilder> HttpTrait<DigitalTwinsClientBuilder> TokenCredentialTrait<DigitalTwinsClientBuilder>

public final class DigitalTwinsClientBuilder
implements ConfigurationTrait<DigitalTwinsClientBuilder>, EndpointTrait<DigitalTwinsClientBuilder>, HttpTrait<DigitalTwinsClientBuilder>, TokenCredentialTrait<DigitalTwinsClientBuilder>

This class provides a fluent builder API to help aid the configuration and instantiation of DigitalTwinsClient and DigitalTwinsAsyncClient, call buildClient() and buildAsyncClient() respectively to construct an instance of the desired client.

Constructor Summary

Constructor	Description
DigitalTwinsClientBuilder()	The public constructor for DigitalTwinsClientBuilder

Method Summary

Modifier and Type	Method and Description
DigitalTwinsClientBuilder	addPolicy(HttpPipelinePolicy pipelinePolicy) Adds a HttpPipelinePolicy to apply on each request sent.
DigitalTwinsAsyncClient	buildAsyncClient() Create a DigitalTwinsAsyncClient based on the builder settings.
DigitalTwinsClient	buildClient() Create a DigitalTwinsClient based on the builder settings.
DigitalTwinsClientBuilder	clientOptions(ClientOptions clientOptions) Allows for setting common properties such as application ID, headers, proxy configuration, etc.
DigitalTwinsClientBuilder	configuration(Configuration configuration) Sets the configuration store that is used during construction of the service client.
DigitalTwinsClientBuilder	credential(TokenCredential tokenCredential) Sets the TokenCredential used to authorize requests sent to the service.
DigitalTwinsClientBuilder	endpoint(String endpoint) Set the service endpoint that the built client will communicate with.
DigitalTwinsClientBuilder	httpClient(HttpClient httpClient) Sets the HttpClient to use for sending and receiving requests to and from the service.
DigitalTwinsClientBuilder	httpLogOptions(HttpLogOptions logOptions) Sets the HttpLogOptions to use when sending and receiving requests to and from the service.
DigitalTwinsClientBuilder	pipeline(HttpPipeline httpPipeline) Sets the HttpPipeline to use for the service client.
DigitalTwinsClientBuilder	retryOptions(RetryOptions retryOptions) Sets the RetryOptions for all the requests made through the client.
DigitalTwinsClientBuilder	retryPolicy(RetryPolicy retryPolicy) Sets the HttpPipelinePolicy that is used as the retry policy for each request that is sent.
DigitalTwinsClientBuilder	serializer(JsonSerializer jsonSerializer) Custom JSON serializer that is used to handle model types that are not contained in the Azure Digital Twins library.
DigitalTwinsClientBuilder	serviceVersion(DigitalTwinsServiceVersion serviceVersion) Sets the DigitalTwinsServiceVersion that is used when making API requests.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DigitalTwinsClientBuilder

public DigitalTwinsClientBuilder()

The public constructor for DigitalTwinsClientBuilder

Method Details

addPolicy

public DigitalTwinsClientBuilder addPolicy(HttpPipelinePolicy pipelinePolicy)

Adds a HttpPipelinePolicy 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 no HttpPipeline 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 an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

Parameters:

pipelinePolicy - A HttpPipelinePolicy.

Returns:

the updated DigitalTwinsClientBuilder instance for fluent building.

buildAsyncClient

public DigitalTwinsAsyncClient buildAsyncClient()

Create a DigitalTwinsAsyncClient based on the builder settings.

Returns:

the created asynchronous DigitalTwinsAsyncClient

buildClient

public DigitalTwinsClient buildClient()

Create a DigitalTwinsClient based on the builder settings.

Returns:

the created synchronous DigitalTwinsClient

clientOptions

public DigitalTwinsClientBuilder clientOptions(ClientOptions 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 the HttpClientOptions class (a subclass of the ClientOptions 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 no HttpPipeline 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 an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

Parameters:

clientOptions - A configured instance of HttpClientOptions.

Returns:

The updated DigitalTwinsClientBuilder object.

configuration

public DigitalTwinsClientBuilder configuration(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 NONE to bypass using configuration settings during construction.

Parameters:

configuration - The configuration store used to

Returns:

The updated DigitalTwinsClientBuilder object for fluent building.

credential

public DigitalTwinsClientBuilder credential(TokenCredential tokenCredential)

Sets the TokenCredential 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 the TokenCredential type.

Parameters:

tokenCredential - TokenCredential used to authorize requests sent to the service.

Returns:

the updated DigitalTwinsClientBuilder instance for fluent building.

endpoint

public DigitalTwinsClientBuilder endpoint(String endpoint)

Set the service endpoint that the built client will communicate with. This field is mandatory to set.

Parameters:

endpoint - URL of the service.

Returns:

the updated DigitalTwinsClientBuilder instance for fluent building.

httpClient

public DigitalTwinsClientBuilder httpClient(HttpClient httpClient)

Sets the HttpClient 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 no HttpPipeline 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 an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

Parameters:

httpClient - The HttpClient to use for requests.

Returns:

the updated DigitalTwinsClientBuilder instance for fluent building.

httpLogOptions

public DigitalTwinsClientBuilder httpLogOptions(HttpLogOptions logOptions)

Sets the HttpLogOptions to use when sending and receiving requests to and from the service. If a logLevel is not provided, default value of HttpLogDetailLevel#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 no HttpPipeline 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 an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

Parameters:

logOptions - The HttpLogOptions to use when sending and receiving requests to and from the service.

Returns:

the updated DigitalTwinsClientBuilder instance for fluent building.

pipeline

public DigitalTwinsClientBuilder pipeline(HttpPipeline httpPipeline)

Sets the HttpPipeline 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 no HttpPipeline 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 an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

If pipeline is set, all other settings are ignored, aside from endpoint(String endpoint).

Parameters:

httpPipeline - HttpPipeline to use for sending service requests and receiving responses.

Returns:

the updated DigitalTwinsClientBuilder instance for fluent building.

retryOptions

public DigitalTwinsClientBuilder retryOptions(RetryOptions retryOptions)

Sets the RetryOptions 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 no HttpPipeline 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 an HttpPipeline 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 retryPolicy).

Parameters:

retryOptions - The RetryOptions to use for all the requests made through the client.

Returns:

the updated DigitalTwinsClientBuilder instance for fluent building.

retryPolicy

public DigitalTwinsClientBuilder retryPolicy(RetryPolicy retryPolicy)

Sets the HttpPipelinePolicy that is used as the retry policy for each request that is sent.

The default retry policy will be used if not provided. The default retry policy is RetryPolicy#RetryPolicy(). For implementing custom retry logic, see RetryPolicy as an example.

Setting this is mutually exclusive with using retryOptions(RetryOptions retryOptions).

Parameters:

retryPolicy - the retry policy applied to each request.

Returns:

the updated DigitalTwinsClientBuilder instance for fluent building.

serializer

public DigitalTwinsClientBuilder serializer(JsonSerializer jsonSerializer)

Custom JSON serializer that is used to handle model types that are not contained in the Azure Digital Twins library.

Parameters:

jsonSerializer - The serializer to deserialize response payloads into user defined models.

Returns:

The updated DigitalTwinsClientBuilder object.

serviceVersion

public DigitalTwinsClientBuilder serviceVersion(DigitalTwinsServiceVersion serviceVersion)

Sets the DigitalTwinsServiceVersion 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 of the client library will have the result of potentially moving to a newer service version.

Targeting a specific service version may also mean that the service will return an error for newer APIs.

Parameters:

serviceVersion - The service API version to use.

Returns:

the updated DigitalTwinsClientBuilder instance for fluent building.