Cloud Firestore V1 Client - Class OperationState (1.27.3)

Reference documentation and code samples for the Cloud Firestore V1 Client class OperationState.

Describes the state of the operation.

Protobuf type google.firestore.admin.v1.OperationState

Methods

name

Parameter
NameDescription
value mixed

value

Parameter
NameDescription
name mixed

Constants

OPERATION_STATE_UNSPECIFIED

Value: 0

Unspecified.

Generated from protobuf enum OPERATION_STATE_UNSPECIFIED = 0;

INITIALIZING

Value: 1

Request is being prepared for processing.

Generated from protobuf enum INITIALIZING = 1;

PROCESSING

Value: 2

Request is actively being processed.

Generated from protobuf enum PROCESSING = 2;

CANCELLING

Value: 3

Request is in the process of being cancelled after user called google.longrunning.Operations.CancelOperation on the operation.

Generated from protobuf enum CANCELLING = 3;

FINALIZING

Value: 4

Request has been processed and is in its finalization stage.

Generated from protobuf enum FINALIZING = 4;

SUCCESSFUL

Value: 5

Request has completed successfully.

Generated from protobuf enum SUCCESSFUL = 5;

FAILED

Value: 6

Request has finished being processed, but encountered an error.

Generated from protobuf enum FAILED = 6;

CANCELLED

Value: 7

Request has finished being cancelled after user called google.longrunning.Operations.CancelOperation.

Generated from protobuf enum CANCELLED = 7;