Package com.azure.iot.modelsrepository

Class ModelsRepositoryClientBuilder

java.lang.Object
com.azure.iot.modelsrepository.ModelsRepositoryClientBuilder
All Implemented Interfaces:
ConfigurationTrait<ModelsRepositoryClientBuilder>, HttpTrait<ModelsRepositoryClientBuilder>
public final class ModelsRepositoryClientBuilder extends Object implements ConfigurationTrait<ModelsRepositoryClientBuilder>, HttpTrait<ModelsRepositoryClientBuilder>
This class provides a fluent builder API to help aid the configuration and instantiation of ModelsRepositoryClient and ModelsRepositoryAsyncClient, call buildClient and buildAsyncClient respectively to construct an instance of the desired client.

  • Constructor Details

    • ModelsRepositoryClientBuilder

      public ModelsRepositoryClientBuilder()
      The public constructor for ModelsRepositoryClientBuilder

  • Method Details

    • buildClient

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

    • buildAsyncClient

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

    • modelDependencyResolution

      public ModelsRepositoryClientBuilder modelDependencyResolution(ModelDependencyResolution modelDependencyResolution)
      Set the default dependency resolution option that the built client will use. This field will have a default value.
      Parameters:
      modelDependencyResolution - A DependencyResolutionOption value to force model resolution behavior.
      Returns:
      the updated ModelsRepositoryClientBuilder instance for fluent building.

    • repositoryEndpoint

      public ModelsRepositoryClientBuilder repositoryEndpoint(String repositoryEndpoint)
      Set the service endpoint that the built client will communicate with. This field is mandatory to set.
      Parameters:
      repositoryEndpoint - Uri of the service in String format.
      Returns:
      the updated ModelsRepositoryClientBuilder instance for fluent building.

    • serviceVersion

      public ModelsRepositoryClientBuilder serviceVersion(ModelsRepositoryServiceVersion serviceVersion)
      Sets the ModelsRepositoryServiceVersion 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 ModelsRepositoryClientBuilder instance for fluent building.

    • httpClient

      public ModelsRepositoryClientBuilder 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<ModelsRepositoryClientBuilder>
      Parameters:
      httpClient - The HttpClient to use for requests.
      Returns:
      the updated ModelsRepositoryClientBuilder instance for fluent building.

    • httpLogOptions

      public ModelsRepositoryClientBuilder 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<ModelsRepositoryClientBuilder>
      Parameters:
      logOptions - The logging configuration to use when sending and receiving requests to and from the service.
      Returns:
      the updated ModelsRepositoryClientBuilder instance for fluent building.

    • addPolicy

      public ModelsRepositoryClientBuilder 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<ModelsRepositoryClientBuilder>
      Parameters:
      pipelinePolicy - A pipeline policy.
      Returns:
      the updated ModelsRepositoryClientBuilder instance for fluent building.
      Throws:
      NullPointerException - If pipelinePolicy is null.

    • retryPolicy

      public ModelsRepositoryClientBuilder 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 ModelsRepositoryClientBuilder instance for fluent building.

    • retryOptions

      public ModelsRepositoryClientBuilder 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<ModelsRepositoryClientBuilder>
      Parameters:
      retryOptions - The RetryOptions to use for all the requests made through the client.
      Returns:
      The updated ModelsRepositoryClientBuilder object for fluent building.

    • pipeline

      public ModelsRepositoryClientBuilder 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<ModelsRepositoryClientBuilder>
      Parameters:
      httpPipeline - HttpPipeline to use for sending service requests and receiving responses.
      Returns:
      The updated ModelsRepositoryClientBuilder object for fluent building.

    • configuration

      public ModelsRepositoryClientBuilder 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<ModelsRepositoryClientBuilder>
      Parameters:
      configuration - The configuration store used to
      Returns:
      The updated ModelsRepositoryClientBuilder object for fluent building.

    • clientOptions

      public ModelsRepositoryClientBuilder 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<ModelsRepositoryClientBuilder>
      Parameters:
      clientOptions - A configured instance of HttpClientOptions.
      Returns:
      The updated ModelsRepositoryClientBuilder object for fluent building.
      See Also: