Share via

CallAutomationClientBuilder Class

Package:
com.azure.communication.callautomation
Maven Artifact:
com.azure:azure-communication-callautomation:1.4.2
  • java.lang.Object
    • com.azure.communication.callautomation.CallAutomationClientBuilder

Implements

AzureKeyCredentialTrait<CallAutomationClientBuilder> ConfigurationTrait<CallAutomationClientBuilder> ConnectionStringTrait<CallAutomationClientBuilder> EndpointTrait<CallAutomationClientBuilder> HttpTrait<CallAutomationClientBuilder> TokenCredentialTrait<CallAutomationClientBuilder>

public final class CallAutomationClientBuilder
implements AzureKeyCredentialTrait<CallAutomationClientBuilder>, ConfigurationTrait<CallAutomationClientBuilder>, ConnectionStringTrait<CallAutomationClientBuilder>, EndpointTrait<CallAutomationClientBuilder>, HttpTrait<CallAutomationClientBuilder>, TokenCredentialTrait<CallAutomationClientBuilder>

Client builder that creates CallAutomationAsyncClient and CallAutomationClient.

Instantiating synchronous and asynchronous Calling Server Clients

Constructor Summary

Constructor Description
CallAutomationClientBuilder()

Public default constructor

Method Summary

Modifier and Type Method and Description
CallAutomationClientBuilder addPolicy(HttpPipelinePolicy customPolicy)

Adds a HttpPipelinePolicy to apply on each request sent.
CallAutomationAsyncClient buildAsyncClient()

Create asynchronous client applying HMACAuthenticationPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy.
CallAutomationClient buildClient()

Create synchronous client applying HmacAuthenticationPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy.
CallAutomationClientBuilder clientOptions(ClientOptions clientOptions)

Allows the user to set a variety of client-related options, such as user-agent string, headers, etc.
CallAutomationClientBuilder configuration(Configuration configuration)

Sets the configuration object used to retrieve environment configuration values during building of the client.
CallAutomationClientBuilder connectionString(String connectionString)

Set connectionString to use.
CallAutomationClientBuilder credential(AzureKeyCredential keyCredential)

Sets the AzureKeyCredential used to authenticate HTTP requests.
CallAutomationClientBuilder credential(TokenCredential tokenCredential)

Sets the TokenCredential used to authorize requests sent to the service.
CallAutomationClientBuilder endpoint(String endpoint)

Set endpoint of the service.
CallAutomationClientBuilder httpClient(HttpClient httpClient)

Sets the HttpClient to use for sending and receiving requests to and from the service.
CallAutomationClientBuilder httpLogOptions(HttpLogOptions logOptions)

Sets the HttpLogOptions to use when sending and receiving requests to and from the service.
CallAutomationClientBuilder pipeline(HttpPipeline pipeline)

Sets the HttpPipeline to use for the service client.
CallAutomationClientBuilder retryOptions(RetryOptions retryOptions)

Sets the RetryOptions for all the requests made through the client.
CallAutomationClientBuilder retryPolicy(RetryPolicy retryPolicy)

Sets the retry policy to use (using the RetryPolicy type).
CallAutomationClientBuilder serviceVersion(CallAutomationServiceVersion version)

Sets the CallAutomationServiceVersion that is used when making API requests.
CallAutomationClientBuilder sourceIdentity(CommunicationUserIdentifier sourceIdentity)

Set Source Identity used to create and answer call

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CallAutomationClientBuilder

public CallAutomationClientBuilder()

Public default constructor

Method Details

addPolicy

public CallAutomationClientBuilder addPolicy(HttpPipelinePolicy customPolicy)

Adds a HttpPipelinePolicy 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.

Parameters:

customPolicy - A HttpPipelinePolicy.

Returns:

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.

buildClient

public CallAutomationClient buildClient()

Create synchronous client applying HmacAuthenticationPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy. Additional HttpPolicies specified by additionalPolicies will be applied after them.

Returns:

clientOptions

public CallAutomationClientBuilder clientOptions(ClientOptions clientOptions)

Allows the user to set a variety of client-related options, such as user-agent string, headers, etc.

Parameters:

clientOptions - object to be applied.

Returns:

configuration

public CallAutomationClientBuilder configuration(Configuration configuration)

Sets the configuration object used to retrieve environment configuration values during building of the client.

Parameters:

configuration - Configuration store used to retrieve environment configurations.

Returns:

connectionString

public CallAutomationClientBuilder connectionString(String connectionString)

Set connectionString to use.

Parameters:

connectionString - connection string to set.

Returns:

credential

public CallAutomationClientBuilder credential(AzureKeyCredential keyCredential)

Sets the AzureKeyCredential used to authenticate HTTP requests.

Parameters:

keyCredential - The AzureKeyCredential used to authenticate HTTP requests.

Returns:

credential

public CallAutomationClientBuilder 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.

Parameters:

tokenCredential - TokenCredential used to authorize requests sent to the service.

Returns:

endpoint

public CallAutomationClientBuilder endpoint(String endpoint)

Set endpoint of the service.

Parameters:

endpoint - url of the service.

Returns:

CallAutomationClientBuilder object.

httpClient

public CallAutomationClientBuilder 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.

Parameters:

httpClient - The HttpClient to use for requests.

Returns:

httpLogOptions

public CallAutomationClientBuilder httpLogOptions(HttpLogOptions logOptions)

Sets the HttpLogOptions 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.

Parameters:

logOptions - The HttpLogOptions to use when sending and receiving requests to and from the service.

Returns:

The updated CallAutomationClientBuilder object.

pipeline

public CallAutomationClientBuilder 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.

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.

retryOptions

public CallAutomationClientBuilder 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 retryPolicy).

Parameters:

retryOptions - The RetryOptions to use for all the requests made through the client.

Returns:

retryPolicy

public CallAutomationClientBuilder retryPolicy(RetryPolicy retryPolicy)

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

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

Parameters:

retryPolicy - object to be applied

Returns:

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

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:

Applies to