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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/datastore_v1beta3/classes.rb,
lib/google/apis/datastore_v1beta3/representations.rb,
lib/google/apis/datastore_v1beta3/representations.rb

Overview

A query for entities. The query stages are executed in the following order: 1. kind 2. filter 3. projection 4. order + start_cursor + end_cursor 5. offset 6. limit 7. find_nearest

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Query

Returns a new instance of Query.



2023
2024
2025
 
# File 'lib/google/apis/datastore_v1beta3/classes.rb', line 2023

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). Requires: * If order is specified, the set of distinct on properties must appear before the non-distinct on properties in order. Corresponds to the JSON property distinctOn

Returns:



1964
1965
1966
 
# File 'lib/google/apis/datastore_v1beta3/classes.rb', line 1964

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) 


1972
1973
1974
 
# File 'lib/google/apis/datastore_v1beta3/classes.rb', line 1972

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:



1977
1978
1979
 
# File 'lib/google/apis/datastore_v1beta3/classes.rb', line 1977

def filter
  @filter
end

#find_nearest ⇒ Google::Apis::DatastoreV1beta3::FindNearest

Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. Corresponds to the JSON property findNearest

Returns:



1985
1986
1987
 
# File 'lib/google/apis/datastore_v1beta3/classes.rb', line 1985

def find_nearest
  @find_nearest
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:



1991
1992
1993
 
# File 'lib/google/apis/datastore_v1beta3/classes.rb', line 1991

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) 


1997
1998
1999
 
# File 'lib/google/apis/datastore_v1beta3/classes.rb', line 1997

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) 


2003
2004
2005
 
# File 'lib/google/apis/datastore_v1beta3/classes.rb', line 2003

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:



2008
2009
2010
 
# File 'lib/google/apis/datastore_v1beta3/classes.rb', line 2008

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:



2013
2014
2015
 
# File 'lib/google/apis/datastore_v1beta3/classes.rb', line 2013

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) 


2021
2022
2023
 
# File 'lib/google/apis/datastore_v1beta3/classes.rb', line 2021

def start_cursor
  @start_cursor
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
 
# File 'lib/google/apis/datastore_v1beta3/classes.rb', line 2028

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)
  @find_nearest = args[:find_nearest] if args.key?(:find_nearest)
  @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