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

Inherits:

Object

• Object
• Google::Apis::FirestoreV1::Cursor

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

lib/google/apis/firestore_v1/classes.rb,
lib/google/apis/firestore_v1/representations.rb,
lib/google/apis/firestore_v1/representations.rb

Overview

A position in a query result set.

Instance Attribute Summary

• #before ⇒ Boolean (also: #before?)

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

• #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.

Instance Method Summary

• #initialize(**args) ⇒ Cursor constructor

  A new instance of Cursor.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ Cursor

Returns a new instance of Cursor.

# File 'lib/google/apis/firestore_v1/classes.rb', line 569

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)

# File 'lib/google/apis/firestore_v1/classes.rb', line 559

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:

• (Array<Google::Apis::FirestoreV1::Value>)

# File 'lib/google/apis/firestore_v1/classes.rb', line 567

def values
  @values
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/firestore_v1/classes.rb', line 574

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