Class: Google::Apis::FirestoreV1beta1::Value

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

Overview

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

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.



2013
2014
2015
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 2013

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

Instance Attribute Details

#array_value ⇒ Google::Apis::FirestoreV1beta1::ArrayValue

An array value. Corresponds to the JSON property arrayValue

Returns:



1947
1948
1949
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1947

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) 


1952
1953
1954
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1952

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) 


1961
1962
1963
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1961

def bytes_value
  @bytes_value
end

#double_value ⇒ Float

A double value. Corresponds to the JSON property doubleValue

Returns:

  • (Float) 


1966
1967
1968
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1966

def double_value
  @double_value
end

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



1975
1976
1977
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1975

def geo_point_value
  @geo_point_value
end

#integer_value ⇒ Fixnum

An integer value. Corresponds to the JSON property integerValue

Returns:

  • (Fixnum) 


1980
1981
1982
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1980

def integer_value
  @integer_value
end

#map_value ⇒ Google::Apis::FirestoreV1beta1::MapValue

A map value. Corresponds to the JSON property mapValue

Returns:



1985
1986
1987
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1985

def map_value
  @map_value
end

#null_value ⇒ String

A null value. Corresponds to the JSON property nullValue

Returns:

  • (String) 


1990
1991
1992
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1990

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) 


1996
1997
1998
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 1996

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) 


2004
2005
2006
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 2004

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) 


2011
2012
2013
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 2011

def timestamp_value
  @timestamp_value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
 
# File 'generated/google/apis/firestore_v1beta1/classes.rb', line 2018

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