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



1333
1334
1335
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 1333

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:



1278
1279
1280
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 1278

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.

Returns:

  • (String) 


1287
1288
1289
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 1287

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:



1292
1293
1294
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 1292

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:



1298
1299
1300
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 1298

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) 


1306
1307
1308
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 1306

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) 


1312
1313
1314
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 1312

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:



1317
1318
1319
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 1317

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:



1322
1323
1324
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 1322

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.

Returns:

  • (String) 


1331
1332
1333
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 1331

def start_cursor
  @start_cursor
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 1338

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