Class: Google::Apis::FirestoreV1::Order

Inherits:

Object

• Object
• Google::Apis::FirestoreV1::Order

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

An order on a field.

Instance Attribute Summary

• #direction ⇒ String

  The direction to order by.

• #field ⇒ Google::Apis::FirestoreV1::FieldReference

  A reference to a field in a document, ex: stats.operations.

Instance Method Summary

• #initialize(**args) ⇒ Order constructor

  A new instance of Order.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ Order

Returns a new instance of Order.

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

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

Instance Attribute Details

#direction ⇒ String

The direction to order by. Defaults to ASCENDING. Corresponds to the JSON property direction

Returns:

• (String)

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

def direction
  @direction
end

#field ⇒ Google::Apis::FirestoreV1::FieldReference

A reference to a field in a document, ex: stats.operations. Corresponds to the JSON property field

Returns:

• (Google::Apis::FirestoreV1::FieldReference)

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

def field
  @field
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

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

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