Cloud Firestore V1 Client - Class State (1.45.0)

Version 1.45.0

• 1.47.1 (latest)
• 1.47.0
• 1.46.0
• 1.45.2
• 1.44.1
• 1.43.3
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.7
• 1.36.1
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.28.0
• 1.27.3

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

The state of an index. During index creation, an index will be in the CREATING state. If the index is created successfully, it will transition to the READY state. If the index creation encounters a problem, the index will transition to the NEEDS_REPAIR state.

Protobuf type google.firestore.admin.v1.Index.State

Namespace

Google \ Cloud \ Firestore \ Admin \ V1 \ Index

Methods

static::name

Parameter
Name	Description
value	mixed

static::value

Parameter
Name	Description
name	mixed

Constants

STATE_UNSPECIFIED

Value: 0

The state is unspecified.

Generated from protobuf enum STATE_UNSPECIFIED = 0;

CREATING

Value: 1

The index is being created.

There is an active long-running operation for the index. The index is updated when writing a document. Some index data may exist.

Generated from protobuf enum CREATING = 1;

READY

Value: 2

The index is ready to be used.

The index is updated when writing a document. The index is fully populated from all stored documents it applies to.

Generated from protobuf enum READY = 2;

NEEDS_REPAIR

Value: 3

The index was being created, but something went wrong.

There is no active long-running operation for the index, and the most recently finished long-running operation failed. The index is not updated when writing a document. Some index data may exist. Use the google.longrunning.Operations API to determine why the operation that last attempted to create this index failed, then re-create the index.

Generated from protobuf enum NEEDS_REPAIR = 3;