@maxim_mazurok/gapi.client.spanner-v1 0.0.20241018 → 0.0.20241028
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 +39 -23
- 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: 20241028
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -71,7 +71,7 @@ declare namespace gapi.client {
|
|
|
71
71
|
databaseDialect?: string;
|
|
72
72
|
/** Output only. The encryption information for the backup. */
|
|
73
73
|
encryptionInfo?: EncryptionInfo;
|
|
74
|
-
/** Output only. The encryption information for the backup, whether it is protected by one or more KMS keys. The information includes all Cloud KMS key versions used to encrypt the backup. The `encryption_status
|
|
74
|
+
/** Output only. The encryption information for the backup, whether it is protected by one or more KMS keys. The information includes all Cloud KMS key versions used to encrypt the backup. The `encryption_status` field inside of each `EncryptionInfo` is not populated. At least one of the key versions must be available for the backup to be restored. If a key version is revoked in the middle of a restore, the restore behavior is undefined. */
|
|
75
75
|
encryptionInformation?: EncryptionInfo[];
|
|
76
76
|
/** Output only. For a backup in an incremental backup chain, this is the storage space needed to keep the data that has changed since the previous backup. For all other backups, this is always the size of the backup. This value may change if backups on the same chain get deleted or expired. This field can be used to calculate the total storage space used by a set of backups. For example, the total space used by all backups of a database can be computed by summing up this field. */
|
|
77
77
|
exclusiveSizeBytes?: string;
|
|
@@ -155,6 +155,8 @@ declare namespace gapi.client {
|
|
|
155
155
|
status?: Status;
|
|
156
156
|
}
|
|
157
157
|
interface BeginTransactionRequest {
|
|
158
|
+
/** Optional. Required for read-write transactions on a multiplexed session that commit mutations but do not perform any reads or queries. Clients should randomly select one of the mutations from the mutation set and send it as a part of this request. */
|
|
159
|
+
mutationKey?: Mutation;
|
|
158
160
|
/** Required. Options for the new transaction. */
|
|
159
161
|
options?: TransactionOptions;
|
|
160
162
|
/** Common options for this request. Priority is ignored for this request. Setting the priority in this request_options struct will not do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead. */
|
|
@@ -197,6 +199,8 @@ declare namespace gapi.client {
|
|
|
197
199
|
maxCommitDelay?: string;
|
|
198
200
|
/** The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list. */
|
|
199
201
|
mutations?: Mutation[];
|
|
202
|
+
/** Optional. If the read-write transaction was executed on a multiplexed session, the precommit token with the highest sequence number received in this transaction attempt, should be included here. Failing to do so will result in a FailedPrecondition error. */
|
|
203
|
+
precommitToken?: MultiplexedSessionPrecommitToken;
|
|
200
204
|
/** Common options for this request. */
|
|
201
205
|
requestOptions?: RequestOptions;
|
|
202
206
|
/** If `true`, then statistics related to the transaction will be included in the CommitResponse. Default value is `false`. */
|
|
@@ -211,6 +215,8 @@ declare namespace gapi.client {
|
|
|
211
215
|
commitStats?: CommitStats;
|
|
212
216
|
/** The Cloud Spanner timestamp at which the transaction committed. */
|
|
213
217
|
commitTimestamp?: string;
|
|
218
|
+
/** If specified, transaction has not committed yet. Clients must retry the commit with the new precommit token. */
|
|
219
|
+
precommitToken?: MultiplexedSessionPrecommitToken;
|
|
214
220
|
}
|
|
215
221
|
interface CommitStats {
|
|
216
222
|
/** The total number of mutations for the transaction. Knowing the `mutation_count` value can help you maximize the number of mutations in a transaction and minimize the number of API round trips. You can also monitor this value to prevent transactions from exceeding the system [limit](https://cloud.google.com/spanner/quotas#limits_for_creating_reading_updating_and_deleting_data). If the number of mutations exceeds the limit, the server returns [INVALID_ARGUMENT](https://cloud.google.com/spanner/docs/reference/rest/v1/Code#ENUM_VALUES.INVALID_ARGUMENT). */
|
|
@@ -231,7 +237,7 @@ declare namespace gapi.client {
|
|
|
231
237
|
encryptionType?: string;
|
|
232
238
|
/** Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. */
|
|
233
239
|
kmsKeyName?: string;
|
|
234
|
-
/** Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`.
|
|
240
|
+
/** Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. KMS keys specified can be in any order. The keys referenced by `kms_key_names` must fully cover all regions of the backup's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for `USER_MANAGED` type instance configurations. */
|
|
235
241
|
kmsKeyNames?: string[];
|
|
236
242
|
}
|
|
237
243
|
interface CopyBackupMetadata {
|
|
@@ -259,7 +265,7 @@ declare namespace gapi.client {
|
|
|
259
265
|
encryptionType?: string;
|
|
260
266
|
/** Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. */
|
|
261
267
|
kmsKeyName?: string;
|
|
262
|
-
/** Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by kms_key_names must fully cover all regions of the backup's instance configuration. Some examples: * For single
|
|
268
|
+
/** Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by `kms_key_names` must fully cover all regions of the backup's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for `USER_MANAGED` type instance configurations. */
|
|
263
269
|
kmsKeyNames?: string[];
|
|
264
270
|
}
|
|
265
271
|
interface CreateBackupMetadata {
|
|
@@ -363,7 +369,7 @@ declare namespace gapi.client {
|
|
|
363
369
|
enableDropProtection?: boolean;
|
|
364
370
|
/** Output only. For databases that are using customer managed encryption, this field contains the encryption configuration for the database. For databases that are using Google default or other types of encryption, this field is empty. */
|
|
365
371
|
encryptionConfig?: EncryptionConfig;
|
|
366
|
-
/** Output only. For databases that are using customer managed encryption, this field contains the encryption information for the database, such as all Cloud KMS key versions that are in use. The `encryption_status
|
|
372
|
+
/** Output only. For databases that are using customer managed encryption, this field contains the encryption information for the database, such as all Cloud KMS key versions that are in use. The `encryption_status` field inside of each `EncryptionInfo` is not populated. For databases that are using Google default or other types of encryption, this field is empty. This field is propagated lazily from the backend. There might be a delay from when a key version is being used and when it appears in this field. */
|
|
367
373
|
encryptionInfo?: EncryptionInfo[];
|
|
368
374
|
/** Required. The name of the database. Values are of the form `projects//instances//databases/`, where `` is as specified in the `CREATE DATABASE` statement. This name can be passed to other API methods to identify the database. */
|
|
369
375
|
name?: string;
|
|
@@ -425,7 +431,7 @@ declare namespace gapi.client {
|
|
|
425
431
|
interface EncryptionConfig {
|
|
426
432
|
/** The Cloud KMS key to be used for encrypting and decrypting the database. Values are of the form `projects//locations//keyRings//cryptoKeys/`. */
|
|
427
433
|
kmsKeyName?: string;
|
|
428
|
-
/** Specifies the KMS configuration for
|
|
434
|
+
/** Specifies the KMS configuration for one or more keys used to encrypt the database. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by `kms_key_names` must fully cover all regions of the database's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for `USER_MANAGED` type instance configurations. */
|
|
429
435
|
kmsKeyNames?: string[];
|
|
430
436
|
}
|
|
431
437
|
interface EncryptionInfo {
|
|
@@ -451,6 +457,8 @@ declare namespace gapi.client {
|
|
|
451
457
|
transaction?: TransactionSelector;
|
|
452
458
|
}
|
|
453
459
|
interface ExecuteBatchDmlResponse {
|
|
460
|
+
/** Optional. A precommit token will be included if the read-write transaction is on a multiplexed session. The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction. */
|
|
461
|
+
precommitToken?: MultiplexedSessionPrecommitToken;
|
|
454
462
|
/** One ResultSet for each statement in the request that ran successfully, in the same order as the statements in the request. Each ResultSet does not contain any rows. The ResultSetStats in each ResultSet contain the number of rows modified by the statement. Only the first ResultSet in the response contains valid ResultSetMetadata. */
|
|
455
463
|
resultSets?: ResultSet[];
|
|
456
464
|
/** If all DML statements are executed successfully, the status is `OK`. Otherwise, the error status of the first failed statement. */
|
|
@@ -549,6 +557,8 @@ declare namespace gapi.client {
|
|
|
549
557
|
config?: string;
|
|
550
558
|
/** Output only. The time at which the instance was created. */
|
|
551
559
|
createTime?: string;
|
|
560
|
+
/** Optional. Controls the default backup behavior for new databases within the instance. Note that `AUTOMATIC` is not permitted for free instances, as backups and backup schedules are not allowed for free instances. In the `GetInstance` or `ListInstances` response, if the value of default_backup_schedule_type is unset or NONE, no default backup schedule will be created for new databases within the instance. */
|
|
561
|
+
defaultBackupScheduleType?: string;
|
|
552
562
|
/** 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. */
|
|
553
563
|
displayName?: string;
|
|
554
564
|
/** Optional. The `Edition` of the current instance. */
|
|
@@ -563,9 +573,9 @@ declare namespace gapi.client {
|
|
|
563
573
|
labels?: {[P in string]: string};
|
|
564
574
|
/** Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects//instances/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. */
|
|
565
575
|
name?: string;
|
|
566
|
-
/** 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 the target number of nodes allocated to the instance. If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state.
|
|
576
|
+
/** 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 the target number of nodes allocated to the instance. If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity). */
|
|
567
577
|
nodeCount?: number;
|
|
568
|
-
/** The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state.
|
|
578
|
+
/** The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes and processing units](https://cloud.google.com/spanner/docs/compute-capacity). */
|
|
569
579
|
processingUnits?: number;
|
|
570
580
|
/** Output only. Lists the compute capacity per ReplicaSelection. A replica selection identifies a set of replicas with common properties. Replicas identified by a ReplicaSelection are scaled with the same compute capacity. */
|
|
571
581
|
replicaComputeCapacity?: ReplicaComputeCapacity[];
|
|
@@ -873,6 +883,8 @@ declare namespace gapi.client {
|
|
|
873
883
|
chunkedValue?: boolean;
|
|
874
884
|
/** Metadata about the result set, such as row type information. Only present in the first response. */
|
|
875
885
|
metadata?: ResultSetMetadata;
|
|
886
|
+
/** Optional. A precommit token will be included if the read-write transaction is on a multiplexed session. The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction. */
|
|
887
|
+
precommitToken?: MultiplexedSessionPrecommitToken;
|
|
876
888
|
/** Streaming calls might be interrupted for a variety of reasons, such as TCP connection loss. If this occurs, the stream of results can be resumed by re-sending the original request and including `resume_token`. Note that executing any other transaction in the same session invalidates the token. */
|
|
877
889
|
resumeToken?: string;
|
|
878
890
|
/** Query plan and execution statistics for the statement that produced this streaming result set. These can be requested by setting ExecuteSqlRequest.query_mode and are sent only once with the last response in the stream. This field will also be present in the last response for DML statements. */
|
|
@@ -1034,6 +1046,8 @@ declare namespace gapi.client {
|
|
|
1034
1046
|
transaction?: TransactionSelector;
|
|
1035
1047
|
}
|
|
1036
1048
|
interface ReadWrite {
|
|
1049
|
+
/** Optional. Clients should pass the transaction ID of the previous transaction attempt that was aborted if this transaction is being executed on a multiplexed session. */
|
|
1050
|
+
multiplexedSessionPreviousTransactionId?: string;
|
|
1037
1051
|
/** Read lock mode for the transaction. */
|
|
1038
1052
|
readLockMode?: string;
|
|
1039
1053
|
}
|
|
@@ -1072,7 +1086,7 @@ declare namespace gapi.client {
|
|
|
1072
1086
|
encryptionType?: string;
|
|
1073
1087
|
/** Optional. The Cloud KMS key that will be used to encrypt/decrypt the restored database. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. */
|
|
1074
1088
|
kmsKeyName?: string;
|
|
1075
|
-
/** Optional. Specifies the KMS configuration for
|
|
1089
|
+
/** Optional. Specifies the KMS configuration for one or more keys used to encrypt the database. Values have the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by `kms_key_names` must fully cover all regions of the database's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for `USER_MANAGED` type instance configurations. */
|
|
1076
1090
|
kmsKeyNames?: string[];
|
|
1077
1091
|
}
|
|
1078
1092
|
interface RestoreDatabaseMetadata {
|
|
@@ -1106,6 +1120,8 @@ declare namespace gapi.client {
|
|
|
1106
1120
|
interface ResultSet {
|
|
1107
1121
|
/** Metadata about the result set, such as row type information. */
|
|
1108
1122
|
metadata?: ResultSetMetadata;
|
|
1123
|
+
/** Optional. A precommit token will be included if the read-write transaction is on a multiplexed session. The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction. */
|
|
1124
|
+
precommitToken?: MultiplexedSessionPrecommitToken;
|
|
1109
1125
|
/** Each element in `rows` is a row whose format is defined by metadata.row_type. The ith element in each row matches the ith field in metadata.row_type. Elements are encoded based on type as described here. */
|
|
1110
1126
|
rows?: any[][];
|
|
1111
1127
|
/** Query plan and execution statistics for the SQL statement that produced this result set. These can be requested by setting ExecuteSqlRequest.query_mode. DML statements always produce stats containing the number of rows modified, unless executed using the ExecuteSqlRequest.QueryMode.PLAN ExecuteSqlRequest.query_mode. Other fields may or may not be populated, based on the ExecuteSqlRequest.query_mode. */
|
|
@@ -1262,7 +1278,7 @@ declare namespace gapi.client {
|
|
|
1262
1278
|
throttled?: boolean;
|
|
1263
1279
|
}
|
|
1264
1280
|
interface UpdateDatabaseDdlRequest {
|
|
1265
|
-
/** If empty, the new update request is assigned an automatically-generated operation ID. Otherwise, `operation_id` is used to construct the name of the resulting Operation. Specifying an explicit operation ID simplifies determining whether the statements were executed in the event that the UpdateDatabaseDdl call is replayed, or the return value is otherwise lost: the database and `operation_id` fields can be combined to form the name of the resulting longrunning.Operation: `/operations/`. `operation_id` should be unique within the database, and must be a valid identifier: `a-z*`. Note that automatically-generated operation IDs always begin with an underscore. If the named operation already exists, UpdateDatabaseDdl returns `ALREADY_EXISTS`. */
|
|
1281
|
+
/** If empty, the new update request is assigned an automatically-generated operation ID. Otherwise, `operation_id` is used to construct the name of the resulting Operation. Specifying an explicit operation ID simplifies determining whether the statements were executed in the event that the UpdateDatabaseDdl call is replayed, or the return value is otherwise lost: the database and `operation_id` fields can be combined to form the `name` of the resulting longrunning.Operation: `/operations/`. `operation_id` should be unique within the database, and must be a valid identifier: `a-z*`. Note that automatically-generated operation IDs always begin with an underscore. If the named operation already exists, UpdateDatabaseDdl returns `ALREADY_EXISTS`. */
|
|
1266
1282
|
operationId?: string;
|
|
1267
1283
|
/** Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements. Contains a protobuf-serialized [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto). To generate it, [install](https://grpc.io/docs/protoc-installation/) and run `protoc` with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run ``` $protoc --proto_path=/app_path --proto_path=/lib_path \ --include_imports \ --descriptor_set_out=descriptors.data \ moon/shot/app.proto ``` For more details, see protobuffer [self description](https://developers.google.com/protocol-buffers/docs/techniques#self-description). */
|
|
1268
1284
|
protoDescriptors?: string;
|
|
@@ -2068,7 +2084,7 @@ declare namespace gapi.client {
|
|
|
2068
2084
|
'encryptionConfig.encryptionType'?: string;
|
|
2069
2085
|
/** Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. */
|
|
2070
2086
|
'encryptionConfig.kmsKeyName'?: string;
|
|
2071
|
-
/** Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by kms_key_names must fully cover all regions of the backup's instance configuration. Some examples: * For single
|
|
2087
|
+
/** Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by `kms_key_names` must fully cover all regions of the backup's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for `USER_MANAGED` type instance configurations. */
|
|
2072
2088
|
'encryptionConfig.kmsKeyNames'?: string | string[];
|
|
2073
2089
|
/** Selector specifying which fields to include in a partial response. */
|
|
2074
2090
|
fields?: string;
|
|
@@ -2105,7 +2121,7 @@ declare namespace gapi.client {
|
|
|
2105
2121
|
'encryptionConfig.encryptionType'?: string;
|
|
2106
2122
|
/** Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. */
|
|
2107
2123
|
'encryptionConfig.kmsKeyName'?: string;
|
|
2108
|
-
/** Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by kms_key_names must fully cover all regions of the backup's instance configuration. Some examples: * For single
|
|
2124
|
+
/** Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by `kms_key_names` must fully cover all regions of the backup's instance configuration. Some examples: * For regional (single-region) instance configurations, specify a regional location KMS key. * For multi-region instance configurations of type `GOOGLE_MANAGED`, either specify a multi-region location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For an instance configuration of type `USER_MANAGED`, specify only regional location KMS keys to cover each region in the instance configuration. Multi-region location KMS keys aren't supported for `USER_MANAGED` type instance configurations. */
|
|
2109
2125
|
'encryptionConfig.kmsKeyNames'?: string | string[];
|
|
2110
2126
|
/** Selector specifying which fields to include in a partial response. */
|
|
2111
2127
|
fields?: string;
|
|
@@ -2180,7 +2196,7 @@ declare namespace gapi.client {
|
|
|
2180
2196
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2181
2197
|
uploadType?: string;
|
|
2182
2198
|
}): Request<Backup>;
|
|
2183
|
-
/** Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.getIamPolicy` permission on resource. */
|
|
2199
|
+
/** Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.getIamPolicy` permission on resource. For backup schedules, authorization requires `spanner.backupSchedules.getIamPolicy` permission on resource. */
|
|
2184
2200
|
getIamPolicy(
|
|
2185
2201
|
request: {
|
|
2186
2202
|
/** V1 error format. */
|
|
@@ -2305,7 +2321,7 @@ declare namespace gapi.client {
|
|
|
2305
2321
|
},
|
|
2306
2322
|
body: Backup
|
|
2307
2323
|
): Request<Backup>;
|
|
2308
|
-
/** Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.setIamPolicy` permission on resource. */
|
|
2324
|
+
/** Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.setIamPolicy` permission on resource. For backup schedules, authorization requires `spanner.backupSchedules.setIamPolicy` permission on resource. */
|
|
2309
2325
|
setIamPolicy(
|
|
2310
2326
|
request: {
|
|
2311
2327
|
/** V1 error format. */
|
|
@@ -2335,7 +2351,7 @@ declare namespace gapi.client {
|
|
|
2335
2351
|
},
|
|
2336
2352
|
body: SetIamPolicyRequest
|
|
2337
2353
|
): Request<Policy>;
|
|
2338
|
-
/** Returns permissions that the caller has on the specified database or backup resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance. */
|
|
2354
|
+
/** Returns permissions that the caller has on the specified database or backup resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance. Calling this method on a backup schedule that does not exist will result in a NOT_FOUND error if the user has `spanner.backupSchedules.list` permission on the containing database. */
|
|
2339
2355
|
testIamPermissions(
|
|
2340
2356
|
request: {
|
|
2341
2357
|
/** V1 error format. */
|
|
@@ -2380,7 +2396,7 @@ declare namespace gapi.client {
|
|
|
2380
2396
|
callback?: string;
|
|
2381
2397
|
/** Selector specifying which fields to include in a partial response. */
|
|
2382
2398
|
fields?: string;
|
|
2383
|
-
/** An expression that filters the list of returned operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the
|
|
2399
|
+
/** An expression that filters the list of returned operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for RestoreDatabaseMetadata is `type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first, if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` \ `(metadata.source_type:BACKUP) AND` \ `(metadata.backup_info.backup:backup_howl) AND` \ `(metadata.name:restored_howl) AND` \ `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` \ `(error:*)` - Return operations where: * The operation's metadata type is RestoreDatabaseMetadata. * The database is restored from a backup. * The backup name contains "backup_howl". * The restored database's name contains "restored_howl". * The operation started before 2018-03-28T14:50:00Z. * The operation resulted in an error. */
|
|
2384
2400
|
filter?: string;
|
|
2385
2401
|
/** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
|
|
2386
2402
|
key?: string;
|
|
@@ -2519,7 +2535,7 @@ declare namespace gapi.client {
|
|
|
2519
2535
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2520
2536
|
uploadType?: string;
|
|
2521
2537
|
}): Request<BackupSchedule>;
|
|
2522
|
-
/** Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.getIamPolicy` permission on resource. */
|
|
2538
|
+
/** Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.getIamPolicy` permission on resource. For backup schedules, authorization requires `spanner.backupSchedules.getIamPolicy` permission on resource. */
|
|
2523
2539
|
getIamPolicy(
|
|
2524
2540
|
request: {
|
|
2525
2541
|
/** V1 error format. */
|
|
@@ -2642,7 +2658,7 @@ declare namespace gapi.client {
|
|
|
2642
2658
|
},
|
|
2643
2659
|
body: BackupSchedule
|
|
2644
2660
|
): Request<BackupSchedule>;
|
|
2645
|
-
/** Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.setIamPolicy` permission on resource. */
|
|
2661
|
+
/** Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.setIamPolicy` permission on resource. For backup schedules, authorization requires `spanner.backupSchedules.setIamPolicy` permission on resource. */
|
|
2646
2662
|
setIamPolicy(
|
|
2647
2663
|
request: {
|
|
2648
2664
|
/** V1 error format. */
|
|
@@ -2672,7 +2688,7 @@ declare namespace gapi.client {
|
|
|
2672
2688
|
},
|
|
2673
2689
|
body: SetIamPolicyRequest
|
|
2674
2690
|
): Request<Policy>;
|
|
2675
|
-
/** Returns permissions that the caller has on the specified database or backup resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance. */
|
|
2691
|
+
/** Returns permissions that the caller has on the specified database or backup resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance. Calling this method on a backup schedule that does not exist will result in a NOT_FOUND error if the user has `spanner.backupSchedules.list` permission on the containing database. */
|
|
2676
2692
|
testIamPermissions(
|
|
2677
2693
|
request: {
|
|
2678
2694
|
/** V1 error format. */
|
|
@@ -2735,7 +2751,7 @@ declare namespace gapi.client {
|
|
|
2735
2751
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2736
2752
|
uploadType?: string;
|
|
2737
2753
|
}): Request<ListDatabaseRolesResponse>;
|
|
2738
|
-
/** Returns permissions that the caller has on the specified database or backup resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance. */
|
|
2754
|
+
/** Returns permissions that the caller has on the specified database or backup resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance. Calling this method on a backup schedule that does not exist will result in a NOT_FOUND error if the user has `spanner.backupSchedules.list` permission on the containing database. */
|
|
2739
2755
|
testIamPermissions(
|
|
2740
2756
|
request: {
|
|
2741
2757
|
/** V1 error format. */
|
|
@@ -3923,7 +3939,7 @@ declare namespace gapi.client {
|
|
|
3923
3939
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3924
3940
|
uploadType?: string;
|
|
3925
3941
|
}): Request<GetDatabaseDdlResponse>;
|
|
3926
|
-
/** Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.getIamPolicy` permission on resource. */
|
|
3942
|
+
/** Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.getIamPolicy` permission on resource. For backup schedules, authorization requires `spanner.backupSchedules.getIamPolicy` permission on resource. */
|
|
3927
3943
|
getIamPolicy(
|
|
3928
3944
|
request: {
|
|
3929
3945
|
/** V1 error format. */
|
|
@@ -4137,7 +4153,7 @@ declare namespace gapi.client {
|
|
|
4137
4153
|
},
|
|
4138
4154
|
body: RestoreDatabaseRequest
|
|
4139
4155
|
): Request<Operation>;
|
|
4140
|
-
/** Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.setIamPolicy` permission on resource. */
|
|
4156
|
+
/** Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.setIamPolicy` permission on resource. For backup schedules, authorization requires `spanner.backupSchedules.setIamPolicy` permission on resource. */
|
|
4141
4157
|
setIamPolicy(
|
|
4142
4158
|
request: {
|
|
4143
4159
|
/** V1 error format. */
|
|
@@ -4167,7 +4183,7 @@ declare namespace gapi.client {
|
|
|
4167
4183
|
},
|
|
4168
4184
|
body: SetIamPolicyRequest
|
|
4169
4185
|
): Request<Policy>;
|
|
4170
|
-
/** Returns permissions that the caller has on the specified database or backup resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance. */
|
|
4186
|
+
/** Returns permissions that the caller has on the specified database or backup resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance. Calling this method on a backup schedule that does not exist will result in a NOT_FOUND error if the user has `spanner.backupSchedules.list` permission on the containing database. */
|
|
4171
4187
|
testIamPermissions(
|
|
4172
4188
|
request: {
|
|
4173
4189
|
/** V1 error format. */
|