Package com.azure.communication.phonenumbers.siprouting

Class SipRoutingClientBuilder

java.lang.Object
com.azure.communication.phonenumbers.siprouting.SipRoutingClientBuilder
All Implemented Interfaces:
com.azure.core.client.traits.AzureKeyCredentialTrait<SipRoutingClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<SipRoutingClientBuilder>, com.azure.core.client.traits.ConnectionStringTrait<SipRoutingClientBuilder>, com.azure.core.client.traits.EndpointTrait<SipRoutingClientBuilder>, com.azure.core.client.traits.HttpTrait<SipRoutingClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<SipRoutingClientBuilder>
public final class SipRoutingClientBuilder extends Object implements com.azure.core.client.traits.AzureKeyCredentialTrait<SipRoutingClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<SipRoutingClientBuilder>, com.azure.core.client.traits.ConnectionStringTrait<SipRoutingClientBuilder>, com.azure.core.client.traits.EndpointTrait<SipRoutingClientBuilder>, com.azure.core.client.traits.HttpTrait<SipRoutingClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<SipRoutingClientBuilder>
Builder for creating clients of Communication Service SIP routing configuration.

Instantiating a SIP Routing Client Builder

 SipRoutingClientBuilder builder = new SipRoutingClientBuilder();

Using a SIP Routing Client Builder to build a SIP Routing Client

 SipRoutingClient sipRoutingClient = new SipRoutingClientBuilder()
     .connectionString(connectionString)
     .buildClient();

  • Constructor Details

    • SipRoutingClientBuilder

      public SipRoutingClientBuilder()

  • Method Details

    • endpoint

      public SipRoutingClientBuilder endpoint(String endpoint)
      Sets endpoint of the service
      Specified by:
      endpoint in interface com.azure.core.client.traits.EndpointTrait<SipRoutingClientBuilder>
      Parameters:
      endpoint - url of the service
      Returns:
      The updated SipRoutingClientBuilder object.
      Throws:
      IllegalArgumentException - If endpoint is null or it cannot be parsed into a valid URL.

    • pipeline

      public SipRoutingClientBuilder pipeline(com.azure.core.http.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 aside from endpoint are ignored.

      Specified by:
      pipeline in interface com.azure.core.client.traits.HttpTrait<SipRoutingClientBuilder>
      Parameters:
      httpPipeline - HttpPipeline to use for sending service requests and receiving responses.
      Returns:
      The updated SipRoutingClientBuilder object.

    • httpClient

      public SipRoutingClientBuilder httpClient(com.azure.core.http.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 com.azure.core.client.traits.HttpTrait<SipRoutingClientBuilder>
      Parameters:
      httpClient - The HttpClient to use for requests.
      Returns:
      The updated SipRoutingClientBuilder object.

    • httpLogOptions

      public SipRoutingClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions httpLogOptions)
      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 com.azure.core.client.traits.HttpTrait<SipRoutingClientBuilder>
      Parameters:
      httpLogOptions - The logging configuration to use when sending and receiving requests to and from the service.
      Returns:
      The updated SipRoutingClientBuilder object.

    • credential

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

    • credential

      public SipRoutingClientBuilder credential(com.azure.core.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 com.azure.core.client.traits.TokenCredentialTrait<SipRoutingClientBuilder>
      Parameters:
      tokenCredential - TokenCredential used to authorize requests sent to the service.
      Returns:
      The updated SipRoutingClientBuilder object.
      Throws:
      NullPointerException - If tokenCredential is null.

    • connectionString

      public SipRoutingClientBuilder connectionString(String connectionString)
      Set the endpoint and AzureKeyCredential for authorization.
      Specified by:
      connectionString in interface com.azure.core.client.traits.ConnectionStringTrait<SipRoutingClientBuilder>
      Parameters:
      connectionString - connection string in the format "endpoint={endpoint_value};accesskey={accesskey_value}"
      Returns:
      The updated SipRoutingClientBuilder object.
      Throws:
      NullPointerException - If connectionString is null.

    • configuration

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

    • addPolicy

      public SipRoutingClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy)
      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 com.azure.core.client.traits.HttpTrait<SipRoutingClientBuilder>
      Parameters:
      policy - A pipeline policy.
      Returns:
      The updated SipRoutingClientBuilder object.
      Throws:
      NullPointerException - If policy is null.

    • clientOptions

      public SipRoutingClientBuilder clientOptions(com.azure.core.util.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 com.azure.core.client.traits.HttpTrait<SipRoutingClientBuilder>
      Parameters:
      clientOptions - A configured instance of HttpClientOptions.
      Returns:
      The updated SipRoutingClientBuilder object.
      See Also:
      • HttpClientOptions

    • serviceVersion

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

    • retryPolicy

      public SipRoutingClientBuilder retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy)
      Sets the RetryPolicy that is used when each request is sent.

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

      Parameters:
      retryPolicy - User's retry policy applied to each request.
      Returns:
      The updated SipRoutingClientBuilder object.

    • retryOptions

      public SipRoutingClientBuilder retryOptions(com.azure.core.http.policy.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 com.azure.core.client.traits.HttpTrait<SipRoutingClientBuilder>
      Parameters:
      retryOptions - The RetryOptions to use for all the requests made through the client.
      Returns:
      The updated SipRoutingClientBuilder object.

    • buildClient

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

    • buildAsyncClient

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