Class DigitalTwinsClientBuilder
- java.lang.Object
-
- com.azure.digitaltwins.core.DigitalTwinsClientBuilder
-
- All Implemented Interfaces:
com.azure.core.client.traits.ConfigurationTrait<DigitalTwinsClientBuilder>
,com.azure.core.client.traits.EndpointTrait<DigitalTwinsClientBuilder>
,com.azure.core.client.traits.HttpTrait<DigitalTwinsClientBuilder>
,com.azure.core.client.traits.TokenCredentialTrait<DigitalTwinsClientBuilder>
public final class DigitalTwinsClientBuilder extends Object implements com.azure.core.client.traits.ConfigurationTrait<DigitalTwinsClientBuilder>, com.azure.core.client.traits.EndpointTrait<DigitalTwinsClientBuilder>, com.azure.core.client.traits.HttpTrait<DigitalTwinsClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<DigitalTwinsClientBuilder>
This class provides a fluent builder API to help aid the configuration and instantiation ofDigitalTwinsClients
andDigitalTwinsAsyncClients
, callbuildClient
andbuildAsyncClient
respectively to construct an instance of the desired client.
-
-
Constructor Summary
Constructors Constructor Description DigitalTwinsClientBuilder()
The public constructor for DigitalTwinsClientBuilder
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DigitalTwinsClientBuilder
addPolicy(com.azure.core.http.policy.HttpPipelinePolicy pipelinePolicy)
Adds apipeline policy
to apply on each request sent.DigitalTwinsAsyncClient
buildAsyncClient()
Create aDigitalTwinsAsyncClient
based on the builder settings.DigitalTwinsClient
buildClient()
Create aDigitalTwinsClient
based on the builder settings.DigitalTwinsClientBuilder
clientOptions(com.azure.core.util.ClientOptions clientOptions)
Allows for setting common properties such as application ID, headers, proxy configuration, etc.DigitalTwinsClientBuilder
configuration(com.azure.core.util.Configuration configuration)
Sets the configuration store that is used during construction of the service client.DigitalTwinsClientBuilder
credential(com.azure.core.credential.TokenCredential tokenCredential)
Sets theTokenCredential
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(com.azure.core.http.HttpClient httpClient)
Sets theHttpClient
to use for sending and receiving requests to and from the service.DigitalTwinsClientBuilder
httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
Sets thelogging configuration
to use when sending and receiving requests to and from the service.DigitalTwinsClientBuilder
pipeline(com.azure.core.http.HttpPipeline httpPipeline)
Sets theHttpPipeline
to use for the service client.DigitalTwinsClientBuilder
retryOptions(com.azure.core.http.policy.RetryOptions retryOptions)
Sets theRetryOptions
for all the requests made through the client.DigitalTwinsClientBuilder
retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy)
Sets theHttpPipelinePolicy
that is used as the retry policy for each request that is sent.DigitalTwinsClientBuilder
serializer(com.azure.core.util.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 theDigitalTwinsServiceVersion
that is used when making API requests.
-
-
-
Method Detail
-
buildClient
public DigitalTwinsClient buildClient()
Create aDigitalTwinsClient
based on the builder settings.- Returns:
- the created synchronous DigitalTwinsClient
- Throws:
IllegalStateException
- If bothretryOptions(RetryOptions)
andretryPolicy(RetryPolicy)
have been set.
-
buildAsyncClient
public DigitalTwinsAsyncClient buildAsyncClient()
Create aDigitalTwinsAsyncClient
based on the builder settings.- Returns:
- the created asynchronous DigitalTwinsAsyncClient
- Throws:
IllegalStateException
- If bothretryOptions(RetryOptions)
andretryPolicy(RetryPolicy)
have been set.
-
endpoint
public DigitalTwinsClientBuilder endpoint(String endpoint)
Set the service endpoint that the built client will communicate with. This field is mandatory to set.- Specified by:
endpoint
in interfacecom.azure.core.client.traits.EndpointTrait<DigitalTwinsClientBuilder>
- Parameters:
endpoint
- URL of the service.- Returns:
- the updated DigitalTwinsClientBuilder instance for fluent building.
-
credential
public DigitalTwinsClientBuilder credential(com.azure.core.credential.TokenCredential tokenCredential)
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<DigitalTwinsClientBuilder>
- Parameters:
tokenCredential
-TokenCredential
used to authorize requests sent to the service.- Returns:
- the updated DigitalTwinsClientBuilder instance for fluent building.
-
serviceVersion
public DigitalTwinsClientBuilder serviceVersion(DigitalTwinsServiceVersion serviceVersion)
Sets theDigitalTwinsServiceVersion
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.
-
httpClient
public DigitalTwinsClientBuilder httpClient(com.azure.core.http.HttpClient 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<DigitalTwinsClientBuilder>
- Parameters:
httpClient
- TheHttpClient
to use for requests.- Returns:
- the updated DigitalTwinsClientBuilder instance for fluent building.
-
httpLogOptions
public DigitalTwinsClientBuilder 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<DigitalTwinsClientBuilder>
- Parameters:
logOptions
- Thelogging configuration
to use when sending and receiving requests to and from the service.- Returns:
- the updated DigitalTwinsClientBuilder instance for fluent building.
-
addPolicy
public DigitalTwinsClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy pipelinePolicy)
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<DigitalTwinsClientBuilder>
- Parameters:
pipelinePolicy
- Apipeline policy
.- Returns:
- the updated DigitalTwinsClientBuilder instance for fluent building.
- Throws:
NullPointerException
- IfpipelinePolicy
isnull
.
-
retryPolicy
public DigitalTwinsClientBuilder retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy)
Sets theHttpPipelinePolicy
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 isRetryPolicy()
. For implementing custom retry logic, seeRetryPolicy
as an example. Setting this is mutually exclusive with usingretryOptions(RetryOptions)
.- Parameters:
retryPolicy
- the retry policy applied to each request.- Returns:
- the updated DigitalTwinsClientBuilder instance for fluent building.
-
retryOptions
public DigitalTwinsClientBuilder 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<DigitalTwinsClientBuilder>
- Parameters:
retryOptions
- TheRetryOptions
to use for all the requests made through the client.- Returns:
- the updated DigitalTwinsClientBuilder instance for fluent building.
-
pipeline
public DigitalTwinsClientBuilder pipeline(com.azure.core.http.HttpPipeline httpPipeline)
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.If
pipeline
is set, all other settings are ignored, aside fromendpoint
.- Specified by:
pipeline
in interfacecom.azure.core.client.traits.HttpTrait<DigitalTwinsClientBuilder>
- Parameters:
httpPipeline
-HttpPipeline
to use for sending service requests and receiving responses.- Returns:
- the updated DigitalTwinsClientBuilder instance for fluent building.
-
configuration
public DigitalTwinsClientBuilder 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 theglobal configuration store
, useConfiguration.NONE
to bypass using configuration settings during construction.- Specified by:
configuration
in interfacecom.azure.core.client.traits.ConfigurationTrait<DigitalTwinsClientBuilder>
- Parameters:
configuration
- The configuration store used to- Returns:
- The updated DigitalTwinsClientBuilder object for fluent building.
-
serializer
public DigitalTwinsClientBuilder serializer(com.azure.core.util.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.
-
clientOptions
public DigitalTwinsClientBuilder clientOptions(com.azure.core.util.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 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<DigitalTwinsClientBuilder>
- Parameters:
clientOptions
- A configured instance ofHttpClientOptions
.- Returns:
- The updated DigitalTwinsClientBuilder object.
- See Also:
HttpClientOptions
-
-