Google Cloud Document Ai V1 Client - Class BatchProcessRequest (1.3.0)

Reference documentation and code samples for the Google Cloud Document Ai V1 Client class BatchProcessRequest.

Request message for batch process document method.

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 or ProcessorVersion. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
`↳ input_documents`	`Google\Cloud\DocumentAI\V1\BatchDocumentsInputConfig` The input documents for batch process.
`↳ document_output_config`	`Google\Cloud\DocumentAI\V1\DocumentOutputConfig` The overall output config for batch process.
`↳ skip_human_review`	`bool` Whether Human Review feature should be skipped for this request. Default to false.

getName

Required. The resource name of Processor or 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 or 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 batch process.

Returns
Type	Description
`Google\Cloud\DocumentAI\V1\BatchDocumentsInputConfig\|null`

hasInputDocuments

clearInputDocuments

setInputDocuments

The input documents for batch process.

Parameter
Name	Description
`var`	`Google\Cloud\DocumentAI\V1\BatchDocumentsInputConfig`

Returns
Type	Description
`$this`

getDocumentOutputConfig

The overall output config for batch process.

Returns
Type	Description
`Google\Cloud\DocumentAI\V1\DocumentOutputConfig\|null`

hasDocumentOutputConfig

clearDocumentOutputConfig

setDocumentOutputConfig

The overall output config for batch process.

Parameter
Name	Description
`var`	`Google\Cloud\DocumentAI\V1\DocumentOutputConfig`

Returns
Type	Description
`$this`

getSkipHumanReview

Whether Human Review feature should be skipped for this request. Default to false.

Returns
Type	Description
`bool`

setSkipHumanReview

Whether Human Review feature should be skipped for this request. Default to false.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

static::build

Parameter
Name	Description
`name`	`string` Required. The resource name of Processor or ProcessorVersion. Format: `projects/{project}/locations/{location}/processors/{processor}`, or `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`

Returns
Type	Description
`Google\Cloud\DocumentAI\V1\BatchProcessRequest`