View Source GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1Field (google_api_firestore v0.27.0)
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.
Attributes
-
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 theancestor_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 formprojects/{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.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 named
address.city, not the map key
cityin the field
address.
``represents a field named
*, not any field. A special
Fieldcontains the default indexing settings for all fields. This field's resource name is:
projects/{projectid}/databases/{database_id}/collectionGroups/__default/fields/*Indexes defined on this
Fieldwill be applied to all fields which do not have their own
Field` index configuration. -
ttlConfig
(type:GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1TtlConfig.t
, default:nil
) - The TTL configuration for thisField
. Setting or unsetting this will enable or disable the TTL for documents that have thisField
.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1Field{ indexConfig: GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1IndexConfig.t() | nil, name: String.t() | nil, ttlConfig: GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1TtlConfig.t() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.