Firestore in Datastore mode V1 API - Class Google::Cloud::Datastore::V1::Value (v1.5.0)

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 field array_value must not set fields meaning or exclude_from_indexes.

    Note: The following fields are mutually exclusive: array_value, null_value, boolean_value, integer_value, double_value, timestamp_value, key_value, string_value, blob_value, geo_point_value, entity_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::Datastore::V1::ArrayValue
Parameter
  • value (::Google::Cloud::Datastore::V1::ArrayValue) — An array value. Cannot contain another array value. A Value instance that sets field array_value must not set fields meaning or exclude_from_indexes.

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

Returns
  • (::Google::Cloud::Datastore::V1::ArrayValue) — An array value. Cannot contain another array value. A Value instance that sets field array_value must not set fields meaning or exclude_from_indexes.

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

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

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

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

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

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.

    Note: The following fields are mutually exclusive: blob_value, null_value, boolean_value, integer_value, double_value, timestamp_value, key_value, string_value, geo_point_value, entity_value, array_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, key_value, string_value, blob_value, geo_point_value, entity_value, array_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, key_value, string_value, blob_value, geo_point_value, entity_value, array_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, key_value, string_value, blob_value, geo_point_value, entity_value, array_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, key_value, string_value, blob_value, geo_point_value, entity_value, array_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, key_value, string_value, blob_value, geo_point_value, entity_value, array_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, key_value, string_value, blob_value, geo_point_value, entity_value, array_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

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

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

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

    Note: The following fields are mutually exclusive: entity_value, null_value, boolean_value, integer_value, double_value, timestamp_value, key_value, string_value, blob_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::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.

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

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

    Note: The following fields are mutually exclusive: geo_point_value, null_value, boolean_value, integer_value, double_value, timestamp_value, key_value, string_value, blob_value, entity_value, array_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, key_value, string_value, blob_value, entity_value, array_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, key_value, string_value, blob_value, entity_value, array_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, key_value, string_value, blob_value, geo_point_value, entity_value, array_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, key_value, string_value, blob_value, geo_point_value, entity_value, array_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, key_value, string_value, blob_value, geo_point_value, entity_value, array_value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#key_value

def key_value() -> ::Google::Cloud::Datastore::V1::Key
Returns
  • (::Google::Cloud::Datastore::V1::Key) — A key value.

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

#key_value=

def key_value=(value) -> ::Google::Cloud::Datastore::V1::Key
Parameter
  • value (::Google::Cloud::Datastore::V1::Key) — A key value.

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

Returns
  • (::Google::Cloud::Datastore::V1::Key) — A key value.

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

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

    Note: The following fields are mutually exclusive: null_value, boolean_value, integer_value, double_value, timestamp_value, key_value, string_value, blob_value, geo_point_value, entity_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=(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, key_value, string_value, blob_value, geo_point_value, entity_value, array_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, key_value, string_value, blob_value, geo_point_value, entity_value, array_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 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.

    Note: The following fields are mutually exclusive: string_value, null_value, boolean_value, integer_value, double_value, timestamp_value, key_value, blob_value, geo_point_value, entity_value, array_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 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.

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

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.

    Note: The following fields are mutually exclusive: string_value, null_value, boolean_value, integer_value, double_value, timestamp_value, key_value, blob_value, geo_point_value, entity_value, array_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. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.

    Note: The following fields are mutually exclusive: timestamp_value, null_value, boolean_value, integer_value, double_value, key_value, string_value, blob_value, geo_point_value, entity_value, array_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. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.

    Note: The following fields are mutually exclusive: timestamp_value, null_value, boolean_value, integer_value, double_value, key_value, string_value, blob_value, geo_point_value, entity_value, array_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. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.

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