Package com.google.datastore.v1

Interface RunQueryResponseOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
RunQueryResponse, RunQueryResponse.Builder
public interface RunQueryResponseOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    QueryResultBatch
    getBatch()
    A batch of query results (always present).
    QueryResultBatchOrBuilder
    getBatchOrBuilder()
    A batch of query results (always present).
    Query
    getQuery()
    The parsed form of the `GqlQuery` from the request, if it was set.
    QueryOrBuilder
    getQueryOrBuilder()
    The parsed form of the `GqlQuery` from the request, if it was set.
    ResultSetStats
    getStats()
    Query plan and execution statistics.
    ResultSetStatsOrBuilder
    getStatsOrBuilder()
    Query plan and execution statistics.
    com.google.protobuf.ByteString
    getTransaction()
    The identifier of the transaction that was started as part of this RunQuery request.
    boolean
    hasBatch()
    A batch of query results (always present).
    boolean
    hasQuery()
    The parsed form of the `GqlQuery` from the request, if it was set.
    boolean
    hasStats()
    Query plan and execution statistics.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasBatch

      boolean hasBatch()
       A batch of query results (always present).
      .google.datastore.v1.QueryResultBatch batch = 1;
      Returns:
      Whether the batch field is set.

    • getBatch

      QueryResultBatch getBatch()
       A batch of query results (always present).
      .google.datastore.v1.QueryResultBatch batch = 1;
      Returns:
      The batch.

    • getBatchOrBuilder

      QueryResultBatchOrBuilder getBatchOrBuilder()
       A batch of query results (always present).
      .google.datastore.v1.QueryResultBatch batch = 1;

    • hasQuery

      boolean hasQuery()
       The parsed form of the `GqlQuery` from the request, if it was set.
      .google.datastore.v1.Query query = 2;
      Returns:
      Whether the query field is set.

    • getQuery

      Query getQuery()
       The parsed form of the `GqlQuery` from the request, if it was set.
      .google.datastore.v1.Query query = 2;
      Returns:
      The query.

    • getQueryOrBuilder

      QueryOrBuilder getQueryOrBuilder()
       The parsed form of the `GqlQuery` from the request, if it was set.
      .google.datastore.v1.Query query = 2;

    • getTransaction

      com.google.protobuf.ByteString getTransaction()
       The identifier of the transaction that was started as part of this
 RunQuery request.

 Set only when
 [ReadOptions.new_transaction][google.datastore.v1.ReadOptions.new_transaction]
 was set in
 [RunQueryRequest.read_options][google.datastore.v1.RunQueryRequest.read_options].
      bytes transaction = 5;
      Returns:
      The transaction.

    • hasStats

      boolean hasStats()
       Query plan and execution statistics. Note that the returned stats are
 subject to change as Firestore evolves.

 This is only present when the request specifies a mode other than `NORMAL`.
      .google.datastore.v1.ResultSetStats stats = 6;
      Returns:
      Whether the stats field is set.

    • getStats

      ResultSetStats getStats()
       Query plan and execution statistics. Note that the returned stats are
 subject to change as Firestore evolves.

 This is only present when the request specifies a mode other than `NORMAL`.
      .google.datastore.v1.ResultSetStats stats = 6;
      Returns:
      The stats.

    • getStatsOrBuilder

      ResultSetStatsOrBuilder getStatsOrBuilder()
       Query plan and execution statistics. Note that the returned stats are
 subject to change as Firestore evolves.

 This is only present when the request specifies a mode other than `NORMAL`.
      .google.datastore.v1.ResultSetStats stats = 6;