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 \u003ccode\u003eIndex.Types.State\u003c/code\u003e enum in the Firestore Admin v1 API represents the current state of an index, indicating whether it's being created, ready for use, or requires repair.\u003c/p\u003e\n"],["\u003cp\u003eThere are four possible states for an index: \u003ccode\u003eCreating\u003c/code\u003e, \u003ccode\u003eNeedsRepair\u003c/code\u003e, \u003ccode\u003eReady\u003c/code\u003e, and \u003ccode\u003eUnspecified\u003c/code\u003e, each describing a different stage or condition of the index's lifecycle.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eCreating\u003c/code\u003e state indicates that an index is being actively built, the \u003ccode\u003eReady\u003c/code\u003e state signifies that the index is fully operational, and \u003ccode\u003eNeedsRepair\u003c/code\u003e means that there was an issue during creation and manual intervention is needed.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of this documentation is 3.12.0 and the provided documentation spans from version 2.2.0 to version 3.12.0.\u003c/p\u003e\n"]]],[],null,[]]
