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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/firestore_v1beta1/classes.rb,
lib/google/apis/firestore_v1beta1/representations.rb,
lib/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

Constructor Details

#initialize(**args) ⇒ Value

Returns a new instance of Value.



2136
2137
2138
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2136

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:



2074
2075
2076
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2074

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) 


2079
2080
2081
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2079

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) 


2087
2088
2089
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2087

def bytes_value
  @bytes_value
end

#double_value ⇒ Float

A double value. Corresponds to the JSON property doubleValue

Returns:

  • (Float) 


2092
2093
2094
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2092

def double_value
  @double_value
end

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



2100
2101
2102
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2100

def geo_point_value
  @geo_point_value
end

#integer_value ⇒ Fixnum

An integer value. Corresponds to the JSON property integerValue

Returns:

  • (Fixnum) 


2105
2106
2107
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2105

def integer_value
  @integer_value
end

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

A map value. Corresponds to the JSON property mapValue

Returns:



2110
2111
2112
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2110

def map_value
  @map_value
end

#null_value ⇒ String

A null value. Corresponds to the JSON property nullValue

Returns:

  • (String) 


2115
2116
2117
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2115

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) 


2121
2122
2123
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2121

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) 


2128
2129
2130
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2128

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) 


2134
2135
2136
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2134

def timestamp_value
  @timestamp_value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 2141

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