Package com.azure.communication.chat

Class ChatClientBuilder

java.lang.Object
com.azure.communication.chat.ChatClientBuilder
All Implemented Interfaces:
ConfigurationTrait<ChatClientBuilder>, EndpointTrait<ChatClientBuilder>, HttpTrait<ChatClientBuilder>
public final class ChatClientBuilder extends Object implements ConfigurationTrait<ChatClientBuilder>, EndpointTrait<ChatClientBuilder>, HttpTrait<ChatClientBuilder>
Builder for creating clients of Azure Communication Service Chat

  • Constructor Details

    • ChatClientBuilder

      public ChatClientBuilder()

  • Method Details

    • endpoint

      public ChatClientBuilder endpoint(String endpoint)
      Set endpoint of the service
      Specified by:
      endpoint in interface EndpointTrait<ChatClientBuilder>
      Parameters:
      endpoint - url of the service
      Returns:
      the updated ChatClientBuilder object

    • httpClient

      public ChatClientBuilder 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<ChatClientBuilder>
      Parameters:
      httpClient - The HttpClient to use for requests.
      Returns:
      the updated ChatClientBuilder object

    • credential

      public ChatClientBuilder credential(CommunicationTokenCredential communicationTokenCredential)
      Set a token credential for authorization
      Parameters:
      communicationTokenCredential - valid token credential as a string
      Returns:
      the updated ChatClientBuilder object

    • clientOptions

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

    • addPolicy

      public ChatClientBuilder addPolicy(HttpPipelinePolicy customPolicy)
      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<ChatClientBuilder>
      Parameters:
      customPolicy - A pipeline policy.
      Returns:
      the updated ChatClientBuilder object
      Throws:
      NullPointerException - If pipelinePolicy is null.

    • retryPolicy

      public ChatClientBuilder retryPolicy(RetryPolicy retryPolicy)
      Sets the HttpPipelinePolicy that will attempt to retry requests when needed.

      A default retry policy will be supplied if one isn't provided.

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

      Parameters:
      retryPolicy - The RetryPolicy that will attempt to retry requests when needed.
      Returns:
      The updated ChatClientBuilder object.

    • retryOptions

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

    • httpLogOptions

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

    • serviceVersion

      public ChatClientBuilder serviceVersion(ChatServiceVersion version)
      Sets the ChatServiceVersion 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:
      version - ChatServiceVersion of the service to be used when making requests.
      Returns:
      the updated ChatClientBuilder object

    • pipeline

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

    • configuration

      public ChatClientBuilder configuration(Configuration configuration)
      Sets the configuration object used to retrieve environment configuration values during building of the client.
      Specified by:
      configuration in interface ConfigurationTrait<ChatClientBuilder>
      Parameters:
      configuration - Configuration store used to retrieve environment configurations.
      Returns:
      the updated ChatClientBuilder object

    • buildClient

      public ChatClient buildClient()
      Create synchronous chat client applying CommunicationTokenCredential, UserAgentPolicy, RetryPolicy, and CookiePolicy. Additional HttpPolicies specified by additionalPolicies will be applied after them
      Returns:
      ChatClient instance
      Throws:
      IllegalStateException - If both retryOptions(RetryOptions) and retryPolicy(RetryPolicy) have been set.

    • buildAsyncClient

      public ChatAsyncClient buildAsyncClient()
      Create asynchronous chat client applying CommunicationTokenCredential, UserAgentPolicy, RetryPolicy, and CookiePolicy. Additional HttpPolicies specified by additionalPolicies will be applied after them
      Returns:
      ChatAsyncClient instance
      Throws:
      IllegalStateException - If both retryOptions(RetryOptions) and retryPolicy(RetryPolicy) have been set.