@maxim_mazurok/gapi.client.datastore-v1 0.0.20240226 → 0.0.20240317

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: 20240226
+// Revision: 20240317
 
 /// <reference types="gapi.client" />
 
@@ -129,6 +129,26 @@ declare namespace gapi.client {
       /** The version of the entity, a strictly positive number that monotonically increases with changes to the entity. This field is set for `FULL` entity results. For missing entities in `LookupResponse`, this is the version of the snapshot that was used to look up the entity, and it is always set except for eventually consistent reads. */
       version?: string;
     }
+    interface ExecutionStats {
+      /** Debugging statistics from the execution of the query. Note that the debugging stats are subject to change as Firestore evolves. It could include: { "indexes_entries_scanned": "1000", "documents_scanned": "20", "billing_details" : { "documents_billable": "20", "index_entries_billable": "1000", "min_query_cost": "0" } } */
+      debugStats?: {[P in string]: any};
+      /** Total time to execute the query in the backend. */
+      executionDuration?: string;
+      /** Total billable read operations. */
+      readOperations?: string;
+      /** Total number of results returned, including documents, projections, aggregation results, keys. */
+      resultsReturned?: string;
+    }
+    interface ExplainMetrics {
+      /** Aggregated stats from the execution of the query. Only present when ExplainOptions.analyze is set to true. */
+      executionStats?: ExecutionStats;
+      /** Planning phase information for the query. */
+      planSummary?: PlanSummary;
+    }
+    interface ExplainOptions {
+      /** Optional. Whether to execute this query. When false (the default), the query will be planned, returning only metrics from the planning stages. When true, the query will be planned and executed, returning the full query results along with both planning and execution stage metrics. */
+      analyze?: boolean;
+    }
     interface Filter {
       /** A composite filter. */
       compositeFilter?: CompositeFilter;
@@ -370,6 +390,8 @@ declare namespace gapi.client {
       databaseId?: string;
       /** Required. Keys of entities to look up. */
       keys?: Key[];
+      /** The properties to return. Defaults to returning all properties. If this field is set and an entity has a property not referenced in the mask, it will be absent from LookupResponse.found.entity.properties. The entity's key is always returned. */
+      propertyMask?: PropertyMask;
       /** The options for this lookup request. */
       readOptions?: ReadOptions;
     }
@@ -392,6 +414,8 @@ declare namespace gapi.client {
       delete?: Key;
       /** The entity to insert. The entity must not already exist. The entity key's final path element may be incomplete. */
       insert?: Entity;
+      /** The properties to write in this mutation. None of the properties in the mask may have a reserved name, except for `__key__`. This field is ignored for `delete`. If the entity already exists, only properties referenced in the mask are updated, others are left untouched. Properties referenced in the mask but not in the entity are deleted. */
+      propertyMask?: PropertyMask;
       /** The entity to update. The entity must already exist. Must have a complete key path. */
       update?: Entity;
       /** The update time of the entity that this mutation is being applied to. If this does not match the current update time on the server, the mutation conflicts. */
@@ -427,6 +451,10 @@ declare namespace gapi.client {
       /** The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. */
       name?: string;
     }
+    interface PlanSummary {
+      /** The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, __name__ ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, __name__ ASC)"} ] */
+      indexesUsed?: Array<{[P in string]: any}>;
+    }
     interface Projection {
       /** The property to project. */
       property?: PropertyReference;
@@ -439,6 +467,10 @@ declare namespace gapi.client {
       /** The value to compare the property to. */
       value?: Value;
     }
+    interface PropertyMask {
+      /** The paths to the properties covered by this mask. A path is a list of property names separated by dots (`.`), for example `foo.bar` means the property `bar` inside the entity property `foo` inside the entity associated with this path. If a property name contains a dot `.` or a backslash `\`, then that name must be escaped. A path must not be empty, and may not reference a value inside an array value. */
+      paths?: string[];
+    }
     interface PropertyOrder {
       /** The direction to order by. Defaults to `ASCENDING`. */
       direction?: string;
@@ -524,6 +556,8 @@ declare namespace gapi.client {
       aggregationQuery?: AggregationQuery;
       /** 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;
+      /** Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned. */
+      explainOptions?: ExplainOptions;
       /** The GQL query to run. This query must be an aggregation query. */
       gqlQuery?: GqlQuery;
       /** 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. */
@@ -534,6 +568,8 @@ declare namespace gapi.client {
     interface RunAggregationQueryResponse {
       /** A batch of aggregation results. Always present. */
       batch?: AggregationResultBatch;
+      /** Query explain metrics. This is only present when the RunAggregationQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream. */
+      explainMetrics?: ExplainMetrics;
       /** The parsed form of the `GqlQuery` from the request, if it was set. */
       query?: AggregationQuery;
       /** 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. */
@@ -542,10 +578,14 @@ declare namespace gapi.client {
     interface RunQueryRequest {
       /** 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;
+      /** Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned. */
+      explainOptions?: ExplainOptions;
       /** The GQL query to run. This query must be a non-aggregation query. */
       gqlQuery?: GqlQuery;
       /** 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 properties to return. This field must not be set for a projection query. See LookupRequest.property_mask. */
+      propertyMask?: PropertyMask;
       /** The query to run. */
       query?: Query;
       /** The options for this query. */
@@ -554,6 +594,8 @@ declare namespace gapi.client {
     interface RunQueryResponse {
       /** A batch of query results (always present). */
       batch?: QueryResultBatch;
+      /** Query explain metrics. This is only present when the RunQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream. */
+      explainMetrics?: ExplainMetrics;
       /** The parsed form of the `GqlQuery` from the request, if it was set. */
       query?: Query;
       /** 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. */

package/package.json

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