Package com.azure.communication.callingserver

Class CallingServerClientBuilder

java.lang.Object

com.azure.communication.callingserver.CallingServerClientBuilder

All Implemented Interfaces:

AzureKeyCredentialTrait<CallingServerClientBuilder>, ConfigurationTrait<CallingServerClientBuilder>, ConnectionStringTrait<CallingServerClientBuilder>, EndpointTrait<CallingServerClientBuilder>, HttpTrait<CallingServerClientBuilder>, TokenCredentialTrait<CallingServerClientBuilder>

public final class CallingServerClientBuilder
extends Object
implements AzureKeyCredentialTrait<CallingServerClientBuilder>, ConfigurationTrait<CallingServerClientBuilder>, ConnectionStringTrait<CallingServerClientBuilder>, EndpointTrait<CallingServerClientBuilder>, HttpTrait<CallingServerClientBuilder>, TokenCredentialTrait<CallingServerClientBuilder>

Client builder that creates CallingServerAsyncClient and CallingServerClient.

Instantiating synchronous and asynchronous Calling Server Clients

 HttpPipeline pipeline = new HttpPipelineBuilder()
     .policies(/* add policies */)
     .build();

 CallingServerClient callingServerClient = new CallingServerClientBuilder()
     .pipeline(pipeline)
     .connectionString(connectionString)
     .buildClient();

 CallingServerAsyncClient callingServerAsyncClient = new CallingServerClientBuilder()
     .pipeline(pipeline)
     .connectionString(connectionString)
     .buildAsyncClient();
 

Constructor Summary

Constructors

Constructor	Description
CallingServerClientBuilder()

Method Summary

Modifier and Type	Method	Description
CallingServerClientBuilder	addPolicy(HttpPipelinePolicy customPolicy)	Adds a pipeline policy to apply on each request sent.
CallingServerAsyncClient	buildAsyncClient()	Create asynchronous client applying HMACAuthenticationPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy.
CallingServerClient	buildClient()	Create synchronous client applying HmacAuthenticationPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy.
CallingServerClientBuilder	clientOptions(ClientOptions clientOptions)	Allows the user to set a variety of client-related options, such as user-agent string, headers, etc.
CallingServerClientBuilder	configuration(Configuration configuration)	Sets the configuration object used to retrieve environment configuration values during building of the client.
CallingServerClientBuilder	connectionString(String connectionString)	Set connectionString to use.
CallingServerClientBuilder	credential(AzureKeyCredential keyCredential)	Sets the AzureKeyCredential used to authenticate HTTP requests.
CallingServerClientBuilder	credential(TokenCredential tokenCredential)	Sets the TokenCredential used to authorize requests sent to the service.
CallingServerClientBuilder	endpoint(String endpoint)	Set endpoint of the service.
CallingServerClientBuilder	httpClient(HttpClient httpClient)	Sets the HttpClient to use for sending and receiving requests to and from the service.
CallingServerClientBuilder	httpLogOptions(HttpLogOptions logOptions)	Sets the logging configuration to use when sending and receiving requests to and from the service.
CallingServerClientBuilder	pipeline(HttpPipeline pipeline)	Sets the HttpPipeline to use for the service client.
CallingServerClientBuilder	retryOptions(RetryOptions retryOptions)	Sets the RetryOptions for all the requests made through the client.
CallingServerClientBuilder	retryPolicy(RetryPolicy retryPolicy)	Sets the retry policy to use (using the RetryPolicy type).
CallingServerClientBuilder	serviceVersion(CallingServerServiceVersion version)	Sets the CallingServerServiceVersion that is used when making API requests.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CallingServerClientBuilder

public CallingServerClientBuilder()

Method Details

endpoint

public CallingServerClientBuilder endpoint(String endpoint)

Set endpoint of the service.

Specified by:

endpoint in interface EndpointTrait<CallingServerClientBuilder>

Parameters:

endpoint - url of the service.

Returns:

CallingServerClientBuilder object.

pipeline

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

Specified by:

pipeline in interface HttpTrait<CallingServerClientBuilder>

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:

CallingServerClientBuilder object.

credential

public CallingServerClientBuilder 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<CallingServerClientBuilder>

Parameters:

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

Returns:

Updated CallingServerClientBuilder object.

Throws:

NullPointerException - If tokenCredential is null.

credential

public CallingServerClientBuilder credential(AzureKeyCredential keyCredential)

Sets the AzureKeyCredential used to authenticate HTTP requests.

Specified by:

credential in interface AzureKeyCredentialTrait<CallingServerClientBuilder>

Parameters:

keyCredential - The AzureKeyCredential used to authenticate HTTP requests.

Returns:

Updated CallingServerClientBuilder object.

Throws:

NullPointerException - If keyCredential is null.

connectionString

public CallingServerClientBuilder connectionString(String connectionString)

Set connectionString to use.

Specified by:

connectionString in interface ConnectionStringTrait<CallingServerClientBuilder>

Parameters:

connectionString - connection string to set.

Returns:

Updated CallingServerClientBuilder object.

retryPolicy

public CallingServerClientBuilder 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:

Updated CallingServerClientBuilder object.

retryOptions

public CallingServerClientBuilder 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<CallingServerClientBuilder>

Parameters:

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

Returns:

Updated CallingServerClientBuilder object.

configuration

public CallingServerClientBuilder configuration(Configuration configuration)

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

Specified by:

configuration in interface ConfigurationTrait<CallingServerClientBuilder>

Parameters:

configuration - Configuration store used to retrieve environment configurations.

Returns:

Updated CallingServerClientBuilder object.

httpLogOptions

public CallingServerClientBuilder 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<CallingServerClientBuilder>

Parameters:

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

Returns:

The updated CallingServerClientBuilder object.

serviceVersion

public CallingServerClientBuilder serviceVersion(CallingServerServiceVersion version)

Sets the CallingServerServiceVersion 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 - CallingServerServiceVersion of the service to be used when making requests.

Returns:

Updated CallingServerClientBuilder object

httpClient

public CallingServerClientBuilder 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<CallingServerClientBuilder>

Parameters:

httpClient - The HttpClient to use for requests.

Returns:

Updated CallingServerClientBuilder object.

addPolicy

public CallingServerClientBuilder 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<CallingServerClientBuilder>

Parameters:

customPolicy - A pipeline policy.

Returns:

Updated CallingServerClientBuilder object.

Throws:

NullPointerException - If pipelinePolicy is null.

buildAsyncClient

public CallingServerAsyncClient buildAsyncClient()

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

Returns:

The updated CallingServerClientBuilder object.

Throws:

IllegalStateException - If both retryOptions(RetryOptions) and retryPolicy(RetryPolicy) have been set.

buildClient

public CallingServerClient buildClient()

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

Returns:

Updated CallingServerClientBuilder object.

Throws:

IllegalStateException - If both retryOptions(RetryOptions) and retryPolicy(RetryPolicy) have been set.

clientOptions

public CallingServerClientBuilder clientOptions(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 HttpTrait<CallingServerClientBuilder>

Parameters:

clientOptions - object to be applied.

Returns:

Updated CallingServerClientBuilder object.

See Also:

• HttpClientOptions