Class: Google::Cloud::Datastore::V1::Value

Inherits:

Object

• Object
• Google::Cloud::Datastore::V1::Value

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/datastore/v1/entity.rb

Overview

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

Instance Attribute Summary

• #array_value ⇒ ::Google::Cloud::Datastore::V1::ArrayValue

  An array value.

• #blob_value ⇒ ::String

  A blob value.

• #boolean_value ⇒ ::Boolean

  A boolean value.

• #double_value ⇒ ::Float

  A double value.

• #entity_value ⇒ ::Google::Cloud::Datastore::V1::Entity

  An entity value.

• #exclude_from_indexes ⇒ ::Boolean

  If the value should be excluded from all indexes including those defined explicitly.

• #geo_point_value ⇒ ::Google::Type::LatLng

  A geo point value representing a point on the surface of Earth.

• #integer_value ⇒ ::Integer

  An integer value.

• #key_value ⇒ ::Google::Cloud::Datastore::V1::Key

  A key value.

• #meaning ⇒ ::Integer

  The meaning field should only be populated for backwards compatibility.

• #null_value ⇒ ::Google::Protobuf::NullValue

  A null value.

• #string_value ⇒ ::String

  A UTF-8 encoded string value.

• #timestamp_value ⇒ ::Google::Protobuf::Timestamp

  A timestamp value.

Instance Attribute Details

#array_value ⇒ ::Google::Cloud::Datastore::V1::ArrayValue

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

# File 'proto_docs/google/datastore/v1/entity.rb', line 221

class Value
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#blob_value ⇒ ::String

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

# File 'proto_docs/google/datastore/v1/entity.rb', line 221

class Value
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#boolean_value ⇒ ::Boolean

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

# File 'proto_docs/google/datastore/v1/entity.rb', line 221

class Value
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#double_value ⇒ ::Float

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

# File 'proto_docs/google/datastore/v1/entity.rb', line 221

class Value
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#entity_value ⇒ ::Google::Cloud::Datastore::V1::Entity

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

# File 'proto_docs/google/datastore/v1/entity.rb', line 221

class Value
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#exclude_from_indexes ⇒ ::Boolean

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

# File 'proto_docs/google/datastore/v1/entity.rb', line 221

class Value
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#geo_point_value ⇒ ::Google::Type::LatLng

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

# File 'proto_docs/google/datastore/v1/entity.rb', line 221

class Value
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#integer_value ⇒ ::Integer

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

# File 'proto_docs/google/datastore/v1/entity.rb', line 221

class Value
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#key_value ⇒ ::Google::Cloud::Datastore::V1::Key

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

# File 'proto_docs/google/datastore/v1/entity.rb', line 221

class Value
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#meaning ⇒ ::Integer

Returns The meaning field should only be populated for backwards compatibility.

Returns:

• (::Integer) —

  The meaning field should only be populated for backwards compatibility.

# File 'proto_docs/google/datastore/v1/entity.rb', line 221

class Value
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#null_value ⇒ ::Google::Protobuf::NullValue

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

# File 'proto_docs/google/datastore/v1/entity.rb', line 221

class Value
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#string_value ⇒ ::String

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

# File 'proto_docs/google/datastore/v1/entity.rb', line 221

class Value
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#timestamp_value ⇒ ::Google::Protobuf::Timestamp

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

# File 'proto_docs/google/datastore/v1/entity.rb', line 221

class Value
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end