Class: Google::Apis::DatastoreV1::Value

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/datastore_v1/classes.rb,
lib/google/apis/datastore_v1/representations.rb,
lib/google/apis/datastore_v1/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

Constructor Details

#initialize(**args) ⇒ Value

Returns a new instance of Value.



2123
2124
2125
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2123

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

Instance Attribute Details

#array_value ⇒ Google::Apis::DatastoreV1::ArrayValue

An array value. Corresponds to the JSON property arrayValue

Returns:



2046
2047
2048
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2046

def array_value
  @array_value
end

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

Returns:

  • (String) 


2053
2054
2055
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2053

def blob_value
  @blob_value
end

#boolean_value ⇒ Boolean Also known as: boolean_value?

A boolean value. Corresponds to the JSON property booleanValue

Returns:

  • (Boolean) 


2058
2059
2060
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2058

def boolean_value
  @boolean_value
end

#double_value ⇒ Float

A double value. Corresponds to the JSON property doubleValue

Returns:

  • (Float) 


2064
2065
2066
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2064

def double_value
  @double_value
end

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

Returns:



2071
2072
2073
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2071

def entity_value
  @entity_value
end

#exclude_from_indexes ⇒ Boolean 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) 


2077
2078
2079
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2077

def exclude_from_indexes
  @exclude_from_indexes
end

#geo_point_value ⇒ Google::Apis::DatastoreV1::LatLng

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

Returns:



2086
2087
2088
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2086

def geo_point_value
  @geo_point_value
end

#integer_value ⇒ Fixnum

An integer value. Corresponds to the JSON property integerValue

Returns:

  • (Fixnum) 


2091
2092
2093
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2091

def integer_value
  @integer_value
end

#key_value ⇒ Google::Apis::DatastoreV1::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

Returns:



2098
2099
2100
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2098

def key_value
  @key_value
end

#meaning ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2103
2104
2105
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2103

def meaning
  @meaning
end

#null_value ⇒ String

A null value. Corresponds to the JSON property nullValue

Returns:

  • (String) 


2108
2109
2110
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2108

def null_value
  @null_value
end

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

Returns:

  • (String) 


2115
2116
2117
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2115

def string_value
  @string_value
end

#timestamp_value ⇒ String

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) 


2121
2122
2123
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2121

def timestamp_value
  @timestamp_value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2128

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