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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/datastore_v1/classes.rb,
lib/google/apis/datastore_v1/representations.rb,
lib/google/apis/datastore_v1/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.



1850
1851
1852
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 1850

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:



1799
1800
1801
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 1799

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) 


1807
1808
1809
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 1807

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:



1812
1813
1814
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 1812

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:



1818
1819
1820
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 1818

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) 


1824
1825
1826
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 1824

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) 


1830
1831
1832
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 1830

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:



1835
1836
1837
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 1835

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:



1840
1841
1842
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 1840

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) 


1848
1849
1850
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 1848

def start_cursor
  @start_cursor
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
 
# File 'lib/google/apis/datastore_v1/classes.rb', line 1855

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