Class: Google::Apis::DatastoreV1::Query

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Query

Returns a new instance of Query.



325
326
327
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 325

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

Returns:



293
294
295
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 293

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

Returns:

  • (String) 


286
287
288
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 286

def end_cursor
  @end_cursor
end

#filter ⇒ Google::Apis::DatastoreV1::Filter

A holder for any type of filter. Corresponds to the JSON property filter

Returns:



278
279
280
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 278

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

Returns:



323
324
325
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 323

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

Returns:

  • (Fixnum) 


273
274
275
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 273

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

Returns:

  • (Fixnum) 


299
300
301
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 299

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

Returns:



309
310
311
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 309

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

Returns:



304
305
306
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 304

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

Returns:

  • (String) 


317
318
319
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 317

def start_cursor
  @start_cursor
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



330
331
332
333
334
335
336
337
338
339
340
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 330

def update!(**args)
  @limit = args[:limit] if args.key?(:limit)
  @filter = args[:filter] if args.key?(:filter)
  @end_cursor = args[:end_cursor] if args.key?(:end_cursor)
  @distinct_on = args[:distinct_on] if args.key?(:distinct_on)
  @offset = args[:offset] if args.key?(:offset)
  @projection = args[:projection] if args.key?(:projection)
  @order = args[:order] if args.key?(:order)
  @start_cursor = args[:start_cursor] if args.key?(:start_cursor)
  @kind = args[:kind] if args.key?(:kind)
end