Google Cloud Document Ai V1 Client - Class Processor (1.9.0)

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

The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.

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

Namespace

Google \ Cloud \ DocumentAI \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Output only. Immutable. The resource name of the processor. Format: projects/{project}/locations/{location}/processors/{processor}

↳ type string

The processor type, such as: OCR_PROCESSOR, INVOICE_PROCESSOR. To get a list of processor types, see FetchProcessorTypes.

↳ display_name string

The display name of the processor.

↳ state int

Output only. The state of the processor.

↳ default_processor_version string

The default processor version.

↳ processor_version_aliases array<Google\Cloud\DocumentAI\V1\ProcessorVersionAlias>

Output only. The processor version aliases.

↳ process_endpoint string

Output only. Immutable. The http endpoint that can be called to invoke processing.

↳ create_time Google\Protobuf\Timestamp

The time the processor was created.

↳ kms_key_name string

The KMS key used for encryption and decryption in CMEK scenarios.

getName

Output only. Immutable. The resource name of the processor.

Format: projects/{project}/locations/{location}/processors/{processor}

Returns
TypeDescription
string

setName

Output only. Immutable. The resource name of the processor.

Format: projects/{project}/locations/{location}/processors/{processor}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getType

The processor type, such as: OCR_PROCESSOR, INVOICE_PROCESSOR.

To get a list of processor types, see FetchProcessorTypes.

Returns
TypeDescription
string

setType

The processor type, such as: OCR_PROCESSOR, INVOICE_PROCESSOR.

To get a list of processor types, see FetchProcessorTypes.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDisplayName

The display name of the processor.

Returns
TypeDescription
string

setDisplayName

The display name of the processor.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getState

Output only. The state of the processor.

Returns
TypeDescription
int

setState

Output only. The state of the processor.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getDefaultProcessorVersion

The default processor version.

Returns
TypeDescription
string

setDefaultProcessorVersion

The default processor version.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getProcessorVersionAliases

Output only. The processor version aliases.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setProcessorVersionAliases

Output only. The processor version aliases.

Parameter
NameDescription
var array<Google\Cloud\DocumentAI\V1\ProcessorVersionAlias>
Returns
TypeDescription
$this

getProcessEndpoint

Output only. Immutable. The http endpoint that can be called to invoke processing.

Returns
TypeDescription
string

setProcessEndpoint

Output only. Immutable. The http endpoint that can be called to invoke processing.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreateTime

The time the processor was created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

The time the processor was created.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getKmsKeyName

The KMS key used for encryption and decryption in CMEK scenarios.

Returns
TypeDescription
string

setKmsKeyName

The KMS key used for encryption and decryption in CMEK scenarios.

Parameter
NameDescription
var string
Returns
TypeDescription
$this