### YamlMime:JavaType
uid: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder"
fullName: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder"
name: "FormRecognizerClientBuilder"
nameWithType: "FormRecognizerClientBuilder"
summary: "This class provides a fluent builder API to help instantiation of <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FormRecognizerClients\"></xref> and <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FormRecognizerAsyncClients\"></xref>, call <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder.buildClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#buildClient()\"></xref> build<wbr>Client\\} and <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder.buildAsyncClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildAsyncClient\"></xref> respectively to construct an instance of the desired client."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **FormRecognizerClientBuilder**</br> implements <xref href=\"com.azure.core.client.traits.AzureKeyCredentialTrait?alt=com.azure.core.client.traits.AzureKeyCredentialTrait&text=AzureKeyCredentialTrait\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder?alt=com.azure.ai.formrecognizer.FormRecognizerClientBuilder&text=FormRecognizerClientBuilder\" data-throw-if-not-resolved=\"False\" />&gt;, <xref href=\"com.azure.core.client.traits.ConfigurationTrait?alt=com.azure.core.client.traits.ConfigurationTrait&text=ConfigurationTrait\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder?alt=com.azure.ai.formrecognizer.FormRecognizerClientBuilder&text=FormRecognizerClientBuilder\" data-throw-if-not-resolved=\"False\" />&gt;, <xref href=\"com.azure.core.client.traits.EndpointTrait?alt=com.azure.core.client.traits.EndpointTrait&text=EndpointTrait\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder?alt=com.azure.ai.formrecognizer.FormRecognizerClientBuilder&text=FormRecognizerClientBuilder\" data-throw-if-not-resolved=\"False\" />&gt;, <xref href=\"com.azure.core.client.traits.HttpTrait?alt=com.azure.core.client.traits.HttpTrait&text=HttpTrait\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder?alt=com.azure.ai.formrecognizer.FormRecognizerClientBuilder&text=FormRecognizerClientBuilder\" data-throw-if-not-resolved=\"False\" />&gt;, <xref href=\"com.azure.core.client.traits.TokenCredentialTrait?alt=com.azure.core.client.traits.TokenCredentialTrait&text=TokenCredentialTrait\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder?alt=com.azure.ai.formrecognizer.FormRecognizerClientBuilder&text=FormRecognizerClientBuilder\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.FormRecognizerClientBuilder()"
  fullName: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.FormRecognizerClientBuilder()"
  name: "FormRecognizerClientBuilder()"
  nameWithType: "FormRecognizerClientBuilder.FormRecognizerClientBuilder()"
  summary: "Constructs a <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FormRecognizerClientBuilder\"></xref> object."
  syntax: "public FormRecognizerClientBuilder()"
  desc: "Constructs a <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FormRecognizerClientBuilder\"></xref> object."
methods:
- uid: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.addPolicy(com.azure.core.http.policy.HttpPipelinePolicy)"
  fullName: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.addPolicy(HttpPipelinePolicy policy)"
  name: "addPolicy(HttpPipelinePolicy policy)"
  nameWithType: "FormRecognizerClientBuilder.addPolicy(HttpPipelinePolicy policy)"
  summary: "Adds a <xref uid=\"com.azure.core.http.policy.HttpPipelinePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pipeline policy\"></xref> to apply on each request sent."
  parameters:
  - description: "A <xref uid=\"com.azure.core.http.policy.HttpPipelinePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pipeline policy\"></xref>."
    name: "policy"
    type: "<xref href=\"com.azure.core.http.policy.HttpPipelinePolicy?alt=com.azure.core.http.policy.HttpPipelinePolicy&text=HttpPipelinePolicy\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public FormRecognizerClientBuilder addPolicy(HttpPipelinePolicy policy)"
  desc: "Adds a <xref uid=\"com.azure.core.http.policy.HttpPipelinePolicy\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pipeline policy\"></xref> to apply on each request sent.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> 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 <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications."
  returns:
    description: "The updated FormRecognizerClientBuilder object."
    type: "<xref href=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder?alt=com.azure.ai.formrecognizer.FormRecognizerClientBuilder&text=FormRecognizerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.audience(com.azure.ai.formrecognizer.models.FormRecognizerAudience)"
  fullName: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.audience(FormRecognizerAudience audience)"
  name: "audience(FormRecognizerAudience audience)"
  nameWithType: "FormRecognizerClientBuilder.audience(FormRecognizerAudience audience)"
  summary: "Sets the audience for the Azure Form Recognizer service."
  parameters:
  - description: "ARM management audience associated with the given form recognizer resource."
    name: "audience"
    type: "<xref href=\"com.azure.ai.formrecognizer.models.FormRecognizerAudience?alt=com.azure.ai.formrecognizer.models.FormRecognizerAudience&text=FormRecognizerAudience\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public FormRecognizerClientBuilder audience(FormRecognizerAudience audience)"
  desc: "Sets the audience for the Azure Form Recognizer service. The default audience is <xref uid=\"com.azure.ai.formrecognizer.models.FormRecognizerAudience.AZURE_PUBLIC_CLOUD\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FormRecognizerAudience#AZURE_PUBLIC_CLOUD\"></xref> when unset."
  returns:
    description: "The updated <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FormRecognizerClientBuilder\"></xref> object."
    type: "<xref href=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder?alt=com.azure.ai.formrecognizer.FormRecognizerClientBuilder&text=FormRecognizerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.buildAsyncClient()"
  fullName: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.buildAsyncClient()"
  name: "buildAsyncClient()"
  nameWithType: "FormRecognizerClientBuilder.buildAsyncClient()"
  summary: "Creates a <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FormRecognizerAsyncClient\"></xref> based on options set in the builder."
  syntax: "public FormRecognizerAsyncClient buildAsyncClient()"
  desc: "Creates a <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FormRecognizerAsyncClient\"></xref> based on options set in the builder. Every time `buildAsyncClient()` is called a new instance of <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FormRecognizerAsyncClient\"></xref> is created.\n\nIf <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder.pipeline(com.azure.core.http.HttpPipeline)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pipeline\"></xref> is set, then the `pipeline` and <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"endpoint\"></xref> are used to create the <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"client\"></xref>. All other builder settings are ignored."
  returns:
    description: "A FormRecognizerAsyncClient with the options set from the builder."
    type: "<xref href=\"com.azure.ai.formrecognizer.FormRecognizerAsyncClient?alt=com.azure.ai.formrecognizer.FormRecognizerAsyncClient&text=FormRecognizerAsyncClient\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.buildClient()"
  fullName: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.buildClient()"
  name: "buildClient()"
  nameWithType: "FormRecognizerClientBuilder.buildClient()"
  summary: "Creates a <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FormRecognizerClient\"></xref> based on options set in the builder."
  syntax: "public FormRecognizerClient buildClient()"
  desc: "Creates a <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FormRecognizerClient\"></xref> based on options set in the builder. Every time `buildClient()` is called a new instance of <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FormRecognizerClient\"></xref> is created.\n\nIf <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder.pipeline(com.azure.core.http.HttpPipeline)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"pipeline\"></xref> is set, then the `pipeline` and <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"endpoint\"></xref> are used to create the <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"client\"></xref>. All other builder settings are ignored."
  returns:
    description: "A FormRecognizerClient with the options set from the builder."
    type: "<xref href=\"com.azure.ai.formrecognizer.FormRecognizerClient?alt=com.azure.ai.formrecognizer.FormRecognizerClient&text=FormRecognizerClient\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.clientOptions(com.azure.core.util.ClientOptions)"
  fullName: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.clientOptions(ClientOptions clientOptions)"
  name: "clientOptions(ClientOptions clientOptions)"
  nameWithType: "FormRecognizerClientBuilder.clientOptions(ClientOptions clientOptions)"
  summary: "Allows for setting common properties such as application ID, headers, proxy configuration, etc."
  parameters:
  - description: "A configured instance of <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClientOptions\"></xref>."
    name: "clientOptions"
    type: "<xref href=\"com.azure.core.util.ClientOptions?alt=com.azure.core.util.ClientOptions&text=ClientOptions\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public FormRecognizerClientBuilder clientOptions(ClientOptions clientOptions)"
  desc: "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 <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClientOptions\"></xref> class (a subclass of the <xref uid=\"com.azure.core.util.ClientOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ClientOptions\"></xref> base class). The HttpClientOptions subclass provides more configuration options suitable for HTTP clients, which is applicable for any class that implements this HttpTrait interface.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> 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 <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications."
  returns:
    description: "The updated FormRecognizerClientBuilder object.\n <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClientOptions\"></xref>"
    type: "<xref href=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder?alt=com.azure.ai.formrecognizer.FormRecognizerClientBuilder&text=FormRecognizerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.configuration(com.azure.core.util.Configuration)"
  fullName: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.configuration(Configuration configuration)"
  name: "configuration(Configuration configuration)"
  nameWithType: "FormRecognizerClientBuilder.configuration(Configuration configuration)"
  summary: "Sets the configuration store that is used during construction of the service client."
  parameters:
  - description: "The configuration store used to."
    name: "configuration"
    type: "<xref href=\"com.azure.core.util.Configuration?alt=com.azure.core.util.Configuration&text=Configuration\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public FormRecognizerClientBuilder configuration(Configuration configuration)"
  desc: "Sets the configuration store that is used during construction of the service client.\n\nThe default configuration store is a clone of the <xref uid=\"Configuration#getGlobalConfiguration()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"global\n configuration store\"></xref>, use <xref uid=\"com.azure.core.util.Configuration.NONE\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Configuration#NONE\"></xref> to bypass using configuration settings during construction."
  returns:
    description: "The updated FormRecognizerClientBuilder object."
    type: "<xref href=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder?alt=com.azure.ai.formrecognizer.FormRecognizerClientBuilder&text=FormRecognizerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.credential(com.azure.core.credential.AzureKeyCredential)"
  fullName: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.credential(AzureKeyCredential azureKeyCredential)"
  name: "credential(AzureKeyCredential azureKeyCredential)"
  nameWithType: "FormRecognizerClientBuilder.credential(AzureKeyCredential azureKeyCredential)"
  summary: "Sets the <xref uid=\"com.azure.core.credential.AzureKeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureKeyCredential\"></xref> to use when authenticating HTTP requests for this Form<wbr>Recognizer<wbr>Client<wbr>Builder."
  parameters:
  - description: "<xref uid=\"com.azure.core.credential.AzureKeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureKeyCredential\"></xref> API key credential"
    name: "azureKeyCredential"
    type: "<xref href=\"com.azure.core.credential.AzureKeyCredential?alt=com.azure.core.credential.AzureKeyCredential&text=AzureKeyCredential\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public FormRecognizerClientBuilder credential(AzureKeyCredential azureKeyCredential)"
  desc: "Sets the <xref uid=\"com.azure.core.credential.AzureKeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AzureKeyCredential\"></xref> to use when authenticating HTTP requests for this FormRecognizerClientBuilder."
  returns:
    description: "The updated FormRecognizerClientBuilder object."
    type: "<xref href=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder?alt=com.azure.ai.formrecognizer.FormRecognizerClientBuilder&text=FormRecognizerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.credential(com.azure.core.credential.TokenCredential)"
  fullName: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.credential(TokenCredential tokenCredential)"
  name: "credential(TokenCredential tokenCredential)"
  nameWithType: "FormRecognizerClientBuilder.credential(TokenCredential tokenCredential)"
  summary: "Sets the <xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> used to authorize requests sent to the service."
  parameters:
  - description: "<xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> used to authorize requests sent to the service."
    name: "tokenCredential"
    type: "<xref href=\"com.azure.core.credential.TokenCredential?alt=com.azure.core.credential.TokenCredential&text=TokenCredential\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public FormRecognizerClientBuilder credential(TokenCredential tokenCredential)"
  desc: "Sets the <xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> 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 <xref uid=\"com.azure.core.credential.TokenCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> type.\n\n\n[identity and authentication]: https://aka.ms/azsdk/java/docs/identity"
  returns:
    description: "The updated <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FormRecognizerClientBuilder\"></xref> object."
    type: "<xref href=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder?alt=com.azure.ai.formrecognizer.FormRecognizerClientBuilder&text=FormRecognizerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.endpoint(java.lang.String)"
  fullName: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.endpoint(String endpoint)"
  name: "endpoint(String endpoint)"
  nameWithType: "FormRecognizerClientBuilder.endpoint(String endpoint)"
  summary: "Sets the service endpoint for the Azure Form Recognizer instance."
  parameters:
  - description: "The URL of the Azure Form Recognizer instance service requests to and receive responses from."
    name: "endpoint"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public FormRecognizerClientBuilder endpoint(String endpoint)"
  desc: "Sets the service endpoint for the Azure Form Recognizer instance."
  returns:
    description: "The updated FormRecognizerClientBuilder object."
    type: "<xref href=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder?alt=com.azure.ai.formrecognizer.FormRecognizerClientBuilder&text=FormRecognizerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.getDefaultLogOptions()"
  fullName: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.getDefaultLogOptions()"
  name: "getDefaultLogOptions()"
  nameWithType: "FormRecognizerClientBuilder.getDefaultLogOptions()"
  summary: "Gets the default Azure Form Recognizer client headers and query parameters that are logged by default if HTTP logging is enabled."
  modifiers:
  - "static"
  syntax: "public static HttpLogOptions getDefaultLogOptions()"
  desc: "Gets the default Azure Form Recognizer client headers and query parameters that are logged by default if HTTP logging is enabled."
  returns:
    description: "The default <xref uid=\"com.azure.core.http.policy.HttpLogOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpLogOptions\"></xref> allow list."
    type: "<xref href=\"com.azure.core.http.policy.HttpLogOptions?alt=com.azure.core.http.policy.HttpLogOptions&text=HttpLogOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.httpClient(com.azure.core.http.HttpClient)"
  fullName: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.httpClient(HttpClient client)"
  name: "httpClient(HttpClient client)"
  nameWithType: "FormRecognizerClientBuilder.httpClient(HttpClient client)"
  summary: "Sets the <xref uid=\"com.azure.core.http.HttpClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClient\"></xref> to use for sending and receiving requests to and from the service."
  parameters:
  - description: "The <xref uid=\"com.azure.core.http.HttpClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClient\"></xref> to use for requests."
    name: "client"
    type: "<xref href=\"com.azure.core.http.HttpClient?alt=com.azure.core.http.HttpClient&text=HttpClient\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public FormRecognizerClientBuilder httpClient(HttpClient client)"
  desc: "Sets the <xref uid=\"com.azure.core.http.HttpClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpClient\"></xref> to use for sending and receiving requests to and from the service.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> 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 <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications."
  returns:
    description: "The updated FormRecognizerClientBuilder object."
    type: "<xref href=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder?alt=com.azure.ai.formrecognizer.FormRecognizerClientBuilder&text=FormRecognizerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.httpLogOptions(com.azure.core.http.policy.HttpLogOptions)"
  fullName: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.httpLogOptions(HttpLogOptions logOptions)"
  name: "httpLogOptions(HttpLogOptions logOptions)"
  nameWithType: "FormRecognizerClientBuilder.httpLogOptions(HttpLogOptions logOptions)"
  summary: "Sets the <xref uid=\"com.azure.core.http.policy.HttpLogOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"logging configuration\"></xref> to use when sending and receiving requests to and from the service."
  parameters:
  - description: "The <xref uid=\"com.azure.core.http.policy.HttpLogOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"logging configuration\"></xref> to use when sending and receiving requests to\n and from the service."
    name: "logOptions"
    type: "<xref href=\"com.azure.core.http.policy.HttpLogOptions?alt=com.azure.core.http.policy.HttpLogOptions&text=HttpLogOptions\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public FormRecognizerClientBuilder httpLogOptions(HttpLogOptions logOptions)"
  desc: "Sets the <xref uid=\"com.azure.core.http.policy.HttpLogOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"logging configuration\"></xref> to use when sending and receiving requests to and from the service. If a `logLevel` is not provided, default value of <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpLogDetailLevel#NONE\"></xref> is set.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> 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 <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications."
  returns:
    description: "The updated FormRecognizerClientBuilder object."
    type: "<xref href=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder?alt=com.azure.ai.formrecognizer.FormRecognizerClientBuilder&text=FormRecognizerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.pipeline(com.azure.core.http.HttpPipeline)"
  fullName: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.pipeline(HttpPipeline httpPipeline)"
  name: "pipeline(HttpPipeline httpPipeline)"
  nameWithType: "FormRecognizerClientBuilder.pipeline(HttpPipeline httpPipeline)"
  summary: "Sets the <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> to use for the service client."
  parameters:
  - description: "<xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> to use for sending service requests and receiving responses."
    name: "httpPipeline"
    type: "<xref href=\"com.azure.core.http.HttpPipeline?alt=com.azure.core.http.HttpPipeline&text=HttpPipeline\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public FormRecognizerClientBuilder pipeline(HttpPipeline httpPipeline)"
  desc: "Sets the <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> to use for the service client.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> 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 <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.\n\nIf `pipeline` is set, all other settings are ignored, aside from <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"endpoint\"></xref> to build <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FormRecognizerAsyncClient\"></xref> or <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FormRecognizerClient\"></xref>."
  returns:
    description: "The updated FormRecognizerClientBuilder object."
    type: "<xref href=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder?alt=com.azure.ai.formrecognizer.FormRecognizerClientBuilder&text=FormRecognizerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)"
  fullName: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.retryOptions(RetryOptions retryOptions)"
  name: "retryOptions(RetryOptions retryOptions)"
  nameWithType: "FormRecognizerClientBuilder.retryOptions(RetryOptions retryOptions)"
  summary: "Sets the <xref uid=\"com.azure.core.http.policy.RetryOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryOptions\"></xref> for all the requests made through the client."
  parameters:
  - description: "The <xref uid=\"com.azure.core.http.policy.RetryOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryOptions\"></xref> to use for all the requests made through the client."
    name: "retryOptions"
    type: "<xref href=\"com.azure.core.http.policy.RetryOptions?alt=com.azure.core.http.policy.RetryOptions&text=RetryOptions\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public FormRecognizerClientBuilder retryOptions(RetryOptions retryOptions)"
  desc: "Sets the <xref uid=\"com.azure.core.http.policy.RetryOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryOptions\"></xref> for all the requests made through the client.\n\n**Note:** It is important to understand the precedence order of the HttpTrait APIs. In particular, if a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> 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 <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.\n\nSetting this is mutually exclusive with using <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder.retryPolicy(com.azure.core.http.policy.RetryPolicy)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#retryPolicy(RetryPolicy)\"></xref>."
  returns:
    description: "The updated DocumentModelAdministrationClientBuilder object."
    type: "<xref href=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder?alt=com.azure.ai.formrecognizer.FormRecognizerClientBuilder&text=FormRecognizerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.retryPolicy(com.azure.core.http.policy.RetryPolicy)"
  fullName: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.retryPolicy(RetryPolicy retryPolicy)"
  name: "retryPolicy(RetryPolicy retryPolicy)"
  nameWithType: "FormRecognizerClientBuilder.retryPolicy(RetryPolicy retryPolicy)"
  summary: "Sets the <xref uid=\"com.azure.core.http.policy.RetryPolicy.RetryPolicy*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryPolicy#RetryPolicy()\"></xref> that is used when each request is sent."
  parameters:
  - description: "user's retry policy applied to each request."
    name: "retryPolicy"
    type: "<xref href=\"com.azure.core.http.policy.RetryPolicy?alt=com.azure.core.http.policy.RetryPolicy&text=RetryPolicy\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public FormRecognizerClientBuilder retryPolicy(RetryPolicy retryPolicy)"
  desc: "Sets the <xref uid=\"com.azure.core.http.policy.RetryPolicy.RetryPolicy*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RetryPolicy#RetryPolicy()\"></xref> that is used when each request is sent.\n\nThe default retry policy will be used if not provided <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder.buildAsyncClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FormRecognizerClientBuilder#buildAsyncClient()\"></xref> to build <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FormRecognizerAsyncClient\"></xref> or <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FormRecognizerClient\"></xref>.\n\nSetting this is mutually exclusive with using <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder.retryOptions(com.azure.core.http.policy.RetryOptions)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#retryOptions(RetryOptions)\"></xref>."
  returns:
    description: "The updated FormRecognizerClientBuilder object."
    type: "<xref href=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder?alt=com.azure.ai.formrecognizer.FormRecognizerClientBuilder&text=FormRecognizerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.serviceVersion(com.azure.ai.formrecognizer.FormRecognizerServiceVersion)"
  fullName: "com.azure.ai.formrecognizer.FormRecognizerClientBuilder.serviceVersion(FormRecognizerServiceVersion version)"
  name: "serviceVersion(FormRecognizerServiceVersion version)"
  nameWithType: "FormRecognizerClientBuilder.serviceVersion(FormRecognizerServiceVersion version)"
  summary: "Sets the <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FormRecognizerServiceVersion\"></xref> that is used when making API requests."
  parameters:
  - description: "<xref uid=\"com.azure.ai.formrecognizer.FormRecognizerServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FormRecognizerServiceVersion\"></xref> of the service to be used when making requests."
    name: "version"
    type: "<xref href=\"com.azure.ai.formrecognizer.FormRecognizerServiceVersion?alt=com.azure.ai.formrecognizer.FormRecognizerServiceVersion&text=FormRecognizerServiceVersion\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public FormRecognizerClientBuilder serviceVersion(FormRecognizerServiceVersion version)"
  desc: "Sets the <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerServiceVersion\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FormRecognizerServiceVersion\"></xref> that is used when making API requests.\n\nIf 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."
  returns:
    description: "The updated FormRecognizerClientBuilder object."
    type: "<xref href=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder?alt=com.azure.ai.formrecognizer.FormRecognizerClientBuilder&text=FormRecognizerClientBuilder\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "This class provides a fluent builder API to help instantiation of <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FormRecognizerClients\"></xref> and <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FormRecognizerAsyncClients\"></xref>, call <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder.buildClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#buildClient()\"></xref> buildClient\\} and <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder.buildAsyncClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"buildAsyncClient\"></xref> respectively to construct an instance of the desired client.\n\nThe client needs the service endpoint of the Azure Form Recognizer to access the resource service. <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder.credential(com.azure.core.credential.AzureKeyCredential)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#credential(AzureKeyCredential)\"></xref> or <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder.credential(com.azure.core.credential.TokenCredential)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"credential(TokenCredential)\"></xref> gives the builder access credential.\n\n**Instantiating an asynchronous Form Recognizer Client**\n\n```java\nFormRecognizerAsyncClient formRecognizerAsyncClient = new FormRecognizerClientBuilder()\n     .credential(new AzureKeyCredential(\"{key}\"))\n     .endpoint(\"{endpoint}\")\n     .buildAsyncClient();\n```\n\n**Instantiating a synchronous Form Recognizer Client**\n\n```java\nFormRecognizerClient formRecognizerClient = new FormRecognizerClientBuilder()\n     .credential(new AzureKeyCredential(\"{key}\"))\n     .endpoint(\"{endpoint}\")\n     .buildClient();\n```\n\nAnother way to construct the client is using a <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref>. The pipeline gives the client an authenticated way to communicate with the service. Set the pipeline with <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder.pipeline(com.azure.core.http.HttpPipeline)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"this\"></xref> and set the service endpoint with <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder.endpoint(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"this\"></xref>. Using a pipeline requires additional setup but allows for finer control on how the <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FormRecognizerClient\"></xref> and <xref uid=\"com.azure.ai.formrecognizer.FormRecognizerAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FormRecognizerAsyncClient\"></xref> is built.\n\n```java\nHttpPipeline pipeline = new HttpPipelineBuilder()\n     .policies(/* add policies */)\n     .build();\n\n FormRecognizerClient formRecognizerClient = new FormRecognizerClientBuilder()\n     .credential(new AzureKeyCredential(\"{key}\"))\n     .endpoint(\"{endpoint}\")\n     .pipeline(pipeline)\n     .buildClient();\n```"
implements:
- "<xref href=\"com.azure.core.client.traits.AzureKeyCredentialTrait?alt=com.azure.core.client.traits.AzureKeyCredentialTrait&text=AzureKeyCredentialTrait\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder?alt=com.azure.ai.formrecognizer.FormRecognizerClientBuilder&text=FormRecognizerClientBuilder\" data-throw-if-not-resolved=\"False\" />&gt;"
- "<xref href=\"com.azure.core.client.traits.ConfigurationTrait?alt=com.azure.core.client.traits.ConfigurationTrait&text=ConfigurationTrait\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder?alt=com.azure.ai.formrecognizer.FormRecognizerClientBuilder&text=FormRecognizerClientBuilder\" data-throw-if-not-resolved=\"False\" />&gt;"
- "<xref href=\"com.azure.core.client.traits.EndpointTrait?alt=com.azure.core.client.traits.EndpointTrait&text=EndpointTrait\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder?alt=com.azure.ai.formrecognizer.FormRecognizerClientBuilder&text=FormRecognizerClientBuilder\" data-throw-if-not-resolved=\"False\" />&gt;"
- "<xref href=\"com.azure.core.client.traits.HttpTrait?alt=com.azure.core.client.traits.HttpTrait&text=HttpTrait\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder?alt=com.azure.ai.formrecognizer.FormRecognizerClientBuilder&text=FormRecognizerClientBuilder\" data-throw-if-not-resolved=\"False\" />&gt;"
- "<xref href=\"com.azure.core.client.traits.TokenCredentialTrait?alt=com.azure.core.client.traits.TokenCredentialTrait&text=TokenCredentialTrait\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.ai.formrecognizer.FormRecognizerClientBuilder?alt=com.azure.ai.formrecognizer.FormRecognizerClientBuilder&text=FormRecognizerClientBuilder\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.ai.formrecognizer"
artifact: com.azure:azure-ai-formrecognizer:4.1.11