Firestore in Datastore mode V1 API - Class Google::Cloud::Datastore::V1::QueryResultBatch (v0.4.0)

Reference documentation and code samples for the Firestore in Datastore mode V1 API class Google::Cloud::Datastore::V1::QueryResultBatch.

A batch of results produced by a query.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#end_cursor

def end_cursor() -> ::String
Returns
  • (::String) — A cursor that points to the position after the last result in the batch.

#end_cursor=

def end_cursor=(value) -> ::String
Parameter
  • value (::String) — A cursor that points to the position after the last result in the batch.
Returns
  • (::String) — A cursor that points to the position after the last result in the batch.

#entity_result_type

def entity_result_type() -> ::Google::Cloud::Datastore::V1::EntityResult::ResultType
Returns

#entity_result_type=

def entity_result_type=(value) -> ::Google::Cloud::Datastore::V1::EntityResult::ResultType
Parameter
Returns

#entity_results

def entity_results() -> ::Array<::Google::Cloud::Datastore::V1::EntityResult>
Returns

#entity_results=

def entity_results=(value) -> ::Array<::Google::Cloud::Datastore::V1::EntityResult>
Parameter
Returns

#more_results

def more_results() -> ::Google::Cloud::Datastore::V1::QueryResultBatch::MoreResultsType
Returns

#more_results=

def more_results=(value) -> ::Google::Cloud::Datastore::V1::QueryResultBatch::MoreResultsType
Parameter
Returns

#skipped_cursor

def skipped_cursor() -> ::String
Returns
  • (::String) — A cursor that points to the position after the last skipped result. Will be set when skipped_results != 0.

#skipped_cursor=

def skipped_cursor=(value) -> ::String
Parameter
  • value (::String) — A cursor that points to the position after the last skipped result. Will be set when skipped_results != 0.
Returns
  • (::String) — A cursor that points to the position after the last skipped result. Will be set when skipped_results != 0.

#skipped_results

def skipped_results() -> ::Integer
Returns
  • (::Integer) — The number of results skipped, typically because of an offset.

#skipped_results=

def skipped_results=(value) -> ::Integer
Parameter
  • value (::Integer) — The number of results skipped, typically because of an offset.
Returns
  • (::Integer) — The number of results skipped, typically because of an offset.

#snapshot_version

def snapshot_version() -> ::Integer
Returns
  • (::Integer) — 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.

#snapshot_version=

def snapshot_version=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.

Returns
  • (::Integer) — 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.