com.azure.communication.callingserver

Class CallingServerClientBuilder

java.lang.Object

com.azure.communication.callingserver.CallingServerClientBuilder

public final class CallingServerClientBuilder
extends Object

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 and Description
CallingServerClientBuilder()

Method Summary

Modifier and Type	Method and Description
CallingServerClientBuilder	addPolicy(com.azure.core.http.policy.HttpPipelinePolicy customPolicy) Apply additional HttpPipelinePolicy
CallingServerAsyncClient	buildAsyncClient() Create asynchronous client applying HMACAuthenticationPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy.
CallingServerClient	buildClient() Create synchronous client applying HmacAuthenticationPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy.
CallingServerClientBuilder	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.
CallingServerClientBuilder	configuration(com.azure.core.util.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(com.azure.core.credential.TokenCredential tokenCredential) Sets the TokenCredential used to authenticate HTTP requests.
CallingServerClientBuilder	endpoint(String endpoint) Set endpoint of the service.
CallingServerClientBuilder	httpClient(com.azure.core.http.HttpClient httpClient) Set httpClient to use
CallingServerClientBuilder	httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions) Sets the HttpLogOptions for service requests.
CallingServerClientBuilder	pipeline(com.azure.core.http.HttpPipeline pipeline) Set endpoint of the service.
CallingServerClientBuilder	retryPolicy(com.azure.core.http.policy.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 Detail

CallingServerClientBuilder

public CallingServerClientBuilder()

Method Detail

endpoint

public CallingServerClientBuilder endpoint(String endpoint)

Set endpoint of the service.

Parameters:

endpoint - url of the service.

Returns:

CallingServerClientBuilder object.

pipeline

public CallingServerClientBuilder pipeline(com.azure.core.http.HttpPipeline pipeline)

Set endpoint of the service.

Parameters:

pipeline - HttpPipeline to use, if a pipeline is not supplied, the credential and httpClient fields must be set.

Returns:

CallingServerClientBuilder object.

credential

public CallingServerClientBuilder credential(com.azure.core.credential.TokenCredential tokenCredential)

Sets the TokenCredential used to authenticate HTTP requests.

Parameters:

tokenCredential - TokenCredential used to authenticate HTTP requests.

Returns:

Updated CallingServerClientBuilder object.

Throws:

NullPointerException - If tokenCredential is null.

connectionString

public CallingServerClientBuilder connectionString(String connectionString)

Set connectionString to use.

Parameters:

connectionString - connection string to set.

Returns:

Updated CallingServerClientBuilder object.

retryPolicy

public CallingServerClientBuilder retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy)

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

Parameters:

retryPolicy - object to be applied

Returns:

Updated CallingServerClientBuilder object.

configuration

public CallingServerClientBuilder configuration(com.azure.core.util.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:

Updated CallingServerClientBuilder object.

httpLogOptions

public CallingServerClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)

Sets the HttpLogOptions for service requests.

Parameters:

logOptions - The logging configuration to use when sending and receiving HTTP requests/responses.

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(com.azure.core.http.HttpClient httpClient)

Set httpClient to use

Parameters:

httpClient - httpClient to use, overridden by the pipeline field.

Returns:

Updated CallingServerClientBuilder object.

addPolicy

public CallingServerClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy customPolicy)

Apply additional HttpPipelinePolicy

Parameters:

customPolicy - HttpPipelinePolicy object to be applied after AzureKeyCredentialPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy.

Returns:

Updated CallingServerClientBuilder object.

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.

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.

clientOptions

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

Parameters:

clientOptions - object to be applied.

Returns:

Updated CallingServerClientBuilder object.