@maxim_mazurok/gapi.client.datastore-v1 0.0.20231221 → 0.0.20240109

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://datastore.googleapis.com/$discovery/rest?version=v1
-// Revision: 20231221
+// Revision: 20240109
 
 /// <reference types="gapi.client" />
 
@@ -469,6 +469,10 @@ declare namespace gapi.client {
       /** A starting point for the query results. Query cursors are returned in query result batches and [can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets). */
       startCursor?: string;
     }
+    interface QueryPlan {
+      /** Planning phase information for the query. It will include: { "indexes_used": [ {"query_scope": "Collection", "properties": "(foo ASC, __name__ ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, __name__ ASC)"} ] } */
+      planInfo?: {[P in string]: any};
+    }
     interface QueryResultBatch {
       /** A cursor that points to the position after the last result in the batch. */
       endCursor?: string;
@@ -512,6 +516,12 @@ declare namespace gapi.client {
       keys?: Key[];
     }
     interface ReserveIdsResponse {}
+    interface ResultSetStats {
+      /** Plan for the query. */
+      queryPlan?: QueryPlan;
+      /** Aggregated statistics from the execution of the query. This will only be present when the request specifies `PROFILE` mode. For example, a query will return the statistics including: { "results_returned": "20", "documents_scanned": "20", "indexes_entries_scanned": "10050", "total_execution_time": "100.7 msecs" } */
+      queryStats?: {[P in string]: any};
+    }
     interface RollbackRequest {
       /** The ID of the database against which to make the request. '(default)' is not allowed; please use empty string '' to refer the default database. */
       databaseId?: string;
@@ -526,6 +536,8 @@ declare namespace gapi.client {
       databaseId?: string;
       /** The GQL query to run. This query must be an aggregation query. */
       gqlQuery?: GqlQuery;
+      /** Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to `NORMAL` mode where no additional statistics will be returned with the query results. */
+      mode?: string;
       /** Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID. */
       partitionId?: PartitionId;
       /** The options for this query. */
@@ -536,6 +548,8 @@ declare namespace gapi.client {
       batch?: AggregationResultBatch;
       /** The parsed form of the `GqlQuery` from the request, if it was set. */
       query?: AggregationQuery;
+      /** Query plan and execution statistics. Note that the returned stats are subject to change as Firestore evolves. This is only present when the request specifies a mode other than `NORMAL`. */
+      stats?: ResultSetStats;
       /** The identifier of the transaction that was started as part of this RunAggregationQuery request. Set only when ReadOptions.new_transaction was set in RunAggregationQueryRequest.read_options. */
       transaction?: string;
     }
@@ -544,6 +558,8 @@ declare namespace gapi.client {
       databaseId?: string;
       /** The GQL query to run. This query must be a non-aggregation query. */
       gqlQuery?: GqlQuery;
+      /** Optional. The mode in which the query request is processed. This field is optional, and when not provided, it defaults to `NORMAL` mode where no additional statistics will be returned with the query results. */
+      mode?: string;
       /** Entities are partitioned into subsets, identified by a partition ID. Queries are scoped to a single partition. This partition ID is normalized with the standard default context partition ID. */
       partitionId?: PartitionId;
       /** The query to run. */
@@ -556,6 +572,8 @@ declare namespace gapi.client {
       batch?: QueryResultBatch;
       /** The parsed form of the `GqlQuery` from the request, if it was set. */
       query?: Query;
+      /** Query plan and execution statistics. Note that the returned stats are subject to change as Firestore evolves. This is only present when the request specifies a mode other than `NORMAL`. */
+      stats?: ResultSetStats;
       /** The identifier of the transaction that was started as part of this RunQuery request. Set only when ReadOptions.new_transaction was set in RunQueryRequest.read_options. */
       transaction?: string;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.datastore-v1",
-  "version": "0.0.20231221",
+  "version": "0.0.20240109",
   "description": "TypeScript typings for Cloud Datastore API v1",
   "repository": {
     "type": "git",