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.



2677
2678
2679
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2677

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:



2602
2603
2604
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2602

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) 


2609
2610
2611
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2609

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) 


2614
2615
2616
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2614

def boolean_value
  @boolean_value
end

#double_value ⇒ Float

A double value. Corresponds to the JSON property doubleValue

Returns:

  • (Float) 


2620
2621
2622
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2620

def double_value
  @double_value
end

#entity_value ⇒ Google::Apis::DatastoreV1::Entity

A Datastore data object. Must not exceed 1 MiB - 4 bytes. Corresponds to the JSON property entityValue

Returns:



2625
2626
2627
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2625

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) 


2631
2632
2633
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2631

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:



2640
2641
2642
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2640

def geo_point_value
  @geo_point_value
end

#integer_value ⇒ Fixnum

An integer value. Corresponds to the JSON property integerValue

Returns:

  • (Fixnum) 


2645
2646
2647
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2645

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:



2652
2653
2654
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2652

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) 


2657
2658
2659
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2657

def meaning
  @meaning
end

#null_value ⇒ String

A null value. Corresponds to the JSON property nullValue

Returns:

  • (String) 


2662
2663
2664
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2662

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) 


2669
2670
2671
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2669

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) 


2675
2676
2677
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2675

def timestamp_value
  @timestamp_value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 2682

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