Class: Google::Apis::FirestoreV1::Cursor

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 position in a query result set.

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

Returns a new instance of Cursor



307
308
309
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 307

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

Instance Attribute Details

#before ⇒ Boolean Also known as: before?

If the position is just before or just after the given values, relative to the sort order defined by the query. Corresponds to the JSON property before

Returns:

  • (Boolean) 


297
298
299
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 297

def before
  @before
end

#values ⇒ Array<Google::Apis::FirestoreV1::Value>

The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause. Corresponds to the JSON property values

Returns:



305
306
307
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 305

def values
  @values
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



312
313
314
315
 
# File 'generated/google/apis/firestore_v1/classes.rb', line 312

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