Skip to content

Commit f275b16

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
feat: add new types ExplainOptions, ExplainMetrics, PlanSummary, ExecutionStats (#1608)
- [ ] Regenerate this pull request now. feat: add ExplainOptions field to RunQueryRequest feat: add ExplainMetrics field to RunQueryResponse feat: add ExplainOptions field to RunAggregationQueryRequest feat: add ExplainMetrics field to RunAggregationQueryResponse PiperOrigin-RevId: 615158086 Source-Link: https://togithub.com/googleapis/googleapis/commit/dbd2d6de9fd7942c1d3507979eff666e37470e18 Source-Link: https://togithub.com/googleapis/googleapis-gen/commit/a1d5d019300d206989746addda921e21d1b02e82 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYTFkNWQwMTkzMDBkMjA2OTg5NzQ2YWRkZGE5MjFlMjFkMWIwMmU4MiJ9
1 parent 0a2eb16 commit f275b16

24 files changed

+6308
-243
lines changed

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

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1107,7 +1107,11 @@ public final UnaryCallable<RollbackRequest, Empty> rollbackCallable() {
11071107
* // - It may require specifying regional endpoints when creating the service client as shown in
11081108
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
11091109
* try (FirestoreClient firestoreClient = FirestoreClient.create()) {
1110-
* RunQueryRequest request = RunQueryRequest.newBuilder().setParent("parent-995424086").build();
1110+
* RunQueryRequest request =
1111+
* RunQueryRequest.newBuilder()
1112+
* .setParent("parent-995424086")
1113+
* .setExplainOptions(ExplainOptions.newBuilder().build())
1114+
* .build();
11111115
* ServerStream<RunQueryResponse> stream = firestoreClient.runQueryCallable().call(request);
11121116
* for (RunQueryResponse response : stream) {
11131117
* // Do something when a response is received.
@@ -1143,7 +1147,10 @@ public final ServerStreamingCallable<RunQueryRequest, RunQueryResponse> runQuery
11431147
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
11441148
* try (FirestoreClient firestoreClient = FirestoreClient.create()) {
11451149
* RunAggregationQueryRequest request =
1146-
* RunAggregationQueryRequest.newBuilder().setParent("parent-995424086").build();
1150+
* RunAggregationQueryRequest.newBuilder()
1151+
* .setParent("parent-995424086")
1152+
* .setExplainOptions(ExplainOptions.newBuilder().build())
1153+
* .build();
11471154
* ServerStream<RunAggregationQueryResponse> stream =
11481155
* firestoreClient.runAggregationQueryCallable().call(request);
11491156
* for (RunAggregationQueryResponse response : stream) {

‎google-cloud-firestore/src/main/resources/META-INF/native-image/com.google.cloud.firestore.v1/reflect-config.json

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -854,6 +854,24 @@
854854
"allDeclaredClasses": true,
855855
"allPublicClasses": true
856856
},
857+
{
858+
"name": "com.google.firestore.v1.ExecutionStats",
859+
"queryAllDeclaredConstructors": true,
860+
"queryAllPublicConstructors": true,
861+
"queryAllDeclaredMethods": true,
862+
"allPublicMethods": true,
863+
"allDeclaredClasses": true,
864+
"allPublicClasses": true
865+
},
866+
{
867+
"name": "com.google.firestore.v1.ExecutionStats$Builder",
868+
"queryAllDeclaredConstructors": true,
869+
"queryAllPublicConstructors": true,
870+
"queryAllDeclaredMethods": true,
871+
"allPublicMethods": true,
872+
"allDeclaredClasses": true,
873+
"allPublicClasses": true
874+
},
857875
{
858876
"name": "com.google.firestore.v1.ExistenceFilter",
859877
"queryAllDeclaredConstructors": true,
@@ -872,6 +890,42 @@
872890
"allDeclaredClasses": true,
873891
"allPublicClasses": true
874892
},
893+
{
894+
"name": "com.google.firestore.v1.ExplainMetrics",
895+
"queryAllDeclaredConstructors": true,
896+
"queryAllPublicConstructors": true,
897+
"queryAllDeclaredMethods": true,
898+
"allPublicMethods": true,
899+
"allDeclaredClasses": true,
900+
"allPublicClasses": true
901+
},
902+
{
903+
"name": "com.google.firestore.v1.ExplainMetrics$Builder",
904+
"queryAllDeclaredConstructors": true,
905+
"queryAllPublicConstructors": true,
906+
"queryAllDeclaredMethods": true,
907+
"allPublicMethods": true,
908+
"allDeclaredClasses": true,
909+
"allPublicClasses": true
910+
},
911+
{
912+
"name": "com.google.firestore.v1.ExplainOptions",
913+
"queryAllDeclaredConstructors": true,
914+
"queryAllPublicConstructors": true,
915+
"queryAllDeclaredMethods": true,
916+
"allPublicMethods": true,
917+
"allDeclaredClasses": true,
918+
"allPublicClasses": true
919+
},
920+
{
921+
"name": "com.google.firestore.v1.ExplainOptions$Builder",
922+
"queryAllDeclaredConstructors": true,
923+
"queryAllPublicConstructors": true,
924+
"queryAllDeclaredMethods": true,
925+
"allPublicMethods": true,
926+
"allDeclaredClasses": true,
927+
"allPublicClasses": true
928+
},
875929
{
876930
"name": "com.google.firestore.v1.GetDocumentRequest",
877931
"queryAllDeclaredConstructors": true,
@@ -1052,6 +1106,24 @@
10521106
"allDeclaredClasses": true,
10531107
"allPublicClasses": true
10541108
},
1109+
{
1110+
"name": "com.google.firestore.v1.PlanSummary",
1111+
"queryAllDeclaredConstructors": true,
1112+
"queryAllPublicConstructors": true,
1113+
"queryAllDeclaredMethods": true,
1114+
"allPublicMethods": true,
1115+
"allDeclaredClasses": true,
1116+
"allPublicClasses": true
1117+
},
1118+
{
1119+
"name": "com.google.firestore.v1.PlanSummary$Builder",
1120+
"queryAllDeclaredConstructors": true,
1121+
"queryAllPublicConstructors": true,
1122+
"queryAllDeclaredMethods": true,
1123+
"allPublicMethods": true,
1124+
"allDeclaredClasses": true,
1125+
"allPublicClasses": true
1126+
},
10551127
{
10561128
"name": "com.google.firestore.v1.Precondition",
10571129
"queryAllDeclaredConstructors": true,

‎google-cloud-firestore/src/test/java/com/google/cloud/firestore/v1/FirestoreClientTest.java

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@
4747
import com.google.firestore.v1.DeleteDocumentRequest;
4848
import com.google.firestore.v1.Document;
4949
import com.google.firestore.v1.DocumentMask;
50+
import com.google.firestore.v1.ExplainMetrics;
51+
import com.google.firestore.v1.ExplainOptions;
5052
import com.google.firestore.v1.GetDocumentRequest;
5153
import com.google.firestore.v1.ListCollectionIdsRequest;
5254
import com.google.firestore.v1.ListCollectionIdsResponse;
@@ -505,9 +507,14 @@ public void runQueryTest() throws Exception {
505507
.setDocument(Document.newBuilder().build())
506508
.setReadTime(Timestamp.newBuilder().build())
507509
.setSkippedResults(880286183)
510+
.setExplainMetrics(ExplainMetrics.newBuilder().build())
508511
.build();
509512
mockFirestore.addResponse(expectedResponse);
510-
RunQueryRequest request = RunQueryRequest.newBuilder().setParent("parent-995424086").build();
513+
RunQueryRequest request =
514+
RunQueryRequest.newBuilder()
515+
.setParent("parent-995424086")
516+
.setExplainOptions(ExplainOptions.newBuilder().build())
517+
.build();
511518

512519
MockStreamObserver<RunQueryResponse> responseObserver = new MockStreamObserver<>();
513520

@@ -523,7 +530,11 @@ public void runQueryTest() throws Exception {
523530
public void runQueryExceptionTest() throws Exception {
524531
StatusRuntimeException exception = new StatusRuntimeException(io.grpc.Status.INVALID_ARGUMENT);
525532
mockFirestore.addException(exception);
526-
RunQueryRequest request = RunQueryRequest.newBuilder().setParent("parent-995424086").build();
533+
RunQueryRequest request =
534+
RunQueryRequest.newBuilder()
535+
.setParent("parent-995424086")
536+
.setExplainOptions(ExplainOptions.newBuilder().build())
537+
.build();
527538

528539
MockStreamObserver<RunQueryResponse> responseObserver = new MockStreamObserver<>();
529540

@@ -547,10 +558,14 @@ public void runAggregationQueryTest() throws Exception {
547558
.setResult(AggregationResult.newBuilder().build())
548559
.setTransaction(ByteString.EMPTY)
549560
.setReadTime(Timestamp.newBuilder().build())
561+
.setExplainMetrics(ExplainMetrics.newBuilder().build())
550562
.build();
551563
mockFirestore.addResponse(expectedResponse);
552564
RunAggregationQueryRequest request =
553-
RunAggregationQueryRequest.newBuilder().setParent("parent-995424086").build();
565+
RunAggregationQueryRequest.newBuilder()
566+
.setParent("parent-995424086")
567+
.setExplainOptions(ExplainOptions.newBuilder().build())
568+
.build();
554569

555570
MockStreamObserver<RunAggregationQueryResponse> responseObserver = new MockStreamObserver<>();
556571

@@ -568,7 +583,10 @@ public void runAggregationQueryExceptionTest() throws Exception {
568583
StatusRuntimeException exception = new StatusRuntimeException(io.grpc.Status.INVALID_ARGUMENT);
569584
mockFirestore.addException(exception);
570585
RunAggregationQueryRequest request =
571-
RunAggregationQueryRequest.newBuilder().setParent("parent-995424086").build();
586+
RunAggregationQueryRequest.newBuilder()
587+
.setParent("parent-995424086")
588+
.setExplainOptions(ExplainOptions.newBuilder().build())
589+
.build();
572590

573591
MockStreamObserver<RunAggregationQueryResponse> responseObserver = new MockStreamObserver<>();
574592

‎proto-google-cloud-firestore-v1/clirr-ignored-differences.xml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,4 +91,34 @@
9191
<className>com/google/firestore/v1/Run*QueryResponse$Builder</className>
9292
<method>* mergeStats(*)</method>
9393
</difference>
94+
<difference>
95+
<differenceType>7012</differenceType>
96+
<className>com/google/firestore/v1/Run*QueryRequestOrBuilder</className>
97+
<method>com.google.firestore.v1.ExplainOptions getExplainOptions()</method>
98+
</difference>
99+
<difference>
100+
<differenceType>7012</differenceType>
101+
<className>com/google/firestore/v1/Run*QueryRequestOrBuilder</className>
102+
<method>com.google.firestore.v1.ExplainOptionsOrBuilder getExplainOptionsOrBuilder()</method>
103+
</difference>
104+
<difference>
105+
<differenceType>7012</differenceType>
106+
<className>com/google/firestore/v1/Run*QueryRequestOrBuilder</className>
107+
<method>boolean hasExplainOptions()</method>
108+
</difference>
109+
<difference>
110+
<differenceType>7012</differenceType>
111+
<className>com/google/firestore/v1/Run*QueryResponseOrBuilder</className>
112+
<method>com.google.firestore.v1.ExplainMetrics getExplainMetrics()</method>
113+
</difference>
114+
<difference>
115+
<differenceType>7012</differenceType>
116+
<className>com/google/firestore/v1/Run*QueryResponseOrBuilder</className>
117+
<method>com.google.firestore.v1.ExplainMetricsOrBuilder getExplainMetricsOrBuilder()</method>
118+
</difference>
119+
<difference>
120+
<differenceType>7012</differenceType>
121+
<className>com/google/firestore/v1/Run*QueryResponseOrBuilder</className>
122+
<method>boolean hasExplainMetrics()</method>
123+
</difference>
94124
</differences>

0 commit comments

Comments
 (0)