Package com.azure.communication.sms

Class SmsClientBuilder

java.lang.Object
com.azure.communication.sms.SmsClientBuilder
All Implemented Interfaces:
AzureKeyCredentialTrait<SmsClientBuilder>, ConfigurationTrait<SmsClientBuilder>, ConnectionStringTrait<SmsClientBuilder>, EndpointTrait<SmsClientBuilder>, HttpTrait<SmsClientBuilder>, TokenCredentialTrait<SmsClientBuilder>
public final class SmsClientBuilder extends Object implements AzureKeyCredentialTrait<SmsClientBuilder>, ConfigurationTrait<SmsClientBuilder>, ConnectionStringTrait<SmsClientBuilder>, EndpointTrait<SmsClientBuilder>, HttpTrait<SmsClientBuilder>, TokenCredentialTrait<SmsClientBuilder>
SmsClientBuilder that creates SmsAsyncClient and SmsClient.

  • Constructor Details

    • SmsClientBuilder

      public SmsClientBuilder()

  • Method Details

    • endpoint

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

    • pipeline

      public SmsClientBuilder pipeline(HttpPipeline pipeline)
      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 a pipeline is not supplied, the credential and httpClient fields must be set

      Specified by:
      pipeline in interface HttpTrait<SmsClientBuilder>
      Parameters:
      pipeline - HttpPipeline to use for sending service requests and receiving responses.
      Returns:
      SmsClientBuilder

    • credential

      public SmsClientBuilder 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<SmsClientBuilder>
      Parameters:
      tokenCredential - TokenCredential used to authorize requests sent to the service.
      Returns:
      The updated SmsClientBuilder object.
      Throws:
      NullPointerException - If tokenCredential is null.

    • credential

      public SmsClientBuilder credential(AzureKeyCredential keyCredential)
      Sets the AzureKeyCredential used to authenticate HTTP requests.
      Specified by:
      credential in interface AzureKeyCredentialTrait<SmsClientBuilder>
      Parameters:
      keyCredential - The AzureKeyCredential used to authenticate HTTP requests.
      Returns:
      The updated SmsClientBuilder object.
      Throws:
      NullPointerException - If keyCredential is null.

    • connectionString

      public SmsClientBuilder connectionString(String connectionString)
      Set endpoint and credential to use
      Specified by:
      connectionString in interface ConnectionStringTrait<SmsClientBuilder>
      Parameters:
      connectionString - connection string for setting endpoint and initalizing AzureKeyCredential
      Returns:
      SmsClientBuilder

    • retryPolicy

      public SmsClientBuilder retryPolicy(RetryPolicy retryPolicy)
      Sets the retry policy to use (using the RetryPolicy type).

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

      Parameters:
      retryPolicy - object to be applied
      Returns:
      SmsClientBuilder

    • retryOptions

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

    • configuration

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

    • httpLogOptions

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

    • serviceVersion

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

    • httpClient

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

    • addPolicy

      public SmsClientBuilder 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<SmsClientBuilder>
      Parameters:
      customPolicy - A pipeline policy.
      Returns:
      SmsClientBuilder
      Throws:
      NullPointerException - If customPolicy is null.

    • buildAsyncClient

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

    • buildClient

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

    • clientOptions

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