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\u003eThe latest version available for \u003ccode\u003eGoogle.Cloud.Firestore.Admin.V1\u003c/code\u003e is 3.12.0, with a range of versions available from 2.2.0 to 3.12.0.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eIndex.Types.State\u003c/code\u003e is an enum within the Firestore Admin v1 API that represents the different states an index can be in during its lifecycle.\u003c/p\u003e\n"],["\u003cp\u003eThe possible states for an index are \u003ccode\u003eCREATING\u003c/code\u003e during creation, \u003ccode\u003eREADY\u003c/code\u003e when fully operational, \u003ccode\u003eNEEDS_REPAIR\u003c/code\u003e if there was an error, and \u003ccode\u003eUNSPECIFIED\u003c/code\u003e if the state is unknown.\u003c/p\u003e\n"],["\u003cp\u003eAn index in the \u003ccode\u003eCREATING\u003c/code\u003e state has an active operation and may contain some index data, while an index in \u003ccode\u003eNEEDS_REPAIR\u003c/code\u003e has no active operation and indicates a failed creation attempt.\u003c/p\u003e\n"]]],[],null,[]]
