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



797
798
799
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 797

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:



790
791
792
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 790

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) 


749
750
751
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 749

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:



762
763
764
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 762

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:



783
784
785
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 783

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) 


757
758
759
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 757

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) 


768
769
770
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 768

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:



795
796
797
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 795

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:



740
741
742
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 740

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) 


777
778
779
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 777

def start_cursor
  @start_cursor
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



802
803
804
805
806
807
808
809
810
811
812
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 802

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