Class TextAnalyticsClientBuilder
- All Implemented Interfaces:
AzureKeyCredentialTrait<TextAnalyticsClientBuilder>
,ConfigurationTrait<TextAnalyticsClientBuilder>
,EndpointTrait<TextAnalyticsClientBuilder>
,HttpTrait<TextAnalyticsClientBuilder>
,TokenCredentialTrait<TextAnalyticsClientBuilder>
TextAnalyticsClients
and TextAnalyticsAsyncClients
, call 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. 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();
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddPolicy
(HttpPipelinePolicy policy) Adds apipeline policy
to apply on each request sent.Creates aTextAnalyticsAsyncClient
based on options set in the builder.Creates aTextAnalyticsClient
based on options set in the builder.clientOptions
(ClientOptions clientOptions) Allows for setting common properties such as application ID, headers, proxy configuration, etc.configuration
(Configuration configuration) Sets the configuration store that is used during construction of the service client.credential
(AzureKeyCredential keyCredential) Sets theAzureKeyCredential
to use when authenticating HTTP requests for thisTextAnalyticsClientBuilder
.credential
(TokenCredential tokenCredential) Sets theTokenCredential
used to authorize requests sent to the service.defaultCountryHint
(String countryHint) Set the default country hint option for one client.defaultLanguage
(String language) Set the default language option for one client.Sets the service endpoint for the Azure Text Analytics instance.static HttpLogOptions
Gets the default Azure Text Analytics headers and query parameters allow list.httpClient
(HttpClient client) 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 httpPipeline) 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 theTextAnalyticsServiceVersion
that is used when making API requests.
-
Constructor Details
-
TextAnalyticsClientBuilder
public TextAnalyticsClientBuilder()
-
-
Method Details
-
buildClient
Creates aTextAnalyticsClient
based on options set in the builder. Every timebuildClient()
is called a new instance ofTextAnalyticsClient
is created.If
pipeline
is set, then thepipeline
andendpoint
are used to create theclient
. All other builder settings are ignored- Returns:
- A
TextAnalyticsClient
with the options set from the builder. - Throws:
NullPointerException
- ifendpoint
orcredential(AzureKeyCredential)
has not been set.IllegalArgumentException
- ifendpoint
cannot be parsed into a valid URL.IllegalStateException
- If bothretryOptions(RetryOptions)
andretryPolicy(RetryPolicy)
have been set.
-
buildAsyncClient
Creates aTextAnalyticsAsyncClient
based on options set in the builder. Every timebuildAsyncClient()
is called a new instance ofTextAnalyticsAsyncClient
is created.If
pipeline
is set, then thepipeline
andendpoint
are used to create theclient
. All other builder settings are ignored.- Returns:
- A
TextAnalyticsAsyncClient
with the options set from the builder. - Throws:
NullPointerException
- ifendpoint
orcredential(AzureKeyCredential)
has not been set.IllegalArgumentException
- ifendpoint
cannot be parsed into a valid URL.IllegalStateException
- If bothretryOptions(RetryOptions)
andretryPolicy(RetryPolicy)
have been set.
-
defaultLanguage
Set the default language option for one client.- Parameters:
language
- default language- Returns:
- The updated
TextAnalyticsClientBuilder
object.
-
defaultCountryHint
Set the default country hint option for one client.- Parameters:
countryHint
- default country hint- Returns:
- The updated
TextAnalyticsClientBuilder
object.
-
endpoint
Sets the service endpoint for the Azure Text Analytics instance.- Specified by:
endpoint
in interfaceEndpointTrait<TextAnalyticsClientBuilder>
- Parameters:
endpoint
- The URL of the Azure Text Analytics instance service requests to and receive responses from.- Returns:
- The updated
TextAnalyticsClientBuilder
object. - Throws:
NullPointerException
- ifendpoint
is nullIllegalArgumentException
- ifendpoint
cannot be parsed into a valid URL.
-
credential
Sets theAzureKeyCredential
to use when authenticating HTTP requests for thisTextAnalyticsClientBuilder
.- Specified by:
credential
in interfaceAzureKeyCredentialTrait<TextAnalyticsClientBuilder>
- Parameters:
keyCredential
-AzureKeyCredential
API key credential- Returns:
- The updated
TextAnalyticsClientBuilder
object. - Throws:
NullPointerException
- IfkeyCredential
is null
-
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<TextAnalyticsClientBuilder>
- Parameters:
tokenCredential
-TokenCredential
used to authorize requests sent to the service.- Returns:
- The updated
TextAnalyticsClientBuilder
object. - Throws:
NullPointerException
- IftokenCredential
is null.
-
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<TextAnalyticsClientBuilder>
- Parameters:
logOptions
- Thelogging configuration
to use when sending and receiving requests to and from the service.- Returns:
- The updated
TextAnalyticsClientBuilder
object.
-
getDefaultLogOptions
Gets the default Azure Text Analytics headers and query parameters allow list.- Returns:
- The default
HttpLogOptions
allow list.
-
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<TextAnalyticsClientBuilder>
- Parameters:
clientOptions
- A configured instance ofHttpClientOptions
.- Returns:
- The updated TextAnalyticsClientBuilder object.
- See Also:
-
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<TextAnalyticsClientBuilder>
- Parameters:
policy
- Apipeline policy
.- Returns:
- The updated
TextAnalyticsClientBuilder
object. - Throws:
NullPointerException
- Ifpolicy
is null.
-
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<TextAnalyticsClientBuilder>
- Parameters:
client
- TheHttpClient
to use for requests.- Returns:
- The updated
TextAnalyticsClientBuilder
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.If
pipeline
is set, all other settings are ignored, aside fromendpoint
to buildTextAnalyticsAsyncClient
orTextAnalyticsClient
.- Specified by:
pipeline
in interfaceHttpTrait<TextAnalyticsClientBuilder>
- Parameters:
httpPipeline
-HttpPipeline
to use for sending service requests and receiving responses.- Returns:
- The updated
TextAnalyticsClientBuilder
object.
-
configuration
Sets the configuration store that is used during construction of the service client.The default configuration store is a clone of the
global configuration store
, useConfiguration.NONE
to bypass using configuration settings during construction.- Specified by:
configuration
in interfaceConfigurationTrait<TextAnalyticsClientBuilder>
- Parameters:
configuration
- The configuration store used to- Returns:
- The updated
TextAnalyticsClientBuilder
object.
-
retryPolicy
Sets theRetryPolicy
that is used when each request is sent.The default retry policy will be used if not provided
buildAsyncClient()
to buildTextAnalyticsAsyncClient
orTextAnalyticsClient
.Setting this is mutually exclusive with using
retryOptions(RetryOptions)
.- Parameters:
retryPolicy
- user's retry policy applied to each request.- Returns:
- The updated
TextAnalyticsClientBuilder
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<TextAnalyticsClientBuilder>
- Parameters:
retryOptions
- TheRetryOptions
to use for all the requests made through the client.- Returns:
- The updated
TextAnalyticsClientBuilder
object.
-
serviceVersion
Sets theTextAnalyticsServiceVersion
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.
- Parameters:
version
-TextAnalyticsServiceVersion
of the service to be used when making requests.- Returns:
- The updated
TextAnalyticsClientBuilder
object.
-