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

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

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

  /**
   *
   *
   *    * The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
   *
   * The key is the
   * [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
   * assigned to the aggregation function on input and the size of this map
   * equals the number of aggregation functions in the query.
   * 
   *
   * map<string, .google.firestore.v1.Value> aggregate_fields = 2;
   */
  int getAggregateFieldsCount();
  /**
   *
   *
   *    * The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
   *
   * The key is the
   * [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
   * assigned to the aggregation function on input and the size of this map
   * equals the number of aggregation functions in the query.
   * 
   *
   * map<string, .google.firestore.v1.Value> aggregate_fields = 2;
   */
  boolean containsAggregateFields(java.lang.String key);
  /** Use {@link #getAggregateFieldsMap()} instead. */
  @java.lang.Deprecated
  java.util.Map getAggregateFields();
  /**
   *
   *
   *    * The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
   *
   * The key is the
   * [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
   * assigned to the aggregation function on input and the size of this map
   * equals the number of aggregation functions in the query.
   * 
   *
   * map<string, .google.firestore.v1.Value> aggregate_fields = 2;
   */
  java.util.Map getAggregateFieldsMap();
  /**
   *
   *
   *    * The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
   *
   * The key is the
   * [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
   * assigned to the aggregation function on input and the size of this map
   * equals the number of aggregation functions in the query.
   * 
   *
   * map<string, .google.firestore.v1.Value> aggregate_fields = 2;
   */
  /* nullable */
  com.google.firestore.v1.Value getAggregateFieldsOrDefault(
      java.lang.String key,
      /* nullable */
      com.google.firestore.v1.Value defaultValue);
  /**
   *
   *
   *    * The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
   *
   * The key is the
   * [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
   * assigned to the aggregation function on input and the size of this map
   * equals the number of aggregation functions in the query.
   * 
   *
   * map<string, .google.firestore.v1.Value> aggregate_fields = 2;
   */
  com.google.firestore.v1.Value getAggregateFieldsOrThrow(java.lang.String key);
}