Skip to content

Commit 566b788

Browse files
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>
1 parent 0f39321 commit 566b788

File tree

58 files changed

+1376
-909
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+1376
-909
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ If you are using Maven without BOM, add this to your dependencies:
4949
If you are using Gradle 5.x or later, add this to your dependencies:
5050

5151
```Groovy
52-
implementation platform('com.google.cloud:libraries-bom:26.7.0')
52+
implementation platform('com.google.cloud:libraries-bom:26.8.0')
5353
5454
implementation 'com.google.cloud:google-cloud-firestore'
5555
```

google-cloud-firestore/src/main/java/com/google/cloud/firestore/v1/FirestoreClient.java

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@
7474
* <p>Cloud Firestore is a fast, fully managed, serverless, cloud-native NoSQL document database
7575
* that simplifies storing, syncing, and querying data for your mobile, web, and IoT apps at global
7676
* scale. Its client libraries provide live synchronization and offline support, while its security
77-
* features and integrations with Firebase and Google Cloud Platform (GCP) accelerate building truly
77+
* features and integrations with Firebase and Google Cloud Platform accelerate building truly
7878
* serverless apps.
7979
*
8080
* <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
10391039

10401040
// AUTO-GENERATED DOCUMENTATION AND METHOD.
10411041
/**
1042-
* Streams batches of document updates and deletes, in order.
1042+
* Streams batches of document updates and deletes, in order. This method is only available via
1043+
* the gRPC API (not REST).
10431044
*
10441045
* <p>Sample code:
10451046
*
@@ -1072,7 +1073,7 @@ public final BidiStreamingCallable<WriteRequest, WriteResponse> writeCallable()
10721073

10731074
// AUTO-GENERATED DOCUMENTATION AND METHOD.
10741075
/**
1075-
* Listens to changes.
1076+
* Listens to changes. This method is only available via the gRPC API (not REST).
10761077
*
10771078
* <p>Sample code:
10781079
*

google-cloud-firestore/src/main/java/com/google/cloud/firestore/v1/package-info.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
* <p>Cloud Firestore is a fast, fully managed, serverless, cloud-native NoSQL document database
2727
* that simplifies storing, syncing, and querying data for your mobile, web, and IoT apps at global
2828
* scale. Its client libraries provide live synchronization and offline support, while its security
29-
* features and integrations with Firebase and Google Cloud Platform (GCP) accelerate building truly
29+
* features and integrations with Firebase and Google Cloud Platform accelerate building truly
3030
* serverless apps.
3131
*
3232
* <p>Sample for FirestoreClient:

grpc-google-cloud-firestore-v1/src/main/java/com/google/firestore/v1/FirestoreGrpc.java

Lines changed: 35 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@
2626
* document database that simplifies storing, syncing, and querying data for
2727
* your mobile, web, and IoT apps at global scale. Its client libraries provide
2828
* live synchronization and offline support, while its security features and
29-
* integrations with Firebase and Google Cloud Platform (GCP) accelerate
30-
* building truly serverless apps.
29+
* integrations with Firebase and Google Cloud Platform accelerate building
30+
* truly serverless apps.
3131
* </pre>
3232
*/
3333
@javax.annotation.Generated(
@@ -772,8 +772,8 @@ public FirestoreFutureStub newStub(
772772
* document database that simplifies storing, syncing, and querying data for
773773
* your mobile, web, and IoT apps at global scale. Its client libraries provide
774774
* live synchronization and offline support, while its security features and
775-
* integrations with Firebase and Google Cloud Platform (GCP) accelerate
776-
* building truly serverless apps.
775+
* integrations with Firebase and Google Cloud Platform accelerate building
776+
* truly serverless apps.
777777
* </pre>
778778
*/
779779
public abstract static class FirestoreImplBase implements io.grpc.BindableService {
@@ -911,8 +911,9 @@ public void runQuery(
911911
*
912912
* <pre>
913913
* Runs an aggregation query.
914-
* Rather than producing [Document][google.firestore.v1.Document] results like [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery],
915-
* this API allows running an aggregation to produce a series of
914+
* Rather than producing [Document][google.firestore.v1.Document] results like
915+
* [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery], this API
916+
* allows running an aggregation to produce a series of
916917
* [AggregationResult][google.firestore.v1.AggregationResult] server-side.
917918
* High-Level Example:
918919
* ```
@@ -950,7 +951,8 @@ public void partitionQuery(
950951
*
951952
*
952953
* <pre>
953-
* Streams batches of document updates and deletes, in order.
954+
* Streams batches of document updates and deletes, in order. This method is
955+
* only available via the gRPC API (not REST).
954956
* </pre>
955957
*/
956958
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(
963965
*
964966
*
965967
* <pre>
966-
* Listens to changes.
968+
* Listens to changes. This method is only available via the gRPC API (not
969+
* REST).
967970
* </pre>
968971
*/
969972
public io.grpc.stub.StreamObserver<com.google.firestore.v1.ListenRequest> listen(
@@ -995,7 +998,8 @@ public void listCollectionIds(
995998
* The BatchWrite method does not apply the write operations atomically
996999
* and can apply them out of order. Method does not allow more than one write
9971000
* per document. Each write succeeds or fails independently. See the
998-
* [BatchWriteResponse][google.firestore.v1.BatchWriteResponse] for the success status of each write.
1001+
* [BatchWriteResponse][google.firestore.v1.BatchWriteResponse] for the
1002+
* success status of each write.
9991003
* If you require an atomically applied set of writes, use
10001004
* [Commit][google.firestore.v1.Firestore.Commit] instead.
10011005
* </pre>
@@ -1138,8 +1142,8 @@ public final io.grpc.ServerServiceDefinition bindService() {
11381142
* document database that simplifies storing, syncing, and querying data for
11391143
* your mobile, web, and IoT apps at global scale. Its client libraries provide
11401144
* live synchronization and offline support, while its security features and
1141-
* integrations with Firebase and Google Cloud Platform (GCP) accelerate
1142-
* building truly serverless apps.
1145+
* integrations with Firebase and Google Cloud Platform accelerate building
1146+
* truly serverless apps.
11431147
* </pre>
11441148
*/
11451149
public static final class FirestoreStub extends io.grpc.stub.AbstractAsyncStub<FirestoreStub> {
@@ -1300,8 +1304,9 @@ public void runQuery(
13001304
*
13011305
* <pre>
13021306
* Runs an aggregation query.
1303-
* Rather than producing [Document][google.firestore.v1.Document] results like [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery],
1304-
* this API allows running an aggregation to produce a series of
1307+
* Rather than producing [Document][google.firestore.v1.Document] results like
1308+
* [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery], this API
1309+
* allows running an aggregation to produce a series of
13051310
* [AggregationResult][google.firestore.v1.AggregationResult] server-side.
13061311
* High-Level Example:
13071312
* ```
@@ -1343,7 +1348,8 @@ public void partitionQuery(
13431348
*
13441349
*
13451350
* <pre>
1346-
* Streams batches of document updates and deletes, in order.
1351+
* Streams batches of document updates and deletes, in order. This method is
1352+
* only available via the gRPC API (not REST).
13471353
* </pre>
13481354
*/
13491355
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(
13561362
*
13571363
*
13581364
* <pre>
1359-
* Listens to changes.
1365+
* Listens to changes. This method is only available via the gRPC API (not
1366+
* REST).
13601367
* </pre>
13611368
*/
13621369
public io.grpc.stub.StreamObserver<com.google.firestore.v1.ListenRequest> listen(
@@ -1390,7 +1397,8 @@ public void listCollectionIds(
13901397
* The BatchWrite method does not apply the write operations atomically
13911398
* and can apply them out of order. Method does not allow more than one write
13921399
* per document. Each write succeeds or fails independently. See the
1393-
* [BatchWriteResponse][google.firestore.v1.BatchWriteResponse] for the success status of each write.
1400+
* [BatchWriteResponse][google.firestore.v1.BatchWriteResponse] for the
1401+
* success status of each write.
13941402
* If you require an atomically applied set of writes, use
13951403
* [Commit][google.firestore.v1.Firestore.Commit] instead.
13961404
* </pre>
@@ -1428,8 +1436,8 @@ public void createDocument(
14281436
* document database that simplifies storing, syncing, and querying data for
14291437
* your mobile, web, and IoT apps at global scale. Its client libraries provide
14301438
* live synchronization and offline support, while its security features and
1431-
* integrations with Firebase and Google Cloud Platform (GCP) accelerate
1432-
* building truly serverless apps.
1439+
* integrations with Firebase and Google Cloud Platform accelerate building
1440+
* truly serverless apps.
14331441
* </pre>
14341442
*/
14351443
public static final class FirestoreBlockingStub
@@ -1567,8 +1575,9 @@ public java.util.Iterator<com.google.firestore.v1.RunQueryResponse> runQuery(
15671575
*
15681576
* <pre>
15691577
* Runs an aggregation query.
1570-
* Rather than producing [Document][google.firestore.v1.Document] results like [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery],
1571-
* this API allows running an aggregation to produce a series of
1578+
* Rather than producing [Document][google.firestore.v1.Document] results like
1579+
* [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery], this API
1580+
* allows running an aggregation to produce a series of
15721581
* [AggregationResult][google.firestore.v1.AggregationResult] server-side.
15731582
* High-Level Example:
15741583
* ```
@@ -1619,7 +1628,8 @@ public com.google.firestore.v1.ListCollectionIdsResponse listCollectionIds(
16191628
* The BatchWrite method does not apply the write operations atomically
16201629
* and can apply them out of order. Method does not allow more than one write
16211630
* per document. Each write succeeds or fails independently. See the
1622-
* [BatchWriteResponse][google.firestore.v1.BatchWriteResponse] for the success status of each write.
1631+
* [BatchWriteResponse][google.firestore.v1.BatchWriteResponse] for the
1632+
* success status of each write.
16231633
* If you require an atomically applied set of writes, use
16241634
* [Commit][google.firestore.v1.Firestore.Commit] instead.
16251635
* </pre>
@@ -1653,8 +1663,8 @@ public com.google.firestore.v1.Document createDocument(
16531663
* document database that simplifies storing, syncing, and querying data for
16541664
* your mobile, web, and IoT apps at global scale. Its client libraries provide
16551665
* live synchronization and offline support, while its security features and
1656-
* integrations with Firebase and Google Cloud Platform (GCP) accelerate
1657-
* building truly serverless apps.
1666+
* integrations with Firebase and Google Cloud Platform accelerate building
1667+
* truly serverless apps.
16581668
* </pre>
16591669
*/
16601670
public static final class FirestoreFutureStub
@@ -1800,7 +1810,8 @@ public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Em
18001810
* The BatchWrite method does not apply the write operations atomically
18011811
* and can apply them out of order. Method does not allow more than one write
18021812
* per document. Each write succeeds or fails independently. See the
1803-
* [BatchWriteResponse][google.firestore.v1.BatchWriteResponse] for the success status of each write.
1813+
* [BatchWriteResponse][google.firestore.v1.BatchWriteResponse] for the
1814+
* success status of each write.
18041815
* If you require an atomically applied set of writes, use
18051816
* [Commit][google.firestore.v1.Firestore.Commit] instead.
18061817
* </pre>

proto-google-cloud-firestore-v1/src/main/java/com/google/firestore/v1/AggregationResult.java

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,8 @@ public int getAggregateFieldsCount() {
115115
*
116116
* <pre>
117117
* The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
118-
* The key is the [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
118+
* The key is the
119+
* [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
119120
* assigned to the aggregation function on input and the size of this map
120121
* equals the number of aggregation functions in the query.
121122
* </pre>
@@ -140,7 +141,8 @@ public java.util.Map<java.lang.String, com.google.firestore.v1.Value> getAggrega
140141
*
141142
* <pre>
142143
* The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
143-
* The key is the [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
144+
* The key is the
145+
* [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
144146
* assigned to the aggregation function on input and the size of this map
145147
* equals the number of aggregation functions in the query.
146148
* </pre>
@@ -156,7 +158,8 @@ public java.util.Map<java.lang.String, com.google.firestore.v1.Value> getAggrega
156158
*
157159
* <pre>
158160
* The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
159-
* The key is the [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
161+
* The key is the
162+
* [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
160163
* assigned to the aggregation function on input and the size of this map
161164
* equals the number of aggregation functions in the query.
162165
* </pre>
@@ -180,7 +183,8 @@ public java.util.Map<java.lang.String, com.google.firestore.v1.Value> getAggrega
180183
*
181184
* <pre>
182185
* The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
183-
* The key is the [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
186+
* The key is the
187+
* [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
184188
* assigned to the aggregation function on input and the size of this map
185189
* equals the number of aggregation functions in the query.
186190
* </pre>
@@ -613,7 +617,8 @@ public int getAggregateFieldsCount() {
613617
*
614618
* <pre>
615619
* The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
616-
* The key is the [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
620+
* The key is the
621+
* [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
617622
* assigned to the aggregation function on input and the size of this map
618623
* equals the number of aggregation functions in the query.
619624
* </pre>
@@ -638,7 +643,8 @@ public java.util.Map<java.lang.String, com.google.firestore.v1.Value> getAggrega
638643
*
639644
* <pre>
640645
* The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
641-
* The key is the [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
646+
* The key is the
647+
* [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
642648
* assigned to the aggregation function on input and the size of this map
643649
* equals the number of aggregation functions in the query.
644650
* </pre>
@@ -654,7 +660,8 @@ public java.util.Map<java.lang.String, com.google.firestore.v1.Value> getAggrega
654660
*
655661
* <pre>
656662
* The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
657-
* The key is the [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
663+
* The key is the
664+
* [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
658665
* assigned to the aggregation function on input and the size of this map
659666
* equals the number of aggregation functions in the query.
660667
* </pre>
@@ -678,7 +685,8 @@ public java.util.Map<java.lang.String, com.google.firestore.v1.Value> getAggrega
678685
*
679686
* <pre>
680687
* The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
681-
* The key is the [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
688+
* The key is the
689+
* [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
682690
* assigned to the aggregation function on input and the size of this map
683691
* equals the number of aggregation functions in the query.
684692
* </pre>
@@ -708,7 +716,8 @@ public Builder clearAggregateFields() {
708716
*
709717
* <pre>
710718
* The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
711-
* The key is the [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
719+
* The key is the
720+
* [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
712721
* assigned to the aggregation function on input and the size of this map
713722
* equals the number of aggregation functions in the query.
714723
* </pre>
@@ -734,7 +743,8 @@ public Builder removeAggregateFields(java.lang.String key) {
734743
*
735744
* <pre>
736745
* The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
737-
* The key is the [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
746+
* The key is the
747+
* [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
738748
* assigned to the aggregation function on input and the size of this map
739749
* equals the number of aggregation functions in the query.
740750
* </pre>
@@ -757,7 +767,8 @@ public Builder putAggregateFields(java.lang.String key, com.google.firestore.v1.
757767
*
758768
* <pre>
759769
* The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
760-
* The key is the [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
770+
* The key is the
771+
* [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
761772
* assigned to the aggregation function on input and the size of this map
762773
* equals the number of aggregation functions in the query.
763774
* </pre>

proto-google-cloud-firestore-v1/src/main/java/com/google/firestore/v1/AggregationResultOrBuilder.java

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ public interface AggregationResultOrBuilder
2828
*
2929
* <pre>
3030
* The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
31-
* The key is the [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
31+
* The key is the
32+
* [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
3233
* assigned to the aggregation function on input and the size of this map
3334
* equals the number of aggregation functions in the query.
3435
* </pre>
@@ -41,7 +42,8 @@ public interface AggregationResultOrBuilder
4142
*
4243
* <pre>
4344
* The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
44-
* The key is the [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
45+
* The key is the
46+
* [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
4547
* assigned to the aggregation function on input and the size of this map
4648
* equals the number of aggregation functions in the query.
4749
* </pre>
@@ -57,7 +59,8 @@ public interface AggregationResultOrBuilder
5759
*
5860
* <pre>
5961
* The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
60-
* The key is the [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
62+
* The key is the
63+
* [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
6164
* assigned to the aggregation function on input and the size of this map
6265
* equals the number of aggregation functions in the query.
6366
* </pre>
@@ -70,7 +73,8 @@ public interface AggregationResultOrBuilder
7073
*
7174
* <pre>
7275
* The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
73-
* The key is the [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
76+
* The key is the
77+
* [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
7478
* assigned to the aggregation function on input and the size of this map
7579
* equals the number of aggregation functions in the query.
7680
* </pre>
@@ -87,7 +91,8 @@ com.google.firestore.v1.Value getAggregateFieldsOrDefault(
8791
*
8892
* <pre>
8993
* The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
90-
* The key is the [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
94+
* The key is the
95+
* [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
9196
* assigned to the aggregation function on input and the size of this map
9297
* equals the number of aggregation functions in the query.
9398
* </pre>

0 commit comments

Comments
 (0)