com.azure.ai.textanalytics

Class TextAnalyticsClientBuilder

java.lang.Object

com.azure.ai.textanalytics.TextAnalyticsClientBuilder

public final class TextAnalyticsClientBuilder
extends Object

This class provides a fluent builder API to help instantiation of 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();
 

See Also:

TextAnalyticsAsyncClient, TextAnalyticsClient

Constructor Summary

Constructors

Constructor and Description
TextAnalyticsClientBuilder()

Method Summary

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextAnalyticsClientBuilder

public TextAnalyticsClientBuilder()

Method Detail

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 is set, then the pipeline and endpoint are used to create the client. All other builder settings are ignored

Returns:

A TextAnalyticsClient with the options set from the builder.

Throws:

NullPointerException - if endpoint or TextAnalyticsClientBuilder.credential(AzureKeyCredential) has not been set.

IllegalArgumentException - if endpoint cannot be parsed into a valid URL.

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 is set, then the pipeline and endpoint are used to create the client. All other builder settings are ignored.

Returns:

A TextAnalyticsAsyncClient with the options set from the builder.

Throws:

NullPointerException - if endpoint or TextAnalyticsClientBuilder.credential(AzureKeyCredential) has not been set.

IllegalArgumentException - if endpoint cannot be parsed into a valid URL.

defaultLanguage

public TextAnalyticsClientBuilder defaultLanguage(String language)

Set the default language option for one client.

Parameters:

language - default language

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.

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.

Throws:

NullPointerException - if endpoint is null

IllegalArgumentException - if endpoint cannot be parsed into a valid URL.

credential

public TextAnalyticsClientBuilder credential(com.azure.core.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.

Throws:

NullPointerException - If keyCredential is null

credential

public TextAnalyticsClientBuilder credential(com.azure.core.credential.TokenCredential tokenCredential)

Sets the TokenCredential used to authenticate HTTP requests.

Parameters:

tokenCredential - TokenCredential used to authenticate HTTP requests.

Returns:

The updated TextAnalyticsClientBuilder object.

Throws:

NullPointerException - If tokenCredential is null.

httpLogOptions

public TextAnalyticsClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)

Sets the logging configuration for HTTP requests and responses.

If logLevel is not provided, default value of HttpLogDetailLevel.NONE is set.

Parameters:

logOptions - The logging configuration to use when sending and receiving HTTP requests/responses.

Returns:

The updated TextAnalyticsClientBuilder object.

getDefaultLogOptions

public static com.azure.core.http.policy.HttpLogOptions getDefaultLogOptions()

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

Returns:

The default HttpLogOptions allow list.

clientOptions

public TextAnalyticsClientBuilder clientOptions(com.azure.core.util.ClientOptions clientOptions)

Sets the client options such as application ID and custom headers to set on a request.

Parameters:

clientOptions - The client options.

Returns:

The updated TextAnalyticsClientBuilder object.

addPolicy

public TextAnalyticsClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy)

Adds a policy to the set of existing policies that are executed after required policies.

Parameters:

policy - The retry policy for service requests.

Returns:

The updated TextAnalyticsClientBuilder object.

Throws:

NullPointerException - If policy is null.

httpClient

public TextAnalyticsClientBuilder httpClient(com.azure.core.http.HttpClient client)

Sets the HTTP client to use for sending and receiving requests to and from the service.

Parameters:

client - The HTTP client to use for requests.

Returns:

The updated TextAnalyticsClientBuilder object.

pipeline

public TextAnalyticsClientBuilder pipeline(com.azure.core.http.HttpPipeline httpPipeline)

Sets the HTTP pipeline to use for the service client.

If pipeline is set, all other settings are ignored, aside from endpoint to build TextAnalyticsAsyncClient or TextAnalyticsClient.

Parameters:

httpPipeline - The HTTP pipeline to use for sending service requests and receiving responses.

Returns:

The updated TextAnalyticsClientBuilder object.

configuration

public TextAnalyticsClientBuilder configuration(com.azure.core.util.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 Configuration.NONE to bypass using configuration settings during construction.

Parameters:

configuration - The configuration store used to

Returns:

The updated TextAnalyticsClientBuilder object.

retryPolicy

public TextAnalyticsClientBuilder retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy)

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

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.