CommunicationIdentityClientBuilder Class

Package:

com.azure.communication.identity

Maven Artifact:

com.azure:azure-communication-identity:1.6.10

• java.lang.Object
• • com.azure.communication.identity.CommunicationIdentityClientBuilder

Implements

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

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

This class provides a fluent builder API to help aid the configuration and instantiation of CommunicationIdentityClient and CommunicationIdentityAsyncClient, call buildClient() and buildAsyncClient() respectively to construct an instance of the desired client.

Instantiating an asynchronous Azure Communication Service Identity Client

// You can find your endpoint and access key from your resource in the Azure Portal
 String endpoint = "https://<RESOURCE_NAME>.communication.azure.com";
 AzureKeyCredential keyCredential = new AzureKeyCredential("<access-key>");

 CommunicationIdentityAsyncClient communicationIdentityAsyncClient = new CommunicationIdentityClientBuilder()
         .endpoint(endpoint)
         .credential(keyCredential)
         .buildAsyncClient();

Instantiating a synchronous Azure Communication Service Identity Client

// You can find your endpoint and access key from your resource in the Azure Portal
 String endpoint = "https://<RESOURCE_NAME>.communication.azure.com";
 AzureKeyCredential keyCredential = new AzureKeyCredential("<access-key>");

 CommunicationIdentityClient communicationIdentityClient = new CommunicationIdentityClientBuilder()
     .endpoint(endpoint)
     .credential(keyCredential)
     .buildClient();

Constructor Summary

Constructor	Description
CommunicationIdentityClientBuilder()

Method Summary

Modifier and Type	Method and Description
CommunicationIdentityClientBuilder	addPolicy(HttpPipelinePolicy customPolicy) Adds a HttpPipelinePolicy to apply on each request sent.
CommunicationIdentityAsyncClient	buildAsyncClient() Create asynchronous client applying HMACAuthenticationPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy.
CommunicationIdentityClient	buildClient() Create synchronous client applying HmacAuthenticationPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy.
CommunicationIdentityClientBuilder	clientOptions(ClientOptions clientOptions) Allows for setting common properties such as application ID, headers, proxy configuration, etc.
CommunicationIdentityClientBuilder	configuration(Configuration configuration) Sets the configuration object used to retrieve environment configuration values during building of the client.
CommunicationIdentityClientBuilder	connectionString(String connectionString) Set endpoint and credential to use
CommunicationIdentityClientBuilder	credential(AzureKeyCredential keyCredential) Sets the AzureKeyCredential used to authenticate HTTP requests.
CommunicationIdentityClientBuilder	credential(TokenCredential tokenCredential) Sets the TokenCredential used to authorize requests sent to the service.
CommunicationIdentityClientBuilder	endpoint(String endpoint) Set endpoint of the service
CommunicationIdentityClientBuilder	httpClient(HttpClient httpClient) Sets the HttpClient to use for sending and receiving requests to and from the service.
CommunicationIdentityClientBuilder	httpLogOptions(HttpLogOptions logOptions) Sets the HttpLogOptions to use when sending and receiving requests to and from the service.
CommunicationIdentityClientBuilder	pipeline(HttpPipeline pipeline) Sets the HttpPipeline to use for the service client.
CommunicationIdentityClientBuilder	retryOptions(RetryOptions retryOptions) Sets the RetryOptions for all the requests made through the client.
CommunicationIdentityClientBuilder	retryPolicy(RetryPolicy retryPolicy) Sets the RetryPolicy that is used when each request is sent.
CommunicationIdentityClientBuilder	serviceVersion(CommunicationIdentityServiceVersion version) Sets the CommunicationIdentityServiceVersion that is used when making API requests.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CommunicationIdentityClientBuilder

public CommunicationIdentityClientBuilder()

Method Details

addPolicy

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

CommunicationIdentityClientBuilder

buildAsyncClient

public CommunicationIdentityAsyncClient buildAsyncClient()

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

Returns:

CommunicationIdentityAsyncClient instance

buildClient

public CommunicationIdentityClient buildClient()

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

Returns:

CommunicationIdentityClient instance

clientOptions

public CommunicationIdentityClientBuilder clientOptions(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.

Parameters:

clientOptions - A configured instance of HttpClientOptions.

Returns:

The updated CommunicationIdentityClientBuilder object.

configuration

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

the updated CommunicationIdentityClientBuilder object

connectionString

public CommunicationIdentityClientBuilder connectionString(String connectionString)

Set endpoint and credential to use

Parameters:

connectionString - connection string for setting endpoint and initalizing CommunicationClientCredential

Returns:

CommunicationIdentityClientBuilder

credential

public CommunicationIdentityClientBuilder credential(AzureKeyCredential keyCredential)

Sets the AzureKeyCredential used to authenticate HTTP requests.

Parameters:

keyCredential - The AzureKeyCredential used to authenticate HTTP requests.

Returns:

The updated CommunicationIdentityClientBuilder object.

credential

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

The updated CommunicationIdentityClientBuilder object.

endpoint

public CommunicationIdentityClientBuilder endpoint(String endpoint)

Set endpoint of the service

Parameters:

endpoint - url of the service

Returns:

CommunicationIdentityClientBuilder

httpClient

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

CommunicationIdentityClientBuilder

httpLogOptions

public CommunicationIdentityClientBuilder 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 CommunicationIdentityClientBuilder object

pipeline

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

If a pipeline is not supplied, the credential and httpClient fields must be set

Parameters:

pipeline - HttpPipeline to use for sending service requests and receiving responses.

Returns:

CommunicationIdentityClientBuilder

retryOptions

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

The updated CommunicationIdentityClientBuilder object.

retryPolicy

public CommunicationIdentityClientBuilder retryPolicy(RetryPolicy retryPolicy)

Sets the RetryPolicy that is used when each request is sent.

A default retry policy will be supplied if one isn't provided.

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

Parameters:

retryPolicy - User's retry policy applied to each request.

Returns:

The updated CommunicationIdentityClientBuilder object.

serviceVersion

public CommunicationIdentityClientBuilder serviceVersion(CommunicationIdentityServiceVersion version)

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

Returns:

the updated CommunicationIdentityClientBuilder object