Google Cloud Datastore Admin V1 Client - Class State (1.0.0)

Reference documentation and code samples for the Google Cloud Datastore Admin V1 Client class State.

The possible set of states of an index.

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

Namespace

Google \ Cloud \ Datastore \ 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, and cannot be used by queries.

There is an active long-running operation for the index. The index is updated when writing an entity. 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 an entity. The index is fully populated from all stored entities it applies to.

Generated from protobuf enum READY = 2;

DELETING

Value: 3

The index is being deleted, and cannot be used by queries.

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

Generated from protobuf enum DELETING = 3;

ERROR

Value: 4

The index was being created or deleted, but something went wrong.

The index cannot by used by queries. 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 an entity. Some index data may exist.

Generated from protobuf enum ERROR = 4;