Output only. When true, the Field's index configuration is set from the configuration specified by the ancestor_field. When false, the Field's index configuration is defined explicitly.
↳ ancestor_field
string
Output only. Specifies the resource name of the Field from which this field's index configuration is set (when uses_ancestor_config is true), or from which it would be set if this field had no index configuration (when uses_ancestor_config is false).
↳ reverting
bool
Output only When true, the Field's index configuration is in the process of being reverted. Once complete, the index config will transition to the same state as the field specified by ancestor_field, at which point uses_ancestor_config will be true and reverting will be false.
Output only. When true, the Field's index configuration is set from the
configuration specified by the ancestor_field.
When false, the Field's index configuration is defined explicitly.
Returns
Type
Description
bool
setUsesAncestorConfig
Output only. When true, the Field's index configuration is set from the
configuration specified by the ancestor_field.
When false, the Field's index configuration is defined explicitly.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getAncestorField
Output only. Specifies the resource name of the Field from which this
field's index configuration is set (when uses_ancestor_config is true),
or from which it would be set if this field had no index configuration
(when uses_ancestor_config is false).
Returns
Type
Description
string
setAncestorField
Output only. Specifies the resource name of the Field from which this
field's index configuration is set (when uses_ancestor_config is true),
or from which it would be set if this field had no index configuration
(when uses_ancestor_config is false).
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getReverting
Output only
When true, the Field's index configuration is in the process of being
reverted. Once complete, the index config will transition to the same
state as the field specified by ancestor_field, at which point
uses_ancestor_config will be true and reverting will be false.
Returns
Type
Description
bool
setReverting
Output only
When true, the Field's index configuration is in the process of being
reverted. Once complete, the index config will transition to the same
state as the field specified by ancestor_field, at which point
uses_ancestor_config will be true and reverting will be false.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Firestore V1 Client - Class IndexConfig (1.53.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.53.0 (latest)](/php/docs/reference/cloud-firestore/latest/Admin.V1.Field.IndexConfig)\n- [1.52.0](/php/docs/reference/cloud-firestore/1.52.0/Admin.V1.Field.IndexConfig)\n- [1.51.0](/php/docs/reference/cloud-firestore/1.51.0/Admin.V1.Field.IndexConfig)\n- [1.50.0](/php/docs/reference/cloud-firestore/1.50.0/Admin.V1.Field.IndexConfig)\n- [1.48.1](/php/docs/reference/cloud-firestore/1.48.1/Admin.V1.Field.IndexConfig)\n- [1.47.3](/php/docs/reference/cloud-firestore/1.47.3/Admin.V1.Field.IndexConfig)\n- [1.46.0](/php/docs/reference/cloud-firestore/1.46.0/Admin.V1.Field.IndexConfig)\n- [1.45.2](/php/docs/reference/cloud-firestore/1.45.2/Admin.V1.Field.IndexConfig)\n- [1.44.1](/php/docs/reference/cloud-firestore/1.44.1/Admin.V1.Field.IndexConfig)\n- [1.43.3](/php/docs/reference/cloud-firestore/1.43.3/Admin.V1.Field.IndexConfig)\n- [1.40.0](/php/docs/reference/cloud-firestore/1.40.0/Admin.V1.Field.IndexConfig)\n- [1.39.0](/php/docs/reference/cloud-firestore/1.39.0/Admin.V1.Field.IndexConfig)\n- [1.38.0](/php/docs/reference/cloud-firestore/1.38.0/Admin.V1.Field.IndexConfig)\n- [1.37.7](/php/docs/reference/cloud-firestore/1.37.7/Admin.V1.Field.IndexConfig)\n- [1.36.1](/php/docs/reference/cloud-firestore/1.36.1/Admin.V1.Field.IndexConfig)\n- [1.35.0](/php/docs/reference/cloud-firestore/1.35.0/Admin.V1.Field.IndexConfig)\n- [1.34.0](/php/docs/reference/cloud-firestore/1.34.0/Admin.V1.Field.IndexConfig)\n- [1.33.0](/php/docs/reference/cloud-firestore/1.33.0/Admin.V1.Field.IndexConfig)\n- [1.32.0](/php/docs/reference/cloud-firestore/1.32.0/Admin.V1.Field.IndexConfig)\n- [1.31.0](/php/docs/reference/cloud-firestore/1.31.0/Admin.V1.Field.IndexConfig)\n- [1.30.0](/php/docs/reference/cloud-firestore/1.30.0/Admin.V1.Field.IndexConfig)\n- [1.28.0](/php/docs/reference/cloud-firestore/1.28.0/Admin.V1.Field.IndexConfig)\n- [1.27.3](/php/docs/reference/cloud-firestore/1.27.3/Admin.V1.Field.IndexConfig) \nReference documentation and code samples for the Cloud Firestore V1 Client class IndexConfig.\n\nThe index configuration for this field.\n\nGenerated from protobuf message `google.firestore.admin.v1.Field.IndexConfig`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Firestore \\\\ Admin \\\\ V1 \\\\ Field\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getIndexes\n\nThe indexes supported for this field.\n\n### setIndexes\n\nThe indexes supported for this field.\n\n### getUsesAncestorConfig\n\nOutput only. When true, the `Field`'s index configuration is set from the\nconfiguration specified by the `ancestor_field`.\n\nWhen false, the `Field`'s index configuration is defined explicitly.\n\n### setUsesAncestorConfig\n\nOutput only. When true, the `Field`'s index configuration is set from the\nconfiguration specified by the `ancestor_field`.\n\nWhen false, the `Field`'s index configuration is defined explicitly.\n\n### getAncestorField\n\nOutput only. Specifies the resource name of the `Field` from which this\nfield's index configuration is set (when `uses_ancestor_config` is true),\nor from which it *would* be set if this field had no index configuration\n(when `uses_ancestor_config` is false).\n\n### setAncestorField\n\nOutput only. Specifies the resource name of the `Field` from which this\nfield's index configuration is set (when `uses_ancestor_config` is true),\nor from which it *would* be set if this field had no index configuration\n(when `uses_ancestor_config` is false).\n\n### getReverting\n\nOutput only\nWhen true, the `Field`'s index configuration is in the process of being\nreverted. Once complete, the index config will transition to the same\nstate as the field specified by `ancestor_field`, at which point\n`uses_ancestor_config` will be `true` and `reverting` will be `false`.\n\n### setReverting\n\nOutput only\nWhen true, the `Field`'s index configuration is in the process of being\nreverted. Once complete, the index config will transition to the same\nstate as the field specified by `ancestor_field`, at which point\n`uses_ancestor_config` will be `true` and `reverting` will be `false`."]]
