Class SipRoutingClientBuilder
- All Implemented Interfaces:
com.azure.core.client.traits.AzureKeyCredentialTrait<SipRoutingClientBuilder>
,com.azure.core.client.traits.ConfigurationTrait<SipRoutingClientBuilder>
,com.azure.core.client.traits.ConnectionStringTrait<SipRoutingClientBuilder>
,com.azure.core.client.traits.EndpointTrait<SipRoutingClientBuilder>
,com.azure.core.client.traits.HttpTrait<SipRoutingClientBuilder>
,com.azure.core.client.traits.TokenCredentialTrait<SipRoutingClientBuilder>
Instantiating a SIP Routing Client Builder
SipRoutingClientBuilder builder = new SipRoutingClientBuilder();
Using a SIP Routing Client Builder to build a SIP Routing Client
SipRoutingClient sipRoutingClient = new SipRoutingClientBuilder() .connectionString(connectionString) .buildClient();
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddPolicy
(com.azure.core.http.policy.HttpPipelinePolicy policy) Adds apipeline policy
to apply on each request sent.Create asynchronous client applying CommunicationClientCredentialPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy.Create synchronous client applying CommunicationClientCredentialPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy.clientOptions
(com.azure.core.util.ClientOptions clientOptions) Allows for setting common properties such as application ID, headers, proxy configuration, 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 the endpoint and AzureKeyCredential for authorization.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.Sets endpoint of the servicehttpClient
(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 httpLogOptions) Sets thelogging configuration
to use when sending and receiving requests to and from the service.pipeline
(com.azure.core.http.HttpPipeline httpPipeline) 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 theRetryPolicy
that is used when each request is sent.serviceVersion
(SipRoutingServiceVersion version) Sets theSipRoutingServiceVersion
that is used when making API requests.
-
Constructor Details
-
SipRoutingClientBuilder
public SipRoutingClientBuilder()
-
-
Method Details
-
endpoint
Sets endpoint of the service- Specified by:
endpoint
in interfacecom.azure.core.client.traits.EndpointTrait<SipRoutingClientBuilder>
- Parameters:
endpoint
- url of the service- Returns:
- The updated
SipRoutingClientBuilder
object. - Throws:
IllegalArgumentException
- Ifendpoint
isnull
or it cannot be parsed into a valid URL.
-
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
pipeline
is set, all other settings aside fromendpoint
are ignored.- Specified by:
pipeline
in interfacecom.azure.core.client.traits.HttpTrait<SipRoutingClientBuilder>
- Parameters:
httpPipeline
-HttpPipeline
to use for sending service requests and receiving responses.- Returns:
- The updated
SipRoutingClientBuilder
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<SipRoutingClientBuilder>
- Parameters:
httpClient
- TheHttpClient
to use for requests.- Returns:
- The updated
SipRoutingClientBuilder
object.
-
httpLogOptions
public SipRoutingClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions 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 interfacecom.azure.core.client.traits.HttpTrait<SipRoutingClientBuilder>
- Parameters:
httpLogOptions
- Thelogging configuration
to use when sending and receiving requests to and from the service.- Returns:
- The updated
SipRoutingClientBuilder
object.
-
credential
public SipRoutingClientBuilder credential(com.azure.core.credential.AzureKeyCredential keyCredential) Sets theAzureKeyCredential
used to authenticate HTTP requests.- Specified by:
credential
in interfacecom.azure.core.client.traits.AzureKeyCredentialTrait<SipRoutingClientBuilder>
- Parameters:
keyCredential
- TheAzureKeyCredential
used to authenticate HTTP requests.- Returns:
- The updated
SipRoutingClientBuilder
object. - Throws:
NullPointerException
- IfkeyCredential
isnull
.
-
credential
public SipRoutingClientBuilder 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<SipRoutingClientBuilder>
- Parameters:
tokenCredential
-TokenCredential
used to authorize requests sent to the service.- Returns:
- The updated
SipRoutingClientBuilder
object. - Throws:
NullPointerException
- IftokenCredential
isnull
.
-
connectionString
Set the endpoint and AzureKeyCredential for authorization.- Specified by:
connectionString
in interfacecom.azure.core.client.traits.ConnectionStringTrait<SipRoutingClientBuilder>
- Parameters:
connectionString
- connection string in the format "endpoint={endpoint_value};accesskey={accesskey_value}"- Returns:
- The updated
SipRoutingClientBuilder
object. - Throws:
NullPointerException
- IfconnectionString
isnull
.
-
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<SipRoutingClientBuilder>
- Parameters:
configuration
- Configuration store used to retrieve environment configurations.- Returns:
- The updated
SipRoutingClientBuilder
object.
-
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 interfacecom.azure.core.client.traits.HttpTrait<SipRoutingClientBuilder>
- Parameters:
policy
- Apipeline policy
.- Returns:
- The updated
SipRoutingClientBuilder
object. - Throws:
NullPointerException
- Ifpolicy
isnull
.
-
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 interfacecom.azure.core.client.traits.HttpTrait<SipRoutingClientBuilder>
- Parameters:
clientOptions
- A configured instance ofHttpClientOptions
.- Returns:
- The updated
SipRoutingClientBuilder
object. - See Also:
-
HttpClientOptions
-
serviceVersion
Sets theSipRoutingServiceVersion
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
-SipRoutingServiceVersion
of the service to be used when making requests.- Returns:
- The updated
SipRoutingClientBuilder
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
SipRoutingClientBuilder
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 interfacecom.azure.core.client.traits.HttpTrait<SipRoutingClientBuilder>
- Parameters:
retryOptions
- TheRetryOptions
to use for all the requests made through the client.- Returns:
- The updated
SipRoutingClientBuilder
object.
-
buildClient
Create synchronous client applying CommunicationClientCredentialPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy. Additional HttpPolicies specified by additionalPolicies will be applied after them- Returns:
SipRoutingClient
instance.- Throws:
IllegalStateException
- If bothretryOptions(RetryOptions)
andretryPolicy(RetryPolicy)
have been set.
-
buildAsyncClient
Create asynchronous client applying CommunicationClientCredentialPolicy, UserAgentPolicy, RetryPolicy, and CookiePolicy. Additional HttpPolicies specified by additionalPolicies will be applied after them- Returns:
SipRoutingAsyncClient
instance.- Throws:
IllegalStateException
- If bothretryOptions(RetryOptions)
andretryPolicy(RetryPolicy)
have been set.
-