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.



1943
1944
1945
 
# File 'lib/google/apis/datastore_v1beta3/classes.rb', line 1943

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) 


1892
1893
1894
 
# File 'lib/google/apis/datastore_v1beta3/classes.rb', line 1892

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) 


1897
1898
1899
 
# File 'lib/google/apis/datastore_v1beta3/classes.rb', line 1897

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:



1902
1903
1904
 
# File 'lib/google/apis/datastore_v1beta3/classes.rb', line 1902

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) 


1907
1908
1909
 
# File 'lib/google/apis/datastore_v1beta3/classes.rb', line 1907

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) 


1918
1919
1920
 
# File 'lib/google/apis/datastore_v1beta3/classes.rb', line 1918

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) 


1925
1926
1927
 
# File 'lib/google/apis/datastore_v1beta3/classes.rb', line 1925

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) 


1930
1931
1932
 
# File 'lib/google/apis/datastore_v1beta3/classes.rb', line 1930

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) 


1941
1942
1943
 
# File 'lib/google/apis/datastore_v1beta3/classes.rb', line 1941

def snapshot_version
  @snapshot_version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
 
# File 'lib/google/apis/datastore_v1beta3/classes.rb', line 1948

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