Class: Google::Apis::DatastoreV1::Query
- Inherits:
-
Object
- Object
- Google::Apis::DatastoreV1::Query
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/datastore_v1/classes.rb,
generated/google/apis/datastore_v1/representations.rb,
generated/google/apis/datastore_v1/representations.rb
Overview
A query for entities.
Instance Attribute Summary collapse
-
#distinct_on ⇒ Array<Google::Apis::DatastoreV1::PropertyReference>
The properties to make distinct.
-
#end_cursor ⇒ String
An ending point for the query results.
-
#filter ⇒ Google::Apis::DatastoreV1::Filter
A holder for any type of filter.
-
#kind ⇒ Array<Google::Apis::DatastoreV1::KindExpression>
The kinds to query (if empty, returns entities of all kinds).
-
#limit ⇒ Fixnum
The maximum number of results to return.
-
#offset ⇒ Fixnum
The number of results to skip.
-
#order ⇒ Array<Google::Apis::DatastoreV1::PropertyOrder>
The order to apply to the query results (if empty, order is unspecified).
-
#projection ⇒ Array<Google::Apis::DatastoreV1::Projection>
The projection to return.
-
#start_cursor ⇒ String
A starting point for the query results.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Query
constructor
A new instance of Query.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Query
Returns a new instance of Query.
1777 1778 1779 |
# File 'generated/google/apis/datastore_v1/classes.rb', line 1777 def initialize(**args) update!(**args) end |
Instance Attribute Details
#distinct_on ⇒ Array<Google::Apis::DatastoreV1::PropertyReference>
The properties to make distinct. The query results will contain the first
result for each distinct combination of values for the given properties
(if empty, all results are returned).
Corresponds to the JSON property distinctOn
1720 1721 1722 |
# File 'generated/google/apis/datastore_v1/classes.rb', line 1720 def distinct_on @distinct_on end |
#end_cursor ⇒ String
An ending point for the query results. Query cursors are
returned in query result batches and
can only be used to limit the same
query.
Corresponds to the JSON property endCursor
NOTE: Values are automatically base64 encoded/decoded in the client library.
1730 1731 1732 |
# File 'generated/google/apis/datastore_v1/classes.rb', line 1730 def end_cursor @end_cursor end |
#filter ⇒ Google::Apis::DatastoreV1::Filter
A holder for any type of filter.
Corresponds to the JSON property filter
1735 1736 1737 |
# File 'generated/google/apis/datastore_v1/classes.rb', line 1735 def filter @filter end |
#kind ⇒ Array<Google::Apis::DatastoreV1::KindExpression>
The kinds to query (if empty, returns entities of all kinds).
Currently at most 1 kind may be specified.
Corresponds to the JSON property kind
1741 1742 1743 |
# File 'generated/google/apis/datastore_v1/classes.rb', line 1741 def kind @kind end |
#limit ⇒ Fixnum
The maximum number of results to return. Applies after all other
constraints. Optional.
Unspecified is interpreted as no limit.
Must be >= 0 if specified.
Corresponds to the JSON property limit
1749 1750 1751 |
# File 'generated/google/apis/datastore_v1/classes.rb', line 1749 def limit @limit end |
#offset ⇒ Fixnum
The number of results to skip. Applies before limit, but after all other
constraints. Optional. Must be >= 0 if specified.
Corresponds to the JSON property offset
1755 1756 1757 |
# File 'generated/google/apis/datastore_v1/classes.rb', line 1755 def offset @offset end |
#order ⇒ Array<Google::Apis::DatastoreV1::PropertyOrder>
The order to apply to the query results (if empty, order is unspecified).
Corresponds to the JSON property order
1760 1761 1762 |
# File 'generated/google/apis/datastore_v1/classes.rb', line 1760 def order @order end |
#projection ⇒ Array<Google::Apis::DatastoreV1::Projection>
The projection to return. Defaults to returning all properties.
Corresponds to the JSON property projection
1765 1766 1767 |
# File 'generated/google/apis/datastore_v1/classes.rb', line 1765 def projection @projection end |
#start_cursor ⇒ String
A starting point for the query results. Query cursors are
returned in query result batches and
can only be used to continue the same
query.
Corresponds to the JSON property startCursor
NOTE: Values are automatically base64 encoded/decoded in the client library.
1775 1776 1777 |
# File 'generated/google/apis/datastore_v1/classes.rb', line 1775 def start_cursor @start_cursor end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 |
# File 'generated/google/apis/datastore_v1/classes.rb', line 1782 def update!(**args) @distinct_on = args[:distinct_on] if args.key?(:distinct_on) @end_cursor = args[:end_cursor] if args.key?(:end_cursor) @filter = args[:filter] if args.key?(:filter) @kind = args[:kind] if args.key?(:kind) @limit = args[:limit] if args.key?(:limit) @offset = args[:offset] if args.key?(:offset) @order = args[:order] if args.key?(:order) @projection = args[:projection] if args.key?(:projection) @start_cursor = args[:start_cursor] if args.key?(:start_cursor) end |