Cloud Firestore V1 API - Class Google::Cloud::Firestore::V1::Value (v1.2.0)

Reference documentation and code samples for the Cloud Firestore V1 API class Google::Cloud::Firestore::V1::Value.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#array_value

def array_value() -> ::Google::Cloud::Firestore::V1::ArrayValue
Returns

#array_value=

def array_value=(value) -> ::Google::Cloud::Firestore::V1::ArrayValue
Parameter
Returns

#boolean_value

def boolean_value() -> ::Boolean
Returns
  • (::Boolean) — A boolean value.

#boolean_value=

def boolean_value=(value) -> ::Boolean
Parameter
  • value (::Boolean) — A boolean value.
Returns
  • (::Boolean) — A boolean value.

#bytes_value

def bytes_value() -> ::String
Returns
  • (::String) — A bytes value.

    Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.

#bytes_value=

def bytes_value=(value) -> ::String
Parameter
  • value (::String) — A bytes value.

    Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.

Returns
  • (::String) — A bytes value.

    Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.

#double_value

def double_value() -> ::Float
Returns
  • (::Float) — A double value.

#double_value=

def double_value=(value) -> ::Float
Parameter
  • value (::Float) — A double value.
Returns
  • (::Float) — A double value.

#geo_point_value

def geo_point_value() -> ::Google::Type::LatLng
Returns

#geo_point_value=

def geo_point_value=(value) -> ::Google::Type::LatLng
Parameter
Returns

#integer_value

def integer_value() -> ::Integer
Returns
  • (::Integer) — An integer value.

#integer_value=

def integer_value=(value) -> ::Integer
Parameter
  • value (::Integer) — An integer value.
Returns
  • (::Integer) — An integer value.

#map_value

def map_value() -> ::Google::Cloud::Firestore::V1::MapValue
Returns

#map_value=

def map_value=(value) -> ::Google::Cloud::Firestore::V1::MapValue
Parameter
Returns

#null_value

def null_value() -> ::Google::Protobuf::NullValue
Returns

#null_value=

def null_value=(value) -> ::Google::Protobuf::NullValue
Parameter
Returns

#reference_value

def reference_value() -> ::String
Returns
  • (::String) — A reference to a document. For example: projects/{project_id}/databases/{database_id}/documents/{document_path}.

#reference_value=

def reference_value=(value) -> ::String
Parameter
  • value (::String) — A reference to a document. For example: projects/{project_id}/databases/{database_id}/documents/{document_path}.
Returns
  • (::String) — A reference to a document. For example: projects/{project_id}/databases/{database_id}/documents/{document_path}.

#string_value

def string_value() -> ::String
Returns
  • (::String) — 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.

#string_value=

def string_value=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#timestamp_value

def timestamp_value() -> ::Google::Protobuf::Timestamp
Returns

#timestamp_value=

def timestamp_value=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::Google::Protobuf::Timestamp) — A timestamp value.

    Precise only to microseconds. When stored, any additional precision is rounded down.

Returns