Package com.azure.communication.chat

Class ChatThreadClientBuilder

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

  • Constructor Details

    • ChatThreadClientBuilder

      public ChatThreadClientBuilder()

  • Method Details

    • endpoint

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

    • httpClient

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

    • credential

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

    • clientOptions

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

    • addPolicy

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

    • retryPolicy

      public ChatThreadClientBuilder 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 ChatThreadClientBuilder object.

    • retryOptions

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

    • httpLogOptions

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

    • serviceVersion

      public ChatThreadClientBuilder 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 ChatThreadClientBuilder object

    • pipeline

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

    • configuration

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

    • chatThreadId

      public ChatThreadClientBuilder chatThreadId(String chatThreadId)
      Sets the ChatThreadId used to construct a client for this chat thread.
      Parameters:
      chatThreadId - The id of the chat thread.
      Returns:
      the updated ChatThreadClientBuilder object

    • buildClient

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

    • buildAsyncClient

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