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



1675
1676
1677
# File 'generated/google/apis/datastore_v1/classes.rb', line 1675

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#distinct_onArray<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



1620
1621
1622
# File 'generated/google/apis/datastore_v1/classes.rb', line 1620

def distinct_on
  @distinct_on
end

#end_cursorString

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)


1629
1630
1631
# File 'generated/google/apis/datastore_v1/classes.rb', line 1629

def end_cursor
  @end_cursor
end

#filterGoogle::Apis::DatastoreV1::Filter

A holder for any type of filter. Corresponds to the JSON property filter



1634
1635
1636
# File 'generated/google/apis/datastore_v1/classes.rb', line 1634

def filter
  @filter
end

#kindArray<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



1640
1641
1642
# File 'generated/google/apis/datastore_v1/classes.rb', line 1640

def kind
  @kind
end

#limitFixnum

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)


1648
1649
1650
# File 'generated/google/apis/datastore_v1/classes.rb', line 1648

def limit
  @limit
end

#offsetFixnum

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)


1654
1655
1656
# File 'generated/google/apis/datastore_v1/classes.rb', line 1654

def offset
  @offset
end

#orderArray<Google::Apis::DatastoreV1::PropertyOrder>

The order to apply to the query results (if empty, order is unspecified). Corresponds to the JSON property order



1659
1660
1661
# File 'generated/google/apis/datastore_v1/classes.rb', line 1659

def order
  @order
end

#projectionArray<Google::Apis::DatastoreV1::Projection>

The projection to return. Defaults to returning all properties. Corresponds to the JSON property projection



1664
1665
1666
# File 'generated/google/apis/datastore_v1/classes.rb', line 1664

def projection
  @projection
end

#start_cursorString

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)


1673
1674
1675
# File 'generated/google/apis/datastore_v1/classes.rb', line 1673

def start_cursor
  @start_cursor
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
# File 'generated/google/apis/datastore_v1/classes.rb', line 1680

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