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

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
Name Description
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.

↳ satisfies_pzs bool

Output only. Reserved for future use.

↳ satisfies_pzi bool

Output only. Reserved for future use.

getName

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

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

Returns
Type Description
string

setName

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

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

Parameter
Name Description
var string
Returns
Type Description
$this

getType

The processor type, such as: OCR_PROCESSOR, INVOICE_PROCESSOR.

To get a list of processor types, see FetchProcessorTypes.

Returns
Type Description
string

setType

The processor type, such as: OCR_PROCESSOR, INVOICE_PROCESSOR.

To get a list of processor types, see FetchProcessorTypes.

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

The display name of the processor.

Returns
Type Description
string

setDisplayName

The display name of the processor.

Parameter
Name Description
var string
Returns
Type Description
$this

getState

Output only. The state of the processor.

Returns
Type Description
int

setState

Output only. The state of the processor.

Parameter
Name Description
var int
Returns
Type Description
$this

getDefaultProcessorVersion

The default processor version.

Returns
Type Description
string

setDefaultProcessorVersion

The default processor version.

Parameter
Name Description
var string
Returns
Type Description
$this

getProcessorVersionAliases

Output only. The processor version aliases.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setProcessorVersionAliases

Output only. The processor version aliases.

Parameter
Name Description
var array<Google\Cloud\DocumentAI\V1\ProcessorVersionAlias>
Returns
Type Description
$this

getProcessEndpoint

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

Returns
Type Description
string

setProcessEndpoint

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

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

The time the processor was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

The time the processor was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getKmsKeyName

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

Returns
Type Description
string

setKmsKeyName

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

Parameter
Name Description
var string
Returns
Type Description
$this

getSatisfiesPzs

Output only. Reserved for future use.

Returns
Type Description
bool

setSatisfiesPzs

Output only. Reserved for future use.

Parameter
Name Description
var bool
Returns
Type Description
$this

getSatisfiesPzi

Output only. Reserved for future use.

Returns
Type Description
bool

setSatisfiesPzi

Output only. Reserved for future use.

Parameter
Name Description
var bool
Returns
Type Description
$this