Class: Google::Apis::DatastoreV1beta3::Query

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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Query

Returns a new instance of Query.



1354
1355
1356
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1354

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

Returns:



1303
1304
1305
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1303

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) 


1311
1312
1313
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1311

def end_cursor
  @end_cursor
end

#filter ⇒ Google::Apis::DatastoreV1beta3::Filter

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

Returns:



1316
1317
1318
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1316

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

Returns:



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

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) 


1328
1329
1330
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1328

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) 


1334
1335
1336
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1334

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

Returns:



1339
1340
1341
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1339

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

Returns:



1344
1345
1346
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1344

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) 


1352
1353
1354
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1352

def start_cursor
  @start_cursor
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1359

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