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
1817 1818 1819 |
# File 'generated/google/apis/datastore_v1/classes.rb', line 1817 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
1760 1761 1762 |
# File 'generated/google/apis/datastore_v1/classes.rb', line 1760 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.
1770 1771 1772 |
# File 'generated/google/apis/datastore_v1/classes.rb', line 1770 def end_cursor @end_cursor end |
#filter ⇒ Google::Apis::DatastoreV1::Filter
A holder for any type of filter.
Corresponds to the JSON property filter
1775 1776 1777 |
# File 'generated/google/apis/datastore_v1/classes.rb', line 1775 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
1781 1782 1783 |
# File 'generated/google/apis/datastore_v1/classes.rb', line 1781 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
1789 1790 1791 |
# File 'generated/google/apis/datastore_v1/classes.rb', line 1789 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
1795 1796 1797 |
# File 'generated/google/apis/datastore_v1/classes.rb', line 1795 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
1800 1801 1802 |
# File 'generated/google/apis/datastore_v1/classes.rb', line 1800 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
1805 1806 1807 |
# File 'generated/google/apis/datastore_v1/classes.rb', line 1805 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.
1815 1816 1817 |
# File 'generated/google/apis/datastore_v1/classes.rb', line 1815 def start_cursor @start_cursor end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 |
# File 'generated/google/apis/datastore_v1/classes.rb', line 1822 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 |