@maxim_mazurok/gapi.client.spanner-v1 0.0.20240422 → 0.0.20240514

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://spanner.googleapis.com/$discovery/rest?version=v1
-// Revision: 20240422
+// Revision: 20240514
 
 /// <reference types="gapi.client" />
 
@@ -55,6 +55,8 @@ declare namespace gapi.client {
       databaseDialect?: string;
       /** Output only. The encryption information for the backup. */
       encryptionInfo?: EncryptionInfo;
+      /** 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. */
+      encryptionInformation?: EncryptionInfo[];
       /** Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup. */
       expireTime?: string;
       /** Output only. The max allowed expiration time of the backup, with microseconds granularity. A backup's expiration time can be configured in multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or copying an existing backup, the expiration time specified must be less than `Backup.max_expire_time`. */
@@ -122,6 +124,22 @@ declare namespace gapi.client {
       /** Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). */
       role?: string;
     }
+    interface ChangeQuorumMetadata {
+      /** If set, the time at which this operation failed or was completed successfully. */
+      endTime?: string;
+      /** The request for ChangeQuorum. */
+      request?: ChangeQuorumRequest;
+      /** Time the request was received. */
+      startTime?: string;
+    }
+    interface ChangeQuorumRequest {
+      /** Optional. The etag is the hash of the QuorumInfo. The ChangeQuorum operation will only be performed if the etag matches that of the QuorumInfo in the current database resource. Otherwise the API will return an `ABORTED` error. The etag is used for optimistic concurrency control as a way to help prevent simultaneous change quorum requests that could create a race condition. */
+      etag?: string;
+      /** Required. Name of the database in which to apply the ChangeQuorum. Values are of the form `projects//instances//databases/`. */
+      name?: string;
+      /** Required. The type of this Quorum. */
+      quorumType?: QuorumType;
+    }
     interface ChildLink {
       /** The node to which the link points. */
       childIndex?: number;
@@ -169,6 +187,8 @@ declare namespace gapi.client {
       encryptionType?: string;
       /** Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. */
       kmsKeyName?: string;
+      /** 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 single region instance configs, specify a single regional location KMS key. * For multi-regional instance configs 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 config. * For an instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs. */
+      kmsKeyNames?: string[];
     }
     interface CopyBackupMetadata {
       /** The time at which cancellation of CopyBackup operation was received. Operations.CancelOperation starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. 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`. */
@@ -287,6 +307,8 @@ declare namespace gapi.client {
       encryptionInfo?: EncryptionInfo[];
       /** Required. The name of the database. Values are of the form `projects//instances//databases/`, where `` is as specified in the `CREATE DATABASE` statement. This name can be passed to other API methods to identify the database. */
       name?: string;
+      /** Output only. Applicable only for databases that use dual region instance configurations. Contains information about the quorum. */
+      quorumInfo?: QuorumInfo;
       /** Output only. If true, the database is being updated. If false, there are no ongoing update operations for the database. */
       reconciling?: boolean;
       /** Output only. Applicable only for restored databases. Contains information about the restore source. */
@@ -338,10 +360,13 @@ declare namespace gapi.client {
       /** Include_replicas indicates the order of replicas (as they appear in this list) to process the request. If auto_failover_disabled is set to true and all replicas are exhausted without finding a healthy replica, Spanner will wait for a replica in the list to become available, requests may fail due to `DEADLINE_EXCEEDED` errors. */
       includeReplicas?: IncludeReplicas;
     }
+    interface DualRegionQuorum {}
     interface Empty {}
     interface EncryptionConfig {
       /** The Cloud KMS key to be used for encrypting and decrypting the database. Values are of the form `projects//locations//keyRings//cryptoKeys/`. */
       kmsKeyName?: string;
+      /** Specifies the KMS configuration for the 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 instance configuration. Some examples: * For single region database instance configs, specify a single regional location KMS key. * For multi-regional database instance configs 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 config. * For a database instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs. */
+      kmsKeyNames?: string[];
     }
     interface EncryptionInfo {
       /** Output only. If present, the status of a recent encrypt/decrypt call on underlying data for this database or backup. Regardless of status, data is always encrypted at rest. */
@@ -474,9 +499,9 @@ declare namespace gapi.client {
       labels?: {[P in string]: string};
       /** 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. */
       name?: string;
-      /** 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. This may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. */
+      /** 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 may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. */
       nodeCount?: number;
-      /** 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. This may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. */
+      /** 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 may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. */
       processingUnits?: number;
       /** 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`. */
       state?: string;
@@ -502,6 +527,8 @@ declare namespace gapi.client {
       name?: string;
       /** Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations. */
       optionalReplicas?: ReplicaInfo[];
+      /** Output only. The `QuorumType` of the instance configuration. */
+      quorumType?: string;
       /** Output only. If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config. */
       reconciling?: boolean;
       /** The geographic placement of nodes in this instance configuration and their replication properties. */
@@ -642,7 +669,7 @@ declare namespace gapi.client {
       instancePartitions?: InstancePartition[];
       /** `next_page_token` can be sent in a subsequent ListInstancePartitions call to fetch more of the matching instance partitions. */
       nextPageToken?: string;
-      /** The list of unreachable instance partitions. It includes the names of instance partitions whose metadata could not be retrieved within instance_partition_deadline. */
+      /** The list of unreachable instances or instance partitions. It includes the names of instances or instance partitions whose metadata could not be retrieved within instance_partition_deadline. */
       unreachable?: string[];
     }
     interface ListInstancesResponse {
@@ -866,6 +893,22 @@ declare namespace gapi.client {
       /** Optional. The advices/recommendations for a query. Currently this field will be serving index recommendations for a query. */
       queryAdvice?: QueryAdvisorResult;
     }
+    interface QuorumInfo {
+      /** Output only. The etag is used for optimistic concurrency control as a way to help prevent simultaneous ChangeQuorum requests that could create a race condition. */
+      etag?: string;
+      /** Output only. Whether this ChangeQuorum is a Google or User initiated. */
+      initiator?: string;
+      /** Output only. The type of this quorum. See QuorumType for more information about quorum type specifications. */
+      quorumType?: QuorumType;
+      /** Output only. The timestamp when the request was triggered. */
+      startTime?: string;
+    }
+    interface QuorumType {
+      /** Dual region quorum type. */
+      dualRegion?: any;
+      /** Single region quorum type. */
+      singleRegion?: SingleRegionQuorum;
+    }
     interface ReadOnly {
       /** Executes all reads at a timestamp that is `exact_staleness` old. The timestamp is chosen soon after the read is started. Guarantees that all writes that have committed more than the specified number of seconds ago are visible. Because Cloud Spanner chooses the exact timestamp, this mode works even if the client's local clock is substantially skewed from Cloud Spanner commit timestamps. Useful for reading at nearby replicas without the distributed timestamp negotiation overhead of `max_staleness`. */
       exactStaleness?: string;
@@ -935,6 +978,8 @@ declare namespace gapi.client {
       encryptionType?: string;
       /** 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/`. */
       kmsKeyName?: string;
+      /** Optional. Specifies the KMS configuration for the 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 instance configuration. Some examples: * For single region database instance configs, specify a single regional location KMS key. * For multi-regional database instance configs 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 config. * For a database instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs. */
+      kmsKeyNames?: string[];
     }
     interface RestoreDatabaseMetadata {
       /** Information about the backup used to restore the database. */
@@ -1038,6 +1083,10 @@ declare namespace gapi.client {
       /** A mapping of (subquery variable name) -> (subquery node id) for cases where the `description` string of this node references a `SCALAR` subquery contained in the expression subtree rooted at this node. The referenced `SCALAR` subquery may not necessarily be a direct child of this node. */
       subqueries?: {[P in string]: number};
     }
+    interface SingleRegionQuorum {
+      /** Required. The location of the serving region, e.g. "us-central1". The location must be one of the regions within the dual region instance configuration of your database. The list of valid locations is available via [GetInstanceConfig[InstanceAdmin.GetInstanceConfig] API. This should only be used if you plan to change quorum in single-region quorum type. */
+      servingLocation?: string;
+    }
     interface Statement {
       /** Parameter names and values that bind to placeholders in the DML string. A parameter placeholder consists of the `@` character followed by the parameter name (for example, `@firstName`). Parameter names can contain letters, numbers, and underscores. 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. */
       params?: {[P in string]: any};
@@ -1923,6 +1972,8 @@ declare namespace gapi.client {
         'encryptionConfig.encryptionType'?: string;
         /** Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. */
         'encryptionConfig.kmsKeyName'?: string;
+        /** 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 region instance configs, specify a single regional location KMS key. * For multi-regional instance configs 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 config. * For an instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs. */
+        'encryptionConfig.kmsKeyNames'?: string | string[];
         /** Selector specifying which fields to include in a partial response. */
         fields?: string;
         /** 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. */
@@ -1958,6 +2009,8 @@ declare namespace gapi.client {
           'encryptionConfig.encryptionType'?: string;
           /** Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. */
           'encryptionConfig.kmsKeyName'?: string;
+          /** 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 region instance configs, specify a single regional location KMS key. * For multi-regional instance configs 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 config. * For an instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs. */
+          'encryptionConfig.kmsKeyNames'?: string | string[];
           /** Selector specifying which fields to include in a partial response. */
           fields?: string;
           /** 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. */
@@ -3276,6 +3329,64 @@ declare namespace gapi.client {
       ): Request<PartialResultSet>;
     }
     interface DatabasesResource {
+      /** ChangeQuorum is strictly restricted to databases that use dual region instance configurations. Initiates a background operation to change quorum a database from dual-region mode to single-region mode and vice versa. The returned long-running operation will have 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. */
+      changequorum(request: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** 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. */
+        key?: string;
+        /** Required. Name of the database in which to apply the ChangeQuorum. Values are of the form `projects//instances//databases/`. */
+        name: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** 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. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+        /** Request body */
+        resource: ChangeQuorumRequest;
+      }): Request<Operation>;
+      changequorum(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** JSONP */
+          callback?: string;
+          /** Selector specifying which fields to include in a partial response. */
+          fields?: string;
+          /** 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. */
+          key?: string;
+          /** Required. Name of the database in which to apply the ChangeQuorum. Values are of the form `projects//instances//databases/`. */
+          name: string;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: string;
+          /** Returns response with indentations and line breaks. */
+          prettyPrint?: boolean;
+          /** 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. */
+          quotaUser?: string;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: ChangeQuorumRequest
+      ): Request<Operation>;
       /** Creates a new Cloud 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. */
       create(request: {
         /** V1 error format. */
@@ -4041,7 +4152,7 @@ declare namespace gapi.client {
         pageSize?: number;
         /** If non-empty, `page_token` should contain a next_page_token from a previous ListInstancePartitionsResponse. */
         pageToken?: string;
-        /** Required. The instance whose instance partitions should be listed. Values are of the form `projects//instances/`. */
+        /** Required. The instance whose instance partitions should be listed. Values are of the form `projects//instances/`. Use `{instance} = '-'` to list instance partitions for all Instances in a project, e.g., `projects/myproject/instances/-`. */
         parent: string;
         /** Returns response with indentations and line breaks. */
         prettyPrint?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.spanner-v1",
-  "version": "0.0.20240422",
+  "version": "0.0.20240514",
   "description": "TypeScript typings for Cloud Spanner API v1",
   "repository": {
     "type": "git",