Class CommunicationRelayClientBuilder
- All Implemented Interfaces:
AzureKeyCredentialTrait<CommunicationRelayClientBuilder>
,ConfigurationTrait<CommunicationRelayClientBuilder>
,ConnectionStringTrait<CommunicationRelayClientBuilder>
,EndpointTrait<CommunicationRelayClientBuilder>
,HttpTrait<CommunicationRelayClientBuilder>
,TokenCredentialTrait<CommunicationRelayClientBuilder>
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
-
Method Summary
Modifier and TypeMethodDescriptionaddPolicy
(HttpPipelinePolicy customPolicy) Adds apipeline policy
to apply on each request sent.Create asynchronous client applying HMACAuthenticationPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy.Create synchronous client applying HmacAuthenticationPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy.clientOptions
(ClientOptions clientOptions) Allows for setting common properties such as application ID, headers, proxy configuration, etc.configuration
(Configuration configuration) Sets the configuration object used to retrieve environment configuration values during building of the client.connectionString
(String connectionString) Set endpoint and credential to usecredential
(AzureKeyCredential keyCredential) Sets theAzureKeyCredential
used to authenticate HTTP requests.credential
(TokenCredential tokenCredential) Sets theTokenCredential
used to authorize requests sent to the service.Set endpoint of the servicehttpClient
(HttpClient httpClient) Sets theHttpClient
to use for sending and receiving requests to and from the service.httpLogOptions
(HttpLogOptions logOptions) Sets thelogging configuration
to use when sending and receiving requests to and from the service.pipeline
(HttpPipeline pipeline) Sets theHttpPipeline
to use for the service client.retryOptions
(RetryOptions retryOptions) Sets theRetryOptions
for all the requests made through the client.retryPolicy
(RetryPolicy retryPolicy) Sets theRetryPolicy
that is used when each request is sent.Sets theCommunicationRelayServiceVersion
that is used when making API requests.
-
Constructor Details
-
CommunicationRelayClientBuilder
public CommunicationRelayClientBuilder()
-
-
Method Details
-
endpoint
Set endpoint of the service- Specified by:
endpoint
in interfaceEndpointTrait<CommunicationRelayClientBuilder>
- Parameters:
endpoint
- url of the service- Returns:
- CommunicationRelayClientBuilder
-
pipeline
Sets theHttpPipeline
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 noHttpPipeline
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 anHttpPipeline
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 interfaceHttpTrait<CommunicationRelayClientBuilder>
- Parameters:
pipeline
-HttpPipeline
to use for sending service requests and receiving responses.- Returns:
- CommunicationRelayClientBuilder
-
credential
Sets theTokenCredential
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 theTokenCredential
type.- Specified by:
credential
in interfaceTokenCredentialTrait<CommunicationRelayClientBuilder>
- Parameters:
tokenCredential
-TokenCredential
used to authorize requests sent to the service.- Returns:
- The updated
CommunicationRelayClientBuilder
object.
-
credential
Sets theAzureKeyCredential
used to authenticate HTTP requests.- Specified by:
credential
in interfaceAzureKeyCredentialTrait<CommunicationRelayClientBuilder>
- Parameters:
keyCredential
- TheAzureKeyCredential
used to authenticate HTTP requests.- Returns:
- The updated
CommunicationRelayClientBuilder
object.
-
connectionString
Set endpoint and credential to use- Specified by:
connectionString
in interfaceConnectionStringTrait<CommunicationRelayClientBuilder>
- Parameters:
connectionString
- connection string for setting endpoint and initalizing CommunicationClientCredential- Returns:
- CommunicationRelayClientBuilder
-
httpClient
Sets theHttpClient
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 noHttpPipeline
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 anHttpPipeline
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 interfaceHttpTrait<CommunicationRelayClientBuilder>
- Parameters:
httpClient
- TheHttpClient
to use for requests.- Returns:
- CommunicationRelayClientBuilder
-
addPolicy
Adds apipeline 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 noHttpPipeline
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 anHttpPipeline
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 interfaceHttpTrait<CommunicationRelayClientBuilder>
- Parameters:
customPolicy
- Apipeline policy
.- Returns:
- CommunicationRelayClientBuilder
-
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 theHttpClientOptions
class (a subclass of theClientOptions
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 noHttpPipeline
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 anHttpPipeline
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 interfaceHttpTrait<CommunicationRelayClientBuilder>
- Parameters:
clientOptions
- A configured instance ofHttpClientOptions
.- Returns:
- The updated
CommunicationRelayClientBuilder
object. - See Also:
-
configuration
Sets the configuration object used to retrieve environment configuration values during building of the client.- Specified by:
configuration
in interfaceConfigurationTrait<CommunicationRelayClientBuilder>
- Parameters:
configuration
- Configuration store used to retrieve environment configurations.- Returns:
- the updated CommunicationRelayClientBuilder object
-
httpLogOptions
Sets thelogging configuration
to use when sending and receiving requests to and from the service. If alogLevel
is not provided, default value ofHttpLogDetailLevel.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 noHttpPipeline
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 anHttpPipeline
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 interfaceHttpTrait<CommunicationRelayClientBuilder>
- Parameters:
logOptions
- Thelogging configuration
to use when sending and receiving requests to and from the service.- Returns:
- the updated CommunicationRelayClientBuilder object
-
retryPolicy
Sets theRetryPolicy
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
Sets theRetryOptions
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 noHttpPipeline
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 anHttpPipeline
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 interfaceHttpTrait<CommunicationRelayClientBuilder>
- Parameters:
retryOptions
- TheRetryOptions
to use for all the requests made through the client.- Returns:
- The updated
CommunicationRelayClientBuilder
object.
-
serviceVersion
Sets theCommunicationRelayServiceVersion
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
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 bothretryOptions(RetryOptions)
andretryPolicy(RetryPolicy)
have been set.
-
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 bothretryOptions(RetryOptions)
andretryPolicy(RetryPolicy)
have been set.
-