@maxim_mazurok/gapi.client.datastore-v1beta3 0.0.20240307 → 0.0.20240324

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +43 -1
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://datastore.googleapis.com/$discovery/rest?version=v1beta3
12
- // Revision: 20240307
12
+ // Revision: 20240324
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -124,6 +124,26 @@ declare namespace gapi.client {
124
124
  /** 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. */
125
125
  version?: string;
126
126
  }
127
+ interface ExecutionStats {
128
+ /** 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" } } */
129
+ debugStats?: {[P in string]: any};
130
+ /** Total time to execute the query in the backend. */
131
+ executionDuration?: string;
132
+ /** Total billable read operations. */
133
+ readOperations?: string;
134
+ /** Total number of results returned, including documents, projections, aggregation results, keys. */
135
+ resultsReturned?: string;
136
+ }
137
+ interface ExplainMetrics {
138
+ /** Aggregated stats from the execution of the query. Only present when ExplainOptions.analyze is set to true. */
139
+ executionStats?: ExecutionStats;
140
+ /** Planning phase information for the query. */
141
+ planSummary?: PlanSummary;
142
+ }
143
+ interface ExplainOptions {
144
+ /** 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. */
145
+ analyze?: boolean;
146
+ }
127
147
  interface Filter {
128
148
  /** A composite filter. */
129
149
  compositeFilter?: CompositeFilter;
@@ -303,6 +323,8 @@ declare namespace gapi.client {
303
323
  interface LookupRequest {
304
324
  /** Required. Keys of entities to look up. */
305
325
  keys?: Key[];
326
+ /** 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. */
327
+ propertyMask?: PropertyMask;
306
328
  /** The options for this lookup request. */
307
329
  readOptions?: ReadOptions;
308
330
  }
@@ -323,6 +345,8 @@ declare namespace gapi.client {
323
345
  delete?: Key;
324
346
  /** The entity to insert. The entity must not already exist. The entity key's final path element may be incomplete. */
325
347
  insert?: Entity;
348
+ /** 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. */
349
+ propertyMask?: PropertyMask;
326
350
  /** The entity to update. The entity must already exist. Must have a complete key path. */
327
351
  update?: Entity;
328
352
  /** 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. */
@@ -356,6 +380,10 @@ declare namespace gapi.client {
356
380
  /** 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. */
357
381
  name?: string;
358
382
  }
383
+ interface PlanSummary {
384
+ /** The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, __name__ ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, __name__ ASC)"} ] */
385
+ indexesUsed?: Array<{[P in string]: any}>;
386
+ }
359
387
  interface Projection {
360
388
  /** The property to project. */
361
389
  property?: PropertyReference;
@@ -368,6 +396,10 @@ declare namespace gapi.client {
368
396
  /** The value to compare the property to. */
369
397
  value?: Value;
370
398
  }
399
+ interface PropertyMask {
400
+ /** 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. */
401
+ paths?: string[];
402
+ }
371
403
  interface PropertyOrder {
372
404
  /** The direction to order by. Defaults to `ASCENDING`. */
373
405
  direction?: string;
@@ -447,6 +479,8 @@ declare namespace gapi.client {
447
479
  interface RunAggregationQueryRequest {
448
480
  /** The query to run. */
449
481
  aggregationQuery?: AggregationQuery;
482
+ /** Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned. */
483
+ explainOptions?: ExplainOptions;
450
484
  /** The GQL query to run. This query must be an aggregation query. */
451
485
  gqlQuery?: GqlQuery;
452
486
  /** 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. */
@@ -457,14 +491,20 @@ declare namespace gapi.client {
457
491
  interface RunAggregationQueryResponse {
458
492
  /** A batch of aggregation results. Always present. */
459
493
  batch?: AggregationResultBatch;
494
+ /** 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. */
495
+ explainMetrics?: ExplainMetrics;
460
496
  /** The parsed form of the `GqlQuery` from the request, if it was set. */
461
497
  query?: AggregationQuery;
462
498
  }
463
499
  interface RunQueryRequest {
500
+ /** Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned. */
501
+ explainOptions?: ExplainOptions;
464
502
  /** The GQL query to run. This query must be a non-aggregation query. */
465
503
  gqlQuery?: GqlQuery;
466
504
  /** 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. */
467
505
  partitionId?: PartitionId;
506
+ /** The properties to return. This field must not be set for a projection query. See LookupRequest.property_mask. */
507
+ propertyMask?: PropertyMask;
468
508
  /** The query to run. */
469
509
  query?: Query;
470
510
  /** The options for this query. */
@@ -473,6 +513,8 @@ declare namespace gapi.client {
473
513
  interface RunQueryResponse {
474
514
  /** A batch of query results (always present). */
475
515
  batch?: QueryResultBatch;
516
+ /** 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. */
517
+ explainMetrics?: ExplainMetrics;
476
518
  /** The parsed form of the `GqlQuery` from the request, if it was set. */
477
519
  query?: Query;
478
520
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.datastore-v1beta3",
3
- "version": "0.0.20240307",
3
+ "version": "0.0.20240324",
4
4
  "description": "TypeScript typings for Cloud Datastore API v1beta3",
5
5
  "repository": {
6
6
  "type": "git",