@maxim_mazurok/gapi.client.spanner-v1 0.0.20230301 → 0.0.20230317

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 (3) hide show
  1. package/index.d.ts +22 -30
  2. package/package.json +1 -1
  3. package/tests.ts +9 -25
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://spanner.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20230301
12
+ // Revision: 20230317
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -439,6 +439,11 @@ declare namespace gapi.client {
439
439
  status?: Status;
440
440
  }
441
441
  interface ExecuteSqlRequest {
442
+ /**
443
+ * If this is for a partitioned query and this field is set to `true`, the request will be executed via Spanner independent compute resources. If the field is set to `true` but the
444
+ * request does not set `partition_token`, the API will return an `INVALID_ARGUMENT` error.
445
+ */
446
+ dataBoostEnabled?: boolean;
442
447
  /**
443
448
  * Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the `@` character followed by the parameter name (for example,
444
449
  * `@firstName`). Parameter names must conform to the naming requirements of identifiers as specified at https://cloud.google.com/spanner/docs/lexical#identifiers. Parameters can
@@ -581,13 +586,15 @@ declare namespace gapi.client {
581
586
  */
582
587
  name?: string;
583
588
  /**
584
- * The number of nodes allocated to this instance. At most one of either node_count or processing_units should be present in the message. This may be zero in API responses for
585
- * instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units.
589
+ * The number of nodes allocated to this instance. At most one of either node_count or processing_units should be present in the message. Users can set the node_count field to specify
590
+ * the target number of nodes allocated to the instance. This may be zero in API responses for instances that are not yet in state `READY`. See [the
591
+ * documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units.
586
592
  */
587
593
  nodeCount?: number;
588
594
  /**
589
- * The number of processing units allocated to this instance. At most one of processing_units or node_count should be present in the message. This may be zero in API responses for
590
- * instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units.
595
+ * The number of processing units allocated to this instance. At most one of processing_units or node_count should be present in the message. Users can set the processing_units field
596
+ * to specify the target number of processing units allocated to the instance. This may be zero in API responses for instances that are not yet in state `READY`. See [the
597
+ * documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units.
591
598
  */
592
599
  processingUnits?: number;
593
600
  /**
@@ -1105,6 +1112,11 @@ declare namespace gapi.client {
1105
1112
  interface ReadRequest {
1106
1113
  /** Required. The columns of table to be returned for each row matching this request. */
1107
1114
  columns?: string[];
1115
+ /**
1116
+ * If this is for a partitioned read and this field is set to `true`, the request will be executed via Spanner independent compute resources. If the field is set to `true` but the
1117
+ * request does not set `partition_token`, the API will return an `INVALID_ARGUMENT` error.
1118
+ */
1119
+ dataBoostEnabled?: boolean;
1108
1120
  /**
1109
1121
  * If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further
1110
1122
  * information.
@@ -1420,7 +1432,7 @@ declare namespace gapi.client {
1420
1432
  /** For an update this list contains all the statements. For an individual statement, this list contains only that statement. */
1421
1433
  statements?: string[];
1422
1434
  /**
1423
- * Output only. When true, indicates that the operation is throttled e.g due to resource constraints. When resources become available the operation will resume and this field will be
1435
+ * Output only. When true, indicates that the operation is throttled e.g. due to resource constraints. When resources become available the operation will resume and this field will be
1424
1436
  * false again.
1425
1437
  */
1426
1438
  throttled?: boolean;
@@ -1668,12 +1680,7 @@ declare namespace gapi.client {
1668
1680
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1669
1681
  uploadType?: string;
1670
1682
  }): Request<Operation>;
1671
- /**
1672
- * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services
1673
- * to override the binding to use different resource name schemes, such as `users/*‍/operations`. To override the binding, API services can add a binding such as
1674
- * `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must
1675
- * ensure the name binding is the parent resource, without the operations collection id.
1676
- */
1683
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
1677
1684
  list(request?: {
1678
1685
  /** V1 error format. */
1679
1686
  "$.xgafv"?: string;
@@ -2085,12 +2092,7 @@ declare namespace gapi.client {
2085
2092
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2086
2093
  uploadType?: string;
2087
2094
  }): Request<Operation>;
2088
- /**
2089
- * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services
2090
- * to override the binding to use different resource name schemes, such as `users/*‍/operations`. To override the binding, API services can add a binding such as
2091
- * `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must
2092
- * ensure the name binding is the parent resource, without the operations collection id.
2093
- */
2095
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
2094
2096
  list(request?: {
2095
2097
  /** V1 error format. */
2096
2098
  "$.xgafv"?: string;
@@ -2754,12 +2756,7 @@ declare namespace gapi.client {
2754
2756
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2755
2757
  uploadType?: string;
2756
2758
  }): Request<Operation>;
2757
- /**
2758
- * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services
2759
- * to override the binding to use different resource name schemes, such as `users/*‍/operations`. To override the binding, API services can add a binding such as
2760
- * `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must
2761
- * ensure the name binding is the parent resource, without the operations collection id.
2762
- */
2759
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
2763
2760
  list(request?: {
2764
2761
  /** V1 error format. */
2765
2762
  "$.xgafv"?: string;
@@ -4142,12 +4139,7 @@ declare namespace gapi.client {
4142
4139
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4143
4140
  uploadType?: string;
4144
4141
  }): Request<Operation>;
4145
- /**
4146
- * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services
4147
- * to override the binding to use different resource name schemes, such as `users/*‍/operations`. To override the binding, API services can add a binding such as
4148
- * `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must
4149
- * ensure the name binding is the parent resource, without the operations collection id.
4150
- */
4142
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
4151
4143
  list(request?: {
4152
4144
  /** V1 error format. */
4153
4145
  "$.xgafv"?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.spanner-v1",
3
- "version": "0.0.20230301",
3
+ "version": "0.0.20230317",
4
4
  "description": "TypeScript typings for Cloud Spanner API v1",
5
5
  "license": "MIT",
6
6
  "author": {
package/tests.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
4
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
5
 
6
- // Revision: 20230301
6
+ // Revision: 20230317
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -174,12 +174,7 @@ gapi.load('client', async () => {
174
174
  await gapi.client.spanner.projects.instanceConfigs.operations.get({
175
175
  name: "Test string",
176
176
  });
177
- /**
178
- * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to
179
- * override the binding to use different resource name schemes, such as `users/*‍/operations`. To override the binding, API services can add a binding such as
180
- * `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must
181
- * ensure the name binding is the parent resource, without the operations collection id.
182
- */
177
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
183
178
  await gapi.client.spanner.projects.instanceConfigs.operations.list({
184
179
  filter: "Test string",
185
180
  name: "Test string",
@@ -510,12 +505,7 @@ gapi.load('client', async () => {
510
505
  await gapi.client.spanner.projects.instances.backups.operations.get({
511
506
  name: "Test string",
512
507
  });
513
- /**
514
- * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to
515
- * override the binding to use different resource name schemes, such as `users/*‍/operations`. To override the binding, API services can add a binding such as
516
- * `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must
517
- * ensure the name binding is the parent resource, without the operations collection id.
518
- */
508
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
519
509
  await gapi.client.spanner.projects.instances.backups.operations.list({
520
510
  filter: "Test string",
521
511
  name: "Test string",
@@ -694,12 +684,7 @@ gapi.load('client', async () => {
694
684
  await gapi.client.spanner.projects.instances.databases.operations.get({
695
685
  name: "Test string",
696
686
  });
697
- /**
698
- * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to
699
- * override the binding to use different resource name schemes, such as `users/*‍/operations`. To override the binding, API services can add a binding such as
700
- * `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must
701
- * ensure the name binding is the parent resource, without the operations collection id.
702
- */
687
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
703
688
  await gapi.client.spanner.projects.instances.databases.operations.list({
704
689
  filter: "Test string",
705
690
  name: "Test string",
@@ -958,6 +943,7 @@ gapi.load('client', async () => {
958
943
  await gapi.client.spanner.projects.instances.databases.sessions.executeSql({
959
944
  session: "Test string",
960
945
  }, {
946
+ dataBoostEnabled: true,
961
947
  params: {
962
948
  A: 42
963
949
  },
@@ -1032,6 +1018,7 @@ gapi.load('client', async () => {
1032
1018
  await gapi.client.spanner.projects.instances.databases.sessions.executeStreamingSql({
1033
1019
  session: "Test string",
1034
1020
  }, {
1021
+ dataBoostEnabled: true,
1035
1022
  params: {
1036
1023
  A: 42
1037
1024
  },
@@ -1265,6 +1252,7 @@ gapi.load('client', async () => {
1265
1252
  columns: [
1266
1253
  "Test string"
1267
1254
  ],
1255
+ dataBoostEnabled: true,
1268
1256
  index: "Test string",
1269
1257
  keySet: {
1270
1258
  all: true,
@@ -1353,6 +1341,7 @@ gapi.load('client', async () => {
1353
1341
  columns: [
1354
1342
  "Test string"
1355
1343
  ],
1344
+ dataBoostEnabled: true,
1356
1345
  index: "Test string",
1357
1346
  keySet: {
1358
1347
  all: true,
@@ -1441,12 +1430,7 @@ gapi.load('client', async () => {
1441
1430
  await gapi.client.spanner.projects.instances.operations.get({
1442
1431
  name: "Test string",
1443
1432
  });
1444
- /**
1445
- * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to
1446
- * override the binding to use different resource name schemes, such as `users/*‍/operations`. To override the binding, API services can add a binding such as
1447
- * `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must
1448
- * ensure the name binding is the parent resource, without the operations collection id.
1449
- */
1433
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
1450
1434
  await gapi.client.spanner.projects.instances.operations.list({
1451
1435
  filter: "Test string",
1452
1436
  name: "Test string",