Class: Google::Apis::FirestoreV1::Value

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Value

Returns a new instance of Value.



3618
3619
3620
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3618

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

Instance Attribute Details

#array_value ⇒ Google::Apis::FirestoreV1::ArrayValue

An array value. Corresponds to the JSON property arrayValue

Returns:



3556
3557
3558
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3556

def array_value
  @array_value
end

#boolean_value ⇒ Boolean Also known as: boolean_value?

A boolean value. Corresponds to the JSON property booleanValue

Returns:

  • (Boolean) 


3561
3562
3563
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3561

def boolean_value
  @boolean_value
end

#bytes_value ⇒ String

A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries. Corresponds to the JSON property bytesValue NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


3569
3570
3571
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3569

def bytes_value
  @bytes_value
end

#double_value ⇒ Float

A double value. Corresponds to the JSON property doubleValue

Returns:

  • (Float) 


3574
3575
3576
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3574

def double_value
  @double_value
end

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



3582
3583
3584
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3582

def geo_point_value
  @geo_point_value
end

#integer_value ⇒ Fixnum

An integer value. Corresponds to the JSON property integerValue

Returns:

  • (Fixnum) 


3587
3588
3589
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3587

def integer_value
  @integer_value
end

#map_value ⇒ Google::Apis::FirestoreV1::MapValue

A map value. Corresponds to the JSON property mapValue

Returns:



3592
3593
3594
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3592

def map_value
  @map_value
end

#null_value ⇒ String

A null value. Corresponds to the JSON property nullValue

Returns:

  • (String) 


3597
3598
3599
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3597

def null_value
  @null_value
end

#reference_value ⇒ String

A reference to a document. For example: projects/project_id/databases/ database_id/documents/document_path`. Corresponds to the JSON propertyreferenceValue`

Returns:

  • (String) 


3603
3604
3605
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3603

def reference_value
  @reference_value
end

#string_value ⇒ String

A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries. Corresponds to the JSON property stringValue

Returns:

  • (String) 


3610
3611
3612
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3610

def string_value
  @string_value
end

#timestamp_value ⇒ String

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

Returns:

  • (String) 


3616
3617
3618
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3616

def timestamp_value
  @timestamp_value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3623

def update!(**args)
  @array_value = args[:array_value] if args.key?(:array_value)
  @boolean_value = args[:boolean_value] if args.key?(:boolean_value)
  @bytes_value = args[:bytes_value] if args.key?(:bytes_value)
  @double_value = args[:double_value] if args.key?(:double_value)
  @geo_point_value = args[:geo_point_value] if args.key?(:geo_point_value)
  @integer_value = args[:integer_value] if args.key?(:integer_value)
  @map_value = args[:map_value] if args.key?(:map_value)
  @null_value = args[:null_value] if args.key?(:null_value)
  @reference_value = args[:reference_value] if args.key?(:reference_value)
  @string_value = args[:string_value] if args.key?(:string_value)
  @timestamp_value = args[:timestamp_value] if args.key?(:timestamp_value)
end