public Field.Types.IndexConfig IndexConfig { get; set; }
The index configuration for this field. If unset, field indexing will
revert to the configuration defined by the ancestor_field. To
explicitly remove all indexes for this field, specify an index config
with an empty list of indexes.
Required. A field name of the form
projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}
A field path may be a simple field name, e.g. address or a path to fields
within map_value , e.g. address.city,
or a special field path. The only valid special field is *, which
represents any field.
Field paths may be quoted using (backtick). The only character that needs
to be escaped within a quoted field path is the backtick character itself,
escaped using a backslash. Special characters in field paths that
must be quoted include:*,.,
``` (backtick),[,]`, as well as any ascii symbolic characters.
Examples:
(Note: Comments here are written in markdown syntax, so there is an
additional layer of backticks to represent a code block)
\address.city`represents a field namedaddress.city, not the map keycityin the fieldaddress.``represents a field named`, not any field.
A special Field contains the default indexing settings for all fields.
This field's resource name is:
projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*
Indexes defined on this Field will be applied to all fields which do not
have their own Field index configuration.
[[["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\u003eField\u003c/code\u003e class represents a single field in the database, grouped by their Collection Group, which signifies collections with the same ID.\u003c/p\u003e\n"],["\u003cp\u003eThis page documents the \u003ccode\u003eField\u003c/code\u003e class within the \u003ccode\u003eGoogle.Cloud.Firestore.Admin.V1\u003c/code\u003e namespace, showing all versions from 2.2.0 up to 3.12.0, with 3.12.0 being the latest.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eField\u003c/code\u003e class, inheriting from \u003ccode\u003eObject\u003c/code\u003e, implements interfaces like \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e, indicating its role in message management and object comparison.\u003c/p\u003e\n"],["\u003cp\u003eKey properties of the \u003ccode\u003eField\u003c/code\u003e class include \u003ccode\u003eFieldName\u003c/code\u003e (a \u003ccode\u003eFieldName\u003c/code\u003e-typed view over the resource name), \u003ccode\u003eIndexConfig\u003c/code\u003e (for managing field indexing), and \u003ccode\u003eName\u003c/code\u003e (the field's resource name).\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eName\u003c/code\u003e property follows a specific format and uses backticks for quoting special field paths and characters, such as \u003ccode\u003e*\u003c/code\u003e, \u003ccode\u003e.\u003c/code\u003e, and backticks themselves.\u003c/p\u003e\n"]]],[],null,[]]
