Reference documentation and code samples for the Firestore in Datastore mode V1 API class Google::Cloud::Datastore::V1::Value.
A message that can hold any of the supported value types and associated metadata.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#array_value
def array_value() -> ::Google::Cloud::Datastore::V1::ArrayValue
Returns
-
(::Google::Cloud::Datastore::V1::ArrayValue) — An array value.
Cannot contain another array value.
A
Value
instance that sets fieldarray_value
must not set fieldsmeaning
orexclude_from_indexes
.
#array_value=
def array_value=(value) -> ::Google::Cloud::Datastore::V1::ArrayValue
Parameter
-
value (::Google::Cloud::Datastore::V1::ArrayValue) — An array value.
Cannot contain another array value.
A
Value
instance that sets fieldarray_value
must not set fieldsmeaning
orexclude_from_indexes
.
Returns
-
(::Google::Cloud::Datastore::V1::ArrayValue) — An array value.
Cannot contain another array value.
A
Value
instance that sets fieldarray_value
must not set fieldsmeaning
orexclude_from_indexes
.
#blob_value
def blob_value() -> ::String
Returns
-
(::String) — A blob value.
May have at most 1,000,000 bytes.
When
exclude_from_indexes
is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
#blob_value=
def blob_value=(value) -> ::String
Parameter
-
value (::String) — A blob value.
May have at most 1,000,000 bytes.
When
exclude_from_indexes
is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
Returns
-
(::String) — A blob value.
May have at most 1,000,000 bytes.
When
exclude_from_indexes
is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.
#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.
#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.
#entity_value
def entity_value() -> ::Google::Cloud::Datastore::V1::Entity
Returns
-
(::Google::Cloud::Datastore::V1::Entity) —
An entity value.
- May have no key.
- May have a key with an incomplete key path.
- May have a reserved/read-only key.
#entity_value=
def entity_value=(value) -> ::Google::Cloud::Datastore::V1::Entity
Parameter
-
value (::Google::Cloud::Datastore::V1::Entity) —
An entity value.
- May have no key.
- May have a key with an incomplete key path.
- May have a reserved/read-only key.
Returns
-
(::Google::Cloud::Datastore::V1::Entity) —
An entity value.
- May have no key.
- May have a key with an incomplete key path.
- May have a reserved/read-only key.
#exclude_from_indexes
def exclude_from_indexes() -> ::Boolean
Returns
- (::Boolean) — If the value should be excluded from all indexes including those defined explicitly.
#exclude_from_indexes=
def exclude_from_indexes=(value) -> ::Boolean
Parameter
- value (::Boolean) — If the value should be excluded from all indexes including those defined explicitly.
Returns
- (::Boolean) — If the value should be excluded from all indexes including those defined explicitly.
#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.
#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.
Returns
- (::Google::Type::LatLng) — A geo point value representing a point on the surface of Earth.
#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.
#key_value
def key_value() -> ::Google::Cloud::Datastore::V1::Key
Returns
- (::Google::Cloud::Datastore::V1::Key) — A key value.
#key_value=
def key_value=(value) -> ::Google::Cloud::Datastore::V1::Key
Parameter
- value (::Google::Cloud::Datastore::V1::Key) — A key value.
Returns
- (::Google::Cloud::Datastore::V1::Key) — A key value.
#meaning
def meaning() -> ::Integer
Returns
-
(::Integer) — The
meaning
field should only be populated for backwards compatibility.
#meaning=
def meaning=(value) -> ::Integer
Parameter
-
value (::Integer) — The
meaning
field should only be populated for backwards compatibility.
Returns
-
(::Integer) — The
meaning
field should only be populated for backwards compatibility.
#null_value
def null_value() -> ::Google::Protobuf::NullValue
Returns
- (::Google::Protobuf::NullValue) — A null value.
#null_value=
def null_value=(value) -> ::Google::Protobuf::NullValue
Parameter
- value (::Google::Protobuf::NullValue) — A null value.
Returns
- (::Google::Protobuf::NullValue) — A null value.
#string_value
def string_value() -> ::String
Returns
-
(::String) — A UTF-8 encoded string value.
When
exclude_from_indexes
is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.
#string_value=
def string_value=(value) -> ::String
Parameter
-
value (::String) — A UTF-8 encoded string value.
When
exclude_from_indexes
is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.
Returns
-
(::String) — A UTF-8 encoded string value.
When
exclude_from_indexes
is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.
#timestamp_value
def timestamp_value() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
#timestamp_value=
def timestamp_value=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
Returns
- (::Google::Protobuf::Timestamp) — A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.