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

View Source

The index configuration for this field.

Attributes

  • ancestorField (type: String.t, default: nil) - Output only. Specifies the resource name of the Field from which this field's index configuration is set (when uses_ancestor_config is true), or from which it would be set if this field had no index configuration (when uses_ancestor_config is false).
  • indexes (type: list(GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1Index.t), default: nil) - The indexes supported for this field.
  • reverting (type: boolean(), default: nil) - Output only When true, the Field's index configuration is in the process of being reverted. Once complete, the index config will transition to the same state as the field specified by ancestor_field, at which point uses_ancestor_config will be true and reverting will be false.
  • usesAncestorConfig (type: boolean(), default: nil) - Output only. When true, the Field's index configuration is set from the configuration specified by the ancestor_field. When false, the Field's index configuration is defined explicitly.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1IndexConfig{
  ancestorField: String.t() | nil,
  indexes: [GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1Index.t()] | nil,
  reverting: boolean() | nil,
  usesAncestorConfig: boolean() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.