Reference documentation and code samples for the Firestore Admin v1 API enum Index.Types.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.
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.
NeedsRepair
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.
Ready
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThis document provides reference information for the \u003ccode\u003eIndex.Types.State\u003c/code\u003e enum within the Google Cloud Firestore Admin v1 API, detailing its different states.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eIndex.Types.State\u003c/code\u003e enum describes the state of an index, which can be \u003ccode\u003eCREATING\u003c/code\u003e, \u003ccode\u003eNEEDS_REPAIR\u003c/code\u003e, \u003ccode\u003eREADY\u003c/code\u003e, or \u003ccode\u003eUNSPECIFIED\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eCREATING\u003c/code\u003e state indicates an ongoing index creation process, while \u003ccode\u003eNEEDS_REPAIR\u003c/code\u003e means the creation failed, and \u003ccode\u003eREADY\u003c/code\u003e signifies that the index is fully functional and updated, with \u003ccode\u003eUNSPECIFIED\u003c/code\u003e being the default if state is unknown.\u003c/p\u003e\n"],["\u003cp\u003eThe provided content also lists various versions of the Google Cloud Firestore Admin v1, from the latest (3.12.0) down to 2.2.0, each linked to its respective documentation.\u003c/p\u003e\n"]]],[],null,[]]
