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.



2836
2837
2838
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2836

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:



2774
2775
2776
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2774

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) 


2779
2780
2781
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2779

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) 


2787
2788
2789
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2787

def bytes_value
  @bytes_value
end

#double_value ⇒ Float

A double value. Corresponds to the JSON property doubleValue

Returns:

  • (Float) 


2792
2793
2794
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2792

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:



2800
2801
2802
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2800

def geo_point_value
  @geo_point_value
end

#integer_value ⇒ Fixnum

An integer value. Corresponds to the JSON property integerValue

Returns:

  • (Fixnum) 


2805
2806
2807
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2805

def integer_value
  @integer_value
end

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

A map value. Corresponds to the JSON property mapValue

Returns:



2810
2811
2812
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2810

def map_value
  @map_value
end

#null_value ⇒ String

A null value. Corresponds to the JSON property nullValue

Returns:

  • (String) 


2815
2816
2817
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2815

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) 


2821
2822
2823
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2821

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) 


2828
2829
2830
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2828

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) 


2834
2835
2836
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2834

def timestamp_value
  @timestamp_value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 2841

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