com.google.firestore.v1.ExecutionStatsOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-firestore-v1 Show documentation
PROTO library for proto-google-cloud-firestore-v1
There is a newer version: 3.29.1
Show newest version
/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/firestore/v1/query_profile.proto

// Protobuf Java Version: 3.25.4
package com.google.firestore.v1;

public interface ExecutionStatsOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.firestore.v1.ExecutionStats)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Total number of results returned, including documents, projections,
   * aggregation results, keys.
   * 
   *
   * int64 results_returned = 1;
   *
   * @return The resultsReturned.
   */
  long getResultsReturned();

  /**
   *
   *
   *    * Total time to execute the query in the backend.
   * 
   *
   * .google.protobuf.Duration execution_duration = 3;
   *
   * @return Whether the executionDuration field is set.
   */
  boolean hasExecutionDuration();
  /**
   *
   *
   *    * Total time to execute the query in the backend.
   * 
   *
   * .google.protobuf.Duration execution_duration = 3;
   *
   * @return The executionDuration.
   */
  com.google.protobuf.Duration getExecutionDuration();
  /**
   *
   *
   *    * Total time to execute the query in the backend.
   * 
   *
   * .google.protobuf.Duration execution_duration = 3;
   */
  com.google.protobuf.DurationOrBuilder getExecutionDurationOrBuilder();

  /**
   *
   *
   *    * Total billable read operations.
   * 
   *
   * int64 read_operations = 4;
   *
   * @return The readOperations.
   */
  long getReadOperations();

  /**
   *
   *
   *    * 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;
   *
   * @return Whether the debugStats field is set.
   */
  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;
   *
   * @return The debugStats.
   */
  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;
   */
  com.google.protobuf.StructOrBuilder getDebugStatsOrBuilder();
}