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

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.



1451
1452
1453
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1451

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:



1394
1395
1396
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1394

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) 


1404
1405
1406
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1404

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:



1409
1410
1411
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1409

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:



1415
1416
1417
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1415

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) 


1423
1424
1425
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1423

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) 


1429
1430
1431
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1429

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:



1434
1435
1436
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1434

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:



1439
1440
1441
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1439

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) 


1449
1450
1451
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1449

def start_cursor
  @start_cursor
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
 
# File 'generated/google/apis/datastore_v1beta3/classes.rb', line 1456

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