com.azure.ai.formrecognizer

Class FormRecognizerClientBuilder

java.lang.Object

com.azure.ai.formrecognizer.FormRecognizerClientBuilder

public final class FormRecognizerClientBuilder
extends Object

This class provides a fluent builder API to help instantiation of FormRecognizerClients and FormRecognizerAsyncClients, call FormRecognizerClientBuilder.buildClient() buildClient} and buildAsyncClient respectively to construct an instance of the desired client.

The client needs the service endpoint of the Azure Form Recognizer to access the resource service. FormRecognizerClientBuilder.credential(AzureKeyCredential) or credential(TokenCredential) gives the builder access credential.

Instantiating an asynchronous Form Recognizer Client

FormRecognizerAsyncClient formRecognizerAsyncClient = new FormRecognizerClientBuilder()
    .credential(new AzureKeyCredential("{key}"))
    .endpoint("{endpoint}")
    .buildAsyncClient();

Instantiating a synchronous Form Recognizer Client

FormRecognizerClient formRecognizerClient = new FormRecognizerClientBuilder()
    .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 FormRecognizerClient and FormRecognizerAsyncClient is built.

HttpPipeline pipeline = new HttpPipelineBuilder()
    .policies(/* add policies */)
    .build();

FormRecognizerClient formRecognizerClient = new FormRecognizerClientBuilder()
    .credential(new AzureKeyCredential("{key}"))
    .endpoint("{endpoint}")
    .pipeline(pipeline)
    .buildClient();

See Also:

FormRecognizerAsyncClient, FormRecognizerClient

Constructor Summary

Constructors

Constructor and Description
FormRecognizerClientBuilder()

Method Summary

Modifier and Type	Method and Description
FormRecognizerClientBuilder	addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy) Adds a policy to the set of existing policies that are executed after required policies.
FormRecognizerAsyncClient	buildAsyncClient() Creates a FormRecognizerAsyncClient based on options set in the builder.
FormRecognizerClient	buildClient() Creates a FormRecognizerClient based on options set in the builder.
FormRecognizerClientBuilder	clientOptions(com.azure.core.util.ClientOptions clientOptions) Sets the client options such as application ID and custom headers to set on a request.
FormRecognizerClientBuilder	configuration(com.azure.core.util.Configuration configuration) Sets the configuration store that is used during construction of the service client.
FormRecognizerClientBuilder	credential(com.azure.core.credential.AzureKeyCredential apiKeyCredential) Sets the AzureKeyCredential to use when authenticating HTTP requests for this FormRecognizerClientBuilder.
FormRecognizerClientBuilder	credential(com.azure.core.credential.TokenCredential tokenCredential) Sets the TokenCredential used to authenticate HTTP requests.
FormRecognizerClientBuilder	endpoint(String endpoint) Sets the service endpoint for the Azure Form Recognizer instance.
static com.azure.core.http.policy.HttpLogOptions	getDefaultLogOptions() Gets the default Azure Form Recognizer client headers and query parameters that are logged by default if HTTP logging is enabled.
FormRecognizerClientBuilder	httpClient(com.azure.core.http.HttpClient client) Sets the HTTP client to use for sending and receiving requests to and from the service.
FormRecognizerClientBuilder	httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions) Sets the logging configuration for HTTP requests and responses.
FormRecognizerClientBuilder	pipeline(com.azure.core.http.HttpPipeline httpPipeline) Sets the HTTP pipeline to use for the service client.
FormRecognizerClientBuilder	retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy) Sets the RetryPolicy.RetryPolicy() that is used when each request is sent.
FormRecognizerClientBuilder	serviceVersion(FormRecognizerServiceVersion version) Sets the FormRecognizerServiceVersion 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

FormRecognizerClientBuilder

public FormRecognizerClientBuilder()

Method Detail

buildClient

public FormRecognizerClient buildClient()

Creates a FormRecognizerClient based on options set in the builder. Every time buildClient() is called a new instance of FormRecognizerClient 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 FormRecognizerClient with the options set from the builder.

Throws:

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

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

buildAsyncClient

public FormRecognizerAsyncClient buildAsyncClient()

Creates a FormRecognizerAsyncClient based on options set in the builder. Every time buildAsyncClient() is called a new instance of FormRecognizerAsyncClient 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 FormRecognizerAsyncClient with the options set from the builder.

Throws:

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

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

endpoint

public FormRecognizerClientBuilder endpoint(String endpoint)

Sets the service endpoint for the Azure Form Recognizer instance.

Parameters:

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

Returns:

The updated FormRecognizerClientBuilder object.

Throws:

NullPointerException - if endpoint is null

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

credential

public FormRecognizerClientBuilder credential(com.azure.core.credential.AzureKeyCredential apiKeyCredential)

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

Parameters:

apiKeyCredential - AzureKeyCredential API key credential

Returns:

The updated FormRecognizerClientBuilder object.

Throws:

NullPointerException - If apiKeyCredential is null.

credential

public FormRecognizerClientBuilder 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 FormRecognizerClientBuilder object.

Throws:

NullPointerException - If tokenCredential is null.

httpLogOptions

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

Sets the logging configuration for HTTP requests and responses.

If logOptions isn't provided, the default options will use HttpLogDetailLevel.NONE which will prevent logging.

Parameters:

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

Returns:

The updated FormRecognizerClientBuilder object.

getDefaultLogOptions

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

Gets the default Azure Form Recognizer client headers and query parameters that are logged by default if HTTP logging is enabled.

Returns:

The default HttpLogOptions allow list.

clientOptions

public FormRecognizerClientBuilder 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 FormRecognizerClientBuilder object.

addPolicy

public FormRecognizerClientBuilder 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 FormRecognizerClientBuilder object.

Throws:

NullPointerException - If policy is null.

httpClient

public FormRecognizerClientBuilder 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 FormRecognizerClientBuilder object.

pipeline

public FormRecognizerClientBuilder 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 FormRecognizerAsyncClient or FormRecognizerClient.

Parameters:

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

Returns:

The updated FormRecognizerClientBuilder object.

configuration

public FormRecognizerClientBuilder 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 FormRecognizerClientBuilder object.

retryPolicy

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

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

The default retry policy will be used if not provided FormRecognizerClientBuilder.buildAsyncClient() to build FormRecognizerAsyncClient or FormRecognizerClient.

Parameters:

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

Returns:

The updated FormRecognizerClientBuilder object.

serviceVersion

public FormRecognizerClientBuilder serviceVersion(FormRecognizerServiceVersion version)

Sets the FormRecognizerServiceVersion 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 - FormRecognizerServiceVersion of the service to be used when making requests.

Returns:

The updated FormRecognizerClientBuilder object.