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
- (::String) — A cursor that points to the position after the last result in the batch.
#end_cursor=
def end_cursor=(value) -> ::String
- value (::String) — A cursor that points to the position after the last result in the batch.
- (::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
-
(::Google::Cloud::Datastore::V1::EntityResult::ResultType) — The result type for every entity in
entity_results
.
#entity_result_type=
def entity_result_type=(value) -> ::Google::Cloud::Datastore::V1::EntityResult::ResultType
-
value (::Google::Cloud::Datastore::V1::EntityResult::ResultType) — The result type for every entity in
entity_results
.
-
(::Google::Cloud::Datastore::V1::EntityResult::ResultType) — The result type for every entity in
entity_results
.
#entity_results
def entity_results() -> ::Array<::Google::Cloud::Datastore::V1::EntityResult>
- (::Array<::Google::Cloud::Datastore::V1::EntityResult>) — The results for this batch.
#entity_results=
def entity_results=(value) -> ::Array<::Google::Cloud::Datastore::V1::EntityResult>
- value (::Array<::Google::Cloud::Datastore::V1::EntityResult>) — The results for this batch.
- (::Array<::Google::Cloud::Datastore::V1::EntityResult>) — The results for this batch.
#more_results
def more_results() -> ::Google::Cloud::Datastore::V1::QueryResultBatch::MoreResultsType
- (::Google::Cloud::Datastore::V1::QueryResultBatch::MoreResultsType) — The state of the query after the current batch.
#more_results=
def more_results=(value) -> ::Google::Cloud::Datastore::V1::QueryResultBatch::MoreResultsType
- value (::Google::Cloud::Datastore::V1::QueryResultBatch::MoreResultsType) — The state of the query after the current batch.
- (::Google::Cloud::Datastore::V1::QueryResultBatch::MoreResultsType) — The state of the query after the current batch.
#read_time
def read_time() -> ::Google::Protobuf::Timestamp
-
(::Google::Protobuf::Timestamp) — 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'send_cursor
(not the query'send_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.
#read_time=
def read_time=(value) -> ::Google::Protobuf::Timestamp
-
value (::Google::Protobuf::Timestamp) — 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'send_cursor
(not the query'send_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.
-
(::Google::Protobuf::Timestamp) — 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'send_cursor
(not the query'send_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.
#skipped_cursor
def skipped_cursor() -> ::String
-
(::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
-
value (::String) — A cursor that points to the position after the last skipped result.
Will be set when
skipped_results
!= 0.
-
(::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
- (::Integer) — The number of results skipped, typically because of an offset.
#skipped_results=
def skipped_results=(value) -> ::Integer
- value (::Integer) — The number of results skipped, typically because of an offset.
- (::Integer) — The number of results skipped, typically because of an offset.
#snapshot_version
def snapshot_version() -> ::Integer
-
(::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'send_cursor
(not the query'send_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
-
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'send_cursor
(not the query'send_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.
-
(::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'send_cursor
(not the query'send_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.