Class DocumentModelAdministrationClientBuilder
- All Implemented Interfaces:
AzureKeyCredentialTrait<DocumentModelAdministrationClientBuilder>,ConfigurationTrait<DocumentModelAdministrationClientBuilder>,EndpointTrait<DocumentModelAdministrationClientBuilder>,HttpTrait<DocumentModelAdministrationClientBuilder>,TokenCredentialTrait<DocumentModelAdministrationClientBuilder>
FormRecognizerAdminClient
and DocumentTrainingAsyncClient, call 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.
credential(AzureKeyCredential) or credential(TokenCredential) gives
the builder access credential.
Instantiating an asynchronous Document Model Administration Client
DocumentModelAdministrationAsyncClient documentModelAdministrationAsyncClient =
new DocumentModelAdministrationClientBuilder().buildAsyncClient();
Instantiating a synchronous Document Model Administration Client
DocumentModelAdministrationClient documentModelAdministrationClient =
new DocumentModelAdministrationClientBuilder().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 DocumentModelAdministrationClient and
DocumentModelAdministrationAsyncClient is built.
HttpPipeline pipeline = new HttpPipelineBuilder()
.policies(/* add policies */)
.build();
DocumentModelAdministrationAsyncClient documentModelAdministrationAsyncClient =
new DocumentModelAdministrationClientBuilder()
.credential(new AzureKeyCredential("{key}"))
.endpoint("{endpoint}")
.pipeline(pipeline)
.buildAsyncClient();
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddPolicy(HttpPipelinePolicy policy) Adds apipeline policyto apply on each request sent.audience(DocumentAnalysisAudience audience) Sets the audience for the Azure Form Recognizer service.Creates aDocumentModelAdministrationAsyncClientbased on options set in the builder.Creates aDocumentModelAdministrationClientbased on options set in the builder.clientOptions(ClientOptions clientOptions) Allows for setting common properties such as application ID, headers, proxy configuration, etc.configuration(Configuration configuration) Sets the configuration store that is used during construction of the service client.credential(AzureKeyCredential azureKeyCredential) Sets theAzureKeyCredentialto use when authenticating HTTP requests for this DocumentModelAdministrationClientBuilder.credential(TokenCredential tokenCredential) Sets theTokenCredentialused to authorize requests sent to the service.Sets the service endpoint for the Azure Form Recognizer instance.static HttpLogOptionsGets the default Azure Form Training client headers and query parameters that are logged by default if HTTP logging is enabled.httpClient(HttpClient client) Sets theHttpClientto use for sending and receiving requests to and from the service.httpLogOptions(HttpLogOptions logOptions) Sets thelogging configurationto use when sending and receiving requests to and from the service.pipeline(HttpPipeline httpPipeline) Sets theHttpPipelineto use for the service client.retryOptions(RetryOptions retryOptions) Sets theRetryOptionsfor all the requests made through the client.retryPolicy(RetryPolicy retryPolicy) Sets theRetryPolicy()that is used when each request is sent.Sets theDocumentAnalysisServiceVersionthat is used when making API requests.
-
Constructor Details
-
DocumentModelAdministrationClientBuilder
public DocumentModelAdministrationClientBuilder()
-
-
Method Details
-
buildClient
Creates aDocumentModelAdministrationClientbased on options set in the builder. Every timebuildClient()is called a new instance ofDocumentModelAdministrationClientis created.If
pipelineis set, then thepipelineandendpointare used to create theclient. All other builder settings are ignored.- Returns:
- A FormRecognizerAdminClient with the options set from the builder.
- Throws:
NullPointerException- ifendpointorcredential(AzureKeyCredential)has not been set.IllegalArgumentException- ifendpointcannot be parsed into a valid URL.IllegalStateException- If bothretryOptions(RetryOptions)andretryPolicy(RetryPolicy)have been set.
-
buildAsyncClient
Creates aDocumentModelAdministrationAsyncClientbased on options set in the builder. Every timebuildAsyncClient()is called a new instance ofDocumentModelAdministrationAsyncClientis created.If
pipelineis set, then thepipelineandendpointare used to create theclient. All other builder settings are ignored.- Returns:
- A DocumentTrainingAsyncClient with the options set from the builder.
- Throws:
NullPointerException- ifendpointorcredential(AzureKeyCredential)has not been set oraudienceis null when usingcredential(TokenCredential).IllegalArgumentException- ifendpointcannot be parsed into a valid URL.IllegalStateException- If bothretryOptions(RetryOptions)andretryPolicy(RetryPolicy)have been set.
-
endpoint
Sets the service endpoint for the Azure Form Recognizer instance.- Specified by:
endpointin interfaceEndpointTrait<DocumentModelAdministrationClientBuilder>- Parameters:
endpoint- The URL of the Azure Form Recognizer instance service requests to and receive responses from.- Returns:
- The updated DocumentModelAdministrationClientBuilder object.
- Throws:
NullPointerException- ifendpointis null.IllegalArgumentException- ifendpointcannot be parsed into a valid URL.
-
credential
Sets theAzureKeyCredentialto use when authenticating HTTP requests for this DocumentModelAdministrationClientBuilder.- Specified by:
credentialin interfaceAzureKeyCredentialTrait<DocumentModelAdministrationClientBuilder>- Parameters:
azureKeyCredential-AzureKeyCredentialAPI key credential.- Returns:
- The updated DocumentModelAdministrationClientBuilder object.
- Throws:
NullPointerException- IfazureKeyCredentialis null.
-
credential
Sets theTokenCredentialused 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 theTokenCredentialtype.- Specified by:
credentialin interfaceTokenCredentialTrait<DocumentModelAdministrationClientBuilder>- Parameters:
tokenCredential-TokenCredentialused to authorize requests sent to the service.- Returns:
- The updated
DocumentModelAdministrationClientBuilderobject. - Throws:
NullPointerException- IftokenCredentialis null.
-
httpLogOptions
Sets thelogging configurationto use when sending and receiving requests to and from the service. If alogLevelis not provided, default value ofHttpLogDetailLevel.NONEis set.Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a
HttpPipelineis specified, this takes precedence over all other APIs in the trait, and they will be ignored. If noHttpPipelineis 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 anHttpPipelineis specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.- Specified by:
httpLogOptionsin interfaceHttpTrait<DocumentModelAdministrationClientBuilder>- Parameters:
logOptions- Thelogging configurationto use when sending and receiving requests to and from the service.- Returns:
- The updated DocumentModelAdministrationClientBuilder object.
-
getDefaultLogOptions
Gets the default Azure Form Training client headers and query parameters that are logged by default if HTTP logging is enabled.- Returns:
- The default
HttpLogOptionsallow list.
-
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 theHttpClientOptionsclass (a subclass of theClientOptionsbase 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
HttpPipelineis specified, this takes precedence over all other APIs in the trait, and they will be ignored. If noHttpPipelineis 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 anHttpPipelineis specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.- Specified by:
clientOptionsin interfaceHttpTrait<DocumentModelAdministrationClientBuilder>- Parameters:
clientOptions- A configured instance ofHttpClientOptions.- Returns:
- The updated DocumentModelAdministrationClientBuilder object.
- See Also:
-
addPolicy
Adds apipeline policyto apply on each request sent.Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a
HttpPipelineis specified, this takes precedence over all other APIs in the trait, and they will be ignored. If noHttpPipelineis 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 anHttpPipelineis specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.- Specified by:
addPolicyin interfaceHttpTrait<DocumentModelAdministrationClientBuilder>- Parameters:
policy- Apipeline policy.- Returns:
- The updated DocumentModelAdministrationClientBuilder object.
- Throws:
NullPointerException- Ifpolicyis null.
-
httpClient
Sets theHttpClientto 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
HttpPipelineis specified, this takes precedence over all other APIs in the trait, and they will be ignored. If noHttpPipelineis 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 anHttpPipelineis specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.- Specified by:
httpClientin interfaceHttpTrait<DocumentModelAdministrationClientBuilder>- Parameters:
client- TheHttpClientto use for requests.- Returns:
- The updated DocumentModelAdministrationClientBuilder object.
-
pipeline
Sets theHttpPipelineto use for the service client.Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a
HttpPipelineis specified, this takes precedence over all other APIs in the trait, and they will be ignored. If noHttpPipelineis 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 anHttpPipelineis specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.If
pipelineis set, all other settings are ignored, aside fromendpointto buildDocumentModelAdministrationAsyncClientorDocumentModelAdministrationClient.- Specified by:
pipelinein interfaceHttpTrait<DocumentModelAdministrationClientBuilder>- Parameters:
httpPipeline-HttpPipelineto use for sending service requests and receiving responses.- Returns:
- The updated DocumentModelAdministrationClientBuilder object.
-
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, useConfiguration.NONEto bypass using configuration settings during construction.- Specified by:
configurationin interfaceConfigurationTrait<DocumentModelAdministrationClientBuilder>- Parameters:
configuration- The configuration store used to.- Returns:
- The updated DocumentModelAdministrationClientBuilder object.
-
retryPolicy
Sets theRetryPolicy()that is used when each request is sent.The default retry policy will be used if not provided
buildAsyncClient()to buildDocumentModelAdministrationAsyncClientorDocumentModelAdministrationClient.Setting this is mutually exclusive with using
retryOptions(RetryOptions).- Parameters:
retryPolicy- user's retry policy applied to each request.- Returns:
- The updated DocumentModelAdministrationClientBuilder object.
-
retryOptions
Sets theRetryOptionsfor all the requests made through the client.Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a
HttpPipelineis specified, this takes precedence over all other APIs in the trait, and they will be ignored. If noHttpPipelineis 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 anHttpPipelineis 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).- Specified by:
retryOptionsin interfaceHttpTrait<DocumentModelAdministrationClientBuilder>- Parameters:
retryOptions- TheRetryOptionsto use for all the requests made through the client.- Returns:
- The updated DocumentModelAdministrationClientBuilder object.
-
serviceVersion
public DocumentModelAdministrationClientBuilder serviceVersion(DocumentAnalysisServiceVersion version) Sets theDocumentAnalysisServiceVersionthat 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-DocumentAnalysisServiceVersionof the service to be used when making requests.- Returns:
- The updated DocumentModelAdministrationClientBuilder object.
-
audience
Sets the audience for the Azure Form Recognizer service. The default audience isDocumentAnalysisAudience.AZURE_RESOURCE_MANAGER_PUBLIC_CLOUDwhen unset.- Parameters:
audience- ARM management audience associated with the given form recognizer resource.- Returns:
- The updated
DocumentModelAdministrationClientBuilderobject. - Throws:
NullPointerException- Ifaudienceis null.
-