feat: Add OR query support (#1198)

* feat: Add `OR` query support docs: Improve the API documentation for the `Firestore.ListDocuments` RPC docs: Minor documentation formatting and cleanup PiperOrigin-RevId: 509631855 Source-Link: googleapis/googleapis@22bd888 Source-Link: https://github.com/googleapis/googleapis-gen/commit/8b14516619c48e1ddabcec1aec55ac0257364102 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiOGIxNDUxNjYxOWM0OGUxZGRhYmNlYzFhZWM1NWFjMDI1NzM2NDEwMiJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
googleapis · Feb 15, 2023 · 566b788 · 566b788
1 parent 0f39321
commit 566b788
Show file tree

Hide file tree

Showing 58 changed files with 1,376 additions and 909 deletions.
diff --git a/README.md b/README.md
@@ -49,7 +49,7 @@ If you are using Maven without BOM, add this to your dependencies:
 If you are using Gradle 5.x or later, add this to your dependencies:
 
 ```Groovy
-implementation platform('com.google.cloud:libraries-bom:26.7.0')
+implementation platform('com.google.cloud:libraries-bom:26.8.0')
 
 implementation 'com.google.cloud:google-cloud-firestore'
 ```

diff --git a/google-cloud-firestore/src/main/java/com/google/cloud/firestore/v1/FirestoreClient.java b/google-cloud-firestore/src/main/java/com/google/cloud/firestore/v1/FirestoreClient.java
@@ -74,7 +74,7 @@
  * <p>Cloud Firestore is a fast, fully managed, serverless, cloud-native NoSQL document database
  * that simplifies storing, syncing, and querying data for your mobile, web, and IoT apps at global
  * scale. Its client libraries provide live synchronization and offline support, while its security
- * features and integrations with Firebase and Google Cloud Platform (GCP) accelerate building truly
+ * features and integrations with Firebase and Google Cloud Platform accelerate building truly
  * serverless apps.
  *
  * <p>This class provides the ability to make remote calls to the backing service through method
@@ -1039,7 +1039,8 @@ public final PartitionQueryPagedResponse partitionQuery(PartitionQueryRequest re
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD.
   /**
-   * Streams batches of document updates and deletes, in order.
+   * Streams batches of document updates and deletes, in order. This method is only available via
+   * the gRPC API (not REST).
    *
    * <p>Sample code:
    *
@@ -1072,7 +1073,7 @@ public final BidiStreamingCallable<WriteRequest, WriteResponse> writeCallable()
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD.
   /**
-   * Listens to changes.
+   * Listens to changes. This method is only available via the gRPC API (not REST).
    *
    * <p>Sample code:
    *

diff --git a/google-cloud-firestore/src/main/java/com/google/cloud/firestore/v1/package-info.java b/google-cloud-firestore/src/main/java/com/google/cloud/firestore/v1/package-info.java
@@ -26,7 +26,7 @@
  * <p>Cloud Firestore is a fast, fully managed, serverless, cloud-native NoSQL document database
  * that simplifies storing, syncing, and querying data for your mobile, web, and IoT apps at global
  * scale. Its client libraries provide live synchronization and offline support, while its security
- * features and integrations with Firebase and Google Cloud Platform (GCP) accelerate building truly
+ * features and integrations with Firebase and Google Cloud Platform accelerate building truly
  * serverless apps.
  *
  * <p>Sample for FirestoreClient:

diff --git a/grpc-google-cloud-firestore-v1/src/main/java/com/google/firestore/v1/FirestoreGrpc.java b/grpc-google-cloud-firestore-v1/src/main/java/com/google/firestore/v1/FirestoreGrpc.java
@@ -26,8 +26,8 @@
  * document database that simplifies storing, syncing, and querying data for
  * your mobile, web, and IoT apps at global scale. Its client libraries provide
  * live synchronization and offline support, while its security features and
- * integrations with Firebase and Google Cloud Platform (GCP) accelerate
- * building truly serverless apps.
+ * integrations with Firebase and Google Cloud Platform accelerate building
+ * truly serverless apps.
  * </pre>
  */
 @javax.annotation.Generated(
@@ -772,8 +772,8 @@ public FirestoreFutureStub newStub(
    * document database that simplifies storing, syncing, and querying data for
    * your mobile, web, and IoT apps at global scale. Its client libraries provide
    * live synchronization and offline support, while its security features and
-   * integrations with Firebase and Google Cloud Platform (GCP) accelerate
-   * building truly serverless apps.
+   * integrations with Firebase and Google Cloud Platform accelerate building
+   * truly serverless apps.
    * </pre>
    */
   public abstract static class FirestoreImplBase implements io.grpc.BindableService {
@@ -911,8 +911,9 @@ public void runQuery(
      *
      * <pre>
      * Runs an aggregation query.
-     * Rather than producing [Document][google.firestore.v1.Document] results like [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery],
-     * this API allows running an aggregation to produce a series of
+     * Rather than producing [Document][google.firestore.v1.Document] results like
+     * [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery], this API
+     * allows running an aggregation to produce a series of
      * [AggregationResult][google.firestore.v1.AggregationResult] server-side.
      * High-Level Example:
      * ```
@@ -950,7 +951,8 @@ public void partitionQuery(
      *
      *
      * <pre>
-     * Streams batches of document updates and deletes, in order.
+     * Streams batches of document updates and deletes, in order. This method is
+     * only available via the gRPC API (not REST).
      * </pre>
      */
     public io.grpc.stub.StreamObserver<com.google.firestore.v1.WriteRequest> write(
@@ -963,7 +965,8 @@ public io.grpc.stub.StreamObserver<com.google.firestore.v1.WriteRequest> write(
      *
      *
      * <pre>
-     * Listens to changes.
+     * Listens to changes. This method is only available via the gRPC API (not
+     * REST).
      * </pre>
      */
     public io.grpc.stub.StreamObserver<com.google.firestore.v1.ListenRequest> listen(
@@ -995,7 +998,8 @@ public void listCollectionIds(
      * The BatchWrite method does not apply the write operations atomically
      * and can apply them out of order. Method does not allow more than one write
      * per document. Each write succeeds or fails independently. See the
-     * [BatchWriteResponse][google.firestore.v1.BatchWriteResponse] for the success status of each write.
+     * [BatchWriteResponse][google.firestore.v1.BatchWriteResponse] for the
+     * success status of each write.
      * If you require an atomically applied set of writes, use
      * [Commit][google.firestore.v1.Firestore.Commit] instead.
      * </pre>
@@ -1138,8 +1142,8 @@ public final io.grpc.ServerServiceDefinition bindService() {
    * document database that simplifies storing, syncing, and querying data for
    * your mobile, web, and IoT apps at global scale. Its client libraries provide
    * live synchronization and offline support, while its security features and
-   * integrations with Firebase and Google Cloud Platform (GCP) accelerate
-   * building truly serverless apps.
+   * integrations with Firebase and Google Cloud Platform accelerate building
+   * truly serverless apps.
    * </pre>
    */
   public static final class FirestoreStub extends io.grpc.stub.AbstractAsyncStub<FirestoreStub> {
@@ -1300,8 +1304,9 @@ public void runQuery(
      *
      * <pre>
      * Runs an aggregation query.
-     * Rather than producing [Document][google.firestore.v1.Document] results like [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery],
-     * this API allows running an aggregation to produce a series of
+     * Rather than producing [Document][google.firestore.v1.Document] results like
+     * [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery], this API
+     * allows running an aggregation to produce a series of
      * [AggregationResult][google.firestore.v1.AggregationResult] server-side.
      * High-Level Example:
      * ```
@@ -1343,7 +1348,8 @@ public void partitionQuery(
      *
      *
      * <pre>
-     * Streams batches of document updates and deletes, in order.
+     * Streams batches of document updates and deletes, in order. This method is
+     * only available via the gRPC API (not REST).
      * </pre>
      */
     public io.grpc.stub.StreamObserver<com.google.firestore.v1.WriteRequest> write(
@@ -1356,7 +1362,8 @@ public io.grpc.stub.StreamObserver<com.google.firestore.v1.WriteRequest> write(
      *
      *
      * <pre>
-     * Listens to changes.
+     * Listens to changes. This method is only available via the gRPC API (not
+     * REST).
      * </pre>
      */
     public io.grpc.stub.StreamObserver<com.google.firestore.v1.ListenRequest> listen(
@@ -1390,7 +1397,8 @@ public void listCollectionIds(
      * The BatchWrite method does not apply the write operations atomically
      * and can apply them out of order. Method does not allow more than one write
      * per document. Each write succeeds or fails independently. See the
-     * [BatchWriteResponse][google.firestore.v1.BatchWriteResponse] for the success status of each write.
+     * [BatchWriteResponse][google.firestore.v1.BatchWriteResponse] for the
+     * success status of each write.
      * If you require an atomically applied set of writes, use
      * [Commit][google.firestore.v1.Firestore.Commit] instead.
      * </pre>
@@ -1428,8 +1436,8 @@ public void createDocument(
    * document database that simplifies storing, syncing, and querying data for
    * your mobile, web, and IoT apps at global scale. Its client libraries provide
    * live synchronization and offline support, while its security features and
-   * integrations with Firebase and Google Cloud Platform (GCP) accelerate
-   * building truly serverless apps.
+   * integrations with Firebase and Google Cloud Platform accelerate building
+   * truly serverless apps.
    * </pre>
    */
   public static final class FirestoreBlockingStub
@@ -1567,8 +1575,9 @@ public java.util.Iterator<com.google.firestore.v1.RunQueryResponse> runQuery(
      *
      * <pre>
      * Runs an aggregation query.
-     * Rather than producing [Document][google.firestore.v1.Document] results like [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery],
-     * this API allows running an aggregation to produce a series of
+     * Rather than producing [Document][google.firestore.v1.Document] results like
+     * [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery], this API
+     * allows running an aggregation to produce a series of
      * [AggregationResult][google.firestore.v1.AggregationResult] server-side.
      * High-Level Example:
      * ```
@@ -1619,7 +1628,8 @@ public com.google.firestore.v1.ListCollectionIdsResponse listCollectionIds(
      * The BatchWrite method does not apply the write operations atomically
      * and can apply them out of order. Method does not allow more than one write
      * per document. Each write succeeds or fails independently. See the
-     * [BatchWriteResponse][google.firestore.v1.BatchWriteResponse] for the success status of each write.
+     * [BatchWriteResponse][google.firestore.v1.BatchWriteResponse] for the
+     * success status of each write.
      * If you require an atomically applied set of writes, use
      * [Commit][google.firestore.v1.Firestore.Commit] instead.
      * </pre>
@@ -1653,8 +1663,8 @@ public com.google.firestore.v1.Document createDocument(
    * document database that simplifies storing, syncing, and querying data for
    * your mobile, web, and IoT apps at global scale. Its client libraries provide
    * live synchronization and offline support, while its security features and
-   * integrations with Firebase and Google Cloud Platform (GCP) accelerate
-   * building truly serverless apps.
+   * integrations with Firebase and Google Cloud Platform accelerate building
+   * truly serverless apps.
    * </pre>
    */
   public static final class FirestoreFutureStub
@@ -1800,7 +1810,8 @@ public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Em
      * The BatchWrite method does not apply the write operations atomically
      * and can apply them out of order. Method does not allow more than one write
      * per document. Each write succeeds or fails independently. See the
-     * [BatchWriteResponse][google.firestore.v1.BatchWriteResponse] for the success status of each write.
+     * [BatchWriteResponse][google.firestore.v1.BatchWriteResponse] for the
+     * success status of each write.
      * If you require an atomically applied set of writes, use
      * [Commit][google.firestore.v1.Firestore.Commit] instead.
      * </pre>

diff --git a/proto-google-cloud-firestore-v1/src/main/java/com/google/firestore/v1/AggregationResult.java b/proto-google-cloud-firestore-v1/src/main/java/com/google/firestore/v1/AggregationResult.java
@@ -115,7 +115,8 @@ public int getAggregateFieldsCount() {
    *
    * <pre>
    * The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
-   * The key is the [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
+   * 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.
    * </pre>
@@ -140,7 +141,8 @@ public java.util.Map<java.lang.String, com.google.firestore.v1.Value> getAggrega
    *
    * <pre>
    * The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
-   * The key is the [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
+   * 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.
    * </pre>
@@ -156,7 +158,8 @@ public java.util.Map<java.lang.String, com.google.firestore.v1.Value> getAggrega
    *
    * <pre>
    * The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
-   * The key is the [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
+   * 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.
    * </pre>
@@ -180,7 +183,8 @@ public java.util.Map<java.lang.String, com.google.firestore.v1.Value> getAggrega
    *
    * <pre>
    * The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
-   * The key is the [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
+   * 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.
    * </pre>
@@ -613,7 +617,8 @@ public int getAggregateFieldsCount() {
      *
      * <pre>
      * The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
-     * The key is the [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
+     * 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.
      * </pre>
@@ -638,7 +643,8 @@ public java.util.Map<java.lang.String, com.google.firestore.v1.Value> getAggrega
      *
      * <pre>
      * The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
-     * The key is the [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
+     * 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.
      * </pre>
@@ -654,7 +660,8 @@ public java.util.Map<java.lang.String, com.google.firestore.v1.Value> getAggrega
      *
      * <pre>
      * The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
-     * The key is the [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
+     * 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.
      * </pre>
@@ -678,7 +685,8 @@ public java.util.Map<java.lang.String, com.google.firestore.v1.Value> getAggrega
      *
      * <pre>
      * The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
-     * The key is the [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
+     * 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.
      * </pre>
@@ -708,7 +716,8 @@ public Builder clearAggregateFields() {
      *
      * <pre>
      * The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
-     * The key is the [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
+     * 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.
      * </pre>
@@ -734,7 +743,8 @@ public Builder removeAggregateFields(java.lang.String key) {
      *
      * <pre>
      * The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
-     * The key is the [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
+     * 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.
      * </pre>
@@ -757,7 +767,8 @@ public Builder putAggregateFields(java.lang.String key, com.google.firestore.v1.
      *
      * <pre>
      * The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
-     * The key is the [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
+     * 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.
      * </pre>

diff --git a/...-cloud-firestore-v1/src/main/java/com/google/firestore/v1/AggregationResultOrBuilder.java b/...-cloud-firestore-v1/src/main/java/com/google/firestore/v1/AggregationResultOrBuilder.java
@@ -28,7 +28,8 @@ public interface AggregationResultOrBuilder
    *
    * <pre>
    * The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
-   * The key is the [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
+   * 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.
    * </pre>
@@ -41,7 +42,8 @@ public interface AggregationResultOrBuilder
    *
    * <pre>
    * The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
-   * The key is the [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
+   * 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.
    * </pre>
@@ -57,7 +59,8 @@ public interface AggregationResultOrBuilder
    *
    * <pre>
    * The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
-   * The key is the [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
+   * 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.
    * </pre>
@@ -70,7 +73,8 @@ public interface AggregationResultOrBuilder
    *
    * <pre>
    * The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
-   * The key is the [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
+   * 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.
    * </pre>
@@ -87,7 +91,8 @@ com.google.firestore.v1.Value getAggregateFieldsOrDefault(
    *
    * <pre>
    * The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
-   * The key is the [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
+   * 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.
    * </pre>