Reference documentation and code samples for the Cloud Firestore V1 Client class Field.
Represents a single field in the database.
Fields are grouped by their "Collection Group", which represent all
collections in the database with the same ID.
Generated from protobuf messagegoogle.firestore.admin.v1.Field
Namespace
Google \ Cloud \ Firestore \ Admin \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. A field name of the form:projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}A field path can be a simple field name, e.g.addressor a path to fields withinmap_value, e.g.address.city, or a special field path. The only valid special field is*, which represents any field. Field paths can be quoted using`(backtick). The only character that must 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:`address.city`represents a field namedaddress.city, not the map keycityin the fieldaddress.`*`represents a field named*, not any field. A specialFieldcontains 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 thisFieldwill be applied to all fields which do not have their ownFieldindex configuration.
The index configuration for this field. If unset, field indexing will revert to the configuration defined by theancestor_field. To explicitly remove all indexes for this field, specify an index config with an empty list of indexes.
The TTL configuration for thisField. Setting or unsetting this will enable or disable the TTL for documents that have thisField.
getName
Required. A field name of the form:projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}A field path can be a simple field name, e.g.addressor a path to fields
withinmap_value, e.g.address.city,
or a special field path. The only valid special field is*, which
represents any field.
Field paths can be quoted using`(backtick). The only character that
must 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:`address.city`represents a field namedaddress.city, not the map
keycityin the fieldaddress.`*`represents a field named*,
not any field.
A specialFieldcontains 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 thisFieldwill be applied to all fields which do not
have their ownFieldindex configuration.
Returns
Type
Description
string
setName
Required. A field name of the form:projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}A field path can be a simple field name, e.g.addressor a path to fields
withinmap_value, e.g.address.city,
or a special field path. The only valid special field is*, which
represents any field.
Field paths can be quoted using`(backtick). The only character that
must 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:`address.city`represents a field namedaddress.city, not the map
keycityin the fieldaddress.`*`represents a field named*,
not any field.
A specialFieldcontains 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 thisFieldwill be applied to all fields which do not
have their ownFieldindex configuration.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getIndexConfig
The index configuration for this field. If unset, field indexing will
revert to the configuration defined by theancestor_field. To
explicitly remove all indexes for this field, specify an index config
with an empty list of indexes.
The index configuration for this field. If unset, field indexing will
revert to the configuration defined by theancestor_field. To
explicitly remove all indexes for this field, specify an index config
with an empty list of indexes.
[[["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 Field (1.53.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.53.0 (latest)](/php/docs/reference/cloud-firestore/latest/Admin.V1.Field)\n- [1.52.0](/php/docs/reference/cloud-firestore/1.52.0/Admin.V1.Field)\n- [1.51.0](/php/docs/reference/cloud-firestore/1.51.0/Admin.V1.Field)\n- [1.50.0](/php/docs/reference/cloud-firestore/1.50.0/Admin.V1.Field)\n- [1.48.1](/php/docs/reference/cloud-firestore/1.48.1/Admin.V1.Field)\n- [1.47.3](/php/docs/reference/cloud-firestore/1.47.3/Admin.V1.Field)\n- [1.46.0](/php/docs/reference/cloud-firestore/1.46.0/Admin.V1.Field)\n- [1.45.2](/php/docs/reference/cloud-firestore/1.45.2/Admin.V1.Field)\n- [1.44.1](/php/docs/reference/cloud-firestore/1.44.1/Admin.V1.Field)\n- [1.43.3](/php/docs/reference/cloud-firestore/1.43.3/Admin.V1.Field)\n- [1.40.0](/php/docs/reference/cloud-firestore/1.40.0/Admin.V1.Field)\n- [1.39.0](/php/docs/reference/cloud-firestore/1.39.0/Admin.V1.Field)\n- [1.38.0](/php/docs/reference/cloud-firestore/1.38.0/Admin.V1.Field)\n- [1.37.7](/php/docs/reference/cloud-firestore/1.37.7/Admin.V1.Field)\n- [1.36.1](/php/docs/reference/cloud-firestore/1.36.1/Admin.V1.Field)\n- [1.35.0](/php/docs/reference/cloud-firestore/1.35.0/Admin.V1.Field)\n- [1.34.0](/php/docs/reference/cloud-firestore/1.34.0/Admin.V1.Field)\n- [1.33.0](/php/docs/reference/cloud-firestore/1.33.0/Admin.V1.Field)\n- [1.32.0](/php/docs/reference/cloud-firestore/1.32.0/Admin.V1.Field)\n- [1.31.0](/php/docs/reference/cloud-firestore/1.31.0/Admin.V1.Field)\n- [1.30.0](/php/docs/reference/cloud-firestore/1.30.0/Admin.V1.Field)\n- [1.28.0](/php/docs/reference/cloud-firestore/1.28.0/Admin.V1.Field)\n- [1.27.3](/php/docs/reference/cloud-firestore/1.27.3/Admin.V1.Field) \nReference documentation and code samples for the Cloud Firestore V1 Client class Field.\n\nRepresents a single field in the database.\n\nFields are grouped by their \"Collection Group\", which represent all\ncollections in the database with the same ID.\n\nGenerated from protobuf message `google.firestore.admin.v1.Field`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Firestore \\\\ Admin \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. A field name of the form:\n`projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}`\nA field path can be a simple field name, e.g. `address` or a path to fields\nwithin `map_value` , e.g. `address.city`,\nor a special field path. The only valid special field is `*`, which\nrepresents any field.\n\nField paths can be quoted using ``` `` (backtick). The only character that\nmust be escaped within a quoted field path is the backtick character\nitself, escaped using a backslash. Special characters in field paths that\nmust be quoted include: `*`, `.`,\n``` `` (backtick), `[`, `]`, as well as any ascii symbolic characters.\nExamples:\n```address.city` `` represents a field named `address.city`, not the map\nkey `city` in the field `address`. ```*` `` represents a field named `*`,\nnot any field.\nA special `Field` contains the default indexing settings for all fields.\nThis field's resource name is:\n`projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`\nIndexes defined on this `Field` will be applied to all fields which do not\nhave their own `Field` index configuration.\n\n### setName\n\nRequired. A field name of the form:\n`projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}`\nA field path can be a simple field name, e.g. `address` or a path to fields\nwithin `map_value` , e.g. `address.city`,\nor a special field path. The only valid special field is `*`, which\nrepresents any field.\n\nField paths can be quoted using ``` `` (backtick). The only character that\nmust be escaped within a quoted field path is the backtick character\nitself, escaped using a backslash. Special characters in field paths that\nmust be quoted include: `*`, `.`,\n``` `` (backtick), `[`, `]`, as well as any ascii symbolic characters.\nExamples:\n```address.city` `` represents a field named `address.city`, not the map\nkey `city` in the field `address`. ```*` `` represents a field named `*`,\nnot any field.\nA special `Field` contains the default indexing settings for all fields.\nThis field's resource name is:\n`projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`\nIndexes defined on this `Field` will be applied to all fields which do not\nhave their own `Field` index configuration.\n\n### getIndexConfig\n\nThe index configuration for this field. If unset, field indexing will\nrevert to the configuration defined by the `ancestor_field`. To\nexplicitly remove all indexes for this field, specify an index config\nwith an empty list of indexes.\n\n### hasIndexConfig\n\n### clearIndexConfig\n\n### setIndexConfig\n\nThe index configuration for this field. If unset, field indexing will\nrevert to the configuration defined by the `ancestor_field`. To\nexplicitly remove all indexes for this field, specify an index config\nwith an empty list of indexes.\n\n### getTtlConfig\n\nThe TTL configuration for this `Field`.\n\nSetting or unsetting this will enable or disable the TTL for\ndocuments that have this `Field`.\n\n### hasTtlConfig\n\n### clearTtlConfig\n\n### setTtlConfig\n\nThe TTL configuration for this `Field`.\n\nSetting or unsetting this will enable or disable the TTL for\ndocuments that have this `Field`."]]
