DocumentAnalysisClientBuilder Class

Package:
com.azure.ai.formrecognizer.documentanalysis
Maven Artifact:
com.azure:azure-ai-formrecognizer:4.1.13
  • java.lang.Object
    • com.azure.ai.formrecognizer.documentanalysis.DocumentAnalysisClientBuilder

Implements

AzureKeyCredentialTrait<DocumentAnalysisClientBuilder> ConfigurationTrait<DocumentAnalysisClientBuilder> EndpointTrait<DocumentAnalysisClientBuilder> HttpTrait<DocumentAnalysisClientBuilder> TokenCredentialTrait<DocumentAnalysisClientBuilder>

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

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

The client needs the service endpoint of the Azure Document Analysis to access the resource service and the audience for the service region that you want to target. credential(AzureKeyCredential azureKeyCredential) or credential(TokenCredential tokenCredential) gives the builder access credential.

Instantiating an asynchronous Document Analysis Client

DocumentAnalysisAsyncClient documentAnalysisAsyncClient = new DocumentAnalysisClientBuilder()
     .credential(new AzureKeyCredential("{key}"))
     .endpoint("{endpoint}")
     .buildAsyncClient();

Instantiating a synchronous Document Analysis Client

DocumentAnalysisClient documentAnalysisClient = new DocumentAnalysisClientBuilder()
     .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 DocumentAnalysisClient and DocumentAnalysisAsyncClient is built.

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

 DocumentAnalysisClient documentAnalysisClient = new DocumentAnalysisClientBuilder()
     .credential(new AzureKeyCredential("{key}"))
     .endpoint("{endpoint}")
     .pipeline(pipeline)
     .buildClient();

Constructor Summary

Constructor Description
DocumentAnalysisClientBuilder()

Create a DocumentAnalysisClientBuilder instance.

Method Summary

Modifier and Type Method and Description
DocumentAnalysisClientBuilder addPolicy(HttpPipelinePolicy policy)

Adds a HttpPipelinePolicy to apply on each request sent.
DocumentAnalysisClientBuilder audience(DocumentAnalysisAudience audience)

Sets the audience for the Azure Form Recognizer service.
DocumentAnalysisAsyncClient buildAsyncClient()

Creates a DocumentAnalysisAsyncClient based on options set in the builder.
DocumentAnalysisClient buildClient()

Creates a DocumentAnalysisClient based on options set in the builder.
DocumentAnalysisClientBuilder clientOptions(ClientOptions clientOptions)

Allows for setting common properties such as application ID, headers, proxy configuration, etc.
DocumentAnalysisClientBuilder configuration(Configuration configuration)

Sets the configuration store that is used during construction of the service client.
DocumentAnalysisClientBuilder credential(AzureKeyCredential azureKeyCredential)

Sets the AzureKeyCredential to use when authenticating HTTP requests for this DocumentAnalysisClientBuilder.
DocumentAnalysisClientBuilder credential(TokenCredential tokenCredential)

Sets the TokenCredential used to authorize requests sent to the service.
DocumentAnalysisClientBuilder endpoint(String endpoint)

Sets the service endpoint for the Azure Document Analysis instance.
static HttpLogOptions getDefaultLogOptions()

Gets the default Azure Document Analysis client headers and query parameters that are logged by default if HTTP logging is enabled.
DocumentAnalysisClientBuilder httpClient(HttpClient client)

Sets the HttpClient to use for sending and receiving requests to and from the service.
DocumentAnalysisClientBuilder httpLogOptions(HttpLogOptions logOptions)

Sets the HttpLogOptions to use when sending and receiving requests to and from the service.
DocumentAnalysisClientBuilder pipeline(HttpPipeline httpPipeline)

Sets the HttpPipeline to use for the service client.
DocumentAnalysisClientBuilder retryOptions(RetryOptions retryOptions)

Sets the RetryOptions for all the requests made through the client.
DocumentAnalysisClientBuilder retryPolicy(RetryPolicy retryPolicy)

Sets the RetryPolicy#RetryPolicy() that is used when each request is sent.
DocumentAnalysisClientBuilder serviceVersion(DocumentAnalysisServiceVersion version)

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

DocumentAnalysisClientBuilder

public DocumentAnalysisClientBuilder()

Create a DocumentAnalysisClientBuilder instance.

Method Details

addPolicy

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

audience

public DocumentAnalysisClientBuilder audience(DocumentAnalysisAudience audience)

Sets the audience for the Azure Form Recognizer service. The default audience is AZURE_PUBLIC_CLOUD when unset.

Parameters:

audience - ARM management audience associated with the given form recognizer resource.

Returns:

The updated DocumentAnalysisClientBuilder object.

buildAsyncClient

public DocumentAnalysisAsyncClient buildAsyncClient()

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

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

Returns:

A DocumentAnalysisAsyncClient with the options set from the builder.

buildClient

public DocumentAnalysisClient buildClient()

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

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

Returns:

A DocumentAnalysisClient with the options set from the builder.

clientOptions

public DocumentAnalysisClientBuilder 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 DocumentAnalysisClientBuilder object. HttpClientOptions

configuration

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

credential

public DocumentAnalysisClientBuilder credential(AzureKeyCredential azureKeyCredential)

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

Parameters:

azureKeyCredential - AzureKeyCredential API key credential

Returns:

The updated DocumentAnalysisClientBuilder object.

credential

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

endpoint

public DocumentAnalysisClientBuilder endpoint(String endpoint)

Sets the service endpoint for the Azure Document Analysis instance.

Parameters:

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

Returns:

The updated DocumentAnalysisClientBuilder object.

getDefaultLogOptions

public static HttpLogOptions getDefaultLogOptions()

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

Returns:

The default HttpLogOptions allow list.

httpClient

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

httpLogOptions

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

pipeline

public DocumentAnalysisClientBuilder 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 DocumentAnalysisAsyncClient or DocumentAnalysisClient.

Parameters:

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

Returns:

The updated DocumentAnalysisClientBuilder object.

retryOptions

public DocumentAnalysisClientBuilder 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 DocumentModelAdministrationClientBuilder object.

retryPolicy

public DocumentAnalysisClientBuilder retryPolicy(RetryPolicy retryPolicy)

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

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

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

Parameters:

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

Returns:

The updated DocumentAnalysisClientBuilder object.

serviceVersion

public DocumentAnalysisClientBuilder serviceVersion(DocumentAnalysisServiceVersion version)

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

Returns:

The updated DocumentAnalysisClientBuilder object.

Applies to