feat: add new types ExplainOptions, ExplainMetrics, PlanSummary, Exec…

…utionStats (#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
googleapis · Mar 13, 2024 · f275b16 · f275b16
1 parent 0a2eb16
commit f275b16
Show file tree

Hide file tree

Showing 24 changed files with 6,308 additions and 243 deletions.
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
@@ -1107,7 +1107,11 @@ public final UnaryCallable<RollbackRequest, Empty> rollbackCallable() {
    * // - It may require specifying regional endpoints when creating the service client as shown in
    * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    * try (FirestoreClient firestoreClient = FirestoreClient.create()) {
-   *   RunQueryRequest request = RunQueryRequest.newBuilder().setParent("parent-995424086").build();
+   *   RunQueryRequest request =
+   *       RunQueryRequest.newBuilder()
+   *           .setParent("parent-995424086")
+   *           .setExplainOptions(ExplainOptions.newBuilder().build())
+   *           .build();
    *   ServerStream<RunQueryResponse> stream = firestoreClient.runQueryCallable().call(request);
    *   for (RunQueryResponse response : stream) {
    *     // Do something when a response is received.
@@ -1143,7 +1147,10 @@ public final ServerStreamingCallable<RunQueryRequest, RunQueryResponse> runQuery
    * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    * try (FirestoreClient firestoreClient = FirestoreClient.create()) {
    *   RunAggregationQueryRequest request =
-   *       RunAggregationQueryRequest.newBuilder().setParent("parent-995424086").build();
+   *       RunAggregationQueryRequest.newBuilder()
+   *           .setParent("parent-995424086")
+   *           .setExplainOptions(ExplainOptions.newBuilder().build())
+   *           .build();
    *   ServerStream<RunAggregationQueryResponse> stream =
    *       firestoreClient.runAggregationQueryCallable().call(request);
    *   for (RunAggregationQueryResponse response : stream) {

diff --git a/...rc/main/resources/META-INF/native-image/com.google.cloud.firestore.v1/reflect-config.json b/...rc/main/resources/META-INF/native-image/com.google.cloud.firestore.v1/reflect-config.json
@@ -854,6 +854,24 @@
     "allDeclaredClasses": true,
     "allPublicClasses": true
   },
+  {
+    "name": "com.google.firestore.v1.ExecutionStats",
+    "queryAllDeclaredConstructors": true,
+    "queryAllPublicConstructors": true,
+    "queryAllDeclaredMethods": true,
+    "allPublicMethods": true,
+    "allDeclaredClasses": true,
+    "allPublicClasses": true
+  },
+  {
+    "name": "com.google.firestore.v1.ExecutionStats$Builder",
+    "queryAllDeclaredConstructors": true,
+    "queryAllPublicConstructors": true,
+    "queryAllDeclaredMethods": true,
+    "allPublicMethods": true,
+    "allDeclaredClasses": true,
+    "allPublicClasses": true
+  },
   {
     "name": "com.google.firestore.v1.ExistenceFilter",
     "queryAllDeclaredConstructors": true,
@@ -872,6 +890,42 @@
     "allDeclaredClasses": true,
     "allPublicClasses": true
   },
+  {
+    "name": "com.google.firestore.v1.ExplainMetrics",
+    "queryAllDeclaredConstructors": true,
+    "queryAllPublicConstructors": true,
+    "queryAllDeclaredMethods": true,
+    "allPublicMethods": true,
+    "allDeclaredClasses": true,
+    "allPublicClasses": true
+  },
+  {
+    "name": "com.google.firestore.v1.ExplainMetrics$Builder",
+    "queryAllDeclaredConstructors": true,
+    "queryAllPublicConstructors": true,
+    "queryAllDeclaredMethods": true,
+    "allPublicMethods": true,
+    "allDeclaredClasses": true,
+    "allPublicClasses": true
+  },
+  {
+    "name": "com.google.firestore.v1.ExplainOptions",
+    "queryAllDeclaredConstructors": true,
+    "queryAllPublicConstructors": true,
+    "queryAllDeclaredMethods": true,
+    "allPublicMethods": true,
+    "allDeclaredClasses": true,
+    "allPublicClasses": true
+  },
+  {
+    "name": "com.google.firestore.v1.ExplainOptions$Builder",
+    "queryAllDeclaredConstructors": true,
+    "queryAllPublicConstructors": true,
+    "queryAllDeclaredMethods": true,
+    "allPublicMethods": true,
+    "allDeclaredClasses": true,
+    "allPublicClasses": true
+  },
   {
     "name": "com.google.firestore.v1.GetDocumentRequest",
     "queryAllDeclaredConstructors": true,
@@ -1052,6 +1106,24 @@
     "allDeclaredClasses": true,
     "allPublicClasses": true
   },
+  {
+    "name": "com.google.firestore.v1.PlanSummary",
+    "queryAllDeclaredConstructors": true,
+    "queryAllPublicConstructors": true,
+    "queryAllDeclaredMethods": true,
+    "allPublicMethods": true,
+    "allDeclaredClasses": true,
+    "allPublicClasses": true
+  },
+  {
+    "name": "com.google.firestore.v1.PlanSummary$Builder",
+    "queryAllDeclaredConstructors": true,
+    "queryAllPublicConstructors": true,
+    "queryAllDeclaredMethods": true,
+    "allPublicMethods": true,
+    "allDeclaredClasses": true,
+    "allPublicClasses": true
+  },
   {
     "name": "com.google.firestore.v1.Precondition",
     "queryAllDeclaredConstructors": true,

diff --git a/google-cloud-firestore/src/test/java/com/google/cloud/firestore/v1/FirestoreClientTest.java b/google-cloud-firestore/src/test/java/com/google/cloud/firestore/v1/FirestoreClientTest.java
@@ -47,6 +47,8 @@
 import com.google.firestore.v1.DeleteDocumentRequest;
 import com.google.firestore.v1.Document;
 import com.google.firestore.v1.DocumentMask;
+import com.google.firestore.v1.ExplainMetrics;
+import com.google.firestore.v1.ExplainOptions;
 import com.google.firestore.v1.GetDocumentRequest;
 import com.google.firestore.v1.ListCollectionIdsRequest;
 import com.google.firestore.v1.ListCollectionIdsResponse;
@@ -505,9 +507,14 @@ public void runQueryTest() throws Exception {
             .setDocument(Document.newBuilder().build())
             .setReadTime(Timestamp.newBuilder().build())
             .setSkippedResults(880286183)
+            .setExplainMetrics(ExplainMetrics.newBuilder().build())
             .build();
     mockFirestore.addResponse(expectedResponse);
-    RunQueryRequest request = RunQueryRequest.newBuilder().setParent("parent-995424086").build();
+    RunQueryRequest request =
+        RunQueryRequest.newBuilder()
+            .setParent("parent-995424086")
+            .setExplainOptions(ExplainOptions.newBuilder().build())
+            .build();
 
     MockStreamObserver<RunQueryResponse> responseObserver = new MockStreamObserver<>();
 
@@ -523,7 +530,11 @@ public void runQueryTest() throws Exception {
   public void runQueryExceptionTest() throws Exception {
     StatusRuntimeException exception = new StatusRuntimeException(io.grpc.Status.INVALID_ARGUMENT);
     mockFirestore.addException(exception);
-    RunQueryRequest request = RunQueryRequest.newBuilder().setParent("parent-995424086").build();
+    RunQueryRequest request =
+        RunQueryRequest.newBuilder()
+            .setParent("parent-995424086")
+            .setExplainOptions(ExplainOptions.newBuilder().build())
+            .build();
 
     MockStreamObserver<RunQueryResponse> responseObserver = new MockStreamObserver<>();
 
@@ -547,10 +558,14 @@ public void runAggregationQueryTest() throws Exception {
             .setResult(AggregationResult.newBuilder().build())
             .setTransaction(ByteString.EMPTY)
             .setReadTime(Timestamp.newBuilder().build())
+            .setExplainMetrics(ExplainMetrics.newBuilder().build())
             .build();
     mockFirestore.addResponse(expectedResponse);
     RunAggregationQueryRequest request =
-        RunAggregationQueryRequest.newBuilder().setParent("parent-995424086").build();
+        RunAggregationQueryRequest.newBuilder()
+            .setParent("parent-995424086")
+            .setExplainOptions(ExplainOptions.newBuilder().build())
+            .build();
 
     MockStreamObserver<RunAggregationQueryResponse> responseObserver = new MockStreamObserver<>();
 
@@ -568,7 +583,10 @@ public void runAggregationQueryExceptionTest() throws Exception {
     StatusRuntimeException exception = new StatusRuntimeException(io.grpc.Status.INVALID_ARGUMENT);
     mockFirestore.addException(exception);
     RunAggregationQueryRequest request =
-        RunAggregationQueryRequest.newBuilder().setParent("parent-995424086").build();
+        RunAggregationQueryRequest.newBuilder()
+            .setParent("parent-995424086")
+            .setExplainOptions(ExplainOptions.newBuilder().build())
+            .build();
 
     MockStreamObserver<RunAggregationQueryResponse> responseObserver = new MockStreamObserver<>();
 

diff --git a/proto-google-cloud-firestore-v1/clirr-ignored-differences.xml b/proto-google-cloud-firestore-v1/clirr-ignored-differences.xml
@@ -91,4 +91,34 @@
     <className>com/google/firestore/v1/Run*QueryResponse$Builder</className>
     <method>* mergeStats(*)</method>
   </difference>
+  <difference>
+    <differenceType>7012</differenceType>
+    <className>com/google/firestore/v1/Run*QueryRequestOrBuilder</className>
+    <method>com.google.firestore.v1.ExplainOptions getExplainOptions()</method>
+  </difference>
+  <difference>
+    <differenceType>7012</differenceType>
+    <className>com/google/firestore/v1/Run*QueryRequestOrBuilder</className>
+    <method>com.google.firestore.v1.ExplainOptionsOrBuilder getExplainOptionsOrBuilder()</method>
+  </difference>
+  <difference>
+    <differenceType>7012</differenceType>
+    <className>com/google/firestore/v1/Run*QueryRequestOrBuilder</className>
+    <method>boolean hasExplainOptions()</method>
+  </difference>
+  <difference>
+    <differenceType>7012</differenceType>
+    <className>com/google/firestore/v1/Run*QueryResponseOrBuilder</className>
+    <method>com.google.firestore.v1.ExplainMetrics getExplainMetrics()</method>
+  </difference>
+  <difference>
+    <differenceType>7012</differenceType>
+    <className>com/google/firestore/v1/Run*QueryResponseOrBuilder</className>
+    <method>com.google.firestore.v1.ExplainMetricsOrBuilder getExplainMetricsOrBuilder()</method>
+  </difference>
+  <difference>
+    <differenceType>7012</differenceType>
+    <className>com/google/firestore/v1/Run*QueryResponseOrBuilder</className>
+    <method>boolean hasExplainMetrics()</method>
+  </difference>
 </differences>