Package com.google.firestore.v1

Interface ExecutionStatsOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.Struct
    getDebugStats()
    Debugging statistics from the execution of the query.
    com.google.protobuf.StructOrBuilder
    getDebugStatsOrBuilder()
    Debugging statistics from the execution of the query.
    com.google.protobuf.Duration
    getExecutionDuration()
    Total time to execute the query in the backend.
    com.google.protobuf.DurationOrBuilder
    getExecutionDurationOrBuilder()
    Total time to execute the query in the backend.
    long
    getReadOperations()
    Total billable read operations.
    long
    getResultsReturned()
    Total number of results returned, including documents, projections, aggregation results, keys.
    boolean
    hasDebugStats()
    Debugging statistics from the execution of the query.
    boolean
    hasExecutionDuration()
    Total time to execute the query in the backend.

    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

    • getResultsReturned

      long getResultsReturned()
       Total number of results returned, including documents, projections,
 aggregation results, keys.
      int64 results_returned = 1;
      Returns:
      The resultsReturned.

    • hasExecutionDuration

      boolean hasExecutionDuration()
       Total time to execute the query in the backend.
      .google.protobuf.Duration execution_duration = 3;
      Returns:
      Whether the executionDuration field is set.

    • getExecutionDuration

      com.google.protobuf.Duration getExecutionDuration()
       Total time to execute the query in the backend.
      .google.protobuf.Duration execution_duration = 3;
      Returns:
      The executionDuration.

    • getExecutionDurationOrBuilder

      com.google.protobuf.DurationOrBuilder getExecutionDurationOrBuilder()
       Total time to execute the query in the backend.
      .google.protobuf.Duration execution_duration = 3;

    • getReadOperations

      long getReadOperations()
       Total billable read operations.
      int64 read_operations = 4;
      Returns:
      The readOperations.

    • hasDebugStats

      boolean hasDebugStats()
       Debugging statistics from the execution of the query. Note that the
 debugging stats are subject to change as Firestore evolves. It could
 include:
  {
    "indexes_entries_scanned": "1000",
    "documents_scanned": "20",
    "billing_details" : {
       "documents_billable": "20",
       "index_entries_billable": "1000",
       "min_query_cost": "0"
    }
  }
      .google.protobuf.Struct debug_stats = 5;
      Returns:
      Whether the debugStats field is set.

    • getDebugStats

      com.google.protobuf.Struct getDebugStats()
       Debugging statistics from the execution of the query. Note that the
 debugging stats are subject to change as Firestore evolves. It could
 include:
  {
    "indexes_entries_scanned": "1000",
    "documents_scanned": "20",
    "billing_details" : {
       "documents_billable": "20",
       "index_entries_billable": "1000",
       "min_query_cost": "0"
    }
  }
      .google.protobuf.Struct debug_stats = 5;
      Returns:
      The debugStats.

    • getDebugStatsOrBuilder

      com.google.protobuf.StructOrBuilder getDebugStatsOrBuilder()
       Debugging statistics from the execution of the query. Note that the
 debugging stats are subject to change as Firestore evolves. It could
 include:
  {
    "indexes_entries_scanned": "1000",
    "documents_scanned": "20",
    "billing_details" : {
       "documents_billable": "20",
       "index_entries_billable": "1000",
       "min_query_cost": "0"
    }
  }
      .google.protobuf.Struct debug_stats = 5;