Class: Google::Apis::FirestoreV1::FieldFilter

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

Overview

A filter on a specific field.

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) ⇒ FieldFilter

Returns a new instance of FieldFilter



628
629
630
# File 'generated/google/apis/firestore_v1/classes.rb', line 628

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

Instance Attribute Details

#fieldGoogle::Apis::FirestoreV1::FieldReference

A reference to a field, such as max(messages.time) as max_time. Corresponds to the JSON property field



616
617
618
# File 'generated/google/apis/firestore_v1/classes.rb', line 616

def field
  @field
end

#opString

The operator to filter by. Corresponds to the JSON property op

Returns:

  • (String)


621
622
623
# File 'generated/google/apis/firestore_v1/classes.rb', line 621

def op
  @op
end

#valueGoogle::Apis::FirestoreV1::Value

A message that can hold any of the supported value types. Corresponds to the JSON property value



626
627
628
# File 'generated/google/apis/firestore_v1/classes.rb', line 626

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



633
634
635
636
637
# File 'generated/google/apis/firestore_v1/classes.rb', line 633

def update!(**args)
  @field = args[:field] if args.key?(:field)
  @op = args[:op] if args.key?(:op)
  @value = args[:value] if args.key?(:value)
end