com.google.firestore.v1.RunAggregationQueryResponseOrBuilder 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/firestore.proto

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

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

  /**
   *
   *
   *    * A single aggregation result.
   *
   * Not present when reporting partial progress.
   * 
   *
   * .google.firestore.v1.AggregationResult result = 1;
   *
   * @return Whether the result field is set.
   */
  boolean hasResult();
  /**
   *
   *
   *    * A single aggregation result.
   *
   * Not present when reporting partial progress.
   * 
   *
   * .google.firestore.v1.AggregationResult result = 1;
   *
   * @return The result.
   */
  com.google.firestore.v1.AggregationResult getResult();
  /**
   *
   *
   *    * A single aggregation result.
   *
   * Not present when reporting partial progress.
   * 
   *
   * .google.firestore.v1.AggregationResult result = 1;
   */
  com.google.firestore.v1.AggregationResultOrBuilder getResultOrBuilder();

  /**
   *
   *
   *    * The transaction that was started as part of this request.
   *
   * Only present on the first response when the request requested to start
   * a new transaction.
   * 
   *
   * bytes transaction = 2;
   *
   * @return The transaction.
   */
  com.google.protobuf.ByteString getTransaction();

  /**
   *
   *
   *    * The time at which the aggregate result was computed. This is always
   * monotonically increasing; in this case, the previous AggregationResult in
   * the result stream are guaranteed not to have changed between their
   * `read_time` and this one.
   *
   * If the query returns no results, a response with `read_time` and no
   * `result` will be sent, and this represents the time at which the query
   * was run.
   * 
   *
   * .google.protobuf.Timestamp read_time = 3;
   *
   * @return Whether the readTime field is set.
   */
  boolean hasReadTime();
  /**
   *
   *
   *    * The time at which the aggregate result was computed. This is always
   * monotonically increasing; in this case, the previous AggregationResult in
   * the result stream are guaranteed not to have changed between their
   * `read_time` and this one.
   *
   * If the query returns no results, a response with `read_time` and no
   * `result` will be sent, and this represents the time at which the query
   * was run.
   * 
   *
   * .google.protobuf.Timestamp read_time = 3;
   *
   * @return The readTime.
   */
  com.google.protobuf.Timestamp getReadTime();
  /**
   *
   *
   *    * The time at which the aggregate result was computed. This is always
   * monotonically increasing; in this case, the previous AggregationResult in
   * the result stream are guaranteed not to have changed between their
   * `read_time` and this one.
   *
   * If the query returns no results, a response with `read_time` and no
   * `result` will be sent, and this represents the time at which the query
   * was run.
   * 
   *
   * .google.protobuf.Timestamp read_time = 3;
   */
  com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder();

  /**
   *
   *
   *    * Query explain metrics. This is only present when the
   * [RunAggregationQueryRequest.explain_options][google.firestore.v1.RunAggregationQueryRequest.explain_options]
   * is provided, and it is sent only once with the last response in the stream.
   * 
   *
   * .google.firestore.v1.ExplainMetrics explain_metrics = 10;
   *
   * @return Whether the explainMetrics field is set.
   */
  boolean hasExplainMetrics();
  /**
   *
   *
   *    * Query explain metrics. This is only present when the
   * [RunAggregationQueryRequest.explain_options][google.firestore.v1.RunAggregationQueryRequest.explain_options]
   * is provided, and it is sent only once with the last response in the stream.
   * 
   *
   * .google.firestore.v1.ExplainMetrics explain_metrics = 10;
   *
   * @return The explainMetrics.
   */
  com.google.firestore.v1.ExplainMetrics getExplainMetrics();
  /**
   *
   *
   *    * Query explain metrics. This is only present when the
   * [RunAggregationQueryRequest.explain_options][google.firestore.v1.RunAggregationQueryRequest.explain_options]
   * is provided, and it is sent only once with the last response in the stream.
   * 
   *
   * .google.firestore.v1.ExplainMetrics explain_metrics = 10;
   */
  com.google.firestore.v1.ExplainMetricsOrBuilder getExplainMetricsOrBuilder();
}