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
Methods
__construct
Constructor.
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, e.g., OCR_PROCESSOR
, INVOICE_PROCESSOR
, etc. To get a list of processors 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.
↳ process_endpoint
string
Output only. Immutable. The http endpoint that can be called to invoke processing.
↳ create_time
↳ kms_key_name
string
The KMS key used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management .
getName
Output only. Immutable. The resource name of the processor.
Format: projects/{project}/locations/{location}/processors/{processor}
string
setName
Output only. Immutable. The resource name of the processor.
Format: projects/{project}/locations/{location}/processors/{processor}
var
string
$this
getType
The processor type, e.g., OCR_PROCESSOR
, INVOICE_PROCESSOR
, etc.
To get a list of processors types, see FetchProcessorTypes .
string
setType
The processor type, e.g., OCR_PROCESSOR
, INVOICE_PROCESSOR
, etc.
To get a list of processors types, see FetchProcessorTypes .
var
string
$this
getDisplayName
The display name of the processor.
string
setDisplayName
The display name of the processor.
var
string
$this
getState
Output only. The state of the processor.
int
setState
Output only. The state of the processor.
var
int
$this
getDefaultProcessorVersion
The default processor version.
string
setDefaultProcessorVersion
The default processor version.
var
string
$this
getProcessEndpoint
Output only. Immutable. The http endpoint that can be called to invoke processing.
string
setProcessEndpoint
Output only. Immutable. The http endpoint that can be called to invoke processing.
var
string
$this
getCreateTime
The time the processor was created.
hasCreateTime
clearCreateTime
setCreateTime
The time the processor was created.
$this
getKmsKeyName
The KMS key used for encryption/decryption in CMEK scenarios.
string
setKmsKeyName
The KMS key used for encryption/decryption in CMEK scenarios.
var
string
$this
