com.google.firestore.v1.ExplainMetricsOrBuilder 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 ExplainMetricsOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.firestore.v1.ExplainMetrics)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Planning phase information for the query.
   * 
   *
   * .google.firestore.v1.PlanSummary plan_summary = 1;
   *
   * @return Whether the planSummary field is set.
   */
  boolean hasPlanSummary();
  /**
   *
   *
   *    * Planning phase information for the query.
   * 
   *
   * .google.firestore.v1.PlanSummary plan_summary = 1;
   *
   * @return The planSummary.
   */
  com.google.firestore.v1.PlanSummary getPlanSummary();
  /**
   *
   *
   *    * Planning phase information for the query.
   * 
   *
   * .google.firestore.v1.PlanSummary plan_summary = 1;
   */
  com.google.firestore.v1.PlanSummaryOrBuilder getPlanSummaryOrBuilder();

  /**
   *
   *
   *    * Aggregated stats from the execution of the query. Only present when
   * [ExplainOptions.analyze][google.firestore.v1.ExplainOptions.analyze] is set
   * to true.
   * 
   *
   * .google.firestore.v1.ExecutionStats execution_stats = 2;
   *
   * @return Whether the executionStats field is set.
   */
  boolean hasExecutionStats();
  /**
   *
   *
   *    * Aggregated stats from the execution of the query. Only present when
   * [ExplainOptions.analyze][google.firestore.v1.ExplainOptions.analyze] is set
   * to true.
   * 
   *
   * .google.firestore.v1.ExecutionStats execution_stats = 2;
   *
   * @return The executionStats.
   */
  com.google.firestore.v1.ExecutionStats getExecutionStats();
  /**
   *
   *
   *    * Aggregated stats from the execution of the query. Only present when
   * [ExplainOptions.analyze][google.firestore.v1.ExplainOptions.analyze] is set
   * to true.
   * 
   *
   * .google.firestore.v1.ExecutionStats execution_stats = 2;
   */
  com.google.firestore.v1.ExecutionStatsOrBuilder getExecutionStatsOrBuilder();
}