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.



3286
3287
3288
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3286

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:



3224
3225
3226
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3224

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) 


3229
3230
3231
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3229

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) 


3237
3238
3239
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3237

def bytes_value
  @bytes_value
end

#double_value ⇒ Float

A double value. Corresponds to the JSON property doubleValue

Returns:

  • (Float) 


3242
3243
3244
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3242

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:



3250
3251
3252
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3250

def geo_point_value
  @geo_point_value
end

#integer_value ⇒ Fixnum

An integer value. Corresponds to the JSON property integerValue

Returns:

  • (Fixnum) 


3255
3256
3257
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3255

def integer_value
  @integer_value
end

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

A map value. Corresponds to the JSON property mapValue

Returns:



3260
3261
3262
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3260

def map_value
  @map_value
end

#null_value ⇒ String

A null value. Corresponds to the JSON property nullValue

Returns:

  • (String) 


3265
3266
3267
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3265

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) 


3271
3272
3273
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3271

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) 


3278
3279
3280
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3278

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) 


3284
3285
3286
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3284

def timestamp_value
  @timestamp_value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 3291

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