Class: Google::Apis::DatastoreV1beta3::QueryResultBatch

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 batch of results produced by a query.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ QueryResultBatch

Returns a new instance of QueryResultBatch.



1737
1738
1739
 
# File 'lib/google/apis/datastore_v1beta3/classes.rb', line 1737

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

Instance Attribute Details

#end_cursor ⇒ String

A cursor that points to the position after the last result in the batch. Corresponds to the JSON property endCursor NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


1686
1687
1688
 
# File 'lib/google/apis/datastore_v1beta3/classes.rb', line 1686

def end_cursor
  @end_cursor
end

#entity_result_type ⇒ String

The result type for every entity in entity_results. Corresponds to the JSON property entityResultType

Returns:

  • (String) 


1691
1692
1693
 
# File 'lib/google/apis/datastore_v1beta3/classes.rb', line 1691

def entity_result_type
  @entity_result_type
end

#entity_results ⇒ Array<Google::Apis::DatastoreV1beta3::EntityResult>

The results for this batch. Corresponds to the JSON property entityResults

Returns:



1696
1697
1698
 
# File 'lib/google/apis/datastore_v1beta3/classes.rb', line 1696

def entity_results
  @entity_results
end

#more_results ⇒ String

The state of the query after the current batch. Corresponds to the JSON property moreResults

Returns:

  • (String) 


1701
1702
1703
 
# File 'lib/google/apis/datastore_v1beta3/classes.rb', line 1701

def more_results
  @more_results
end

#read_time ⇒ String

Read timestamp this batch was returned from. This applies to the range of results from the query's start_cursor (or the beginning of the query if no cursor was given) to this batch's end_cursor (not the query's end_cursor). In a single transaction, subsequent query result batches for the same query can have a greater timestamp. Each batch's read timestamp is valid for all preceding batches. This value will not be set for eventually consistent queries in Cloud Datastore. Corresponds to the JSON property readTime

Returns:

  • (String) 


1712
1713
1714
 
# File 'lib/google/apis/datastore_v1beta3/classes.rb', line 1712

def read_time
  @read_time
end

#skipped_cursor ⇒ String

A cursor that points to the position after the last skipped result. Will be set when skipped_results != 0. Corresponds to the JSON property skippedCursor NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


1719
1720
1721
 
# File 'lib/google/apis/datastore_v1beta3/classes.rb', line 1719

def skipped_cursor
  @skipped_cursor
end

#skipped_results ⇒ Fixnum

The number of results skipped, typically because of an offset. Corresponds to the JSON property skippedResults

Returns:

  • (Fixnum) 


1724
1725
1726
 
# File 'lib/google/apis/datastore_v1beta3/classes.rb', line 1724

def skipped_results
  @skipped_results
end

#snapshot_version ⇒ Fixnum

The version number of the snapshot this batch was returned from. This applies to the range of results from the query's start_cursor (or the beginning of the query if no cursor was given) to this batch's end_cursor (not the query' s end_cursor). In a single transaction, subsequent query result batches for the same query can have a greater snapshot version number. Each batch's snapshot version is valid for all preceding batches. The value will be zero for eventually consistent queries. Corresponds to the JSON property snapshotVersion

Returns:

  • (Fixnum) 


1735
1736
1737
 
# File 'lib/google/apis/datastore_v1beta3/classes.rb', line 1735

def snapshot_version
  @snapshot_version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
 
# File 'lib/google/apis/datastore_v1beta3/classes.rb', line 1742

def update!(**args)
  @end_cursor = args[:end_cursor] if args.key?(:end_cursor)
  @entity_result_type = args[:entity_result_type] if args.key?(:entity_result_type)
  @entity_results = args[:entity_results] if args.key?(:entity_results)
  @more_results = args[:more_results] if args.key?(:more_results)
  @read_time = args[:read_time] if args.key?(:read_time)
  @skipped_cursor = args[:skipped_cursor] if args.key?(:skipped_cursor)
  @skipped_results = args[:skipped_results] if args.key?(:skipped_results)
  @snapshot_version = args[:snapshot_version] if args.key?(:snapshot_version)
end