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 content outlines different versions of the \u003ccode\u003eGoogle.Cloud.Firestore.Admin.V1.Index.Types.State\u003c/code\u003e component, with version 3.12.0 being the latest.\u003c/p\u003e\n"],["\u003cp\u003eThis component is an enum that represents the state of an index in Firestore, indicating whether it's being created, needs repair, is ready, or is in an unspecified state.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eState\u003c/code\u003e enum has four possible fields: \u003ccode\u003eCreating\u003c/code\u003e, \u003ccode\u003eNeedsRepair\u003c/code\u003e, \u003ccode\u003eReady\u003c/code\u003e, and \u003ccode\u003eUnspecified\u003c/code\u003e, each with specific meanings regarding the index's operational status and data population.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eCreating\u003c/code\u003e state means there is an active long-running operation, with the \u003ccode\u003eNeedsRepair\u003c/code\u003e state meaning the previous long-running operation failed, and the \u003ccode\u003eReady\u003c/code\u003e state meaning it is fully functional.\u003c/p\u003e\n"],["\u003cp\u003eThe namespace for this component is \u003ccode\u003eGoogle.Cloud.Firestore.Admin.V1\u003c/code\u003e within the assembly \u003ccode\u003eGoogle.Cloud.Firestore.Admin.V1.dll\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,[]]
