Google Cloud Document Ai V1 Client - Class State (1.9.0)

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
NameDescription
value mixed

static::value

Parameter
NameDescription
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.

Generated from protobuf enum DELETING = 7;