Package com.azure.digitaltwins.core

Class DigitalTwinsClientBuilder

java.lang.Object
com.azure.digitaltwins.core.DigitalTwinsClientBuilder
All Implemented Interfaces:
ConfigurationTrait<DigitalTwinsClientBuilder>, EndpointTrait<DigitalTwinsClientBuilder>, HttpTrait<DigitalTwinsClientBuilder>, TokenCredentialTrait<DigitalTwinsClientBuilder>
public final class DigitalTwinsClientBuilder extends Object implements ConfigurationTrait<DigitalTwinsClientBuilder>, EndpointTrait<DigitalTwinsClientBuilder>, HttpTrait<DigitalTwinsClientBuilder>, TokenCredentialTrait<DigitalTwinsClientBuilder>
This class provides a fluent builder API to help aid the configuration and instantiation of DigitalTwinsClients and DigitalTwinsAsyncClients, call buildClient and buildAsyncClient respectively to construct an instance of the desired client.

  • Constructor Details

    • DigitalTwinsClientBuilder

      public DigitalTwinsClientBuilder()
      The public constructor for DigitalTwinsClientBuilder

  • Method Details

    • buildClient

      public DigitalTwinsClient buildClient()
      Create a DigitalTwinsClient based on the builder settings.
      Returns:
      the created synchronous DigitalTwinsClient
      Throws:
      IllegalStateException - If both retryOptions(RetryOptions) and retryPolicy(RetryPolicy) have been set.

    • buildAsyncClient

      public DigitalTwinsAsyncClient buildAsyncClient()
      Create a DigitalTwinsAsyncClient based on the builder settings.
      Returns:
      the created asynchronous DigitalTwinsAsyncClient
      Throws:
      IllegalStateException - If both retryOptions(RetryOptions) and retryPolicy(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 interface EndpointTrait<DigitalTwinsClientBuilder>
      Parameters:
      endpoint - URL of the service.
      Returns:
      the updated DigitalTwinsClientBuilder instance 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.
      Specified by:
      credential in interface 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 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.

    • 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.

      Specified by:
      httpClient in interface HttpTrait<DigitalTwinsClientBuilder>
      Parameters:
      httpClient - The HttpClient to use for requests.
      Returns:
      the updated DigitalTwinsClientBuilder instance for fluent building.

    • httpLogOptions

      public DigitalTwinsClientBuilder httpLogOptions(HttpLogOptions logOptions)
      Sets the logging configuration 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.

      Specified by:
      httpLogOptions in interface HttpTrait<DigitalTwinsClientBuilder>
      Parameters:
      logOptions - The logging 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(HttpPipelinePolicy pipelinePolicy)
      Adds a pipeline 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 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.

      Specified by:
      addPolicy in interface HttpTrait<DigitalTwinsClientBuilder>
      Parameters:
      pipelinePolicy - A pipeline policy.
      Returns:
      the updated DigitalTwinsClientBuilder instance for fluent building.
      Throws:
      NullPointerException - If pipelinePolicy is null.

    • 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(). For implementing custom retry logic, see RetryPolicy as an example. Setting this is mutually exclusive with using retryOptions(RetryOptions).
      Parameters:
      retryPolicy - the retry policy applied to each request.
      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).

      Specified by:
      retryOptions in interface HttpTrait<DigitalTwinsClientBuilder>
      Parameters:
      retryOptions - The RetryOptions to use for all the requests made through the client.
      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.

      Specified by:
      pipeline in interface 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(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 Configuration.NONE to bypass using configuration settings during construction.
      Specified by:
      configuration in interface ConfigurationTrait<DigitalTwinsClientBuilder>
      Parameters:
      configuration - The configuration store used to
      Returns:
      The updated DigitalTwinsClientBuilder object 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.

    • 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.

      Specified by:
      clientOptions in interface HttpTrait<DigitalTwinsClientBuilder>
      Parameters:
      clientOptions - A configured instance of HttpClientOptions.
      Returns:
      The updated DigitalTwinsClientBuilder object.
      See Also: