Reference documentation and code samples for the Google Cloud Document Ai V1 Client class ProcessorType.
A processor type is responsible for performing a certain document understanding task on a certain type of document.
Generated from protobuf message google.cloud.documentai.v1.ProcessorType
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
The resource name of the processor type. Format: |
↳ type |
string
The processor type, e.g., |
↳ category |
string
The processor category, used by UI to group processor types. |
↳ available_locations |
array<Google\Cloud\DocumentAI\V1\ProcessorType\LocationInfo>
The locations in which this processor is available. |
↳ allow_creation |
bool
Whether the processor type allows creation. If true, users can create a processor of this processor type. Otherwise, users need to request access. |
↳ launch_stage |
int
Launch stage of the processor type |
↳ sample_document_uris |
array
A set of Cloud Storage URIs of sample documents for this processor. |
getName
The resource name of the processor type.
Format: projects/{project}/processorTypes/{processor_type}
| Returns | |
|---|---|
| Type | Description |
string | |
setName
The resource name of the processor type.
Format: projects/{project}/processorTypes/{processor_type}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getType
The processor type, e.g., OCR_PROCESSOR, INVOICE_PROCESSOR, etc.
| Returns | |
|---|---|
| Type | Description |
string | |
setType
The processor type, e.g., OCR_PROCESSOR, INVOICE_PROCESSOR, etc.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCategory
The processor category, used by UI to group processor types.
| Returns | |
|---|---|
| Type | Description |
string | |
setCategory
The processor category, used by UI to group processor types.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAvailableLocations
The locations in which this processor is available.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setAvailableLocations
The locations in which this processor is available.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\DocumentAI\V1\ProcessorType\LocationInfo>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAllowCreation
Whether the processor type allows creation. If true, users can create a processor of this processor type. Otherwise, users need to request access.
| Returns | |
|---|---|
| Type | Description |
bool | |
setAllowCreation
Whether the processor type allows creation. If true, users can create a processor of this processor type. Otherwise, users need to request access.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLaunchStage
Launch stage of the processor type
| Returns | |
|---|---|
| Type | Description |
int | |
setLaunchStage
Launch stage of the processor type
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSampleDocumentUris
A set of Cloud Storage URIs of sample documents for this processor.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setSampleDocumentUris
A set of Cloud Storage URIs of sample documents for this processor.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |