Class: Google::Apis::DatastoreV1beta3::Query
- Inherits:
-
Object
- Object
- Google::Apis::DatastoreV1beta3::Query
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/datastore_v1beta3/classes.rb,
generated/google/apis/datastore_v1beta3/representations.rb,
generated/google/apis/datastore_v1beta3/representations.rb
Overview
A query for entities.
Instance Attribute Summary collapse
-
#distinct_on ⇒ Array<Google::Apis::DatastoreV1beta3::PropertyReference>
The properties to make distinct.
-
#end_cursor ⇒ String
An ending point for the query results.
-
#filter ⇒ Google::Apis::DatastoreV1beta3::Filter
A holder for any type of filter.
-
#kind ⇒ Array<Google::Apis::DatastoreV1beta3::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::DatastoreV1beta3::PropertyOrder>
The order to apply to the query results (if empty, order is unspecified).
-
#projection ⇒ Array<Google::Apis::DatastoreV1beta3::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
1448 1449 1450 |
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1448 def initialize(**args) update!(**args) end |
Instance Attribute Details
#distinct_on ⇒ Array<Google::Apis::DatastoreV1beta3::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
1393 1394 1395 |
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1393 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.
1402 1403 1404 |
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1402 def end_cursor @end_cursor end |
#filter ⇒ Google::Apis::DatastoreV1beta3::Filter
A holder for any type of filter.
Corresponds to the JSON property filter
1407 1408 1409 |
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1407 def filter @filter end |
#kind ⇒ Array<Google::Apis::DatastoreV1beta3::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
1413 1414 1415 |
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1413 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
1421 1422 1423 |
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1421 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
1427 1428 1429 |
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1427 def offset @offset end |
#order ⇒ Array<Google::Apis::DatastoreV1beta3::PropertyOrder>
The order to apply to the query results (if empty, order is unspecified).
Corresponds to the JSON property order
1432 1433 1434 |
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1432 def order @order end |
#projection ⇒ Array<Google::Apis::DatastoreV1beta3::Projection>
The projection to return. Defaults to returning all properties.
Corresponds to the JSON property projection
1437 1438 1439 |
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1437 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.
1446 1447 1448 |
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1446 def start_cursor @start_cursor end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 |
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1453 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 |