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

Version latest

• 1.3.0 (latest)
• 1.2.0
• 1.1.1
• 1.0.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.8

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

• (::Google::Cloud::Firestore::V1::ArrayValue) — An array value.

  Cannot directly contain another array value, though can contain a map which contains another array.

  Note: The following fields are mutually exclusive: array_value, null_value, boolean_value, integer_value, double_value, timestamp_value, string_value, bytes_value, reference_value, geo_point_value, map_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#array_value=

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

Parameter

• value (::Google::Cloud::Firestore::V1::ArrayValue) — An array value.

  Cannot directly contain another array value, though can contain a map which contains another array.

  Note: The following fields are mutually exclusive: array_value, null_value, boolean_value, integer_value, double_value, timestamp_value, string_value, bytes_value, reference_value, geo_point_value, map_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::Firestore::V1::ArrayValue) — An array value.

  Cannot directly contain another array value, though can contain a map which contains another array.

  Note: The following fields are mutually exclusive: array_value, null_value, boolean_value, integer_value, double_value, timestamp_value, string_value, bytes_value, reference_value, geo_point_value, map_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#boolean_value

def boolean_value() -> ::Boolean

Returns

• (::Boolean) — A boolean value.

  Note: The following fields are mutually exclusive: boolean_value, null_value, integer_value, double_value, timestamp_value, string_value, bytes_value, reference_value, geo_point_value, array_value, map_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#boolean_value=

def boolean_value=(value) -> ::Boolean

Parameter

• value (::Boolean) — A boolean value.

  Note: The following fields are mutually exclusive: boolean_value, null_value, integer_value, double_value, timestamp_value, string_value, bytes_value, reference_value, geo_point_value, array_value, map_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Boolean) — A boolean value.

  Note: The following fields are mutually exclusive: boolean_value, null_value, integer_value, double_value, timestamp_value, string_value, bytes_value, reference_value, geo_point_value, array_value, map_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#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.

  Note: The following fields are mutually exclusive: bytes_value, null_value, boolean_value, integer_value, double_value, timestamp_value, string_value, reference_value, geo_point_value, array_value, map_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#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.

  Note: The following fields are mutually exclusive: bytes_value, null_value, boolean_value, integer_value, double_value, timestamp_value, string_value, reference_value, geo_point_value, array_value, map_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::String) — A bytes value.

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

  Note: The following fields are mutually exclusive: bytes_value, null_value, boolean_value, integer_value, double_value, timestamp_value, string_value, reference_value, geo_point_value, array_value, map_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#double_value

def double_value() -> ::Float

Returns

• (::Float) — A double value.

  Note: The following fields are mutually exclusive: double_value, null_value, boolean_value, integer_value, timestamp_value, string_value, bytes_value, reference_value, geo_point_value, array_value, map_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#double_value=

def double_value=(value) -> ::Float

Parameter

• value (::Float) — A double value.

  Note: The following fields are mutually exclusive: double_value, null_value, boolean_value, integer_value, timestamp_value, string_value, bytes_value, reference_value, geo_point_value, array_value, map_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Float) — A double value.

  Note: The following fields are mutually exclusive: double_value, null_value, boolean_value, integer_value, timestamp_value, string_value, bytes_value, reference_value, geo_point_value, array_value, map_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#geo_point_value

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

Returns

• (::Google::Type::LatLng) — A geo point value representing a point on the surface of Earth.

  Note: The following fields are mutually exclusive: geo_point_value, null_value, boolean_value, integer_value, double_value, timestamp_value, string_value, bytes_value, reference_value, array_value, map_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#geo_point_value=

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

Parameter

• value (::Google::Type::LatLng) — A geo point value representing a point on the surface of Earth.

  Note: The following fields are mutually exclusive: geo_point_value, null_value, boolean_value, integer_value, double_value, timestamp_value, string_value, bytes_value, reference_value, array_value, map_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Type::LatLng) — A geo point value representing a point on the surface of Earth.

  Note: The following fields are mutually exclusive: geo_point_value, null_value, boolean_value, integer_value, double_value, timestamp_value, string_value, bytes_value, reference_value, array_value, map_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#integer_value

def integer_value() -> ::Integer

Returns

• (::Integer) — An integer value.

  Note: The following fields are mutually exclusive: integer_value, null_value, boolean_value, double_value, timestamp_value, string_value, bytes_value, reference_value, geo_point_value, array_value, map_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#integer_value=

def integer_value=(value) -> ::Integer

Parameter

• value (::Integer) — An integer value.

  Note: The following fields are mutually exclusive: integer_value, null_value, boolean_value, double_value, timestamp_value, string_value, bytes_value, reference_value, geo_point_value, array_value, map_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Integer) — An integer value.

  Note: The following fields are mutually exclusive: integer_value, null_value, boolean_value, double_value, timestamp_value, string_value, bytes_value, reference_value, geo_point_value, array_value, map_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#map_value

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

Returns

• (::Google::Cloud::Firestore::V1::MapValue) — A map value.

  Note: The following fields are mutually exclusive: map_value, null_value, boolean_value, integer_value, double_value, timestamp_value, string_value, bytes_value, reference_value, geo_point_value, array_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#map_value=

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

Parameter

• value (::Google::Cloud::Firestore::V1::MapValue) — A map value.

  Note: The following fields are mutually exclusive: map_value, null_value, boolean_value, integer_value, double_value, timestamp_value, string_value, bytes_value, reference_value, geo_point_value, array_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::Firestore::V1::MapValue) — A map value.

  Note: The following fields are mutually exclusive: map_value, null_value, boolean_value, integer_value, double_value, timestamp_value, string_value, bytes_value, reference_value, geo_point_value, array_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#null_value

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

Returns

• (::Google::Protobuf::NullValue) — A null value.

  Note: The following fields are mutually exclusive: null_value, boolean_value, integer_value, double_value, timestamp_value, string_value, bytes_value, reference_value, geo_point_value, array_value, map_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#null_value=

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

Parameter

• value (::Google::Protobuf::NullValue) — A null value.

  Note: The following fields are mutually exclusive: null_value, boolean_value, integer_value, double_value, timestamp_value, string_value, bytes_value, reference_value, geo_point_value, array_value, map_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Protobuf::NullValue) — A null value.

  Note: The following fields are mutually exclusive: null_value, boolean_value, integer_value, double_value, timestamp_value, string_value, bytes_value, reference_value, geo_point_value, array_value, map_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#reference_value

def reference_value() -> ::String

Returns

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

  Note: The following fields are mutually exclusive: reference_value, null_value, boolean_value, integer_value, double_value, timestamp_value, string_value, bytes_value, geo_point_value, array_value, map_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#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}.

  Note: The following fields are mutually exclusive: reference_value, null_value, boolean_value, integer_value, double_value, timestamp_value, string_value, bytes_value, geo_point_value, array_value, map_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

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

  Note: The following fields are mutually exclusive: reference_value, null_value, boolean_value, integer_value, double_value, timestamp_value, string_value, bytes_value, geo_point_value, array_value, map_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#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.

  Note: The following fields are mutually exclusive: string_value, null_value, boolean_value, integer_value, double_value, timestamp_value, bytes_value, reference_value, geo_point_value, array_value, map_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#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.

  Note: The following fields are mutually exclusive: string_value, null_value, boolean_value, integer_value, double_value, timestamp_value, bytes_value, reference_value, geo_point_value, array_value, map_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

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.

  Note: The following fields are mutually exclusive: string_value, null_value, boolean_value, integer_value, double_value, timestamp_value, bytes_value, reference_value, geo_point_value, array_value, map_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#timestamp_value

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

Returns

• (::Google::Protobuf::Timestamp) — A timestamp value.

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

  Note: The following fields are mutually exclusive: timestamp_value, null_value, boolean_value, integer_value, double_value, string_value, bytes_value, reference_value, geo_point_value, array_value, map_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#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.

  Note: The following fields are mutually exclusive: timestamp_value, null_value, boolean_value, integer_value, double_value, string_value, bytes_value, reference_value, geo_point_value, array_value, map_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Protobuf::Timestamp) — A timestamp value.

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

  Note: The following fields are mutually exclusive: timestamp_value, null_value, boolean_value, integer_value, double_value, string_value, bytes_value, reference_value, geo_point_value, array_value, map_value. If a field in that set is populated, all other fields in the set will automatically be cleared.