TextAnalyticsClientBuilder Class

Package:

com.azure.ai.textanalytics

Maven Artifact:

com.azure:azure-ai-textanalytics:5.4.1

• java.lang.Object
• • com.azure.ai.textanalytics.TextAnalyticsClientBuilder

Implements

AzureKeyCredentialTrait<TextAnalyticsClientBuilder> ConfigurationTrait<TextAnalyticsClientBuilder> EndpointTrait<TextAnalyticsClientBuilder> HttpTrait<TextAnalyticsClientBuilder> TokenCredentialTrait<TextAnalyticsClientBuilder>

public final class TextAnalyticsClientBuilder
implements AzureKeyCredentialTrait<TextAnalyticsClientBuilder>, ConfigurationTrait<TextAnalyticsClientBuilder>, EndpointTrait<TextAnalyticsClientBuilder>, HttpTrait<TextAnalyticsClientBuilder>, TokenCredentialTrait<TextAnalyticsClientBuilder>

This class provides a fluent builder API to help instantiation of TextAnalyticsClient and TextAnalyticsAsyncClient, 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 keyCredential) or credential(TokenCredential 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 pipeline(HttpPipeline httpPipeline) and set the service endpoint with endpoint(String endpoint). 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();

Constructor Summary

Constructor	Description
TextAnalyticsClientBuilder()	Construct a TextAnalyticsClientBuilder object.

Method Summary

Modifier and Type	Method and Description
TextAnalyticsClientBuilder	addPolicy(HttpPipelinePolicy policy) Adds a HttpPipelinePolicy to apply on each request sent.
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(ClientOptions clientOptions) Allows for setting common properties such as application ID, headers, proxy configuration, etc.
TextAnalyticsClientBuilder	configuration(Configuration configuration) Sets the configuration store that is used during construction of the service client.
TextAnalyticsClientBuilder	credential(AzureKeyCredential keyCredential) Sets the AzureKeyCredential to use when authenticating HTTP requests for this TextAnalyticsClientBuilder.
TextAnalyticsClientBuilder	credential(TokenCredential tokenCredential) Sets the TokenCredential used to authorize requests sent to the service.
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 HttpLogOptions	getDefaultLogOptions() Gets the default Azure Text Analytics headers and query parameters allow list.
TextAnalyticsClientBuilder	httpClient(HttpClient client) Sets the HttpClient to use for sending and receiving requests to and from the service.
TextAnalyticsClientBuilder	httpLogOptions(HttpLogOptions logOptions) Sets the HttpLogOptions to use when sending and receiving requests to and from the service.
TextAnalyticsClientBuilder	pipeline(HttpPipeline httpPipeline) Sets the HttpPipeline to use for the service client.
TextAnalyticsClientBuilder	retryOptions(RetryOptions retryOptions) Sets the RetryOptions for all the requests made through the client.
TextAnalyticsClientBuilder	retryPolicy(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.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

TextAnalyticsClientBuilder

public TextAnalyticsClientBuilder()

Construct a TextAnalyticsClientBuilder object.

Method Details

addPolicy

public TextAnalyticsClientBuilder addPolicy(HttpPipelinePolicy policy)

Adds a HttpPipelinePolicy 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 no HttpPipeline 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 an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

Parameters:

policy - A HttpPipelinePolicy.

Returns:

The updated TextAnalyticsClientBuilder object.

buildAsyncClient

public TextAnalyticsAsyncClient buildAsyncClient()

Creates a TextAnalyticsAsyncClient based on options set in the builder. Every time buildAsyncClient() is called a new instance of TextAnalyticsAsyncClient is created.

If pipeline(HttpPipeline httpPipeline) is set, then the pipeline and endpoint(String endpoint) are used to create the TextAnalyticsClient. All other builder settings are ignored.

Returns:

A TextAnalyticsAsyncClient with the options set from the builder.

buildClient

public TextAnalyticsClient buildClient()

Creates a TextAnalyticsClient based on options set in the builder. Every time buildClient() is called a new instance of TextAnalyticsClient is created.

If pipeline(HttpPipeline httpPipeline) is set, then the pipeline and endpoint(String endpoint) are used to create the TextAnalyticsClient. All other builder settings are ignored

Returns:

A TextAnalyticsClient with the options set from the builder.

clientOptions

public TextAnalyticsClientBuilder clientOptions(ClientOptions 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 the HttpClientOptions class (a subclass of the ClientOptions 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 no HttpPipeline 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 an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

Parameters:

clientOptions - A configured instance of HttpClientOptions.

Returns:

The updated TextAnalyticsClientBuilder object.

configuration

public TextAnalyticsClientBuilder configuration(Configuration 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, use NONE to bypass using configuration settings during construction.

Parameters:

configuration - The configuration store used to

Returns:

The updated TextAnalyticsClientBuilder object.

credential

public TextAnalyticsClientBuilder credential(AzureKeyCredential keyCredential)

Sets the AzureKeyCredential to use when authenticating HTTP requests for this TextAnalyticsClientBuilder.

Parameters:

keyCredential - AzureKeyCredential API key credential

Returns:

The updated TextAnalyticsClientBuilder object.

credential

public TextAnalyticsClientBuilder credential(TokenCredential tokenCredential)

Sets the TokenCredential 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 the TokenCredential type.

Parameters:

tokenCredential - TokenCredential used to authorize requests sent to the service.

Returns:

The updated TextAnalyticsClientBuilder object.

defaultCountryHint

public TextAnalyticsClientBuilder defaultCountryHint(String countryHint)

Set the default country hint option for one client.

Parameters:

countryHint - default country hint

Returns:

The updated TextAnalyticsClientBuilder object.

defaultLanguage

public TextAnalyticsClientBuilder defaultLanguage(String language)

Set the default language option for one client.

Parameters:

language - default language

Returns:

The updated TextAnalyticsClientBuilder object.

endpoint

public TextAnalyticsClientBuilder endpoint(String endpoint)

Sets the service endpoint for the Azure Text Analytics instance.

Parameters:

endpoint - The URL of the Azure Text Analytics instance service requests to and receive responses from.

Returns:

The updated TextAnalyticsClientBuilder object.

getDefaultLogOptions

public static HttpLogOptions getDefaultLogOptions()

Gets the default Azure Text Analytics headers and query parameters allow list.

Returns:

The default HttpLogOptions allow list.

httpClient

public TextAnalyticsClientBuilder httpClient(HttpClient client)

Sets the HttpClient 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 no HttpPipeline 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 an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

Parameters:

client - The HttpClient to use for requests.

Returns:

The updated TextAnalyticsClientBuilder object.

httpLogOptions

public TextAnalyticsClientBuilder httpLogOptions(HttpLogOptions logOptions)

Sets the HttpLogOptions to use when sending and receiving requests to and from the service. If a logLevel is not provided, default value of HttpLogDetailLevel#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 no HttpPipeline 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 an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

Parameters:

logOptions - The HttpLogOptions to use when sending and receiving requests to and from the service.

Returns:

The updated TextAnalyticsClientBuilder object.

pipeline

public TextAnalyticsClientBuilder pipeline(HttpPipeline httpPipeline)

Sets the HttpPipeline 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 no HttpPipeline 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 an HttpPipeline 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 from endpoint(String endpoint) to build TextAnalyticsAsyncClient or TextAnalyticsClient.

Parameters:

httpPipeline - HttpPipeline to use for sending service requests and receiving responses.

Returns:

The updated TextAnalyticsClientBuilder object.

retryOptions

public TextAnalyticsClientBuilder retryOptions(RetryOptions retryOptions)

Sets the RetryOptions 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 no HttpPipeline 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 an HttpPipeline 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 retryPolicy).

Parameters:

retryOptions - The RetryOptions to use for all the requests made through the client.

Returns:

The updated TextAnalyticsClientBuilder object.

retryPolicy

public TextAnalyticsClientBuilder retryPolicy(RetryPolicy retryPolicy)

Sets the RetryPolicy that is used when each request is sent.

The default retry policy will be used if not provided buildAsyncClient() to build TextAnalyticsAsyncClient or TextAnalyticsClient.

Setting this is mutually exclusive with using retryOptions(RetryOptions retryOptions).

Parameters:

retryPolicy - user's retry policy applied to each request.

Returns:

The updated TextAnalyticsClientBuilder object.

serviceVersion

public TextAnalyticsClientBuilder serviceVersion(TextAnalyticsServiceVersion version)

Sets the 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.

Parameters:

version - TextAnalyticsServiceVersion of the service to be used when making requests.

Returns:

The updated TextAnalyticsClientBuilder object.