Reference documentation and code samples for the Google Cloud Document Ai V1 Client class State.
The possible states of the processor.
Protobuf type google.cloud.documentai.v1.Processor.State
Namespace
Google \ Cloud \ DocumentAI \ V1 \ Processor
Methods
static::name
Parameter
Name
Description
value
mixed
static::value
Parameter
Name
Description
name
mixed
Constants
STATE_UNSPECIFIED
Value: 0
The processor is in an unspecified state.
Generated from protobuf enum STATE_UNSPECIFIED = 0;
ENABLED
Value: 1
The processor is enabled, i.e., has an enabled version which can
currently serve processing requests and all the feature dependencies have
been successfully initialized.
Generated from protobuf enum ENABLED = 1;
DISABLED
Value: 2
The processor is disabled.
Generated from protobuf enum DISABLED = 2;
ENABLING
Value: 3
The processor is being enabled, will become ENABLED if successful.
Generated from protobuf enum ENABLING = 3;
DISABLING
Value: 4
The processor is being disabled, will become DISABLED if successful.
Generated from protobuf enum DISABLING = 4;
CREATING
Value: 5
The processor is being created, will become either ENABLED (for
successful creation) or FAILED (for failed ones).
Once a processor is in this state, it can then be used for document
processing, but the feature dependencies of the processor might not be
fully created yet.
Generated from protobuf enum CREATING = 5;
FAILED
Value: 6
The processor failed during creation or initialization of feature
dependencies. The user should delete the processor and recreate one as
all the functionalities of the processor are disabled.
Generated from protobuf enum FAILED = 6;
DELETING
Value: 7
The processor is being deleted, will be removed if successful.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Document Ai V1 Client - Class State (2.3.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.3.0 (latest)](/php/docs/reference/cloud-document-ai/latest/V1.Processor.State)\n- [2.2.2](/php/docs/reference/cloud-document-ai/2.2.2/V1.Processor.State)\n- [2.1.3](/php/docs/reference/cloud-document-ai/2.1.3/V1.Processor.State)\n- [2.0.0](/php/docs/reference/cloud-document-ai/2.0.0/V1.Processor.State)\n- [1.14.0](/php/docs/reference/cloud-document-ai/1.14.0/V1.Processor.State)\n- [1.13.1](/php/docs/reference/cloud-document-ai/1.13.1/V1.Processor.State)\n- [1.12.2](/php/docs/reference/cloud-document-ai/1.12.2/V1.Processor.State)\n- [1.9.0](/php/docs/reference/cloud-document-ai/1.9.0/V1.Processor.State)\n- [1.8.2](/php/docs/reference/cloud-document-ai/1.8.2/V1.Processor.State)\n- [1.7.0](/php/docs/reference/cloud-document-ai/1.7.0/V1.Processor.State)\n- [1.6.0](/php/docs/reference/cloud-document-ai/1.6.0/V1.Processor.State)\n- [1.5.0](/php/docs/reference/cloud-document-ai/1.5.0/V1.Processor.State)\n- [1.4.0](/php/docs/reference/cloud-document-ai/1.4.0/V1.Processor.State)\n- [1.3.0](/php/docs/reference/cloud-document-ai/1.3.0/V1.Processor.State)\n- [1.2.2](/php/docs/reference/cloud-document-ai/1.2.2/V1.Processor.State)\n- [1.1.1](/php/docs/reference/cloud-document-ai/1.1.1/V1.Processor.State)\n- [1.0.1](/php/docs/reference/cloud-document-ai/1.0.1/V1.Processor.State) \nReference documentation and code samples for the Google Cloud Document Ai V1 Client class State.\n\nThe possible states of the processor.\n\nProtobuf type `google.cloud.documentai.v1.Processor.State`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DocumentAI \\\\ V1 \\\\ Processor\n\nMethods\n-------\n\n### static::name\n\n### static::value\n\nConstants\n---------\n\n### STATE_UNSPECIFIED\n\n Value: 0\n\nThe processor is in an unspecified state.\n\nGenerated from protobuf enum `STATE_UNSPECIFIED = 0;`\n\n### ENABLED\n\n Value: 1\n\nThe processor is enabled, i.e., has an enabled version which can\ncurrently serve processing requests and all the feature dependencies have\nbeen successfully initialized.\n\nGenerated from protobuf enum `ENABLED = 1;`\n\n### DISABLED\n\n Value: 2\n\nThe processor is disabled.\n\nGenerated from protobuf enum `DISABLED = 2;`\n\n### ENABLING\n\n Value: 3\n\nThe processor is being enabled, will become `ENABLED` if successful.\n\nGenerated from protobuf enum `ENABLING = 3;`\n\n### DISABLING\n\n Value: 4\n\nThe processor is being disabled, will become `DISABLED` if successful.\n\nGenerated from protobuf enum `DISABLING = 4;`\n\n### CREATING\n\n Value: 5\n\nThe processor is being created, will become either `ENABLED` (for\nsuccessful creation) or `FAILED` (for failed ones).\n\nOnce a processor is in this state, it can then be used for document\nprocessing, but the feature dependencies of the processor might not be\nfully created yet.\n\nGenerated from protobuf enum `CREATING = 5;`\n\n### FAILED\n\n Value: 6\n\nThe processor failed during creation or initialization of feature\ndependencies. The user should delete the processor and recreate one as\nall the functionalities of the processor are disabled.\n\nGenerated from protobuf enum `FAILED = 6;`\n\n### DELETING\n\n Value: 7\n\nThe processor is being deleted, will be removed if successful.\n\nGenerated from protobuf enum `DELETING = 7;`"]]
