Package com.azure.ai.formrecognizer.training

Class FormTrainingClientBuilder

java.lang.Object
com.azure.ai.formrecognizer.training.FormTrainingClientBuilder
All Implemented Interfaces:
com.azure.core.client.traits.AzureKeyCredentialTrait<FormTrainingClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<FormTrainingClientBuilder>, com.azure.core.client.traits.EndpointTrait<FormTrainingClientBuilder>, com.azure.core.client.traits.HttpTrait<FormTrainingClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<FormTrainingClientBuilder>
public final class FormTrainingClientBuilder extends Object implements com.azure.core.client.traits.AzureKeyCredentialTrait<FormTrainingClientBuilder>, com.azure.core.client.traits.ConfigurationTrait<FormTrainingClientBuilder>, com.azure.core.client.traits.EndpointTrait<FormTrainingClientBuilder>, com.azure.core.client.traits.HttpTrait<FormTrainingClientBuilder>, com.azure.core.client.traits.TokenCredentialTrait<FormTrainingClientBuilder>
This class provides a fluent builder API to help instantiation of FormTrainingClient and FormTrainingAsyncClient, 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 Form Training Client

 FormTrainingAsyncClient formTrainingAsyncClient = new FormTrainingClientBuilder().buildAsyncClient();

Instantiating a synchronous Form Training Client

 FormTrainingClient formTrainingClient = new FormTrainingClientBuilder().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 FormTrainingClient and FormTrainingAsyncClient is built. 

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

 FormTrainingAsyncClient formTrainingAsyncClient = new FormTrainingClientBuilder()
     .credential(new AzureKeyCredential("{key}"))
     .endpoint("{endpoint}")
     .pipeline(pipeline)
     .buildAsyncClient();
See Also:

  • Constructor Details

    • FormTrainingClientBuilder

      public FormTrainingClientBuilder()

  • Method Details

    • buildClient

      public FormTrainingClient buildClient()
      Creates a FormTrainingClient based on options set in the builder. Every time buildClient() is called a new instance of FormTrainingClient 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 FormTrainingClient with the options set from the builder.
      Throws:
      NullPointerException - if endpoint or credential(AzureKeyCredential) has not been set.
      IllegalArgumentException - if endpoint cannot be parsed into a valid URL.
      IllegalStateException - If both retryOptions(RetryOptions) and retryPolicy(RetryPolicy) have been set.

    • buildAsyncClient

      public FormTrainingAsyncClient buildAsyncClient()
      Creates a FormTrainingAsyncClient based on options set in the builder. Every time buildAsyncClient() is called a new instance of FormTrainingAsyncClient 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 FormTrainingAsyncClient with the options set from the builder.
      Throws:
      NullPointerException - if endpoint or credential(AzureKeyCredential) has not been set or audience is null when using credential(TokenCredential). You can set the values by calling endpoint(String) and audience(FormRecognizerAudience) respectively.
      IllegalArgumentException - if endpoint cannot be parsed into a valid URL.
      IllegalStateException - If both retryOptions(RetryOptions) and retryPolicy(RetryPolicy) have been set.

    • endpoint

      public FormTrainingClientBuilder endpoint(String endpoint)
      Sets the service endpoint for the Azure Form Recognizer instance.
      Specified by:
      endpoint in interface com.azure.core.client.traits.EndpointTrait<FormTrainingClientBuilder>
      Parameters:
      endpoint - The URL of the Azure Form Recognizer instance service requests to and receive responses from.
      Returns:
      The updated FormTrainingClientBuilder object.
      Throws:
      NullPointerException - if endpoint is null
      IllegalArgumentException - if endpoint cannot be parsed into a valid URL.

    • credential

      public FormTrainingClientBuilder credential(com.azure.core.credential.AzureKeyCredential azureKeyCredential)
      Sets the AzureKeyCredential to use when authenticating HTTP requests for this FormTrainingClientBuilder.
      Specified by:
      credential in interface com.azure.core.client.traits.AzureKeyCredentialTrait<FormTrainingClientBuilder>
      Parameters:
      azureKeyCredential - AzureKeyCredential API key credential
      Returns:
      The updated FormTrainingClientBuilder object.
      Throws:
      NullPointerException - If azureKeyCredential is null.

    • credential

      public FormTrainingClientBuilder credential(com.azure.core.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.
      Specified by:
      credential in interface com.azure.core.client.traits.TokenCredentialTrait<FormTrainingClientBuilder>
      Parameters:
      tokenCredential - TokenCredential used to authorize requests sent to the service.
      Returns:
      The updated FormTrainingClientBuilder object.
      Throws:
      NullPointerException - If tokenCredential is null.

    • httpLogOptions

      public FormTrainingClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
      Sets the logging configuration 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.

      Specified by:
      httpLogOptions in interface com.azure.core.client.traits.HttpTrait<FormTrainingClientBuilder>
      Parameters:
      logOptions - The logging configuration to use when sending and receiving requests to and from the service.
      Returns:
      The updated FormTrainingClientBuilder object.

    • getDefaultLogOptions

      public static com.azure.core.http.policy.HttpLogOptions 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 HttpLogOptions allow list.

    • clientOptions

      public FormTrainingClientBuilder clientOptions(com.azure.core.util.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.

      Specified by:
      clientOptions in interface com.azure.core.client.traits.HttpTrait<FormTrainingClientBuilder>
      Parameters:
      clientOptions - A configured instance of HttpClientOptions.
      Returns:
      The updated FormTrainingClientBuilder object.
      See Also:
      • HttpClientOptions

    • addPolicy

      public FormTrainingClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy)
      Adds a pipeline policy 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.

      Specified by:
      addPolicy in interface com.azure.core.client.traits.HttpTrait<FormTrainingClientBuilder>
      Parameters:
      policy - A pipeline policy.
      Returns:
      The updated FormTrainingClientBuilder object.
      Throws:
      NullPointerException - If policy is null.

    • httpClient

      public FormTrainingClientBuilder httpClient(com.azure.core.http.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.

      Specified by:
      httpClient in interface com.azure.core.client.traits.HttpTrait<FormTrainingClientBuilder>
      Parameters:
      client - The HttpClient to use for requests.
      Returns:
      The updated FormTrainingClientBuilder object.

    • pipeline

      public FormTrainingClientBuilder pipeline(com.azure.core.http.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 to build FormTrainingAsyncClient or FormTrainingClient.

      Specified by:
      pipeline in interface com.azure.core.client.traits.HttpTrait<FormTrainingClientBuilder>
      Parameters:
      httpPipeline - HttpPipeline to use for sending service requests and receiving responses.
      Returns:
      The updated FormTrainingClientBuilder object.

    • configuration

      public FormTrainingClientBuilder 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.

      Specified by:
      configuration in interface com.azure.core.client.traits.ConfigurationTrait<FormTrainingClientBuilder>
      Parameters:
      configuration - The configuration store used to.
      Returns:
      The updated FormTrainingClientBuilder object.

    • retryPolicy

      public FormTrainingClientBuilder 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 buildAsyncClient() to build FormTrainingAsyncClient or FormTrainingClient.

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

      Parameters:
      retryPolicy - user's retry policy applied to each request.
      Returns:
      The updated FormTrainingClientBuilder object.

    • retryOptions

      public FormTrainingClientBuilder retryOptions(com.azure.core.http.policy.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).

      Specified by:
      retryOptions in interface com.azure.core.client.traits.HttpTrait<FormTrainingClientBuilder>
      Parameters:
      retryOptions - The RetryOptions to use for all the requests made through the client.
      Returns:
      The updated DocumentModelAdministrationClientBuilder object.

    • serviceVersion

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

    • audience

      public FormTrainingClientBuilder audience(FormRecognizerAudience audience)
      Sets the audience for the Azure Form Recognizer service. The default audience is FormRecognizerAudience.AZURE_PUBLIC_CLOUD when unset.
      Parameters:
      audience - ARM management audience associated with the given form recognizer resource.
      Returns:
      The updated FormTrainingClientBuilder object.
      Throws:
      NullPointerException - If audience is null.