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



1578
1579
1580
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1578

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

Instance Attribute Details

#array_value ⇒ Google::Apis::DatastoreV1beta3::ArrayValue

An array value. Corresponds to the JSON property arrayValue

Returns:



1494
1495
1496
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1494

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) 


1503
1504
1505
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1503

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) 


1508
1509
1510
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1508

def boolean_value
  @boolean_value
end

#double_value ⇒ Float

A double value. Corresponds to the JSON property doubleValue

Returns:

  • (Float) 


1514
1515
1516
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1514

def double_value
  @double_value
end

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

Returns:



1522
1523
1524
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1522

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) 


1528
1529
1530
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1528

def exclude_from_indexes
  @exclude_from_indexes
end

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

Returns:



1538
1539
1540
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1538

def geo_point_value
  @geo_point_value
end

#integer_value ⇒ Fixnum

An integer value. Corresponds to the JSON property integerValue

Returns:

  • (Fixnum) 


1543
1544
1545
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1543

def integer_value
  @integer_value
end

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

Returns:



1551
1552
1553
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1551

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) 


1556
1557
1558
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1556

def meaning
  @meaning
end

#null_value ⇒ String

A null value. Corresponds to the JSON property nullValue

Returns:

  • (String) 


1561
1562
1563
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1561

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 least 1,000,000 bytes. Corresponds to the JSON property stringValue

Returns:

  • (String) 


1569
1570
1571
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1569

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) 


1576
1577
1578
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1576

def timestamp_value
  @timestamp_value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1583

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