Class: Google::Apis::DatastoreV1::QueryResultBatch

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

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) ⇒ QueryResultBatch

Returns a new instance of QueryResultBatch



596
597
598
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 596

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) 


560
561
562
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 560

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) 


594
595
596
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 594

def entity_result_type
  @entity_result_type
end

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

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

Returns:



554
555
556
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 554

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) 


565
566
567
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 565

def more_results
  @more_results
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) 


584
585
586
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 584

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) 


589
590
591
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 589

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) 


577
578
579
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 577

def snapshot_version
  @snapshot_version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



601
602
603
604
605
606
607
608
609
 
# File 'generated/google/apis/datastore_v1/classes.rb', line 601

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