GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1Field (google_api_firestore v0.33.0)

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.

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 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 can 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 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 named address.city, not the map key city in the field address. `*` 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.
  • ttlConfig (type: GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1TtlConfig.t, default: nil) - The TTL configuration for this Field. Setting or unsetting this will enable or disable the TTL for documents that have this Field.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

t()

@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

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.