View Source GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1IndexField (google_api_firestore v0.27.0)

A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.

Attributes

arrayConfig (type: String.t, default: nil) - Indicates that this field supports operations on array_values.
fieldPath (type: String.t, default: nil) - Can be name. For single field indexes, this must match the name of the field or may be omitted.
order (type: String.t, default: nil) - Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
vectorConfig (type: GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1VectorConfig.t, default: nil) - Indicates that this field supports nearest neighbors and distance operations on vector.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1IndexField{
  arrayConfig: String.t() | nil,
  fieldPath: String.t() | nil,
  order: String.t() | nil,
  vectorConfig:
    GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1VectorConfig.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.