@maxim_mazurok/gapi.client.spanner-v1 0.0.20241218 → 0.0.20241220
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.
- package/index.d.ts +16 -12
- 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://spanner.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20241220
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -351,7 +351,7 @@ declare namespace gapi.client {
|
|
|
351
351
|
interface CrontabSpec {
|
|
352
352
|
/** Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`. */
|
|
353
353
|
creationWindow?: string;
|
|
354
|
-
/** Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC
|
|
354
|
+
/** Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timezone. The backup will contain an externally consistent copy of the database at the version time. Full backups must be scheduled a minimum of 12 hours apart and incremental backups must be scheduled a minimum of 4 hours apart. Examples of valid cron specifications: * `0 2/12 * * *` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * *` : every 12 hours at (2,14) hours past midnight in UTC. * `0 */4 * * *` : (incremental backups only) every 4 hours at (0, 4, 8, 12, 16, 20) hours past midnight in UTC. * `0 2 * * *` : once a day at 2 past midnight in UTC. * `0 2 * * 0` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * *` : once a month on 8th day at 2 past midnight in UTC. */
|
|
355
355
|
text?: string;
|
|
356
356
|
/** Output only. The time zone of the times in `CrontabSpec.text`. Currently only UTC is supported. */
|
|
357
357
|
timeZone?: string;
|
|
@@ -447,6 +447,8 @@ declare namespace gapi.client {
|
|
|
447
447
|
replicaSelections?: ReplicaSelection[];
|
|
448
448
|
}
|
|
449
449
|
interface ExecuteBatchDmlRequest {
|
|
450
|
+
/** Optional. If set to true, this request marks the end of the transaction. The transaction should be committed or aborted after these statements execute, and attempts to execute any other requests against this transaction (including reads and queries) will be rejected. Setting this option may cause some error reporting to be deferred until commit time (e.g. validation of unique constraints). Given this, successful execution of statements should not be assumed until a subsequent Commit call completes successfully. */
|
|
451
|
+
lastStatements?: boolean;
|
|
450
452
|
/** Common options for this request. */
|
|
451
453
|
requestOptions?: RequestOptions;
|
|
452
454
|
/** Required. A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one will succeed. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction may be aborted. Replays of previously handled requests will yield the same response as the first execution. */
|
|
@@ -469,6 +471,8 @@ declare namespace gapi.client {
|
|
|
469
471
|
dataBoostEnabled?: boolean;
|
|
470
472
|
/** Directed read options for this request. */
|
|
471
473
|
directedReadOptions?: DirectedReadOptions;
|
|
474
|
+
/** Optional. If set to true, this statement marks the end of the transaction. The transaction should be committed or aborted after this statement executes, and attempts to execute any other requests against this transaction (including reads and queries) will be rejected. For DML statements, setting this option may cause some error reporting to be deferred until commit time (e.g. validation of unique constraints). Given this, successful execution of a DML statement should not be assumed until a subsequent Commit call completes successfully. */
|
|
475
|
+
lastStatement?: boolean;
|
|
472
476
|
/** 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, `@firstName`). Parameter names must conform to the naming requirements of identifiers as specified at https://cloud.google.com/spanner/docs/lexical#identifiers. Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: `"WHERE id > @msg_id AND id < @msg_id + 100"` It is an error to execute a SQL statement with unbound parameters. */
|
|
473
477
|
params?: {[P in string]: any};
|
|
474
478
|
/** It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type `BYTES` and values of type `STRING` both appear in params as JSON strings. In these cases, `param_types` can be used to specify the exact SQL type for some or all of the SQL statement parameters. See the definition of Type for more information about SQL types. */
|
|
@@ -557,7 +561,7 @@ declare namespace gapi.client {
|
|
|
557
561
|
config?: string;
|
|
558
562
|
/** Output only. The time at which the instance was created. */
|
|
559
563
|
createTime?: string;
|
|
560
|
-
/** Optional. Controls the default backup behavior for new databases within the instance. Note that `AUTOMATIC`
|
|
564
|
+
/** Optional. Controls the default backup schedule behavior for new databases within the instance. By default, a backup schedule is created automatically when a new database is created in a new instance. Note that the `AUTOMATIC` value isn't permitted for free instances, as backups and backup schedules aren't supported for free instances. In the `GetInstance` or `ListInstances` response, if the value of `default_backup_schedule_type` isn't set, or set to `NONE`, Spanner doesn't create a default backup schedule for new databases in the instance. */
|
|
561
565
|
defaultBackupScheduleType?: string;
|
|
562
566
|
/** Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length. */
|
|
563
567
|
displayName?: string;
|
|
@@ -984,7 +988,7 @@ declare namespace gapi.client {
|
|
|
984
988
|
interface QueryPlan {
|
|
985
989
|
/** The nodes in the query plan. Plan nodes are returned in pre-order starting with the plan root. Each PlanNode's `id` corresponds to its index in `plan_nodes`. */
|
|
986
990
|
planNodes?: PlanNode[];
|
|
987
|
-
/** Optional. The
|
|
991
|
+
/** Optional. The advise/recommendations for a query. Currently this field will be serving index recommendations for a query. */
|
|
988
992
|
queryAdvice?: QueryAdvisorResult;
|
|
989
993
|
}
|
|
990
994
|
interface QuorumInfo {
|
|
@@ -1415,7 +1419,7 @@ declare namespace gapi.client {
|
|
|
1415
1419
|
}): Request<ListInstanceConfigOperationsResponse>;
|
|
1416
1420
|
}
|
|
1417
1421
|
interface OperationsResource {
|
|
1418
|
-
/** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1
|
|
1422
|
+
/** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. */
|
|
1419
1423
|
cancel(request?: {
|
|
1420
1424
|
/** V1 error format. */
|
|
1421
1425
|
'$.xgafv'?: string;
|
|
@@ -1531,7 +1535,7 @@ declare namespace gapi.client {
|
|
|
1531
1535
|
}): Request<ListOperationsResponse>;
|
|
1532
1536
|
}
|
|
1533
1537
|
interface OperationsResource {
|
|
1534
|
-
/** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1
|
|
1538
|
+
/** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. */
|
|
1535
1539
|
cancel(request?: {
|
|
1536
1540
|
/** V1 error format. */
|
|
1537
1541
|
'$.xgafv'?: string;
|
|
@@ -1894,7 +1898,7 @@ declare namespace gapi.client {
|
|
|
1894
1898
|
}): Request<ListBackupOperationsResponse>;
|
|
1895
1899
|
}
|
|
1896
1900
|
interface OperationsResource {
|
|
1897
|
-
/** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1
|
|
1901
|
+
/** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. */
|
|
1898
1902
|
cancel(request?: {
|
|
1899
1903
|
/** V1 error format. */
|
|
1900
1904
|
'$.xgafv'?: string;
|
|
@@ -2783,7 +2787,7 @@ declare namespace gapi.client {
|
|
|
2783
2787
|
): Request<TestIamPermissionsResponse>;
|
|
2784
2788
|
}
|
|
2785
2789
|
interface OperationsResource {
|
|
2786
|
-
/** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1
|
|
2790
|
+
/** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. */
|
|
2787
2791
|
cancel(request?: {
|
|
2788
2792
|
/** V1 error format. */
|
|
2789
2793
|
'$.xgafv'?: string;
|
|
@@ -3274,7 +3278,7 @@ declare namespace gapi.client {
|
|
|
3274
3278
|
},
|
|
3275
3279
|
body: ExecuteBatchDmlRequest
|
|
3276
3280
|
): Request<ExecuteBatchDmlResponse>;
|
|
3277
|
-
/** Executes an SQL statement, returning all results in a single reply. This method cannot be used to return a result set larger than 10 MiB; if the query yields more data than that, the query fails with a `FAILED_PRECONDITION` error. Operations inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead. */
|
|
3281
|
+
/** Executes an SQL statement, returning all results in a single reply. This method cannot be used to return a result set larger than 10 MiB; if the query yields more data than that, the query fails with a `FAILED_PRECONDITION` error. Operations inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead. The query string can be SQL or [Graph Query Language (GQL)](https://cloud.google.com/spanner/docs/reference/standard-sql/graph-intro). */
|
|
3278
3282
|
executeSql(request: {
|
|
3279
3283
|
/** V1 error format. */
|
|
3280
3284
|
'$.xgafv'?: string;
|
|
@@ -3332,7 +3336,7 @@ declare namespace gapi.client {
|
|
|
3332
3336
|
},
|
|
3333
3337
|
body: ExecuteSqlRequest
|
|
3334
3338
|
): Request<ResultSet>;
|
|
3335
|
-
/** Like ExecuteSql, except returns the result set as a stream. Unlike ExecuteSql, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB. */
|
|
3339
|
+
/** Like ExecuteSql, except returns the result set as a stream. Unlike ExecuteSql, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB. The query string can be SQL or [Graph Query Language (GQL)](https://cloud.google.com/spanner/docs/reference/standard-sql/graph-intro). */
|
|
3336
3340
|
executeStreamingSql(request: {
|
|
3337
3341
|
/** V1 error format. */
|
|
3338
3342
|
'$.xgafv'?: string;
|
|
@@ -4314,7 +4318,7 @@ declare namespace gapi.client {
|
|
|
4314
4318
|
}): Request<ListInstancePartitionOperationsResponse>;
|
|
4315
4319
|
}
|
|
4316
4320
|
interface OperationsResource {
|
|
4317
|
-
/** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1
|
|
4321
|
+
/** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. */
|
|
4318
4322
|
cancel(request?: {
|
|
4319
4323
|
/** V1 error format. */
|
|
4320
4324
|
'$.xgafv'?: string;
|
|
@@ -4638,7 +4642,7 @@ declare namespace gapi.client {
|
|
|
4638
4642
|
operations: OperationsResource;
|
|
4639
4643
|
}
|
|
4640
4644
|
interface OperationsResource {
|
|
4641
|
-
/** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1
|
|
4645
|
+
/** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. */
|
|
4642
4646
|
cancel(request?: {
|
|
4643
4647
|
/** V1 error format. */
|
|
4644
4648
|
'$.xgafv'?: string;
|