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

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

A processor version is an implementation of a processor. Each processor can have multiple versions, pretrained by Google internally or uptrained by the customer. A processor can only have one default version at a time.

Its document-processing behavior is defined by that version.

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

Namespace

Google \ Cloud \ DocumentAI \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

The resource name of the processor version. Format: projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}

↳ display_name string

The display name of the processor version.

↳ document_schema Google\Cloud\DocumentAI\V1\DocumentSchema

The schema of the processor version. Describes the output.

↳ state int

The state of the processor version.

↳ create_time Google\Protobuf\Timestamp

The time the processor version was created.

↳ latest_evaluation Google\Cloud\DocumentAI\V1\EvaluationReference

The most recently invoked evaluation for the processor version.

↳ kms_key_name string

The KMS key name used for encryption.

↳ kms_key_version_name string

The KMS key version with which data is encrypted.

↳ google_managed bool

Denotes that this ProcessorVersion is managed by Google.

↳ deprecation_info Google\Cloud\DocumentAI\V1\ProcessorVersion\DeprecationInfo

If set, information about the eventual deprecation of this version.

getName

The resource name of the processor version.

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

Returns
TypeDescription
string

setName

The resource name of the processor version.

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDisplayName

The display name of the processor version.

Returns
TypeDescription
string

setDisplayName

The display name of the processor version.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDocumentSchema

The schema of the processor version. Describes the output.

Returns
TypeDescription
Google\Cloud\DocumentAI\V1\DocumentSchema|null

hasDocumentSchema

clearDocumentSchema

setDocumentSchema

The schema of the processor version. Describes the output.

Parameter
NameDescription
var Google\Cloud\DocumentAI\V1\DocumentSchema
Returns
TypeDescription
$this

getState

The state of the processor version.

Returns
TypeDescription
int

setState

The state of the processor version.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getCreateTime

The time the processor version was created.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

The time the processor version was created.

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

getLatestEvaluation

The most recently invoked evaluation for the processor version.

Returns
TypeDescription
Google\Cloud\DocumentAI\V1\EvaluationReference|null

hasLatestEvaluation

clearLatestEvaluation

setLatestEvaluation

The most recently invoked evaluation for the processor version.

Parameter
NameDescription
var Google\Cloud\DocumentAI\V1\EvaluationReference
Returns
TypeDescription
$this

getKmsKeyName

The KMS key name used for encryption.

Returns
TypeDescription
string

setKmsKeyName

The KMS key name used for encryption.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getKmsKeyVersionName

The KMS key version with which data is encrypted.

Returns
TypeDescription
string

setKmsKeyVersionName

The KMS key version with which data is encrypted.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getGoogleManaged

Denotes that this ProcessorVersion is managed by Google.

Returns
TypeDescription
bool

setGoogleManaged

Denotes that this ProcessorVersion is managed by Google.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getDeprecationInfo

If set, information about the eventual deprecation of this version.

Returns
TypeDescription
Google\Cloud\DocumentAI\V1\ProcessorVersion\DeprecationInfo|null

hasDeprecationInfo

clearDeprecationInfo

setDeprecationInfo

If set, information about the eventual deprecation of this version.

Parameter
NameDescription
var Google\Cloud\DocumentAI\V1\ProcessorVersion\DeprecationInfo
Returns
TypeDescription
$this