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

Inherits:

Object

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

Defined in:

lib/google/cloud/datastore/v1/doc/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::Datastore::V1::ArrayValue

  An array value.

• #blob_value ⇒ String

  A blob value.

• #boolean_value ⇒ true, false

  A boolean value.

• #double_value ⇒ Float

  A double value.

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

  An entity value.

• #exclude_from_indexes ⇒ true, false

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

Returns:

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

# File 'lib/google/cloud/datastore/v1/doc/google/datastore/v1/entity.rb', line 162

class Value; 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.

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.

# File 'lib/google/cloud/datastore/v1/doc/google/datastore/v1/entity.rb', line 162

class Value; end

#boolean_value ⇒ true, false

Returns A boolean value.

Returns:

• (true, false) —

  A boolean value.

# File 'lib/google/cloud/datastore/v1/doc/google/datastore/v1/entity.rb', line 162

class Value; end

#double_value ⇒ Float

Returns A double value.

Returns:

• (Float) —

  A double value.

# File 'lib/google/cloud/datastore/v1/doc/google/datastore/v1/entity.rb', line 162

class Value; end

#entity_value ⇒ Google::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.

Returns:

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

# File 'lib/google/cloud/datastore/v1/doc/google/datastore/v1/entity.rb', line 162

class Value; end

#exclude_from_indexes ⇒ true, false

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

Returns:

• (true, false) —

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

# File 'lib/google/cloud/datastore/v1/doc/google/datastore/v1/entity.rb', line 162

class Value; end

#geo_point_value ⇒ Google::Type::LatLng

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

# File 'lib/google/cloud/datastore/v1/doc/google/datastore/v1/entity.rb', line 162

class Value; end

#integer_value ⇒ Integer

Returns An integer value.

Returns:

• (Integer) —

  An integer value.

# File 'lib/google/cloud/datastore/v1/doc/google/datastore/v1/entity.rb', line 162

class Value; end

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

Returns A key value.

Returns:

• (Google::Datastore::V1::Key) —

  A key value.

# File 'lib/google/cloud/datastore/v1/doc/google/datastore/v1/entity.rb', line 162

class Value; 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 'lib/google/cloud/datastore/v1/doc/google/datastore/v1/entity.rb', line 162

class Value; end

#null_value ⇒ Google::Protobuf::NullValue

Returns A null value.

Returns:

• (Google::Protobuf::NullValue) —

  A null value.

# File 'lib/google/cloud/datastore/v1/doc/google/datastore/v1/entity.rb', line 162

class Value; 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 least 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 least 1,000,000 bytes.

# File 'lib/google/cloud/datastore/v1/doc/google/datastore/v1/entity.rb', line 162

class Value; 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.

Returns:

• (Google::Protobuf::Timestamp) —

  A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.

# File 'lib/google/cloud/datastore/v1/doc/google/datastore/v1/entity.rb', line 162

class Value; end