# Google Cloud Document Ai V1 Client - Class BatchProcessRequest (2.7.0)

2.7.0 (latest) 2.6.1 2.5.1 2.4.1 2.3.0 2.2.2 2.1.3 2.0.0 1.14.0 1.13.1 1.12.2 1.9.0 1.8.2 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.2 1.1.1 1.0.1 Reference documentation and code samples for the Google Cloud Document Ai V1 Client class BatchProcessRequest.

Request message for
[BatchProcessDocuments](https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.Client.DocumentProcessorServiceClient#_Google_Cloud_DocumentAI_V1_Client_DocumentProcessorServiceClient__batchProcessDocuments__).

Generated from protobuf message `google.cloud.documentai.v1.BatchProcessRequest`

## Namespace

Google \\ Cloud \\ DocumentAI \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ name` | `string` Required. The resource name of [Processor](https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.Processor) or [ProcessorVersion](https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.ProcessorVersion). Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` |
| `↳ input_documents` | `https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.BatchDocumentsInputConfig` The input documents for the [BatchProcessDocuments](https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.Client.DocumentProcessorServiceClient#_Google_Cloud_DocumentAI_V1_Client_DocumentProcessorServiceClient__batchProcessDocuments__) method. |
| `↳ document_output_config` | `https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.DocumentOutputConfig` The output configuration for the [BatchProcessDocuments](https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.Client.DocumentProcessorServiceClient#_Google_Cloud_DocumentAI_V1_Client_DocumentProcessorServiceClient__batchProcessDocuments__) method. |
| `↳ skip_human_review` | `bool` Whether human review should be skipped for this request. Default to `false`. |
| `↳ process_options` | `https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.ProcessOptions` Inference-time options for the process API |
| `↳ labels` | `array|https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/MapField` Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. |

### getName

Required. The resource name of
[Processor](https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.Processor) or
[ProcessorVersion](https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.ProcessorVersion).

Format: `projects/{project}/locations/{location}/processors/{processor}`,
or
`projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setName

Required. The resource name of
[Processor](https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.Processor) or
[ProcessorVersion](https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.ProcessorVersion).

Format: `projects/{project}/locations/{location}/processors/{processor}`,
or
`projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getInputDocuments

The input documents for the
[BatchProcessDocuments](https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.Client.DocumentProcessorServiceClient#_Google_Cloud_DocumentAI_V1_Client_DocumentProcessorServiceClient__batchProcessDocuments__)
method.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.BatchDocumentsInputConfig|null` |   |

### hasInputDocuments

### clearInputDocuments

### setInputDocuments

The input documents for the
[BatchProcessDocuments](https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.Client.DocumentProcessorServiceClient#_Google_Cloud_DocumentAI_V1_Client_DocumentProcessorServiceClient__batchProcessDocuments__)
method.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.BatchDocumentsInputConfig` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getDocumentOutputConfig

The output configuration for the
[BatchProcessDocuments](https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.Client.DocumentProcessorServiceClient#_Google_Cloud_DocumentAI_V1_Client_DocumentProcessorServiceClient__batchProcessDocuments__)
method.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.DocumentOutputConfig|null` |   |

### hasDocumentOutputConfig

### clearDocumentOutputConfig

### setDocumentOutputConfig

The output configuration for the
[BatchProcessDocuments](https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.Client.DocumentProcessorServiceClient#_Google_Cloud_DocumentAI_V1_Client_DocumentProcessorServiceClient__batchProcessDocuments__)
method.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.DocumentOutputConfig` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getSkipHumanReview

Whether human review should be skipped for this request. Default to
`false`.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `bool` |   |

### setSkipHumanReview

Whether human review should be skipped for this request. Default to
`false`.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `bool` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getProcessOptions

Inference-time options for the process API

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.ProcessOptions|null` |   |

### hasProcessOptions

### clearProcessOptions

### setProcessOptions

Inference-time options for the process API

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.ProcessOptions` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getLabels

Optional. The labels with user-defined metadata for the request.

Label keys and values can be no longer than 63 characters
(Unicode codepoints) and can only contain lowercase letters, numeric
characters, underscores, and dashes. International characters are allowed.
Label values are optional. Label keys must start with a letter.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/MapField` |   |

### setLabels

Optional. The labels with user-defined metadata for the request.

Label keys and values can be no longer than 63 characters
(Unicode codepoints) and can only contain lowercase letters, numeric
characters, underscores, and dashes. International characters are allowed.
Label values are optional. Label keys must start with a letter.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array|https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Internal/MapField` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### static::build

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `name` | `string` Required. The resource name of [Processor](https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.Processor) or [ProcessorVersion](https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.ProcessorVersion). Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.BatchProcessRequest` |   |