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

A message that can hold any of the supported value types.


  • arrayValue (type: GoogleApi.Firestore.V1.Model.ArrayValue.t, default: nil) - An array value. Cannot directly contain another array value, though can contain an map which contains another array.
  • booleanValue (type: boolean(), default: nil) - A boolean value.
  • bytesValue (type: String.t, default: nil) - A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
  • doubleValue (type: float(), default: nil) - A double value.
  • geoPointValue (type: GoogleApi.Firestore.V1.Model.LatLng.t, default: nil) - A geo point value representing a point on the surface of Earth.
  • integerValue (type: String.t, default: nil) - An integer value.
  • mapValue (type: GoogleApi.Firestore.V1.Model.MapValue.t, default: nil) - A map value.
  • nullValue (type: String.t, default: nil) - A null value.
  • referenceValue (type: String.t, default: nil) - A reference to a document. For example: projects/{project_id}/databases/{database_id}/documents/{document_path}.
  • stringValue (type: String.t, default: nil) - A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.
  • timestampValue (type: DateTime.t, default: nil) - A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.

Link to this section Summary


Unwrap a decoded JSON object into its complex fields.

Link to this section Types


t() :: %GoogleApi.Firestore.V1.Model.Value{
  arrayValue: GoogleApi.Firestore.V1.Model.ArrayValue.t() | nil,
  booleanValue: boolean() | nil,
  bytesValue: String.t() | nil,
  doubleValue: float() | nil,
  geoPointValue: GoogleApi.Firestore.V1.Model.LatLng.t() | nil,
  integerValue: String.t() | nil,
  mapValue: GoogleApi.Firestore.V1.Model.MapValue.t() | nil,
  nullValue: String.t() | nil,
  referenceValue: String.t() | nil,
  stringValue: String.t() | nil,
  timestampValue: DateTime.t() | nil

Link to this section Functions


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

Unwrap a decoded JSON object into its complex fields.