/*
 * Copyright 2025 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.8
package com.google.firestore.v1;

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

  /**
   *
   *
   * <pre>
   * Optional. Whether to execute this query.
   *
   * When false (the default), the query will be planned, returning only
   * metrics from the planning stages.
   *
   * When true, the query will be planned and executed, returning the full
   * query results along with both planning and execution stage metrics.
   * </pre>
   *
   * <code>bool analyze = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
   *
   * @return The analyze.
   */
  boolean getAnalyze();
}
