public final class TextAnalyticsClientBuilder extends Object
TextAnalyticsClients
and TextAnalyticsAsyncClients
, call TextAnalyticsClientBuilder.buildClient()
buildClient} and buildAsyncClient
respectively to construct an instance of the desired client.
The client needs the service endpoint of the Azure Text Analytics to access the resource service. TextAnalyticsClientBuilder.credential(AzureKeyCredential)
or credential(TokenCredential)
give the builder
access credential.
Instantiating an asynchronous Text Analytics Client
TextAnalyticsAsyncClient textAnalyticsAsyncClient = new TextAnalyticsClientBuilder() .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildAsyncClient();
Instantiating a synchronous Text Analytics Client
TextAnalyticsClient textAnalyticsClient = new TextAnalyticsClientBuilder() .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .buildClient();
Another way to construct the client is using a HttpPipeline
. The pipeline gives the client an authenticated
way to communicate with the service. Set the pipeline with this
and set the service
endpoint with this
. Using a pipeline requires additional setup but allows for finer control
on how the TextAnalyticsClient
and TextAnalyticsAsyncClient
is built.
HttpPipeline pipeline = new HttpPipelineBuilder() .policies(/* add policies */) .build(); TextAnalyticsClient textAnalyticsClient = new TextAnalyticsClientBuilder() .credential(new AzureKeyCredential("{key}")) .endpoint("{endpoint}") .pipeline(pipeline) .buildClient();
TextAnalyticsAsyncClient
,
TextAnalyticsClient
Constructor and Description |
---|
TextAnalyticsClientBuilder() |
Modifier and Type | Method and Description |
---|---|
TextAnalyticsClientBuilder |
addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy)
Adds a policy to the set of existing policies that are executed after required policies.
|
TextAnalyticsAsyncClient |
buildAsyncClient()
Creates a
TextAnalyticsAsyncClient based on options set in the builder. |
TextAnalyticsClient |
buildClient()
Creates a
TextAnalyticsClient based on options set in the builder. |
TextAnalyticsClientBuilder |
clientOptions(com.azure.core.util.ClientOptions clientOptions)
Sets the client options such as application ID and custom headers to set on a request.
|
TextAnalyticsClientBuilder |
configuration(com.azure.core.util.Configuration configuration)
Sets the configuration store that is used during construction of the service client.
|
TextAnalyticsClientBuilder |
credential(com.azure.core.credential.AzureKeyCredential keyCredential)
Sets the
AzureKeyCredential to use when authenticating HTTP requests for this
TextAnalyticsClientBuilder . |
TextAnalyticsClientBuilder |
credential(com.azure.core.credential.TokenCredential tokenCredential)
Sets the
TokenCredential used to authenticate HTTP requests. |
TextAnalyticsClientBuilder |
defaultCountryHint(String countryHint)
Set the default country hint option for one client.
|
TextAnalyticsClientBuilder |
defaultLanguage(String language)
Set the default language option for one client.
|
TextAnalyticsClientBuilder |
endpoint(String endpoint)
Sets the service endpoint for the Azure Text Analytics instance.
|
static com.azure.core.http.policy.HttpLogOptions |
getDefaultLogOptions()
Gets the default Azure Text Analytics headers and query parameters allow list.
|
TextAnalyticsClientBuilder |
httpClient(com.azure.core.http.HttpClient client)
Sets the HTTP client to use for sending and receiving requests to and from the service.
|
TextAnalyticsClientBuilder |
httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
Sets the logging configuration for HTTP requests and responses.
|
TextAnalyticsClientBuilder |
pipeline(com.azure.core.http.HttpPipeline httpPipeline)
Sets the HTTP pipeline to use for the service client.
|
TextAnalyticsClientBuilder |
retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy)
Sets the
RetryPolicy that is used when each request is sent. |
TextAnalyticsClientBuilder |
serviceVersion(TextAnalyticsServiceVersion version)
Sets the
TextAnalyticsServiceVersion that is used when making API requests. |
public TextAnalyticsClient buildClient()
TextAnalyticsClient
based on options set in the builder. Every time buildClient()
is
called a new instance of TextAnalyticsClient
is created.
If pipeline
is set, then the pipeline
and endpoint
are used to create the client
. All other builder settings are ignored
TextAnalyticsClient
with the options set from the builder.NullPointerException
- if endpoint
or TextAnalyticsClientBuilder.credential(AzureKeyCredential)
has not been set.IllegalArgumentException
- if endpoint
cannot be parsed into a valid URL.public TextAnalyticsAsyncClient buildAsyncClient()
TextAnalyticsAsyncClient
based on options set in the builder. Every time buildAsyncClient()
is called a new instance of TextAnalyticsAsyncClient
is created.
If pipeline
is set, then the pipeline
and endpoint
are used to create the client
. All other builder settings are ignored.
TextAnalyticsAsyncClient
with the options set from the builder.NullPointerException
- if endpoint
or TextAnalyticsClientBuilder.credential(AzureKeyCredential)
has not been set.IllegalArgumentException
- if endpoint
cannot be parsed into a valid URL.public TextAnalyticsClientBuilder defaultLanguage(String language)
language
- default languageTextAnalyticsClientBuilder
object.public TextAnalyticsClientBuilder defaultCountryHint(String countryHint)
countryHint
- default country hintTextAnalyticsClientBuilder
object.public TextAnalyticsClientBuilder endpoint(String endpoint)
endpoint
- The URL of the Azure Text Analytics instance service requests to and receive responses from.TextAnalyticsClientBuilder
object.NullPointerException
- if endpoint
is nullIllegalArgumentException
- if endpoint
cannot be parsed into a valid URL.public TextAnalyticsClientBuilder credential(com.azure.core.credential.AzureKeyCredential keyCredential)
AzureKeyCredential
to use when authenticating HTTP requests for this
TextAnalyticsClientBuilder
.keyCredential
- AzureKeyCredential
API key credentialTextAnalyticsClientBuilder
object.NullPointerException
- If keyCredential
is nullpublic TextAnalyticsClientBuilder credential(com.azure.core.credential.TokenCredential tokenCredential)
TokenCredential
used to authenticate HTTP requests.tokenCredential
- TokenCredential
used to authenticate HTTP requests.TextAnalyticsClientBuilder
object.NullPointerException
- If tokenCredential
is null.public TextAnalyticsClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
If logLevel is not provided, default value of HttpLogDetailLevel.NONE
is set.
logOptions
- The logging configuration to use when sending and receiving HTTP requests/responses.TextAnalyticsClientBuilder
object.public static com.azure.core.http.policy.HttpLogOptions getDefaultLogOptions()
HttpLogOptions
allow list.public TextAnalyticsClientBuilder clientOptions(com.azure.core.util.ClientOptions clientOptions)
clientOptions
- The client options.public TextAnalyticsClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy)
policy
- The retry policy for service requests.TextAnalyticsClientBuilder
object.NullPointerException
- If policy
is null.public TextAnalyticsClientBuilder httpClient(com.azure.core.http.HttpClient client)
client
- The HTTP client to use for requests.TextAnalyticsClientBuilder
object.public TextAnalyticsClientBuilder pipeline(com.azure.core.http.HttpPipeline httpPipeline)
If pipeline
is set, all other settings are ignored, aside from endpoint
to build TextAnalyticsAsyncClient
or TextAnalyticsClient
.
httpPipeline
- The HTTP pipeline to use for sending service requests and receiving responses.TextAnalyticsClientBuilder
object.public TextAnalyticsClientBuilder configuration(com.azure.core.util.Configuration configuration)
The default configuration store is a clone of the global
configuration store
, use Configuration.NONE
to bypass using configuration settings during construction.
configuration
- The configuration store used toTextAnalyticsClientBuilder
object.public TextAnalyticsClientBuilder retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy)
RetryPolicy
that is used when each request is sent.
The default retry policy will be used if not provided TextAnalyticsClientBuilder.buildAsyncClient()
to
build TextAnalyticsAsyncClient
or TextAnalyticsClient
.
retryPolicy
- user's retry policy applied to each request.TextAnalyticsClientBuilder
object.public TextAnalyticsClientBuilder serviceVersion(TextAnalyticsServiceVersion version)
TextAnalyticsServiceVersion
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.
version
- TextAnalyticsServiceVersion
of the service to be used when making requests.TextAnalyticsClientBuilder
object.Copyright © 2021 Microsoft Corporation. All rights reserved.