Google Cloud Document Ai V1 Client - Class CreateProcessorRequest (1.13.1)

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

Request message for the CreateProcessor method. Notice this request is sent to a regionalized backend service. If the ProcessorType isn't available in that region, the creation fails.

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

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 and location) under which to create the processor. Format: projects/{project}/locations/{location}

↳ processor Google\Cloud\DocumentAI\V1\Processor

Required. The processor to be created, requires Processor.type and Processor.display_name to be set. Also, the Processor.kms_key_name field must be set if the processor is under CMEK.

getParent

Required. The parent (project and location) under which to create the processor. Format: projects/{project}/locations/{location}

Returns
Type Description
string

setParent

Required. The parent (project and location) under which to create the processor. Format: projects/{project}/locations/{location}

Parameter
Name Description
var string
Returns
Type Description
$this

getProcessor

Required. The processor to be created, requires Processor.type and Processor.display_name to be set. Also, the Processor.kms_key_name field must be set if the processor is under CMEK.

Returns
Type Description
Google\Cloud\DocumentAI\V1\Processor|null

hasProcessor

clearProcessor

setProcessor

Required. The processor to be created, requires Processor.type and Processor.display_name to be set. Also, the Processor.kms_key_name field must be set if the processor is under CMEK.

Parameter
Name Description
var Google\Cloud\DocumentAI\V1\Processor
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. The parent (project and location) under which to create the processor. Format: projects/{project}/locations/{location} Please see Google\Cloud\DocumentAI\V1\DocumentProcessorServiceClient::locationName() for help formatting this field.

processor Google\Cloud\DocumentAI\V1\Processor

Required. The processor to be created, requires Processor.type and Processor.display_name to be set. Also, the Processor.kms_key_name field must be set if the processor is under CMEK.

Returns
Type Description
Google\Cloud\DocumentAI\V1\CreateProcessorRequest