@maxim_mazurok/gapi.client.spanner-v1 0.0.20240628 → 0.0.20240709
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 +128 -35
- 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: 20240709
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -233,21 +233,21 @@ declare namespace gapi.client {
|
|
|
233
233
|
encryptionConfig?: EncryptionConfig;
|
|
234
234
|
/** Optional. A list of DDL statements to run inside the newly created database. Statements can create tables, indexes, etc. These statements execute atomically with the creation of the database: if there is an error in any statement, the database is not created. */
|
|
235
235
|
extraStatements?: string[];
|
|
236
|
-
/** Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements in 'extra_statements'
|
|
236
|
+
/** Optional. Proto descriptors used by `CREATE/ALTER PROTO BUNDLE` statements in 'extra_statements'. Contains a protobuf-serialized [`google.protobuf.FileDescriptorSet`](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto) descriptor set. 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). */
|
|
237
237
|
protoDescriptors?: string;
|
|
238
238
|
}
|
|
239
239
|
interface CreateInstanceConfigMetadata {
|
|
240
240
|
/** The time at which this operation was cancelled. */
|
|
241
241
|
cancelTime?: string;
|
|
242
|
-
/** The target instance
|
|
242
|
+
/** The target instance configuration end state. */
|
|
243
243
|
instanceConfig?: InstanceConfig;
|
|
244
244
|
/** The progress of the CreateInstanceConfig operation. */
|
|
245
245
|
progress?: InstanceOperationProgress;
|
|
246
246
|
}
|
|
247
247
|
interface CreateInstanceConfigRequest {
|
|
248
|
-
/** Required. The InstanceConfig proto of the configuration to create. instance_config.name must be `/instanceConfigs/`. instance_config.base_config must be a Google
|
|
248
|
+
/** Required. The InstanceConfig proto of the configuration to create. instance_config.name must be `/instanceConfigs/`. instance_config.base_config must be a Google-managed configuration name, e.g. /instanceConfigs/us-east1, /instanceConfigs/nam3. */
|
|
249
249
|
instanceConfig?: InstanceConfig;
|
|
250
|
-
/** Required. The ID of the instance
|
|
250
|
+
/** Required. The ID of the instance configuration to create. Valid identifiers are of the form `custom-[-a-z0-9]*[a-z0-9]` and must be between 2 and 64 characters in length. The `custom-` prefix is required to avoid name conflicts with Google-managed configurations. */
|
|
251
251
|
instanceConfigId?: string;
|
|
252
252
|
/** An option to validate, but not actually execute, a request, and provide the same response. */
|
|
253
253
|
validateOnly?: boolean;
|
|
@@ -499,9 +499,9 @@ declare namespace gapi.client {
|
|
|
499
499
|
labels?: {[P in string]: string};
|
|
500
500
|
/** 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. */
|
|
501
501
|
name?: string;
|
|
502
|
-
/** 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
|
|
502
|
+
/** 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). */
|
|
503
503
|
nodeCount?: number;
|
|
504
|
-
/** The number of processing units allocated to this instance. At most one of processing_units or node_count should be present in the message. Users can set the processing_units field 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
|
|
504
|
+
/** 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. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. */
|
|
505
505
|
processingUnits?: number;
|
|
506
506
|
/** 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`. */
|
|
507
507
|
state?: string;
|
|
@@ -509,13 +509,13 @@ declare namespace gapi.client {
|
|
|
509
509
|
updateTime?: string;
|
|
510
510
|
}
|
|
511
511
|
interface InstanceConfig {
|
|
512
|
-
/** Base configuration name, e.g. projects//instanceConfigs/nam3, based on which this configuration is created. Only set for user
|
|
512
|
+
/** Base configuration name, e.g. projects//instanceConfigs/nam3, based on which this configuration is created. Only set for user-managed configurations. `base_config` must refer to a configuration of type `GOOGLE_MANAGED` in the same project as this configuration. */
|
|
513
513
|
baseConfig?: string;
|
|
514
|
-
/** Output only. Whether this instance
|
|
514
|
+
/** Output only. Whether this instance configuration is a Google- or user-managed configuration. */
|
|
515
515
|
configType?: string;
|
|
516
516
|
/** The name of this instance configuration as it appears in UIs. */
|
|
517
517
|
displayName?: string;
|
|
518
|
-
/** etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance
|
|
518
|
+
/** etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance configuration from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance configuration updates in order to avoid race conditions: An etag is returned in the response which contains instance configurations, and systems are expected to put that etag in the request to update instance configuration to ensure that their change is applied to the same version of the instance configuration. If no etag is provided in the call to update the instance configuration, then the existing instance configuration is overwritten blindly. */
|
|
519
519
|
etag?: string;
|
|
520
520
|
/** Output only. Describes whether free instances are available to be created in this instance config. */
|
|
521
521
|
freeInstanceAvailability?: string;
|
|
@@ -523,17 +523,17 @@ declare namespace gapi.client {
|
|
|
523
523
|
labels?: {[P in string]: string};
|
|
524
524
|
/** Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration. */
|
|
525
525
|
leaderOptions?: string[];
|
|
526
|
-
/** A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance
|
|
526
|
+
/** A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance configuration must start with `custom-`. */
|
|
527
527
|
name?: string;
|
|
528
|
-
/** Output only. The available optional replicas to choose from for user
|
|
528
|
+
/** Output only. The available optional replicas to choose from for user-managed configurations. Populated for Google-managed configurations. */
|
|
529
529
|
optionalReplicas?: ReplicaInfo[];
|
|
530
530
|
/** Output only. The `QuorumType` of the instance configuration. */
|
|
531
531
|
quorumType?: string;
|
|
532
|
-
/** Output only. If true, the instance
|
|
532
|
+
/** Output only. If true, the instance configuration is being created or updated. If false, there are no ongoing operations for the instance config. */
|
|
533
533
|
reconciling?: boolean;
|
|
534
|
-
/** The geographic placement of nodes in this instance configuration and their replication properties. To create user
|
|
534
|
+
/** The geographic placement of nodes in this instance configuration and their replication properties. To create user-managed configurations, input `replicas` must include all replicas in `replicas` of the `base_config` and include one or more replicas in the `optional_replicas` of the `base_config`. */
|
|
535
535
|
replicas?: ReplicaInfo[];
|
|
536
|
-
/** Output only. The current instance
|
|
536
|
+
/** Output only. The current instance configuration state. Applicable only for `USER_MANAGED` configurations. */
|
|
537
537
|
state?: string;
|
|
538
538
|
/** Output only. The storage limit in bytes per processing unit. */
|
|
539
539
|
storageLimitPerProcessingUnit?: string;
|
|
@@ -557,9 +557,9 @@ declare namespace gapi.client {
|
|
|
557
557
|
etag?: string;
|
|
558
558
|
/** Required. A unique identifier for the instance partition. Values are of the form `projects//instances//instancePartitions/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. An instance partition's name cannot be changed after the instance partition is created. */
|
|
559
559
|
name?: string;
|
|
560
|
-
/** The number of nodes allocated to this instance partition. Users can set the node_count field to specify the target number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. */
|
|
560
|
+
/** The number of nodes allocated to this instance partition. Users can set the `node_count` field to specify the target number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. */
|
|
561
561
|
nodeCount?: number;
|
|
562
|
-
/** The number of processing units allocated to this instance partition. Users can set the processing_units field to specify the target number of processing units allocated to the instance partition. This
|
|
562
|
+
/** The number of processing units allocated to this instance partition. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance partition. This might be zero in API responses for instance partitions that are not yet in the `READY` state. */
|
|
563
563
|
processingUnits?: number;
|
|
564
564
|
/** Output only. The names of the backups that reference this instance partition. Referencing backups should share the parent instance. The existence of any referencing backup prevents the instance partition from being deleted. */
|
|
565
565
|
referencingBackups?: string[];
|
|
@@ -647,7 +647,7 @@ declare namespace gapi.client {
|
|
|
647
647
|
interface ListInstanceConfigOperationsResponse {
|
|
648
648
|
/** `next_page_token` can be sent in a subsequent ListInstanceConfigOperations call to fetch more of the matching metadata. */
|
|
649
649
|
nextPageToken?: string;
|
|
650
|
-
/** The list of matching instance
|
|
650
|
+
/** The list of matching instance configuration long-running operations. Each operation's name will be prefixed by the instance config's name. The operation's metadata field type `metadata.type_url` describes the type of the metadata. */
|
|
651
651
|
operations?: Operation[];
|
|
652
652
|
}
|
|
653
653
|
interface ListInstanceConfigsResponse {
|
|
@@ -741,7 +741,7 @@ declare namespace gapi.client {
|
|
|
741
741
|
cols?: number[];
|
|
742
742
|
}
|
|
743
743
|
interface MoveInstanceRequest {
|
|
744
|
-
/** Required. The target instance
|
|
744
|
+
/** Required. The target instance configuration for the instance to move. Values are of the form `projects//instanceConfigs/`. */
|
|
745
745
|
targetConfig?: string;
|
|
746
746
|
}
|
|
747
747
|
interface Mutation {
|
|
@@ -816,7 +816,7 @@ declare namespace gapi.client {
|
|
|
816
816
|
paramTypes?: {[P in string]: Type};
|
|
817
817
|
/** Additional options that affect how many partitions are created. */
|
|
818
818
|
partitionOptions?: PartitionOptions;
|
|
819
|
-
/** Required. The query request to generate partitions for. The request
|
|
819
|
+
/** Required. The query request to generate partitions for. The request fails if the query is not root partitionable. For a query to be root partitionable, it needs to satisfy a few conditions. For example, if the query execution plan contains a distributed union operator, then it must be the first operator in the plan. For more information about other conditions, see [Read data in parallel](https://cloud.google.com/spanner/docs/reads#read_data_in_parallel). The query request must not contain DML commands, such as `INSERT`, `UPDATE`, or `DELETE`. Use `ExecuteStreamingSql` with a PartitionedDml transaction for large, partition-friendly DML operations. */
|
|
820
820
|
sql?: string;
|
|
821
821
|
/** Read only snapshot transactions are supported, read/write and single use transactions are not. */
|
|
822
822
|
transaction?: TransactionSelector;
|
|
@@ -982,7 +982,7 @@ declare namespace gapi.client {
|
|
|
982
982
|
encryptionType?: string;
|
|
983
983
|
/** 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/`. */
|
|
984
984
|
kmsKeyName?: string;
|
|
985
|
-
/** Optional. Specifies the KMS configuration for the one or more keys used to encrypt the database. Values
|
|
985
|
+
/** Optional. Specifies the KMS configuration for the 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 instance configuration. Some examples: * For single region database instance configurations, specify a single regional location KMS key. * For multi-regional database instance configurations of type `GOOGLE_MANAGED`, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For a database instance configuration of type `USER_MANAGED`, please specify only regional location KMS keys to cover each region in the instance configuration. Multi-regional location KMS keys are not supported for USER_MANAGED instance configurations. */
|
|
986
986
|
kmsKeyNames?: string[];
|
|
987
987
|
}
|
|
988
988
|
interface RestoreDatabaseMetadata {
|
|
@@ -1194,13 +1194,13 @@ declare namespace gapi.client {
|
|
|
1194
1194
|
interface UpdateInstanceConfigMetadata {
|
|
1195
1195
|
/** The time at which this operation was cancelled. */
|
|
1196
1196
|
cancelTime?: string;
|
|
1197
|
-
/** The desired instance
|
|
1197
|
+
/** The desired instance configuration after updating. */
|
|
1198
1198
|
instanceConfig?: InstanceConfig;
|
|
1199
1199
|
/** The progress of the UpdateInstanceConfig operation. */
|
|
1200
1200
|
progress?: InstanceOperationProgress;
|
|
1201
1201
|
}
|
|
1202
1202
|
interface UpdateInstanceConfigRequest {
|
|
1203
|
-
/** Required. The user instance
|
|
1203
|
+
/** Required. The user instance configuration to update, which must always include the instance configuration name. Otherwise, only fields mentioned in update_mask need be included. To prevent conflicts of concurrent updates, etag can be used. */
|
|
1204
1204
|
instanceConfig?: InstanceConfig;
|
|
1205
1205
|
/** Required. A mask specifying which fields in InstanceConfig should be updated. The field mask must always be specified; this prevents any future fields in InstanceConfig from being erased accidentally by clients that do not know about them. Only display_name and labels can be updated. */
|
|
1206
1206
|
updateMask?: string;
|
|
@@ -1272,7 +1272,7 @@ declare namespace gapi.client {
|
|
|
1272
1272
|
values?: any[][];
|
|
1273
1273
|
}
|
|
1274
1274
|
interface InstanceConfigOperationsResource {
|
|
1275
|
-
/** Lists the user-managed instance
|
|
1275
|
+
/** Lists the user-managed instance configuration long-running operations in the given project. An instance configuration operation has a name of the form `projects//instanceConfigs//operations/`. The long-running operation metadata field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.start_time` in descending order starting from the most recently started operation. */
|
|
1276
1276
|
list(request?: {
|
|
1277
1277
|
/** V1 error format. */
|
|
1278
1278
|
'$.xgafv'?: string;
|
|
@@ -1284,7 +1284,7 @@ declare namespace gapi.client {
|
|
|
1284
1284
|
callback?: string;
|
|
1285
1285
|
/** Selector specifying which fields to include in a partial response. */
|
|
1286
1286
|
fields?: string;
|
|
1287
|
-
/** 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 CreateInstanceConfigMetadata is `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata`. * `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.instance.v1.CreateInstanceConfigMetadata) AND` \ `(metadata.instance_config.name:custom-config) AND` \ `(metadata.progress.start_time < \"2021-03-28T14:50:00Z\") AND` \ `(error:*)` - Return operations where: * The operation's metadata type is CreateInstanceConfigMetadata. * The instance
|
|
1287
|
+
/** 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 CreateInstanceConfigMetadata is `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata`. * `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.instance.v1.CreateInstanceConfigMetadata) AND` \ `(metadata.instance_config.name:custom-config) AND` \ `(metadata.progress.start_time < \"2021-03-28T14:50:00Z\") AND` \ `(error:*)` - Return operations where: * The operation's metadata type is CreateInstanceConfigMetadata. * The instance configuration name contains "custom-config". * The operation started before 2021-03-28T14:50:00Z. * The operation resulted in an error. */
|
|
1288
1288
|
filter?: string;
|
|
1289
1289
|
/** 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. */
|
|
1290
1290
|
key?: string;
|
|
@@ -1294,7 +1294,7 @@ declare namespace gapi.client {
|
|
|
1294
1294
|
pageSize?: number;
|
|
1295
1295
|
/** If non-empty, `page_token` should contain a next_page_token from a previous ListInstanceConfigOperationsResponse to the same `parent` and with the same `filter`. */
|
|
1296
1296
|
pageToken?: string;
|
|
1297
|
-
/** Required. The project of the instance
|
|
1297
|
+
/** Required. The project of the instance configuration operations. Values are of the form `projects/`. */
|
|
1298
1298
|
parent: string;
|
|
1299
1299
|
/** Returns response with indentations and line breaks. */
|
|
1300
1300
|
prettyPrint?: boolean;
|
|
@@ -1542,7 +1542,7 @@ declare namespace gapi.client {
|
|
|
1542
1542
|
operations: OperationsResource;
|
|
1543
1543
|
}
|
|
1544
1544
|
interface InstanceConfigsResource {
|
|
1545
|
-
/** Creates an instance
|
|
1545
|
+
/** Creates an instance configuration and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance config. The instance configuration name is assigned by the caller. If the named instance configuration already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance configuration is readable via the API, with all requested attributes. The instance config's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance configuration immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance configuration are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance config's reconciling field becomes false. Its state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance config. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent. */
|
|
1546
1546
|
create(request: {
|
|
1547
1547
|
/** V1 error format. */
|
|
1548
1548
|
'$.xgafv'?: string;
|
|
@@ -1600,7 +1600,7 @@ declare namespace gapi.client {
|
|
|
1600
1600
|
},
|
|
1601
1601
|
body: CreateInstanceConfigRequest
|
|
1602
1602
|
): Request<Operation>;
|
|
1603
|
-
/** Deletes the instance config. Deletion is only allowed when no instances are using the configuration. If any instances are using the config, returns `FAILED_PRECONDITION`. Only user
|
|
1603
|
+
/** Deletes the instance config. Deletion is only allowed when no instances are using the configuration. If any instances are using the config, returns `FAILED_PRECONDITION`. Only user-managed configurations can be deleted. Authorization requires `spanner.instanceConfigs.delete` permission on the resource name. */
|
|
1604
1604
|
delete(request?: {
|
|
1605
1605
|
/** V1 error format. */
|
|
1606
1606
|
'$.xgafv'?: string;
|
|
@@ -1610,7 +1610,7 @@ declare namespace gapi.client {
|
|
|
1610
1610
|
alt?: string;
|
|
1611
1611
|
/** JSONP */
|
|
1612
1612
|
callback?: string;
|
|
1613
|
-
/** Used for optimistic concurrency control as a way to help prevent simultaneous deletes of an instance
|
|
1613
|
+
/** Used for optimistic concurrency control as a way to help prevent simultaneous deletes of an instance configuration from overwriting each other. If not empty, the API only deletes the instance configuration when the etag provided matches the current status of the requested instance config. Otherwise, deletes the instance configuration without checking the current status of the requested instance config. */
|
|
1614
1614
|
etag?: string;
|
|
1615
1615
|
/** Selector specifying which fields to include in a partial response. */
|
|
1616
1616
|
fields?: string;
|
|
@@ -1658,7 +1658,7 @@ declare namespace gapi.client {
|
|
|
1658
1658
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1659
1659
|
uploadType?: string;
|
|
1660
1660
|
}): Request<InstanceConfig>;
|
|
1661
|
-
/** Lists the supported instance configurations for a given project. Returns both Google
|
|
1661
|
+
/** Lists the supported instance configurations for a given project. Returns both Google-managed configurations and user-managed configurations. */
|
|
1662
1662
|
list(request?: {
|
|
1663
1663
|
/** V1 error format. */
|
|
1664
1664
|
'$.xgafv'?: string;
|
|
@@ -1689,7 +1689,7 @@ declare namespace gapi.client {
|
|
|
1689
1689
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1690
1690
|
uploadType?: string;
|
|
1691
1691
|
}): Request<ListInstanceConfigsResponse>;
|
|
1692
|
-
/** Updates an instance config. The returned long-running operation can be used to track the progress of updating the instance. If the named instance
|
|
1692
|
+
/** Updates an instance config. The returned long-running operation can be used to track the progress of updating the instance. If the named instance configuration does not exist, returns `NOT_FOUND`. Only user-managed configurations can be updated. Immediately after the request returns: * The instance config's reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance configuration are rejected. * Reading the instance configuration via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The instance config's new values are readable via the API. * The instance config's reconciling field becomes false. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance configuration modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.update` permission on the resource name. */
|
|
1693
1693
|
patch(request: {
|
|
1694
1694
|
/** V1 error format. */
|
|
1695
1695
|
'$.xgafv'?: string;
|
|
@@ -1703,7 +1703,7 @@ declare namespace gapi.client {
|
|
|
1703
1703
|
fields?: string;
|
|
1704
1704
|
/** 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. */
|
|
1705
1705
|
key?: string;
|
|
1706
|
-
/** A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance
|
|
1706
|
+
/** A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance configuration must start with `custom-`. */
|
|
1707
1707
|
name: string;
|
|
1708
1708
|
/** OAuth 2.0 token for the current user. */
|
|
1709
1709
|
oauth_token?: string;
|
|
@@ -1732,7 +1732,7 @@ declare namespace gapi.client {
|
|
|
1732
1732
|
fields?: string;
|
|
1733
1733
|
/** 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. */
|
|
1734
1734
|
key?: string;
|
|
1735
|
-
/** A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance
|
|
1735
|
+
/** A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance configuration must start with `custom-`. */
|
|
1736
1736
|
name: string;
|
|
1737
1737
|
/** OAuth 2.0 token for the current user. */
|
|
1738
1738
|
oauth_token?: string;
|
|
@@ -2310,6 +2310,98 @@ declare namespace gapi.client {
|
|
|
2310
2310
|
uploadType?: string;
|
|
2311
2311
|
}): Request<ListDatabaseOperationsResponse>;
|
|
2312
2312
|
}
|
|
2313
|
+
interface BackupSchedulesResource {
|
|
2314
|
+
/** 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. */
|
|
2315
|
+
getIamPolicy(
|
|
2316
|
+
request: {
|
|
2317
|
+
/** V1 error format. */
|
|
2318
|
+
'$.xgafv'?: string;
|
|
2319
|
+
/** OAuth access token. */
|
|
2320
|
+
access_token?: string;
|
|
2321
|
+
/** Data format for response. */
|
|
2322
|
+
alt?: string;
|
|
2323
|
+
/** JSONP */
|
|
2324
|
+
callback?: string;
|
|
2325
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2326
|
+
fields?: string;
|
|
2327
|
+
/** 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. */
|
|
2328
|
+
key?: string;
|
|
2329
|
+
/** OAuth 2.0 token for the current user. */
|
|
2330
|
+
oauth_token?: string;
|
|
2331
|
+
/** Returns response with indentations and line breaks. */
|
|
2332
|
+
prettyPrint?: boolean;
|
|
2333
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2334
|
+
quotaUser?: string;
|
|
2335
|
+
/** REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources. */
|
|
2336
|
+
resource: string;
|
|
2337
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2338
|
+
upload_protocol?: string;
|
|
2339
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2340
|
+
uploadType?: string;
|
|
2341
|
+
},
|
|
2342
|
+
body: GetIamPolicyRequest
|
|
2343
|
+
): Request<Policy>;
|
|
2344
|
+
/** 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. */
|
|
2345
|
+
setIamPolicy(
|
|
2346
|
+
request: {
|
|
2347
|
+
/** V1 error format. */
|
|
2348
|
+
'$.xgafv'?: string;
|
|
2349
|
+
/** OAuth access token. */
|
|
2350
|
+
access_token?: string;
|
|
2351
|
+
/** Data format for response. */
|
|
2352
|
+
alt?: string;
|
|
2353
|
+
/** JSONP */
|
|
2354
|
+
callback?: string;
|
|
2355
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2356
|
+
fields?: string;
|
|
2357
|
+
/** 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. */
|
|
2358
|
+
key?: string;
|
|
2359
|
+
/** OAuth 2.0 token for the current user. */
|
|
2360
|
+
oauth_token?: string;
|
|
2361
|
+
/** Returns response with indentations and line breaks. */
|
|
2362
|
+
prettyPrint?: boolean;
|
|
2363
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2364
|
+
quotaUser?: string;
|
|
2365
|
+
/** REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for databases resources. */
|
|
2366
|
+
resource: string;
|
|
2367
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2368
|
+
upload_protocol?: string;
|
|
2369
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2370
|
+
uploadType?: string;
|
|
2371
|
+
},
|
|
2372
|
+
body: SetIamPolicyRequest
|
|
2373
|
+
): Request<Policy>;
|
|
2374
|
+
/** 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. */
|
|
2375
|
+
testIamPermissions(
|
|
2376
|
+
request: {
|
|
2377
|
+
/** V1 error format. */
|
|
2378
|
+
'$.xgafv'?: string;
|
|
2379
|
+
/** OAuth access token. */
|
|
2380
|
+
access_token?: string;
|
|
2381
|
+
/** Data format for response. */
|
|
2382
|
+
alt?: string;
|
|
2383
|
+
/** JSONP */
|
|
2384
|
+
callback?: string;
|
|
2385
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2386
|
+
fields?: string;
|
|
2387
|
+
/** 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. */
|
|
2388
|
+
key?: string;
|
|
2389
|
+
/** OAuth 2.0 token for the current user. */
|
|
2390
|
+
oauth_token?: string;
|
|
2391
|
+
/** Returns response with indentations and line breaks. */
|
|
2392
|
+
prettyPrint?: boolean;
|
|
2393
|
+
/** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
|
|
2394
|
+
quotaUser?: string;
|
|
2395
|
+
/** REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources. */
|
|
2396
|
+
resource: string;
|
|
2397
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2398
|
+
upload_protocol?: string;
|
|
2399
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2400
|
+
uploadType?: string;
|
|
2401
|
+
},
|
|
2402
|
+
body: TestIamPermissionsRequest
|
|
2403
|
+
): Request<TestIamPermissionsResponse>;
|
|
2404
|
+
}
|
|
2313
2405
|
interface DatabaseRolesResource {
|
|
2314
2406
|
/** Lists Cloud Spanner database roles. */
|
|
2315
2407
|
list(request?: {
|
|
@@ -3391,7 +3483,7 @@ declare namespace gapi.client {
|
|
|
3391
3483
|
},
|
|
3392
3484
|
body: ChangeQuorumRequest
|
|
3393
3485
|
): Request<Operation>;
|
|
3394
|
-
/** Creates a new
|
|
3486
|
+
/** Creates a new Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `/operations/` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful. */
|
|
3395
3487
|
create(request: {
|
|
3396
3488
|
/** V1 error format. */
|
|
3397
3489
|
'$.xgafv'?: string;
|
|
@@ -3862,6 +3954,7 @@ declare namespace gapi.client {
|
|
|
3862
3954
|
},
|
|
3863
3955
|
body: UpdateDatabaseDdlRequest
|
|
3864
3956
|
): Request<Operation>;
|
|
3957
|
+
backupSchedules: BackupSchedulesResource;
|
|
3865
3958
|
databaseRoles: DatabaseRolesResource;
|
|
3866
3959
|
operations: OperationsResource;
|
|
3867
3960
|
sessions: SessionsResource;
|
|
@@ -4523,7 +4616,7 @@ declare namespace gapi.client {
|
|
|
4523
4616
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4524
4617
|
uploadType?: string;
|
|
4525
4618
|
}): Request<ListInstancesResponse>;
|
|
4526
|
-
/** Moves the instance to the target instance config. The returned long-running operation can be used to track the progress of moving the instance. `MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of the following criteria: * Has an ongoing move to a different instance config * Has backups * Has an ongoing update * Is under free trial * Contains any CMEK-enabled databases While the operation is pending: * All other attempts to modify the instance, including changes to its compute capacity, are rejected. * The following database and backup admin operations are rejected: * DatabaseAdmin.CreateDatabase, * DatabaseAdmin.UpdateDatabaseDdl (Disabled if default_leader is specified in the request.) * DatabaseAdmin.RestoreDatabase * DatabaseAdmin.CreateBackup * DatabaseAdmin.CopyBackup * Both the source and target instance
|
|
4619
|
+
/** Moves the instance to the target instance config. The returned long-running operation can be used to track the progress of moving the instance. `MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of the following criteria: * Has an ongoing move to a different instance config * Has backups * Has an ongoing update * Is under free trial * Contains any CMEK-enabled databases While the operation is pending: * All other attempts to modify the instance, including changes to its compute capacity, are rejected. * The following database and backup admin operations are rejected: * DatabaseAdmin.CreateDatabase, * DatabaseAdmin.UpdateDatabaseDdl (Disabled if default_leader is specified in the request.) * DatabaseAdmin.RestoreDatabase * DatabaseAdmin.CreateBackup * DatabaseAdmin.CopyBackup * Both the source and target instance configurations are subject to hourly compute and storage charges. * The instance may experience higher read-write latencies and a higher transaction abort rate. However, moving an instance does not cause any downtime. The returned long-running operation will have a name of the format `/operations/` and can be used to track the move instance operation. The metadata field type is MoveInstanceMetadata. The response field type is Instance, if successful. Cancelling the operation sets its metadata's cancel_time. Cancellation is not immediate since it involves moving any data previously moved to target instance configuration back to the original instance config. The same operation can be used to track the progress of the cancellation. Upon successful completion of the cancellation, the operation terminates with `CANCELLED` status. Upon completion(if not cancelled) of the returned operation: * Instance would be successfully moved to the target instance config. * You are billed for compute and storage in target instance config. Authorization requires `spanner.instances.update` permission on the resource instance. For more details, please see [documentation](https://cloud.google.com/spanner/docs/move-instance). */
|
|
4527
4620
|
move(request: {
|
|
4528
4621
|
/** V1 error format. */
|
|
4529
4622
|
'$.xgafv'?: string;
|