Package com.azure.communication.networktraversal

Class CommunicationRelayClientBuilder

java.lang.Object

com.azure.communication.networktraversal.CommunicationRelayClientBuilder

All Implemented Interfaces:

com.azure.core.client.traits.AzureKeyCredentialTrait<CommunicationRelayClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<CommunicationRelayClientBuilder>, com.azure.core.client.traits.ConnectionStringTrait<CommunicationRelayClientBuilder>, com.azure.core.client.traits.EndpointTrait<CommunicationRelayClientBuilder>, com.azure.core.client.traits.HttpTrait<CommunicationRelayClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<CommunicationRelayClientBuilder>

public final class CommunicationRelayClientBuilder
extends Object
implements com.azure.core.client.traits.AzureKeyCredentialTrait<CommunicationRelayClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<CommunicationRelayClientBuilder>, com.azure.core.client.traits.ConnectionStringTrait<CommunicationRelayClientBuilder>, com.azure.core.client.traits.EndpointTrait<CommunicationRelayClientBuilder>, com.azure.core.client.traits.HttpTrait<CommunicationRelayClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<CommunicationRelayClientBuilder>

CommunicationRelayClientBuilder that creates CommunicationRelayAsyncClient and CommunicationRelayClient.

Instantiating a CommunicationRelayClientBuilder

 // 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>");

 CommunicationRelayClientBuilder communicationRelayClientBuilder = new CommunicationRelayClientBuilder()
     .endpoint(endpoint)
     .credential(keyCredential);
 

Constructor Summary

Constructors

Constructor	Description
CommunicationRelayClientBuilder()

Method Summary

Modifier and Type	Method	Description
CommunicationRelayClientBuilder	addPolicy(com.azure.core.http.policy.HttpPipelinePolicy customPolicy)	Adds a pipeline policy to apply on each request sent.
CommunicationRelayAsyncClient	buildAsyncClient()	Create asynchronous client applying HMACAuthenticationPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy.
CommunicationRelayClient	buildClient()	Create synchronous client applying HmacAuthenticationPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy.
CommunicationRelayClientBuilder	clientOptions(com.azure.core.util.ClientOptions clientOptions)	Allows for setting common properties such as application ID, headers, proxy configuration, etc.
CommunicationRelayClientBuilder	configuration(com.azure.core.util.Configuration configuration)	Sets the configuration object used to retrieve environment configuration values during building of the client.
CommunicationRelayClientBuilder	connectionString(String connectionString)	Set endpoint and credential to use
CommunicationRelayClientBuilder	credential(com.azure.core.credential.AzureKeyCredential keyCredential)	Sets the AzureKeyCredential used to authenticate HTTP requests.
CommunicationRelayClientBuilder	credential(com.azure.core.credential.TokenCredential tokenCredential)	Sets the TokenCredential used to authorize requests sent to the service.
CommunicationRelayClientBuilder	endpoint(String endpoint)	Set endpoint of the service
CommunicationRelayClientBuilder	httpClient(com.azure.core.http.HttpClient httpClient)	Sets the HttpClient to use for sending and receiving requests to and from the service.
CommunicationRelayClientBuilder	httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)	Sets the logging configuration to use when sending and receiving requests to and from the service.
CommunicationRelayClientBuilder	pipeline(com.azure.core.http.HttpPipeline pipeline)	Sets the HttpPipeline to use for the service client.
CommunicationRelayClientBuilder	retryOptions(com.azure.core.http.policy.RetryOptions retryOptions)	Sets the RetryOptions for all the requests made through the client.
CommunicationRelayClientBuilder	retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy)	Sets the RetryPolicy that is used when each request is sent.
CommunicationRelayClientBuilder	serviceVersion(CommunicationRelayServiceVersion version)	Sets the CommunicationRelayServiceVersion 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

CommunicationRelayClientBuilder

public CommunicationRelayClientBuilder()

Method Detail

endpoint

public CommunicationRelayClientBuilder endpoint(String endpoint)

Set endpoint of the service

Specified by:

endpoint in interface com.azure.core.client.traits.EndpointTrait<CommunicationRelayClientBuilder>

Parameters:

endpoint - url of the service

Returns:

CommunicationRelayClientBuilder

pipeline

public CommunicationRelayClientBuilder pipeline(com.azure.core.http.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

Specified by:

pipeline in interface com.azure.core.client.traits.HttpTrait<CommunicationRelayClientBuilder>

Parameters:

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

Returns:

CommunicationRelayClientBuilder

credential

public CommunicationRelayClientBuilder credential(com.azure.core.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 com.azure.core.client.traits.TokenCredentialTrait<CommunicationRelayClientBuilder>

Parameters:

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

Returns:

The updated CommunicationRelayClientBuilder object.

credential

public CommunicationRelayClientBuilder credential(com.azure.core.credential.AzureKeyCredential keyCredential)

Sets the AzureKeyCredential used to authenticate HTTP requests.

Specified by:

credential in interface com.azure.core.client.traits.AzureKeyCredentialTrait<CommunicationRelayClientBuilder>

Parameters:

keyCredential - The AzureKeyCredential used to authenticate HTTP requests.

Returns:

The updated CommunicationRelayClientBuilder object.

connectionString

public CommunicationRelayClientBuilder connectionString(String connectionString)

Set endpoint and credential to use

Specified by:

connectionString in interface com.azure.core.client.traits.ConnectionStringTrait<CommunicationRelayClientBuilder>

Parameters:

connectionString - connection string for setting endpoint and initalizing CommunicationClientCredential

Returns:

CommunicationRelayClientBuilder

httpClient

public CommunicationRelayClientBuilder httpClient(com.azure.core.http.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 com.azure.core.client.traits.HttpTrait<CommunicationRelayClientBuilder>

Parameters:

httpClient - The HttpClient to use for requests.

Returns:

CommunicationRelayClientBuilder

addPolicy

public CommunicationRelayClientBuilder addPolicy(com.azure.core.http.policy.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 com.azure.core.client.traits.HttpTrait<CommunicationRelayClientBuilder>

Parameters:

customPolicy - A pipeline policy.

Returns:

CommunicationRelayClientBuilder

clientOptions

public CommunicationRelayClientBuilder clientOptions(com.azure.core.util.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.

Specified by:

clientOptions in interface com.azure.core.client.traits.HttpTrait<CommunicationRelayClientBuilder>

Parameters:

clientOptions - A configured instance of HttpClientOptions.

Returns:

The updated CommunicationRelayClientBuilder object.

See Also:

HttpClientOptions

configuration

public CommunicationRelayClientBuilder configuration(com.azure.core.util.Configuration configuration)

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

Specified by:

configuration in interface com.azure.core.client.traits.ConfigurationTrait<CommunicationRelayClientBuilder>

Parameters:

configuration - Configuration store used to retrieve environment configurations.

Returns:

the updated CommunicationRelayClientBuilder object

httpLogOptions

public CommunicationRelayClientBuilder httpLogOptions(com.azure.core.http.policy.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 com.azure.core.client.traits.HttpTrait<CommunicationRelayClientBuilder>

Parameters:

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

Returns:

the updated CommunicationRelayClientBuilder object

retryPolicy

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

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

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

Parameters:

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

Returns:

The updated CommunicationRelayClientBuilder object.

retryOptions

public CommunicationRelayClientBuilder retryOptions(com.azure.core.http.policy.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 com.azure.core.client.traits.HttpTrait<CommunicationRelayClientBuilder>

Parameters:

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

Returns:

The updated CommunicationRelayClientBuilder object.

serviceVersion

public CommunicationRelayClientBuilder serviceVersion(CommunicationRelayServiceVersion version)

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

Returns:

the updated CommunicationRelayClientBuilder object

buildAsyncClient

public CommunicationRelayAsyncClient buildAsyncClient()

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

Returns:

CommunicationRelayAsyncClient instance

Throws:

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

buildClient

public CommunicationRelayClient buildClient()

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

Returns:

CommunicationRelayClient instance

Throws:

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