public final class FormRecognizerClientBuilder extends Object
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
Snippet 'com.azure.ai.formrecognizer.FormRecognizerAsyncClient.instantiation' not found.
Instantiating a synchronous Form Recognizer Client
Snippet 'com.azure.ai.formrecognizer.FormRecognizerClient.instantiation' not found.
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.
Snippet 'com.azure.ai.formrecognizer.FormRecognizerClient.pipeline.instantiation' not found.
FormRecognizerAsyncClient
,
FormRecognizerClient
Constructor and Description |
---|
FormRecognizerClientBuilder() |
Modifier and Type | Method and Description |
---|---|
FormRecognizerClientBuilder |
addPolicy(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(ClientOptions clientOptions)
Sets the client options such as application ID and custom headers to set on a request.
|
FormRecognizerClientBuilder |
configuration(Configuration configuration)
Sets the configuration store that is used during construction of the service client.
|
FormRecognizerClientBuilder |
credential(AzureKeyCredential apiKeyCredential)
Sets the
AzureKeyCredential to use when authenticating HTTP requests for this
FormRecognizerClientBuilder. |
FormRecognizerClientBuilder |
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 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(HttpClient client)
Sets the HTTP client to use for sending and receiving requests to and from the service.
|
FormRecognizerClientBuilder |
httpLogOptions(HttpLogOptions logOptions)
Sets the logging configuration for HTTP requests and responses.
|
FormRecognizerClientBuilder |
pipeline(HttpPipeline httpPipeline)
Sets the HTTP pipeline to use for the service client.
|
FormRecognizerClientBuilder |
retryPolicy(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. |
public FormRecognizerClient buildClient()
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.
NullPointerException
- if endpoint
or
FormRecognizerClientBuilder.credential(AzureKeyCredential)
has not been set.IllegalArgumentException
- if endpoint
cannot be parsed into a valid URL.public FormRecognizerAsyncClient buildAsyncClient()
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.
NullPointerException
- if endpoint
or FormRecognizerClientBuilder.credential(AzureKeyCredential)
has not been set.IllegalArgumentException
- if endpoint
cannot be parsed into a valid URL.public FormRecognizerClientBuilder endpoint(String endpoint)
endpoint
- The URL of the Azure Form Recognizer instance service requests to and receive responses from.NullPointerException
- if endpoint
is nullIllegalArgumentException
- if endpoint
cannot be parsed into a valid URL.public FormRecognizerClientBuilder credential(AzureKeyCredential apiKeyCredential)
AzureKeyCredential
to use when authenticating HTTP requests for this
FormRecognizerClientBuilder.apiKeyCredential
- AzureKeyCredential
API key credentialNullPointerException
- If apiKeyCredential
is null.public FormRecognizerClientBuilder credential(TokenCredential tokenCredential)
TokenCredential
used to authenticate HTTP requests.tokenCredential
- TokenCredential
used to authenticate HTTP requests.FormRecognizerClientBuilder
object.NullPointerException
- If tokenCredential
is null.public FormRecognizerClientBuilder httpLogOptions(HttpLogOptions logOptions)
If logOptions
isn't provided, the default options will use HttpLogDetailLevel.NONE
which will prevent logging.
logOptions
- The logging configuration to use when sending and receiving HTTP requests/responses.public static HttpLogOptions getDefaultLogOptions()
HttpLogOptions
allow list.public FormRecognizerClientBuilder clientOptions(ClientOptions clientOptions)
clientOptions
- The client options.public FormRecognizerClientBuilder addPolicy(HttpPipelinePolicy policy)
policy
- The retry policy for service requests.NullPointerException
- If policy
is null.public FormRecognizerClientBuilder httpClient(HttpClient client)
client
- The HTTP client to use for requests.public FormRecognizerClientBuilder pipeline(HttpPipeline httpPipeline)
If pipeline
is set, all other settings are ignored, aside from
endpoint
to build FormRecognizerAsyncClient
or
FormRecognizerClient
.
httpPipeline
- The HTTP pipeline to use for sending service requests and receiving responses.public FormRecognizerClientBuilder configuration(Configuration configuration)
The default configuration store is a clone of the global
configuration store
, use Configuration.NONE
to bypass using configuration settings during construction.
configuration
- The configuration store used to.public FormRecognizerClientBuilder retryPolicy(RetryPolicy retryPolicy)
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
.
retryPolicy
- user's retry policy applied to each request.public FormRecognizerClientBuilder serviceVersion(FormRecognizerServiceVersion version)
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.
version
- FormRecognizerServiceVersion
of the service to be used when making requests.Copyright © 2021. All rights reserved.