Class: Google::Apis::FirestoreV1beta1::Function

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

Represents an unevaluated scalar expression. For example, the expression like( user_name, "%alice%") is represented as: name: "like" args ` field_reference: "user_name" ` args ` string_value: "%alice%" `

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Function

Returns a new instance of Function.



1301
1302
1303
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 1301

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

Instance Attribute Details

#args ⇒ Array<Google::Apis::FirestoreV1beta1::Value>

Optional. Ordered list of arguments the given function expects. Corresponds to the JSON property args

Returns:



1288
1289
1290
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 1288

def args
  @args
end

#name ⇒ String

Required. The name of the function to evaluate. Requires: * must be in snake case (lower case with underscore separator). Corresponds to the JSON property name

Returns:

  • (String) 


1294
1295
1296
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 1294

def name
  @name
end

#options ⇒ Hash<String,Google::Apis::FirestoreV1beta1::Value>

Optional. Optional named arguments that certain functions may support. Corresponds to the JSON property options

Returns:



1299
1300
1301
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 1299

def options
  @options
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1306
1307
1308
1309
1310
 
# File 'lib/google/apis/firestore_v1beta1/classes.rb', line 1306

def update!(**args)
  @args = args[:args] if args.key?(:args)
  @name = args[:name] if args.key?(:name)
  @options = args[:options] if args.key?(:options)
end