# Google Cloud Document Ai V1 Client - Class ProcessRequest (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 ProcessRequest.

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

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

## Namespace

Google \\ Cloud \\ DocumentAI \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ inline_document` | `https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.Document` An inline document proto. |
| `↳ raw_document` | `https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.RawDocument` A raw document content (bytes). |
| `↳ gcs_document` | `https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.GcsDocument` A raw document on Google Cloud Storage. |
| `↳ name` | `string` Required. The resource name of the [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) to use for processing. If a [Processor](https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.Processor) is specified, the server will use its [default version](https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.Processor#_Google_Cloud_DocumentAI_V1_Processor__getDefaultProcessorVersion__). Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` |
| `↳ skip_human_review` | `bool` Whether human review should be skipped for this request. Default to `false`. |
| `↳ field_mask` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/FieldMask` Specifies which fields to include in the [ProcessResponse.document](https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.ProcessResponse#_Google_Cloud_DocumentAI_V1_ProcessResponse__getDocument__) output. Only supports top-level document and pages field, so it must be in the form of `{document_field_name}` or `pages.{page_field_name}`. |
| `↳ 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. |
| `↳ imageless_mode` | `bool` Optional. Option to remove images from the document. |

### getInlineDocument

An inline document proto.

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

### hasInlineDocument

### setInlineDocument

An inline document proto.

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

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

### getRawDocument

A raw document content (bytes).

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

### hasRawDocument

### setRawDocument

A raw document content (bytes).

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

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

### getGcsDocument

A raw document on Google Cloud Storage.

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

### hasGcsDocument

### setGcsDocument

A raw document on Google Cloud Storage.

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

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

### getName

Required. The resource name of the
[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)
to use for processing. If a
[Processor](https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.Processor) is specified, the server
will use its [default
version](https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.Processor#_Google_Cloud_DocumentAI_V1_Processor__getDefaultProcessorVersion__).

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 the
[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)
to use for processing. If a
[Processor](https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.Processor) is specified, the server
will use its [default
version](https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.Processor#_Google_Cloud_DocumentAI_V1_Processor__getDefaultProcessorVersion__).

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` |   |

### 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` |   |

### getFieldMask

Specifies which fields to include in the
[ProcessResponse.document](https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.ProcessResponse#_Google_Cloud_DocumentAI_V1_ProcessResponse__getDocument__)
output. Only supports top-level document and pages field, so it must be in
the form of `{document_field_name}` or `pages.{page_field_name}`.

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

### hasFieldMask

### clearFieldMask

### setFieldMask

Specifies which fields to include in the
[ProcessResponse.document](https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.ProcessResponse#_Google_Cloud_DocumentAI_V1_ProcessResponse__getDocument__)
output. Only supports top-level document and pages field, so it must be in
the form of `{document_field_name}` or `pages.{page_field_name}`.

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

| **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` |   |

### getImagelessMode

Optional. Option to remove images from the document.

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

### setImagelessMode

Optional. Option to remove images from the document.

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

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

### getSource

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

### static::build

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `name` | `string` Required. The resource name of the [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) to use for processing. If a [Processor](https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.Processor) is specified, the server will use its [default version](https://docs.cloud.google.com/php/docs/reference/cloud-document-ai/latest/V1.Processor#_Google_Cloud_DocumentAI_V1_Processor__getDefaultProcessorVersion__). 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.ProcessRequest` |   |