PhoneNumbersClientBuilder Class

Package:

com.azure.communication.phonenumbers

Maven Artifact:

com.azure:azure-communication-phonenumbers:1.1.12

• java.lang.Object
• • com.azure.communication.phonenumbers.PhoneNumbersClientBuilder

Implements

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

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

Builder for creating clients of Communication Service phone number configuration.

Instantiating a Phone Numbers Client Builder

PhoneNumbersClientBuilder builder = new PhoneNumbersClientBuilder();

Using a Phone Numbers Client Builder to build a Phone Numbers Client

PhoneNumbersClient phoneNumberClient = new PhoneNumbersClientBuilder()
     .endpoint(endpoint)
     .credential(keyCredential)
     .httpClient(httpClient)
     .buildClient();

Constructor Summary

Constructor	Description
PhoneNumbersClientBuilder()

Method Summary

Modifier and Type	Method and Description
PhoneNumbersClientBuilder	acceptLanguage(String acceptLanguage) Sets the accepted language to be used in the client.
PhoneNumbersClientBuilder	addPolicy(HttpPipelinePolicy policy) Adds a HttpPipelinePolicy to apply on each request sent.
PhoneNumbersAsyncClient	buildAsyncClient() Create asynchronous client applying CommunicationClientCredentialPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy.
PhoneNumbersClient	buildClient() Create synchronous client applying CommunicationClientCredentialPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy.
PhoneNumbersClientBuilder	clientOptions(ClientOptions clientOptions) Allows for setting common properties such as application ID, headers, proxy configuration, etc.
PhoneNumbersClientBuilder	configuration(Configuration configuration) Sets the configuration object used to retrieve environment configuration values during building of the client.
PhoneNumbersClientBuilder	connectionString(String connectionString) Set the endpoint and AzureKeyCredential for authorization
PhoneNumbersClientBuilder	credential(AzureKeyCredential keyCredential) Sets the AzureKeyCredential used to authenticate HTTP requests.
PhoneNumbersClientBuilder	credential(TokenCredential tokenCredential) Sets the TokenCredential used to authorize requests sent to the service.
PhoneNumbersClientBuilder	endpoint(String endpoint) Set endpoint of the service
PhoneNumbersClientBuilder	httpClient(HttpClient httpClient) Sets the HttpClient to use for sending and receiving requests to and from the service.
PhoneNumbersClientBuilder	httpLogOptions(HttpLogOptions httpLogOptions) Sets the HttpLogOptions to use when sending and receiving requests to and from the service.
PhoneNumbersClientBuilder	pipeline(HttpPipeline pipeline) Sets the HttpPipeline to use for the service client.
PhoneNumbersClientBuilder	retryOptions(RetryOptions retryOptions) Sets the RetryOptions for all the requests made through the client.
PhoneNumbersClientBuilder	retryPolicy(RetryPolicy retryPolicy) Sets the RetryPolicy that is used when each request is sent.
PhoneNumbersClientBuilder	serviceVersion(PhoneNumbersServiceVersion version) Sets the PhoneNumbersServiceVersion 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

PhoneNumbersClientBuilder

public PhoneNumbersClientBuilder()

Method Details

acceptLanguage

public PhoneNumbersClientBuilder acceptLanguage(String acceptLanguage)

Sets the accepted language to be used in the client.

Parameters:

acceptLanguage - The locale to be used in the client. E.g. "en-US"

Returns:

The updated PhoneNumbersClientBuilder object.

addPolicy

public PhoneNumbersClientBuilder addPolicy(HttpPipelinePolicy policy)

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:

policy - A HttpPipelinePolicy.

Returns:

The updated PhoneNumbersClientBuilder object.

buildAsyncClient

public PhoneNumbersAsyncClient buildAsyncClient()

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

Returns:

PhoneNumbersAsyncClient instance

buildClient

public PhoneNumbersClient buildClient()

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

Returns:

PhoneNumbersClient instance

clientOptions

public PhoneNumbersClientBuilder 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 PhoneNumbersClientBuilder object.

configuration

public PhoneNumbersClientBuilder 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 PhoneNumbersClientBuilder object.

connectionString

public PhoneNumbersClientBuilder connectionString(String connectionString)

Set the endpoint and AzureKeyCredential for authorization

Parameters:

connectionString - connection string for setting endpoint and initalizing AzureKeyCredential

Returns:

The updated PhoneNumbersClientBuilder object.

credential

public PhoneNumbersClientBuilder credential(AzureKeyCredential keyCredential)

Sets the AzureKeyCredential used to authenticate HTTP requests.

Parameters:

keyCredential - The AzureKeyCredential used to authenticate HTTP requests.

Returns:

The updated PhoneNumbersClientBuilder object.

credential

public PhoneNumbersClientBuilder 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 PhoneNumbersClientBuilder object.

endpoint

public PhoneNumbersClientBuilder endpoint(String endpoint)

Set endpoint of the service

Parameters:

endpoint - url of the service

Returns:

The updated PhoneNumbersClientBuilder object.

httpClient

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

The updated PhoneNumbersClientBuilder object.

httpLogOptions

public PhoneNumbersClientBuilder httpLogOptions(HttpLogOptions httpLogOptions)

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:

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

Returns:

the updated PhoneNumbersClientBuilder object.

pipeline

public PhoneNumbersClientBuilder 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 pipeline is set, all other settings aside from endpoint(String endpoint) are ignored.

Parameters:

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

Returns:

The updated PhoneNumbersClientBuilder object.

retryOptions

public PhoneNumbersClientBuilder 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 PhoneNumbersClientBuilder object.

retryPolicy

public PhoneNumbersClientBuilder retryPolicy(RetryPolicy retryPolicy)

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

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

Parameters:

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

Returns:

The updated PhoneNumbersClientBuilder object.

serviceVersion

public PhoneNumbersClientBuilder serviceVersion(PhoneNumbersServiceVersion version)

Sets the PhoneNumbersServiceVersion 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 the client library will have the result of potentially moving to a newer service version.

Parameters:

version - PhoneNumbersServiceVersion of the service to be used when making requests.

Returns:

The updated PhoneNumbersClientBuilder object.