google_api_datastore v0.1.0 GoogleApi.Datastore.V1.Model.QueryResultBatch View Source

A batch of results produced by a query.

Attributes

  • endCursor (binary()): A cursor that points to the position after the last result in the batch. Defaults to: null.
  • entityResultType (String.t): The result type for every entity in `entity_results`. Defaults to: null.

    • Enum - one of [RESULT_TYPE_UNSPECIFIED, FULL, PROJECTION, KEY_ONLY]
  • entityResults ([EntityResult]): The results for this batch. Defaults to: null.
  • moreResults (String.t): The state of the query after the current batch. Defaults to: null.

    • Enum - one of [MORE_RESULTS_TYPE_UNSPECIFIED, NOT_FINISHED, MORE_RESULTS_AFTER_LIMIT, MORE_RESULTS_AFTER_CURSOR, NO_MORE_RESULTS]
  • skippedCursor (binary()): A cursor that points to the position after the last skipped result. Will be set when `skipped_results` != 0. Defaults to: null.
  • skippedResults (integer()): The number of results skipped, typically because of an offset. Defaults to: null.
  • snapshotVersion (String.t): 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. Defaults to: null.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields

Link to this section Types

Link to this type t() View Source
t() :: %GoogleApi.Datastore.V1.Model.QueryResultBatch{
  endCursor: any(),
  entityResultType: any(),
  entityResults: [GoogleApi.Datastore.V1.Model.EntityResult.t()],
  moreResults: any(),
  skippedCursor: any(),
  skippedResults: any(),
  snapshotVersion: any()
}

Link to this section Functions

Link to this function decode(value, options) View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.