class Google::Apis::FirestoreV1beta1::StructuredQuery

A Firestore query.

Attributes

end_at[RW]

A position in a query result set. Corresponds to the JSON property `endAt` @return [Google::Apis::FirestoreV1beta1::Cursor]

from[RW]

The collections to query. Corresponds to the JSON property `from` @return [Array<Google::Apis::FirestoreV1beta1::CollectionSelector>]

limit[RW]

The maximum number of results to return. Applies after all other constraints. Must be >= 0 if specified. Corresponds to the JSON property `limit` @return [Fixnum]

offset[RW]

The number of results to skip. Applies before limit, but after all other constraints. Must be >= 0 if specified. Corresponds to the JSON property `offset` @return [Fixnum]

order_by[RW]

The order to apply to the query results. Firestore guarantees a stable ordering through the following rules: * Any field required to appear in ` order_by`, that is not already specified in `order_by`, is appended to the order in field name order by default. * If an order on `__name__` is not specified, it is appended by default. Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example: * `SELECT * FROM Foo ORDER BY A` becomes `SELECT * FROM Foo ORDER BY A, __name__` * `SELECT * FROM Foo ORDER BY A DESC` becomes ` SELECT * FROM Foo ORDER BY A DESC, __name__ DESC` * `SELECT * FROM Foo WHERE A > 1` becomes `SELECT * FROM Foo WHERE A > 1 ORDER BY A, __name__` Corresponds to the JSON property `orderBy` @return [Array<Google::Apis::FirestoreV1beta1::Order>]

select[RW]

The projection of document's fields to return. Corresponds to the JSON property `select` @return [Google::Apis::FirestoreV1beta1::Projection]

start_at[RW]

A position in a query result set. Corresponds to the JSON property `startAt` @return [Google::Apis::FirestoreV1beta1::Cursor]

where[RW]

A filter. Corresponds to the JSON property `where` @return [Google::Apis::FirestoreV1beta1::Filter]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/firestore_v1beta1/classes.rb, line 1854
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/firestore_v1beta1/classes.rb, line 1859
def update!(**args)
  @end_at = args[:end_at] if args.key?(:end_at)
  @from = args[:from] if args.key?(:from)
  @limit = args[:limit] if args.key?(:limit)
  @offset = args[:offset] if args.key?(:offset)
  @order_by = args[:order_by] if args.key?(:order_by)
  @select = args[:select] if args.key?(:select)
  @start_at = args[:start_at] if args.key?(:start_at)
  @where = args[:where] if args.key?(:where)
end