Class CallAutomationClientBuilder
- All Implemented Interfaces:
com.azure.core.client.traits.AzureKeyCredentialTrait<CallAutomationClientBuilder>
,com.azure.core.client.traits.ConfigurationTrait<CallAutomationClientBuilder>
,com.azure.core.client.traits.ConnectionStringTrait<CallAutomationClientBuilder>
,com.azure.core.client.traits.EndpointTrait<CallAutomationClientBuilder>
,com.azure.core.client.traits.HttpTrait<CallAutomationClientBuilder>
,com.azure.core.client.traits.TokenCredentialTrait<CallAutomationClientBuilder>
Instantiating synchronous and asynchronous Calling Server Clients
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddPolicy
(com.azure.core.http.policy.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
(com.azure.core.util.ClientOptions clientOptions) Allows the user to set a variety of client-related options, such as user-agent string, headers, etc.configuration
(com.azure.core.util.Configuration configuration) Sets the configuration object used to retrieve environment configuration values during building of the client.connectionString
(String connectionString) Set connectionString to use.credential
(com.azure.core.credential.AzureKeyCredential keyCredential) Sets theAzureKeyCredential
used to authenticate HTTP requests.credential
(com.azure.core.credential.TokenCredential tokenCredential) Sets theTokenCredential
used to authorize requests sent to the service.Set endpoint of the service.httpClient
(com.azure.core.http.HttpClient httpClient) Sets theHttpClient
to use for sending and receiving requests to and from the service.httpLogOptions
(com.azure.core.http.policy.HttpLogOptions logOptions) Sets thelogging configuration
to use when sending and receiving requests to and from the service.pipeline
(com.azure.core.http.HttpPipeline pipeline) Sets theHttpPipeline
to use for the service client.retryOptions
(com.azure.core.http.policy.RetryOptions retryOptions) Sets theRetryOptions
for all the requests made through the client.retryPolicy
(com.azure.core.http.policy.RetryPolicy retryPolicy) Sets the retry policy to use (using the RetryPolicy type).Sets theCallingServerServiceVersion
that is used when making API requests.
-
Constructor Details
-
CallAutomationClientBuilder
public CallAutomationClientBuilder()Public default constructor
-
-
Method Details
-
endpoint
Set endpoint of the service.- Specified by:
endpoint
in interfacecom.azure.core.client.traits.EndpointTrait<CallAutomationClientBuilder>
- Parameters:
endpoint
- url of the service.- Returns:
- CallAutomationClientBuilder object.
-
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.- Specified by:
pipeline
in interfacecom.azure.core.client.traits.HttpTrait<CallAutomationClientBuilder>
- Parameters:
pipeline
-HttpPipeline
to use for sending service requests and receiving responses, if a pipeline is not supplied, the credential and httpClient fields must be set.- Returns:
- CallAutomationClientBuilder object.
-
credential
public CallAutomationClientBuilder credential(com.azure.core.credential.TokenCredential tokenCredential) 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 interfacecom.azure.core.client.traits.TokenCredentialTrait<CallAutomationClientBuilder>
- Parameters:
tokenCredential
-TokenCredential
used to authorize requests sent to the service.- Returns:
- Updated
CallAutomationClientBuilder
object. - Throws:
NullPointerException
- IftokenCredential
is null.
-
credential
public CallAutomationClientBuilder credential(com.azure.core.credential.AzureKeyCredential keyCredential) Sets theAzureKeyCredential
used to authenticate HTTP requests.- Specified by:
credential
in interfacecom.azure.core.client.traits.AzureKeyCredentialTrait<CallAutomationClientBuilder>
- Parameters:
keyCredential
- TheAzureKeyCredential
used to authenticate HTTP requests.- Returns:
- Updated
CallAutomationClientBuilder
object. - Throws:
NullPointerException
- IfkeyCredential
is null.
-
connectionString
Set connectionString to use.- Specified by:
connectionString
in interfacecom.azure.core.client.traits.ConnectionStringTrait<CallAutomationClientBuilder>
- Parameters:
connectionString
- connection string to set.- Returns:
- Updated
CallAutomationClientBuilder
object.
-
retryPolicy
Sets the retry policy to use (using the RetryPolicy type).Setting this is mutually exclusive with using
retryOptions(RetryOptions)
.- Parameters:
retryPolicy
- object to be applied- Returns:
- Updated
CallAutomationClientBuilder
object.
-
retryOptions
public CallAutomationClientBuilder retryOptions(com.azure.core.http.policy.RetryOptions 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 interfacecom.azure.core.client.traits.HttpTrait<CallAutomationClientBuilder>
- Parameters:
retryOptions
- TheRetryOptions
to use for all the requests made through the client.- Returns:
- Updated
CallAutomationClientBuilder
object.
-
configuration
Sets the configuration object used to retrieve environment configuration values during building of the client.- Specified by:
configuration
in interfacecom.azure.core.client.traits.ConfigurationTrait<CallAutomationClientBuilder>
- Parameters:
configuration
- Configuration store used to retrieve environment configurations.- Returns:
- Updated
CallAutomationClientBuilder
object.
-
httpLogOptions
public CallAutomationClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions) 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 interfacecom.azure.core.client.traits.HttpTrait<CallAutomationClientBuilder>
- Parameters:
logOptions
- Thelogging configuration
to use when sending and receiving requests to and from the service.- Returns:
- The updated
CallAutomationClientBuilder
object.
-
serviceVersion
Sets theCallingServerServiceVersion
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 CallAutomationClientBuilder object
-
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 interfacecom.azure.core.client.traits.HttpTrait<CallAutomationClientBuilder>
- Parameters:
httpClient
- TheHttpClient
to use for requests.- Returns:
- Updated
CallAutomationClientBuilder
object.
-
addPolicy
public CallAutomationClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy customPolicy) 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 interfacecom.azure.core.client.traits.HttpTrait<CallAutomationClientBuilder>
- Parameters:
customPolicy
- Apipeline policy
.- Returns:
- Updated
CallAutomationClientBuilder
object. - Throws:
NullPointerException
- IfpipelinePolicy
isnull
.
-
buildAsyncClient
Create asynchronous client applying HMACAuthenticationPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy. Additional HttpPolicies specified by additionalPolicies will be applied after them- Returns:
- The updated
CallAutomationClientBuilder
object. - 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:
- Updated
CallAutomationClientBuilder
object. - Throws:
IllegalStateException
- If bothretryOptions(RetryOptions)
andretryPolicy(RetryPolicy)
have been set.
-
clientOptions
Allows the user to set a variety of client-related options, such as user-agent string, headers, etc.- Specified by:
clientOptions
in interfacecom.azure.core.client.traits.HttpTrait<CallAutomationClientBuilder>
- Parameters:
clientOptions
- object to be applied.- Returns:
- Updated
CallAutomationClientBuilder
object.
-