com.google.datastore.v1.QueryResultBatchOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of datastore-v1-protos Show documentation
Protocol buffers for accessing the Google Cloud Datastore API.
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/datastore/v1/query.proto

package com.google.datastore.v1;

public interface QueryResultBatchOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.datastore.v1.QueryResultBatch)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * The number of results skipped, typically because of an offset.
   * 
   *
   * optional int32 skipped_results = 6;
   */
  int getSkippedResults();

  /**
   *    * A cursor that points to the position after the last skipped result.
   * Will be set when `skipped_results` != 0.
   * 
   *
   * optional bytes skipped_cursor = 3;
   */
  com.google.protobuf.ByteString getSkippedCursor();

  /**
   *    * The result type for every entity in `entity_results`.
   * 
   *
   * optional .google.datastore.v1.EntityResult.ResultType entity_result_type = 1;
   */
  int getEntityResultTypeValue();
  /**
   *    * The result type for every entity in `entity_results`.
   * 
   *
   * optional .google.datastore.v1.EntityResult.ResultType entity_result_type = 1;
   */
  com.google.datastore.v1.EntityResult.ResultType getEntityResultType();

  /**
   *    * The results for this batch.
   * 
   *
   * repeated .google.datastore.v1.EntityResult entity_results = 2;
   */
  java.util.List 
      getEntityResultsList();
  /**
   *    * The results for this batch.
   * 
   *
   * repeated .google.datastore.v1.EntityResult entity_results = 2;
   */
  com.google.datastore.v1.EntityResult getEntityResults(int index);
  /**
   *    * The results for this batch.
   * 
   *
   * repeated .google.datastore.v1.EntityResult entity_results = 2;
   */
  int getEntityResultsCount();
  /**
   *    * The results for this batch.
   * 
   *
   * repeated .google.datastore.v1.EntityResult entity_results = 2;
   */
  java.util.List 
      getEntityResultsOrBuilderList();
  /**
   *    * The results for this batch.
   * 
   *
   * repeated .google.datastore.v1.EntityResult entity_results = 2;
   */
  com.google.datastore.v1.EntityResultOrBuilder getEntityResultsOrBuilder(
      int index);

  /**
   *    * A cursor that points to the position after the last result in the batch.
   * 
   *
   * optional bytes end_cursor = 4;
   */
  com.google.protobuf.ByteString getEndCursor();

  /**
   *    * The state of the query after the current batch.
   * 
   *
   * optional .google.datastore.v1.QueryResultBatch.MoreResultsType more_results = 5;
   */
  int getMoreResultsValue();
  /**
   *    * The state of the query after the current batch.
   * 
   *
   * optional .google.datastore.v1.QueryResultBatch.MoreResultsType more_results = 5;
   */
  com.google.datastore.v1.QueryResultBatch.MoreResultsType getMoreResults();

  /**
   *    * 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.
   * 
   *
   * optional int64 snapshot_version = 7;
   */
  long getSnapshotVersion();
}