Package com.azure.communication.callautomation

Class CallAutomationClientBuilder

java.lang.Object
com.azure.communication.callautomation.CallAutomationClientBuilder
All Implemented Interfaces:
com.azure.core.client.traits.AzureKeyCredentialTrait<CallAutomationClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<CallAutomationClientBuilder>, com.azure.core.client.traits.ConnectionStringTrait<CallAutomationClientBuilder>, com.azure.core.client.traits.EndpointTrait<CallAutomationClientBuilder>, com.azure.core.client.traits.HttpTrait<CallAutomationClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<CallAutomationClientBuilder>
public final class CallAutomationClientBuilder extends Object implements com.azure.core.client.traits.AzureKeyCredentialTrait<CallAutomationClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<CallAutomationClientBuilder>, com.azure.core.client.traits.ConnectionStringTrait<CallAutomationClientBuilder>, com.azure.core.client.traits.EndpointTrait<CallAutomationClientBuilder>, com.azure.core.client.traits.HttpTrait<CallAutomationClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<CallAutomationClientBuilder>
Client builder that creates CallAutomationAsyncClient and CallAutomationClient.

Instantiating synchronous and asynchronous Calling Server Clients

  • Constructor Details

    • CallAutomationClientBuilder

      public CallAutomationClientBuilder()
      Public default constructor

  • Method Details

    • endpoint

      public CallAutomationClientBuilder endpoint(String endpoint)
      Set endpoint of the service.
      Specified by:
      endpoint in interface com.azure.core.client.traits.EndpointTrait<CallAutomationClientBuilder>
      Parameters:
      endpoint - url of the service.
      Returns:
      CallAutomationClientBuilder object.

    • pipeline

      public CallAutomationClientBuilder pipeline(com.azure.core.http.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.

      Specified by:
      pipeline in interface com.azure.core.client.traits.HttpTrait<CallAutomationClientBuilder>
      Parameters:
      pipeline - HttpPipeline to use for sending service requests and receiving responses, if a pipeline is not supplied, the credential and httpClient fields must be set.
      Returns:
      CallAutomationClientBuilder object.

    • credential

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

    • credential

      public CallAutomationClientBuilder 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<CallAutomationClientBuilder>
      Parameters:
      keyCredential - The AzureKeyCredential used to authenticate HTTP requests.
      Returns:
      Updated CallAutomationClientBuilder object.
      Throws:
      NullPointerException - If keyCredential is null.

    • connectionString

      public CallAutomationClientBuilder connectionString(String connectionString)
      Set connectionString to use.
      Specified by:
      connectionString in interface com.azure.core.client.traits.ConnectionStringTrait<CallAutomationClientBuilder>
      Parameters:
      connectionString - connection string to set.
      Returns:
      Updated CallAutomationClientBuilder object.

    • sourceIdentity

      public CallAutomationClientBuilder sourceIdentity(CommunicationUserIdentifier sourceIdentity)
      Set Source Identity used to create and answer call
      Parameters:
      sourceIdentity - CommunicationUserIdentifier to used to create and answer call.
      Returns:
      CallAutomationClientBuilder object.

    • retryPolicy

      public CallAutomationClientBuilder retryPolicy(com.azure.core.http.policy.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:
      Updated CallAutomationClientBuilder object.

    • retryOptions

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

    • configuration

      public CallAutomationClientBuilder 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<CallAutomationClientBuilder>
      Parameters:
      configuration - Configuration store used to retrieve environment configurations.
      Returns:
      Updated CallAutomationClientBuilder object.

    • httpLogOptions

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

    • serviceVersion

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

    • httpClient

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

    • addPolicy

      public CallAutomationClientBuilder addPolicy(com.azure.core.http.policy.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 com.azure.core.client.traits.HttpTrait<CallAutomationClientBuilder>
      Parameters:
      customPolicy - A pipeline policy.
      Returns:
      Updated CallAutomationClientBuilder object.
      Throws:
      NullPointerException - If pipelinePolicy is null.

    • buildAsyncClient

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

    • buildClient

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

    • clientOptions

      public CallAutomationClientBuilder clientOptions(com.azure.core.util.ClientOptions clientOptions)
      Allows the user to set a variety of client-related options, such as user-agent string, headers, etc.
      Specified by:
      clientOptions in interface com.azure.core.client.traits.HttpTrait<CallAutomationClientBuilder>
      Parameters:
      clientOptions - object to be applied.
      Returns:
      Updated CallAutomationClientBuilder object.