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



208
209
210
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 208

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:



187
188
189
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 187

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) 


206
207
208
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 206

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:



159
160
161
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 159

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:



180
181
182
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 180

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) 


154
155
156
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 154

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) 


174
175
176
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 174

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:



192
193
194
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 192

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:



197
198
199
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 197

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) 


168
169
170
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 168

def start_cursor
  @start_cursor
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



213
214
215
216
217
218
219
220
221
222
223
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 213

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