GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1Field (google_api_firestore v0.21.3) View Source

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.


  • indexConfig (type: GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1IndexConfig.t, default: nil) - 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.
  • name (type: String.t, default: nil) - 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 mapvalue , e.g., 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)``represents a field, 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/{projectid}/databases/{database_id}/collectionGroups/__default/fields/*Indexes defined on thisFieldwill be applied to all fields which do not have their ownField` index configuration.

Link to this section Summary


Unwrap a decoded JSON object into its complex fields.

Link to this section Types


t() :: %GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1Field{
    GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1IndexConfig.t() | nil,
  name: String.t() | nil

Link to this section Functions


decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.