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, pre-trained by Google internally or up-trained by the customer. At a time, a processor can only have one default version version. So the processor's behavior (when processing documents) is defined by a default version
Generated from protobuf message google.cloud.documentai.v1.ProcessorVersion
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
The resource name of the processor version. Format: |
↳ 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. |
↳ 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}
Generated from protobuf field string name = 1;
| Returns | |
|---|---|
| Type | Description |
string | |
setName
The resource name of the processor version.
Format:
projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}
Generated from protobuf field string name = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
The display name of the processor version.
Generated from protobuf field string display_name = 2;
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
The display name of the processor version.
Generated from protobuf field string display_name = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDocumentSchema
The schema of the processor version. Describes the output.
Generated from protobuf field .google.cloud.documentai.v1.DocumentSchema document_schema = 12;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DocumentAI\V1\DocumentSchema|null | |
hasDocumentSchema
clearDocumentSchema
setDocumentSchema
The schema of the processor version. Describes the output.
Generated from protobuf field .google.cloud.documentai.v1.DocumentSchema document_schema = 12;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\DocumentAI\V1\DocumentSchema
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
The state of the processor version.
Generated from protobuf field .google.cloud.documentai.v1.ProcessorVersion.State state = 6;
| Returns | |
|---|---|
| Type | Description |
int | |
setState
The state of the processor version.
Generated from protobuf field .google.cloud.documentai.v1.ProcessorVersion.State state = 6;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCreateTime
The time the processor version was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 7;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasCreateTime
clearCreateTime
setCreateTime
The time the processor version was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 7;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getKmsKeyName
The KMS key name used for encryption.
Generated from protobuf field string kms_key_name = 9;
| Returns | |
|---|---|
| Type | Description |
string | |
setKmsKeyName
The KMS key name used for encryption.
Generated from protobuf field string kms_key_name = 9;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getKmsKeyVersionName
The KMS key version with which data is encrypted.
Generated from protobuf field string kms_key_version_name = 10;
| Returns | |
|---|---|
| Type | Description |
string | |
setKmsKeyVersionName
The KMS key version with which data is encrypted.
Generated from protobuf field string kms_key_version_name = 10;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getGoogleManaged
Denotes that this ProcessorVersion is managed by google.
Generated from protobuf field bool google_managed = 11;
| Returns | |
|---|---|
| Type | Description |
bool | |
setGoogleManaged
Denotes that this ProcessorVersion is managed by google.
Generated from protobuf field bool google_managed = 11;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDeprecationInfo
If set, information about the eventual deprecation of this version.
Generated from protobuf field .google.cloud.documentai.v1.ProcessorVersion.DeprecationInfo deprecation_info = 13;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DocumentAI\V1\ProcessorVersion\DeprecationInfo|null | |
hasDeprecationInfo
clearDeprecationInfo
setDeprecationInfo
If set, information about the eventual deprecation of this version.
Generated from protobuf field .google.cloud.documentai.v1.ProcessorVersion.DeprecationInfo deprecation_info = 13;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\DocumentAI\V1\ProcessorVersion\DeprecationInfo
|
| Returns | |
|---|---|
| Type | Description |
$this | |