Google Cloud Document Ai V1 Client - Class TrainProcessorVersionRequest (1.5.0)

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

Request message for the TrainProcessorVersion method.

Generated from protobuf message google.cloud.documentai.v1.TrainProcessorVersionRequest

Namespace

Google \ Cloud \ DocumentAI \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. The parent (project, location and processor) to create the new version for. Format: `projects/{project}/locations/{location}/processors/{processor}`.
`↳ processor_version`	`Google\Cloud\DocumentAI\V1\ProcessorVersion` Required. The processor version to be created.
`↳ document_schema`	`Google\Cloud\DocumentAI\V1\DocumentSchema` Optional. The schema the processor version will be trained with.
`↳ input_data`	`Google\Cloud\DocumentAI\V1\TrainProcessorVersionRequest\InputData` Optional. The input data used to train the ProcessorVersion.
`↳ base_processor_version`	`string` Optional. The processor version to use as a base for training. This processor version must be a child of `parent`. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.

getParent

Required. The parent (project, location and processor) to create the new version for. Format: projects/{project}/locations/{location}/processors/{processor}.

Returns
Type	Description
`string`

setParent

Required. The parent (project, location and processor) to create the new version for. Format: projects/{project}/locations/{location}/processors/{processor}.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getProcessorVersion

Required. The processor version to be created.

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

hasProcessorVersion

clearProcessorVersion

setProcessorVersion

Required. The processor version to be created.

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

Returns
Type	Description
`$this`

getDocumentSchema

Optional. The schema the processor version will be trained with.

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

hasDocumentSchema

clearDocumentSchema

setDocumentSchema

Optional. The schema the processor version will be trained with.

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

Returns
Type	Description
`$this`

getInputData

Optional. The input data used to train the ProcessorVersion.

Returns
Type	Description
`Google\Cloud\DocumentAI\V1\TrainProcessorVersionRequest\InputData\|null`

hasInputData

clearInputData

setInputData

Optional. The input data used to train the ProcessorVersion.

Parameter
Name	Description
`var`	`Google\Cloud\DocumentAI\V1\TrainProcessorVersionRequest\InputData`

Returns
Type	Description
`$this`

getBaseProcessorVersion

Optional. The processor version to use as a base for training. This processor version must be a child of parent. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}.

Returns
Type	Description
`string`

setBaseProcessorVersion

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

static::build

Parameters
Name	Description
`parent`	`string` Required. The parent (project, location and processor) to create the new version for. Format: `projects/{project}/locations/{location}/processors/{processor}`. Please see Google\Cloud\DocumentAI\V1\DocumentProcessorServiceClient::processorName() for help formatting this field.
`processorVersion`	`Google\Cloud\DocumentAI\V1\ProcessorVersion` Required. The processor version to be created.

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