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-
(::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-
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.
-
(::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-
(::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-
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.
-
(::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-
(::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-
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.
-
(::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-
(::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-
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.
-
(::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-
(::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-
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.
-
(::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-
(::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-
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.
-
(::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-
(::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-
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.
-
(::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-
(::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-
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.
-
(::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-
(::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-
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.
-
(::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-
(::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-
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.
-
(::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-
(::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-
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.
-
(::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.