Class: Google::Apis::DatastoreV1beta3::Value

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/datastore_v1beta3/classes.rb,
generated/google/apis/datastore_v1beta3/representations.rb,
generated/google/apis/datastore_v1beta3/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Value

Returns a new instance of Value



1864
1865
1866
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1864

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#array_valueGoogle::Apis::DatastoreV1beta3::ArrayValue

An array value. Corresponds to the JSON property arrayValue



1780
1781
1782
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1780

def array_value
  @array_value
end

#blob_valueString

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. Corresponds to the JSON property blobValue NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String)


1789
1790
1791
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1789

def blob_value
  @blob_value
end

#boolean_valueBoolean Also known as: boolean_value?

A boolean value. Corresponds to the JSON property booleanValue

Returns:

  • (Boolean)


1794
1795
1796
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1794

def boolean_value
  @boolean_value
end

#double_valueFloat

A double value. Corresponds to the JSON property doubleValue

Returns:

  • (Float)


1800
1801
1802
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1800

def double_value
  @double_value
end

#entity_valueGoogle::Apis::DatastoreV1beta3::Entity

A Datastore data object. An entity is limited to 1 megabyte when stored. That roughly corresponds to a limit of 1 megabyte for the serialized form of this message. Corresponds to the JSON property entityValue



1808
1809
1810
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1808

def entity_value
  @entity_value
end

#exclude_from_indexesBoolean Also known as: exclude_from_indexes?

If the value should be excluded from all indexes including those defined explicitly. Corresponds to the JSON property excludeFromIndexes

Returns:

  • (Boolean)


1814
1815
1816
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1814

def exclude_from_indexes
  @exclude_from_indexes
end

#geo_point_valueGoogle::Apis::DatastoreV1beta3::LatLng

An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges. Corresponds to the JSON property geoPointValue



1824
1825
1826
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1824

def geo_point_value
  @geo_point_value
end

#integer_valueFixnum

An integer value. Corresponds to the JSON property integerValue

Returns:

  • (Fixnum)


1829
1830
1831
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1829

def integer_value
  @integer_value
end

#key_valueGoogle::Apis::DatastoreV1beta3::Key

A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. Corresponds to the JSON property keyValue



1837
1838
1839
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1837

def key_value
  @key_value
end

#meaningFixnum

The meaning field should only be populated for backwards compatibility. Corresponds to the JSON property meaning

Returns:

  • (Fixnum)


1842
1843
1844
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1842

def meaning
  @meaning
end

#null_valueString

A null value. Corresponds to the JSON property nullValue

Returns:

  • (String)


1847
1848
1849
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1847

def null_value
  @null_value
end

#string_valueString

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. Corresponds to the JSON property stringValue

Returns:

  • (String)


1855
1856
1857
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1855

def string_value
  @string_value
end

#timestamp_valueString

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

Returns:

  • (String)


1862
1863
1864
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1862

def timestamp_value
  @timestamp_value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1869

def update!(**args)
  @array_value = args[:array_value] if args.key?(:array_value)
  @blob_value = args[:blob_value] if args.key?(:blob_value)
  @boolean_value = args[:boolean_value] if args.key?(:boolean_value)
  @double_value = args[:double_value] if args.key?(:double_value)
  @entity_value = args[:entity_value] if args.key?(:entity_value)
  @exclude_from_indexes = args[:exclude_from_indexes] if args.key?(:exclude_from_indexes)
  @geo_point_value = args[:geo_point_value] if args.key?(:geo_point_value)
  @integer_value = args[:integer_value] if args.key?(:integer_value)
  @key_value = args[:key_value] if args.key?(:key_value)
  @meaning = args[:meaning] if args.key?(:meaning)
  @null_value = args[:null_value] if args.key?(:null_value)
  @string_value = args[:string_value] if args.key?(:string_value)
  @timestamp_value = args[:timestamp_value] if args.key?(:timestamp_value)
end