@googleapis/spanner 7.4.0 → 7.6.0
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/CHANGELOG.md +21 -0
- package/build/v1.d.ts +223 -34
- package/build/v1.js +33 -0
- package/build/v1.js.map +1 -1
- package/package.json +1 -1
- package/v1.ts +306 -34
package/v1.ts
CHANGED
|
@@ -126,10 +126,44 @@ export namespace spanner_v1 {
|
|
|
126
126
|
}
|
|
127
127
|
}
|
|
128
128
|
|
|
129
|
+
/**
|
|
130
|
+
* The request for AddSplitPoints.
|
|
131
|
+
*/
|
|
132
|
+
export interface Schema$AddSplitPointsRequest {
|
|
133
|
+
/**
|
|
134
|
+
* Optional. A user-supplied tag associated with the split points. For example, "intital_data_load", "special_event_1". Defaults to "CloudAddSplitPointsAPI" if not specified. The length of the tag must not exceed 50 characters,else will be trimmed. Only valid UTF8 characters are allowed.
|
|
135
|
+
*/
|
|
136
|
+
initiator?: string | null;
|
|
137
|
+
/**
|
|
138
|
+
* Required. The split points to add.
|
|
139
|
+
*/
|
|
140
|
+
splitPoints?: Schema$SplitPoints[];
|
|
141
|
+
}
|
|
142
|
+
/**
|
|
143
|
+
* The response for AddSplitPoints.
|
|
144
|
+
*/
|
|
145
|
+
export interface Schema$AddSplitPointsResponse {}
|
|
146
|
+
/**
|
|
147
|
+
* AsymmetricAutoscalingOption specifies the scaling of replicas identified by the given selection.
|
|
148
|
+
*/
|
|
149
|
+
export interface Schema$AsymmetricAutoscalingOption {
|
|
150
|
+
/**
|
|
151
|
+
* Optional. Overrides applied to the top-level autoscaling configuration for the selected replicas.
|
|
152
|
+
*/
|
|
153
|
+
overrides?: Schema$AutoscalingConfigOverrides;
|
|
154
|
+
/**
|
|
155
|
+
* Required. Selects the replicas to which this AsymmetricAutoscalingOption applies. Only read-only replicas are supported.
|
|
156
|
+
*/
|
|
157
|
+
replicaSelection?: Schema$InstanceReplicaSelection;
|
|
158
|
+
}
|
|
129
159
|
/**
|
|
130
160
|
* Autoscaling configuration for an instance.
|
|
131
161
|
*/
|
|
132
162
|
export interface Schema$AutoscalingConfig {
|
|
163
|
+
/**
|
|
164
|
+
* Optional. Optional asymmetric autoscaling options. Replicas matching the replica selection criteria will be autoscaled independently from other replicas. The autoscaler will scale the replicas based on the utilization of replicas identified by the replica selection. Replica selections should not overlap with each other. Other replicas (those do not match any replica selection) will be autoscaled together and will have the same compute capacity allocated to them.
|
|
165
|
+
*/
|
|
166
|
+
asymmetricAutoscalingOptions?: Schema$AsymmetricAutoscalingOption[];
|
|
133
167
|
/**
|
|
134
168
|
* Required. Autoscaling limits for an instance.
|
|
135
169
|
*/
|
|
@@ -139,6 +173,19 @@ export namespace spanner_v1 {
|
|
|
139
173
|
*/
|
|
140
174
|
autoscalingTargets?: Schema$AutoscalingTargets;
|
|
141
175
|
}
|
|
176
|
+
/**
|
|
177
|
+
* Overrides the top-level autoscaling configuration for the replicas identified by `replica_selection`. All fields in this message are optional. Any unspecified fields will use the corresponding values from the top-level autoscaling configuration.
|
|
178
|
+
*/
|
|
179
|
+
export interface Schema$AutoscalingConfigOverrides {
|
|
180
|
+
/**
|
|
181
|
+
* Optional. If specified, overrides the min/max limit in the top-level autoscaling configuration for the selected replicas.
|
|
182
|
+
*/
|
|
183
|
+
autoscalingLimits?: Schema$AutoscalingLimits;
|
|
184
|
+
/**
|
|
185
|
+
* Optional. If specified, overrides the autoscaling target high_priority_cpu_utilization_percent in the top-level autoscaling configuration for the selected replicas.
|
|
186
|
+
*/
|
|
187
|
+
autoscalingTargetHighPriorityCpuUtilizationPercent?: number | null;
|
|
188
|
+
}
|
|
142
189
|
/**
|
|
143
190
|
* The autoscaling limits for the instance. Users can define the minimum and maximum compute capacity allocated to the instance, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the min_limit and max_limit.
|
|
144
191
|
*/
|
|
@@ -198,7 +245,7 @@ export namespace spanner_v1 {
|
|
|
198
245
|
*/
|
|
199
246
|
encryptionInfo?: Schema$EncryptionInfo;
|
|
200
247
|
/**
|
|
201
|
-
* 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
|
|
248
|
+
* 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.
|
|
202
249
|
*/
|
|
203
250
|
encryptionInformation?: Schema$EncryptionInfo[];
|
|
204
251
|
/**
|
|
@@ -272,7 +319,7 @@ export namespace spanner_v1 {
|
|
|
272
319
|
versionTime?: string | null;
|
|
273
320
|
}
|
|
274
321
|
/**
|
|
275
|
-
* BackupSchedule expresses the automated backup creation specification for a Spanner database.
|
|
322
|
+
* BackupSchedule expresses the automated backup creation specification for a Spanner database.
|
|
276
323
|
*/
|
|
277
324
|
export interface Schema$BackupSchedule {
|
|
278
325
|
/**
|
|
@@ -373,6 +420,10 @@ export namespace spanner_v1 {
|
|
|
373
420
|
* The request for BeginTransaction.
|
|
374
421
|
*/
|
|
375
422
|
export interface Schema$BeginTransactionRequest {
|
|
423
|
+
/**
|
|
424
|
+
* 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.
|
|
425
|
+
*/
|
|
426
|
+
mutationKey?: Schema$Mutation;
|
|
376
427
|
/**
|
|
377
428
|
* Required. Options for the new transaction.
|
|
378
429
|
*/
|
|
@@ -462,6 +513,10 @@ export namespace spanner_v1 {
|
|
|
462
513
|
* The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list.
|
|
463
514
|
*/
|
|
464
515
|
mutations?: Schema$Mutation[];
|
|
516
|
+
/**
|
|
517
|
+
* 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.
|
|
518
|
+
*/
|
|
519
|
+
precommitToken?: Schema$MultiplexedSessionPrecommitToken;
|
|
465
520
|
/**
|
|
466
521
|
* Common options for this request.
|
|
467
522
|
*/
|
|
@@ -491,6 +546,10 @@ export namespace spanner_v1 {
|
|
|
491
546
|
* The Cloud Spanner timestamp at which the transaction committed.
|
|
492
547
|
*/
|
|
493
548
|
commitTimestamp?: string | null;
|
|
549
|
+
/**
|
|
550
|
+
* If specified, transaction has not committed yet. Clients must retry the commit with the new precommit token.
|
|
551
|
+
*/
|
|
552
|
+
precommitToken?: Schema$MultiplexedSessionPrecommitToken;
|
|
494
553
|
}
|
|
495
554
|
/**
|
|
496
555
|
* Additional statistics about a commit.
|
|
@@ -535,7 +594,7 @@ export namespace spanner_v1 {
|
|
|
535
594
|
*/
|
|
536
595
|
kmsKeyName?: string | null;
|
|
537
596
|
/**
|
|
538
|
-
* 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/`.
|
|
597
|
+
* 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.
|
|
539
598
|
*/
|
|
540
599
|
kmsKeyNames?: string[] | null;
|
|
541
600
|
}
|
|
@@ -594,7 +653,7 @@ export namespace spanner_v1 {
|
|
|
594
653
|
*/
|
|
595
654
|
kmsKeyName?: string | null;
|
|
596
655
|
/**
|
|
597
|
-
* 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
|
|
656
|
+
* 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.
|
|
598
657
|
*/
|
|
599
658
|
kmsKeyNames?: string[] | null;
|
|
600
659
|
}
|
|
@@ -671,7 +730,7 @@ export namespace spanner_v1 {
|
|
|
671
730
|
progress?: Schema$InstanceOperationProgress;
|
|
672
731
|
}
|
|
673
732
|
/**
|
|
674
|
-
* The request for
|
|
733
|
+
* The request for CreateInstanceConfig.
|
|
675
734
|
*/
|
|
676
735
|
export interface Schema$CreateInstanceConfigRequest {
|
|
677
736
|
/**
|
|
@@ -777,7 +836,7 @@ export namespace spanner_v1 {
|
|
|
777
836
|
*/
|
|
778
837
|
creationWindow?: string | null;
|
|
779
838
|
/**
|
|
780
|
-
* 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
|
|
839
|
+
* 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 x/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.
|
|
781
840
|
*/
|
|
782
841
|
text?: string | null;
|
|
783
842
|
/**
|
|
@@ -814,7 +873,7 @@ export namespace spanner_v1 {
|
|
|
814
873
|
*/
|
|
815
874
|
encryptionConfig?: Schema$EncryptionConfig;
|
|
816
875
|
/**
|
|
817
|
-
* 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
|
|
876
|
+
* 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.
|
|
818
877
|
*/
|
|
819
878
|
encryptionInfo?: Schema$EncryptionInfo[];
|
|
820
879
|
/**
|
|
@@ -949,7 +1008,7 @@ export namespace spanner_v1 {
|
|
|
949
1008
|
*/
|
|
950
1009
|
kmsKeyName?: string | null;
|
|
951
1010
|
/**
|
|
952
|
-
* Specifies the KMS configuration for
|
|
1011
|
+
* 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.
|
|
953
1012
|
*/
|
|
954
1013
|
kmsKeyNames?: string[] | null;
|
|
955
1014
|
}
|
|
@@ -983,6 +1042,10 @@ export namespace spanner_v1 {
|
|
|
983
1042
|
* The request for ExecuteBatchDml.
|
|
984
1043
|
*/
|
|
985
1044
|
export interface Schema$ExecuteBatchDmlRequest {
|
|
1045
|
+
/**
|
|
1046
|
+
* 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.
|
|
1047
|
+
*/
|
|
1048
|
+
lastStatements?: boolean | null;
|
|
986
1049
|
/**
|
|
987
1050
|
* Common options for this request.
|
|
988
1051
|
*/
|
|
@@ -1004,6 +1067,10 @@ export namespace spanner_v1 {
|
|
|
1004
1067
|
* The response for ExecuteBatchDml. Contains a list of ResultSet messages, one for each DML statement that has successfully executed, in the same order as the statements in the request. If a statement fails, the status in the response body identifies the cause of the failure. To check for DML statements that failed, use the following approach: 1. Check the status in the response message. The google.rpc.Code enum value `OK` indicates that all statements were executed successfully. 2. If the status was not `OK`, check the number of result sets in the response. If the response contains `N` ResultSet messages, then statement `N+1` in the request failed. Example 1: * Request: 5 DML statements, all executed successfully. * Response: 5 ResultSet messages, with the status `OK`. Example 2: * Request: 5 DML statements. The third statement has a syntax error. * Response: 2 ResultSet messages, and a syntax error (`INVALID_ARGUMENT`) status. The number of ResultSet messages indicates that the third statement failed, and the fourth and fifth statements were not executed.
|
|
1005
1068
|
*/
|
|
1006
1069
|
export interface Schema$ExecuteBatchDmlResponse {
|
|
1070
|
+
/**
|
|
1071
|
+
* 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.
|
|
1072
|
+
*/
|
|
1073
|
+
precommitToken?: Schema$MultiplexedSessionPrecommitToken;
|
|
1007
1074
|
/**
|
|
1008
1075
|
* 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.
|
|
1009
1076
|
*/
|
|
@@ -1025,6 +1092,10 @@ export namespace spanner_v1 {
|
|
|
1025
1092
|
* Directed read options for this request.
|
|
1026
1093
|
*/
|
|
1027
1094
|
directedReadOptions?: Schema$DirectedReadOptions;
|
|
1095
|
+
/**
|
|
1096
|
+
* 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.
|
|
1097
|
+
*/
|
|
1098
|
+
lastStatement?: boolean | null;
|
|
1028
1099
|
/**
|
|
1029
1100
|
* 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.
|
|
1030
1101
|
*/
|
|
@@ -1216,6 +1287,10 @@ export namespace spanner_v1 {
|
|
|
1216
1287
|
* Output only. The time at which the instance was created.
|
|
1217
1288
|
*/
|
|
1218
1289
|
createTime?: string | null;
|
|
1290
|
+
/**
|
|
1291
|
+
* 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.
|
|
1292
|
+
*/
|
|
1293
|
+
defaultBackupScheduleType?: string | null;
|
|
1219
1294
|
/**
|
|
1220
1295
|
* 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.
|
|
1221
1296
|
*/
|
|
@@ -1252,6 +1327,10 @@ export namespace spanner_v1 {
|
|
|
1252
1327
|
* 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).
|
|
1253
1328
|
*/
|
|
1254
1329
|
processingUnits?: number | null;
|
|
1330
|
+
/**
|
|
1331
|
+
* 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.
|
|
1332
|
+
*/
|
|
1333
|
+
replicaComputeCapacity?: Schema$ReplicaComputeCapacity[];
|
|
1255
1334
|
/**
|
|
1256
1335
|
* Output only. The current instance state. For CreateInstance, the state must be either omitted or set to `CREATING`. For UpdateInstance, the state must be either omitted or set to `READY`.
|
|
1257
1336
|
*/
|
|
@@ -1388,6 +1467,24 @@ export namespace spanner_v1 {
|
|
|
1388
1467
|
*/
|
|
1389
1468
|
updateTime?: string | null;
|
|
1390
1469
|
}
|
|
1470
|
+
/**
|
|
1471
|
+
* ReplicaSelection identifies replicas with common properties.
|
|
1472
|
+
*/
|
|
1473
|
+
export interface Schema$InstanceReplicaSelection {
|
|
1474
|
+
/**
|
|
1475
|
+
* Required. Name of the location of the replicas (e.g., "us-central1").
|
|
1476
|
+
*/
|
|
1477
|
+
location?: string | null;
|
|
1478
|
+
}
|
|
1479
|
+
/**
|
|
1480
|
+
* A split key.
|
|
1481
|
+
*/
|
|
1482
|
+
export interface Schema$Key {
|
|
1483
|
+
/**
|
|
1484
|
+
* Required. The column values making up the split key.
|
|
1485
|
+
*/
|
|
1486
|
+
keyParts?: any[] | null;
|
|
1487
|
+
}
|
|
1391
1488
|
/**
|
|
1392
1489
|
* KeyRange represents a range of rows in a table or index. A range has a start key and an end key. These keys can be open or closed, indicating if the range includes rows with that key. Keys are represented by lists, where the ith value in the list corresponds to the ith component of the table or index primary key. Individual values are encoded as described here. For example, consider the following table definition: CREATE TABLE UserEvents ( UserName STRING(MAX), EventDate STRING(10) ) PRIMARY KEY(UserName, EventDate); The following keys name rows in this table: "Bob", "2014-09-23" Since the `UserEvents` table's `PRIMARY KEY` clause names two columns, each `UserEvents` key has two elements; the first is the `UserName`, and the second is the `EventDate`. Key ranges with multiple components are interpreted lexicographically by component using the table or index key's declared sort order. For example, the following range returns all events for user `"Bob"` that occurred in the year 2015: "start_closed": ["Bob", "2015-01-01"] "end_closed": ["Bob", "2015-12-31"] Start and end keys can omit trailing key components. This affects the inclusion and exclusion of rows that exactly match the provided key components: if the key is closed, then rows that exactly match the provided components are included; if the key is open, then rows that exactly match are not included. For example, the following range includes all events for `"Bob"` that occurred during and after the year 2000: "start_closed": ["Bob", "2000-01-01"] "end_closed": ["Bob"] The next example retrieves all events for `"Bob"`: "start_closed": ["Bob"] "end_closed": ["Bob"] To retrieve events before the year 2000: "start_closed": ["Bob"] "end_open": ["Bob", "2000-01-01"] The following range includes all rows in the table: "start_closed": [] "end_closed": [] This range returns all users whose `UserName` begins with any character from A to C: "start_closed": ["A"] "end_open": ["D"] This range returns all users whose `UserName` begins with B: "start_closed": ["B"] "end_open": ["C"] Key ranges honor column sort order. For example, suppose a table is defined as follows: CREATE TABLE DescendingSortedTable { Key INT64, ... ) PRIMARY KEY(Key DESC); The following range retrieves all rows with key values between 1 and 100 inclusive: "start_closed": ["100"] "end_closed": ["1"] Note that 100 is passed as the start, and 1 is passed as the end, because `Key` is a descending column in the schema.
|
|
1393
1490
|
*/
|
|
@@ -1771,6 +1868,19 @@ export namespace spanner_v1 {
|
|
|
1771
1868
|
*/
|
|
1772
1869
|
targetConfig?: string | null;
|
|
1773
1870
|
}
|
|
1871
|
+
/**
|
|
1872
|
+
* When a read-write transaction is executed on a multiplexed session, this precommit token is sent back to the client as a part of the [Transaction] message in the BeginTransaction response and also as a part of the [ResultSet] and [PartialResultSet] responses.
|
|
1873
|
+
*/
|
|
1874
|
+
export interface Schema$MultiplexedSessionPrecommitToken {
|
|
1875
|
+
/**
|
|
1876
|
+
* Opaque precommit token.
|
|
1877
|
+
*/
|
|
1878
|
+
precommitToken?: string | null;
|
|
1879
|
+
/**
|
|
1880
|
+
* An incrementing seq number is generated on every precommit token that is returned. Clients should remember the precommit token with the highest sequence number from the current transaction attempt.
|
|
1881
|
+
*/
|
|
1882
|
+
seqNum?: number | null;
|
|
1883
|
+
}
|
|
1774
1884
|
/**
|
|
1775
1885
|
* A modification to one or more Cloud Spanner rows. Mutations can be applied to a Cloud Spanner database by sending them in a Commit call.
|
|
1776
1886
|
*/
|
|
@@ -1872,6 +1982,10 @@ export namespace spanner_v1 {
|
|
|
1872
1982
|
* Metadata about the result set, such as row type information. Only present in the first response.
|
|
1873
1983
|
*/
|
|
1874
1984
|
metadata?: Schema$ResultSetMetadata;
|
|
1985
|
+
/**
|
|
1986
|
+
* 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.
|
|
1987
|
+
*/
|
|
1988
|
+
precommitToken?: Schema$MultiplexedSessionPrecommitToken;
|
|
1875
1989
|
/**
|
|
1876
1990
|
* 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.
|
|
1877
1991
|
*/
|
|
@@ -2084,7 +2198,7 @@ export namespace spanner_v1 {
|
|
|
2084
2198
|
*/
|
|
2085
2199
|
planNodes?: Schema$PlanNode[];
|
|
2086
2200
|
/**
|
|
2087
|
-
* Optional. The
|
|
2201
|
+
* Optional. The advise/recommendations for a query. Currently this field will be serving index recommendations for a query.
|
|
2088
2202
|
*/
|
|
2089
2203
|
queryAdvice?: Schema$QueryAdvisorResult;
|
|
2090
2204
|
}
|
|
@@ -2212,11 +2326,32 @@ export namespace spanner_v1 {
|
|
|
2212
2326
|
* Message type to initiate a read-write transaction. Currently this transaction type has no options.
|
|
2213
2327
|
*/
|
|
2214
2328
|
export interface Schema$ReadWrite {
|
|
2329
|
+
/**
|
|
2330
|
+
* 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.
|
|
2331
|
+
*/
|
|
2332
|
+
multiplexedSessionPreviousTransactionId?: string | null;
|
|
2215
2333
|
/**
|
|
2216
2334
|
* Read lock mode for the transaction.
|
|
2217
2335
|
*/
|
|
2218
2336
|
readLockMode?: string | null;
|
|
2219
2337
|
}
|
|
2338
|
+
/**
|
|
2339
|
+
* ReplicaComputeCapacity describes the amount of server resources that are allocated to each replica identified by the replica selection.
|
|
2340
|
+
*/
|
|
2341
|
+
export interface Schema$ReplicaComputeCapacity {
|
|
2342
|
+
/**
|
|
2343
|
+
* The number of nodes allocated to each replica. This may be zero in API responses for instances that are not yet in state `READY`.
|
|
2344
|
+
*/
|
|
2345
|
+
nodeCount?: number | null;
|
|
2346
|
+
/**
|
|
2347
|
+
* The number of processing units allocated to each replica. This may be zero in API responses for instances that are not yet in state `READY`.
|
|
2348
|
+
*/
|
|
2349
|
+
processingUnits?: number | null;
|
|
2350
|
+
/**
|
|
2351
|
+
* Required. Identifies replicas by specified properties. All replicas in the selection have the same amount of compute capacity.
|
|
2352
|
+
*/
|
|
2353
|
+
replicaSelection?: Schema$InstanceReplicaSelection;
|
|
2354
|
+
}
|
|
2220
2355
|
export interface Schema$ReplicaInfo {
|
|
2221
2356
|
/**
|
|
2222
2357
|
* If true, this location is designated as the default leader location where leader replicas are placed. See the [region types documentation](https://cloud.google.com/spanner/docs/instances#region_types) for more details.
|
|
@@ -2274,7 +2409,7 @@ export namespace spanner_v1 {
|
|
|
2274
2409
|
*/
|
|
2275
2410
|
kmsKeyName?: string | null;
|
|
2276
2411
|
/**
|
|
2277
|
-
* Optional. Specifies the KMS configuration for
|
|
2412
|
+
* 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.
|
|
2278
2413
|
*/
|
|
2279
2414
|
kmsKeyNames?: string[] | null;
|
|
2280
2415
|
}
|
|
@@ -2345,6 +2480,10 @@ export namespace spanner_v1 {
|
|
|
2345
2480
|
* Metadata about the result set, such as row type information.
|
|
2346
2481
|
*/
|
|
2347
2482
|
metadata?: Schema$ResultSetMetadata;
|
|
2483
|
+
/**
|
|
2484
|
+
* 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.
|
|
2485
|
+
*/
|
|
2486
|
+
precommitToken?: Schema$MultiplexedSessionPrecommitToken;
|
|
2348
2487
|
/**
|
|
2349
2488
|
* 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.
|
|
2350
2489
|
*/
|
|
@@ -2503,6 +2642,27 @@ export namespace spanner_v1 {
|
|
|
2503
2642
|
*/
|
|
2504
2643
|
servingLocation?: string | null;
|
|
2505
2644
|
}
|
|
2645
|
+
/**
|
|
2646
|
+
* The split points of a table/index.
|
|
2647
|
+
*/
|
|
2648
|
+
export interface Schema$SplitPoints {
|
|
2649
|
+
/**
|
|
2650
|
+
* Optional. The expiration timestamp of the split points. A timestamp in the past means immediate expiration. The maximum value can be 30 days in the future. Defaults to 10 days in the future if not specified.
|
|
2651
|
+
*/
|
|
2652
|
+
expireTime?: string | null;
|
|
2653
|
+
/**
|
|
2654
|
+
* The index to split. If specified, the `table` field must refer to the index's base table.
|
|
2655
|
+
*/
|
|
2656
|
+
index?: string | null;
|
|
2657
|
+
/**
|
|
2658
|
+
* Required. The list of split keys, i.e., the split boundaries.
|
|
2659
|
+
*/
|
|
2660
|
+
keys?: Schema$Key[];
|
|
2661
|
+
/**
|
|
2662
|
+
* The table to split.
|
|
2663
|
+
*/
|
|
2664
|
+
table?: string | null;
|
|
2665
|
+
}
|
|
2506
2666
|
/**
|
|
2507
2667
|
* A single DML statement.
|
|
2508
2668
|
*/
|
|
@@ -2572,6 +2732,10 @@ export namespace spanner_v1 {
|
|
|
2572
2732
|
* `id` may be used to identify the transaction in subsequent Read, ExecuteSql, Commit, or Rollback calls. Single-use read-only transactions do not have IDs, because single-use transactions do not support multiple requests.
|
|
2573
2733
|
*/
|
|
2574
2734
|
id?: string | null;
|
|
2735
|
+
/**
|
|
2736
|
+
* A precommit token will be included in the response of a BeginTransaction request if the read-write transaction is on a multiplexed session and a mutation_key was specified in the BeginTransaction. The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction.
|
|
2737
|
+
*/
|
|
2738
|
+
precommitToken?: Schema$MultiplexedSessionPrecommitToken;
|
|
2575
2739
|
/**
|
|
2576
2740
|
* For snapshot read-only transactions, the read timestamp chosen for the transaction. Not returned by default: see TransactionOptions.ReadOnly.return_read_timestamp. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: `"2014-10-02T15:01:23.045123456Z"`.
|
|
2577
2741
|
*/
|
|
@@ -2674,7 +2838,7 @@ export namespace spanner_v1 {
|
|
|
2674
2838
|
*/
|
|
2675
2839
|
export interface Schema$UpdateDatabaseDdlRequest {
|
|
2676
2840
|
/**
|
|
2677
|
-
* 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`.
|
|
2841
|
+
* 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`.
|
|
2678
2842
|
*/
|
|
2679
2843
|
operationId?: string | null;
|
|
2680
2844
|
/**
|
|
@@ -2734,7 +2898,7 @@ export namespace spanner_v1 {
|
|
|
2734
2898
|
progress?: Schema$InstanceOperationProgress;
|
|
2735
2899
|
}
|
|
2736
2900
|
/**
|
|
2737
|
-
* The request for
|
|
2901
|
+
* The request for UpdateInstanceConfig.
|
|
2738
2902
|
*/
|
|
2739
2903
|
export interface Schema$UpdateInstanceConfigRequest {
|
|
2740
2904
|
/**
|
|
@@ -3544,7 +3708,7 @@ export namespace spanner_v1 {
|
|
|
3544
3708
|
}
|
|
3545
3709
|
|
|
3546
3710
|
/**
|
|
3547
|
-
* 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
|
|
3711
|
+
* 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`.
|
|
3548
3712
|
*
|
|
3549
3713
|
* @param params - Parameters for request
|
|
3550
3714
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -3951,7 +4115,7 @@ export namespace spanner_v1 {
|
|
|
3951
4115
|
}
|
|
3952
4116
|
|
|
3953
4117
|
/**
|
|
3954
|
-
* 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
|
|
4118
|
+
* 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`.
|
|
3955
4119
|
*
|
|
3956
4120
|
* @param params - Parameters for request
|
|
3957
4121
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -5758,7 +5922,7 @@ export namespace spanner_v1 {
|
|
|
5758
5922
|
}
|
|
5759
5923
|
|
|
5760
5924
|
/**
|
|
5761
|
-
* 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.
|
|
5925
|
+
* 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.
|
|
5762
5926
|
*
|
|
5763
5927
|
* @param params - Parameters for request
|
|
5764
5928
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -6022,7 +6186,7 @@ export namespace spanner_v1 {
|
|
|
6022
6186
|
}
|
|
6023
6187
|
|
|
6024
6188
|
/**
|
|
6025
|
-
* 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.
|
|
6189
|
+
* 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.
|
|
6026
6190
|
*
|
|
6027
6191
|
* @param params - Parameters for request
|
|
6028
6192
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -6110,7 +6274,7 @@ export namespace spanner_v1 {
|
|
|
6110
6274
|
}
|
|
6111
6275
|
|
|
6112
6276
|
/**
|
|
6113
|
-
* 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.
|
|
6277
|
+
* 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.
|
|
6114
6278
|
*
|
|
6115
6279
|
* @param params - Parameters for request
|
|
6116
6280
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -6233,7 +6397,7 @@ export namespace spanner_v1 {
|
|
|
6233
6397
|
*/
|
|
6234
6398
|
'encryptionConfig.kmsKeyName'?: string;
|
|
6235
6399
|
/**
|
|
6236
|
-
* 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
|
|
6400
|
+
* 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.
|
|
6237
6401
|
*/
|
|
6238
6402
|
'encryptionConfig.kmsKeyNames'?: string[];
|
|
6239
6403
|
/**
|
|
@@ -6275,7 +6439,7 @@ export namespace spanner_v1 {
|
|
|
6275
6439
|
export interface Params$Resource$Projects$Instances$Backups$List
|
|
6276
6440
|
extends StandardParameters {
|
|
6277
6441
|
/**
|
|
6278
|
-
* An expression that filters the list of returned backups. 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 Backup are eligible for filtering: * `name` * `database` * `state` * `create_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * `expire_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * `version_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * `size_bytes` You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic, but you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `name:Howl` - The backup's name contains the string "howl". * `database:prod` - The database's name contains the string "prod". * `state:CREATING` - The backup is pending creation. * `state:READY` - The backup is fully created and ready for use. * `(name:howl) AND (create_time < \"2018-03-28T14:50:00Z\")` - The backup name contains the string "howl" and `create_time` of the backup is before 2018-03-28T14:50:00Z. * `expire_time < \"2018-03-28T14:50:00Z\"` - The backup `expire_time` is before 2018-03-28T14:50:00Z. * `size_bytes \> 10000000000` - The backup's size is greater than 10GB
|
|
6442
|
+
* An expression that filters the list of returned backups. 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 Backup are eligible for filtering: * `name` * `database` * `state` * `create_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * `expire_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * `version_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * `size_bytes` * `backup_schedules` You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic, but you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `name:Howl` - The backup's name contains the string "howl". * `database:prod` - The database's name contains the string "prod". * `state:CREATING` - The backup is pending creation. * `state:READY` - The backup is fully created and ready for use. * `(name:howl) AND (create_time < \"2018-03-28T14:50:00Z\")` - The backup name contains the string "howl" and `create_time` of the backup is before 2018-03-28T14:50:00Z. * `expire_time < \"2018-03-28T14:50:00Z\"` - The backup `expire_time` is before 2018-03-28T14:50:00Z. * `size_bytes \> 10000000000` - The backup's size is greater than 10GB * `backup_schedules:daily` - The backup is created from a schedule with "daily" in its name.
|
|
6279
6443
|
*/
|
|
6280
6444
|
filter?: string;
|
|
6281
6445
|
/**
|
|
@@ -6339,7 +6503,7 @@ export namespace spanner_v1 {
|
|
|
6339
6503
|
}
|
|
6340
6504
|
|
|
6341
6505
|
/**
|
|
6342
|
-
* 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
|
|
6506
|
+
* 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`.
|
|
6343
6507
|
*
|
|
6344
6508
|
* @param params - Parameters for request
|
|
6345
6509
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -6837,7 +7001,7 @@ export namespace spanner_v1 {
|
|
|
6837
7001
|
export interface Params$Resource$Projects$Instances$Databaseoperations$List
|
|
6838
7002
|
extends StandardParameters {
|
|
6839
7003
|
/**
|
|
6840
|
-
* 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
|
|
7004
|
+
* 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.
|
|
6841
7005
|
*/
|
|
6842
7006
|
filter?: string;
|
|
6843
7007
|
/**
|
|
@@ -6874,6 +7038,102 @@ export namespace spanner_v1 {
|
|
|
6874
7038
|
);
|
|
6875
7039
|
}
|
|
6876
7040
|
|
|
7041
|
+
/**
|
|
7042
|
+
* Adds split points to specified tables, indexes of a database.
|
|
7043
|
+
*
|
|
7044
|
+
* @param params - Parameters for request
|
|
7045
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
7046
|
+
* @param callback - Optional callback that handles the response.
|
|
7047
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
7048
|
+
*/
|
|
7049
|
+
addSplitPoints(
|
|
7050
|
+
params: Params$Resource$Projects$Instances$Databases$Addsplitpoints,
|
|
7051
|
+
options: StreamMethodOptions
|
|
7052
|
+
): GaxiosPromise<Readable>;
|
|
7053
|
+
addSplitPoints(
|
|
7054
|
+
params?: Params$Resource$Projects$Instances$Databases$Addsplitpoints,
|
|
7055
|
+
options?: MethodOptions
|
|
7056
|
+
): GaxiosPromise<Schema$AddSplitPointsResponse>;
|
|
7057
|
+
addSplitPoints(
|
|
7058
|
+
params: Params$Resource$Projects$Instances$Databases$Addsplitpoints,
|
|
7059
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
7060
|
+
callback: BodyResponseCallback<Readable>
|
|
7061
|
+
): void;
|
|
7062
|
+
addSplitPoints(
|
|
7063
|
+
params: Params$Resource$Projects$Instances$Databases$Addsplitpoints,
|
|
7064
|
+
options:
|
|
7065
|
+
| MethodOptions
|
|
7066
|
+
| BodyResponseCallback<Schema$AddSplitPointsResponse>,
|
|
7067
|
+
callback: BodyResponseCallback<Schema$AddSplitPointsResponse>
|
|
7068
|
+
): void;
|
|
7069
|
+
addSplitPoints(
|
|
7070
|
+
params: Params$Resource$Projects$Instances$Databases$Addsplitpoints,
|
|
7071
|
+
callback: BodyResponseCallback<Schema$AddSplitPointsResponse>
|
|
7072
|
+
): void;
|
|
7073
|
+
addSplitPoints(
|
|
7074
|
+
callback: BodyResponseCallback<Schema$AddSplitPointsResponse>
|
|
7075
|
+
): void;
|
|
7076
|
+
addSplitPoints(
|
|
7077
|
+
paramsOrCallback?:
|
|
7078
|
+
| Params$Resource$Projects$Instances$Databases$Addsplitpoints
|
|
7079
|
+
| BodyResponseCallback<Schema$AddSplitPointsResponse>
|
|
7080
|
+
| BodyResponseCallback<Readable>,
|
|
7081
|
+
optionsOrCallback?:
|
|
7082
|
+
| MethodOptions
|
|
7083
|
+
| StreamMethodOptions
|
|
7084
|
+
| BodyResponseCallback<Schema$AddSplitPointsResponse>
|
|
7085
|
+
| BodyResponseCallback<Readable>,
|
|
7086
|
+
callback?:
|
|
7087
|
+
| BodyResponseCallback<Schema$AddSplitPointsResponse>
|
|
7088
|
+
| BodyResponseCallback<Readable>
|
|
7089
|
+
):
|
|
7090
|
+
| void
|
|
7091
|
+
| GaxiosPromise<Schema$AddSplitPointsResponse>
|
|
7092
|
+
| GaxiosPromise<Readable> {
|
|
7093
|
+
let params = (paramsOrCallback ||
|
|
7094
|
+
{}) as Params$Resource$Projects$Instances$Databases$Addsplitpoints;
|
|
7095
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
7096
|
+
|
|
7097
|
+
if (typeof paramsOrCallback === 'function') {
|
|
7098
|
+
callback = paramsOrCallback;
|
|
7099
|
+
params =
|
|
7100
|
+
{} as Params$Resource$Projects$Instances$Databases$Addsplitpoints;
|
|
7101
|
+
options = {};
|
|
7102
|
+
}
|
|
7103
|
+
|
|
7104
|
+
if (typeof optionsOrCallback === 'function') {
|
|
7105
|
+
callback = optionsOrCallback;
|
|
7106
|
+
options = {};
|
|
7107
|
+
}
|
|
7108
|
+
|
|
7109
|
+
const rootUrl = options.rootUrl || 'https://spanner.googleapis.com/';
|
|
7110
|
+
const parameters = {
|
|
7111
|
+
options: Object.assign(
|
|
7112
|
+
{
|
|
7113
|
+
url: (rootUrl + '/v1/{+database}:addSplitPoints').replace(
|
|
7114
|
+
/([^:]\/)\/+/g,
|
|
7115
|
+
'$1'
|
|
7116
|
+
),
|
|
7117
|
+
method: 'POST',
|
|
7118
|
+
apiVersion: '',
|
|
7119
|
+
},
|
|
7120
|
+
options
|
|
7121
|
+
),
|
|
7122
|
+
params,
|
|
7123
|
+
requiredParams: ['database'],
|
|
7124
|
+
pathParams: ['database'],
|
|
7125
|
+
context: this.context,
|
|
7126
|
+
};
|
|
7127
|
+
if (callback) {
|
|
7128
|
+
createAPIRequest<Schema$AddSplitPointsResponse>(
|
|
7129
|
+
parameters,
|
|
7130
|
+
callback as BodyResponseCallback<unknown>
|
|
7131
|
+
);
|
|
7132
|
+
} else {
|
|
7133
|
+
return createAPIRequest<Schema$AddSplitPointsResponse>(parameters);
|
|
7134
|
+
}
|
|
7135
|
+
}
|
|
7136
|
+
|
|
6877
7137
|
/**
|
|
6878
7138
|
* `ChangeQuorum` is strictly restricted to databases that use dual-region instance configurations. Initiates a background operation to change the quorum of a database from dual-region mode to single-region mode or vice versa. The returned long-running operation has a name of the format `projects//instances//databases//operations/` and can be used to track execution of the `ChangeQuorum`. The metadata field type is ChangeQuorumMetadata. Authorization requires `spanner.databases.changequorum` permission on the resource database.
|
|
6879
7139
|
*
|
|
@@ -7316,7 +7576,7 @@ export namespace spanner_v1 {
|
|
|
7316
7576
|
}
|
|
7317
7577
|
|
|
7318
7578
|
/**
|
|
7319
|
-
* 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.
|
|
7579
|
+
* 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.
|
|
7320
7580
|
*
|
|
7321
7581
|
* @param params - Parameters for request
|
|
7322
7582
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -7756,7 +8016,7 @@ export namespace spanner_v1 {
|
|
|
7756
8016
|
}
|
|
7757
8017
|
|
|
7758
8018
|
/**
|
|
7759
|
-
* 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.
|
|
8019
|
+
* 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.
|
|
7760
8020
|
*
|
|
7761
8021
|
* @param params - Parameters for request
|
|
7762
8022
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -7845,7 +8105,7 @@ export namespace spanner_v1 {
|
|
|
7845
8105
|
}
|
|
7846
8106
|
|
|
7847
8107
|
/**
|
|
7848
|
-
* 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.
|
|
8108
|
+
* 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.
|
|
7849
8109
|
*
|
|
7850
8110
|
* @param params - Parameters for request
|
|
7851
8111
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -8029,6 +8289,18 @@ export namespace spanner_v1 {
|
|
|
8029
8289
|
}
|
|
8030
8290
|
}
|
|
8031
8291
|
|
|
8292
|
+
export interface Params$Resource$Projects$Instances$Databases$Addsplitpoints
|
|
8293
|
+
extends StandardParameters {
|
|
8294
|
+
/**
|
|
8295
|
+
* Required. The database on whose tables/indexes split points are to be added. Values are of the form `projects//instances//databases/`.
|
|
8296
|
+
*/
|
|
8297
|
+
database?: string;
|
|
8298
|
+
|
|
8299
|
+
/**
|
|
8300
|
+
* Request body metadata
|
|
8301
|
+
*/
|
|
8302
|
+
requestBody?: Schema$AddSplitPointsRequest;
|
|
8303
|
+
}
|
|
8032
8304
|
export interface Params$Resource$Projects$Instances$Databases$Changequorum
|
|
8033
8305
|
extends StandardParameters {
|
|
8034
8306
|
/**
|
|
@@ -8453,7 +8725,7 @@ export namespace spanner_v1 {
|
|
|
8453
8725
|
}
|
|
8454
8726
|
|
|
8455
8727
|
/**
|
|
8456
|
-
* 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.
|
|
8728
|
+
* 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.
|
|
8457
8729
|
*
|
|
8458
8730
|
* @param params - Parameters for request
|
|
8459
8731
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -8724,7 +8996,7 @@ export namespace spanner_v1 {
|
|
|
8724
8996
|
}
|
|
8725
8997
|
|
|
8726
8998
|
/**
|
|
8727
|
-
* 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.
|
|
8999
|
+
* 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.
|
|
8728
9000
|
*
|
|
8729
9001
|
* @param params - Parameters for request
|
|
8730
9002
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -8813,7 +9085,7 @@ export namespace spanner_v1 {
|
|
|
8813
9085
|
}
|
|
8814
9086
|
|
|
8815
9087
|
/**
|
|
8816
|
-
* 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.
|
|
9088
|
+
* 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.
|
|
8817
9089
|
*
|
|
8818
9090
|
* @param params - Parameters for request
|
|
8819
9091
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -9110,7 +9382,7 @@ export namespace spanner_v1 {
|
|
|
9110
9382
|
}
|
|
9111
9383
|
|
|
9112
9384
|
/**
|
|
9113
|
-
* 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.
|
|
9385
|
+
* 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.
|
|
9114
9386
|
*
|
|
9115
9387
|
* @param params - Parameters for request
|
|
9116
9388
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -9241,7 +9513,7 @@ export namespace spanner_v1 {
|
|
|
9241
9513
|
}
|
|
9242
9514
|
|
|
9243
9515
|
/**
|
|
9244
|
-
* 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
|
|
9516
|
+
* 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`.
|
|
9245
9517
|
*
|
|
9246
9518
|
* @param params - Parameters for request
|
|
9247
9519
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -10275,7 +10547,7 @@ export namespace spanner_v1 {
|
|
|
10275
10547
|
}
|
|
10276
10548
|
|
|
10277
10549
|
/**
|
|
10278
|
-
* 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.
|
|
10550
|
+
* 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).
|
|
10279
10551
|
*
|
|
10280
10552
|
* @param params - Parameters for request
|
|
10281
10553
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -10364,7 +10636,7 @@ export namespace spanner_v1 {
|
|
|
10364
10636
|
}
|
|
10365
10637
|
|
|
10366
10638
|
/**
|
|
10367
|
-
* 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.
|
|
10639
|
+
* 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).
|
|
10368
10640
|
*
|
|
10369
10641
|
* @param params - Parameters for request
|
|
10370
10642
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -11393,7 +11665,7 @@ export namespace spanner_v1 {
|
|
|
11393
11665
|
*/
|
|
11394
11666
|
filter?: string;
|
|
11395
11667
|
/**
|
|
11396
|
-
* Optional. Deadline used while retrieving metadata for instance partition operations. Instance partitions whose operation metadata cannot be retrieved within this deadline will be added to
|
|
11668
|
+
* Optional. Deadline used while retrieving metadata for instance partition operations. Instance partitions whose operation metadata cannot be retrieved within this deadline will be added to unreachable_instance_partitions in ListInstancePartitionOperationsResponse.
|
|
11397
11669
|
*/
|
|
11398
11670
|
instancePartitionDeadline?: string;
|
|
11399
11671
|
/**
|
|
@@ -11939,7 +12211,7 @@ export namespace spanner_v1 {
|
|
|
11939
12211
|
}
|
|
11940
12212
|
|
|
11941
12213
|
/**
|
|
11942
|
-
* 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
|
|
12214
|
+
* 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`.
|
|
11943
12215
|
*
|
|
11944
12216
|
* @param params - Parameters for request
|
|
11945
12217
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -12336,7 +12608,7 @@ export namespace spanner_v1 {
|
|
|
12336
12608
|
}
|
|
12337
12609
|
|
|
12338
12610
|
/**
|
|
12339
|
-
* 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
|
|
12611
|
+
* 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`.
|
|
12340
12612
|
*
|
|
12341
12613
|
* @param params - Parameters for request
|
|
12342
12614
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|