@maxim_mazurok/gapi.client.spanner-v1 0.0.20231023 → 0.0.20231101

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: 20231023
+// Revision: 20231101
 
 /// <reference types="gapi.client" />
 
@@ -22,6 +22,42 @@ declare namespace gapi.client {
     function load(name: "spanner", version: "v1", callback: () => any): void;
 
     namespace spanner {
+        interface AutoscalingConfig {
+            /** Required. Autoscaling limits for an instance. */
+            autoscalingLimits?:
+                AutoscalingLimits;
+            /** Required. The autoscaling targets for an instance. */
+            autoscalingTargets?:
+                AutoscalingTargets;
+        }
+        interface AutoscalingLimits {
+            /** Maximum number of nodes allocated to the instance. If set, this number should be greater than or equal to min_nodes. */
+            maxNodes?:
+                number;
+            /** Maximum number of processing units allocated to the instance. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units. */
+            maxProcessingUnits?:
+                number;
+            /** Minimum number of nodes allocated to the instance. If set, this number should be greater than or equal to 1. */
+            minNodes?:
+                number;
+            /** Minimum number of processing units allocated to the instance. If set, this number should be multiples of 1000. */
+            minProcessingUnits?:
+                number;
+        }
+        interface AutoscalingTargets {
+            /**
+             * Required. The target high priority cpu utilization percentage that the autoscaler should be trying to achieve for the instance. This number is on a scale from 0 (no utilization) to
+             * 100 (full utilization). The valid range is [10, 90] inclusive.
+             */
+            highPriorityCpuUtilizationPercent?:
+                number;
+            /**
+             * Required. The target storage utilization percentage that the autoscaler should be trying to achieve for the instance. This number is on a scale from 0 (no utilization) to 100 (full
+             * utilization). The valid range is [10, 100] inclusive.
+             */
+            storageUtilizationPercent?:
+                number;
+        }
         interface Backup {
             /** Output only. The time the CreateBackup request is received. If the request does not specify `version_time`, the `version_time` of the backup will be equivalent to the `create_time`. */
             createTime?:
@@ -528,6 +564,17 @@ declare namespace gapi.client {
             shortMessage?:
                 LocalizedString;
         }
+        interface DirectedReadOptions {
+            /** Exclude_replicas indicates that should be excluded from serving requests. Spanner will not route requests to the replicas in this list. */
+            excludeReplicas?:
+                ExcludeReplicas;
+            /**
+             * 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;
+        }
         // tslint:disable-next-line:no-empty-interface
         interface Empty {
         }
@@ -547,6 +594,11 @@ declare namespace gapi.client {
             kmsKeyVersion?:
                 string;
         }
+        interface ExcludeReplicas {
+            /** The directed read replica selector. */
+            replicaSelections?:
+                ReplicaSelection[];
+        }
         interface ExecuteBatchDmlRequest {
             /** Common options for this request. */
             requestOptions?:
@@ -589,6 +641,9 @@ declare namespace gapi.client {
              */
             dataBoostEnabled?:
                 boolean;
+            /** Directed read options for this request. */
+            directedReadOptions?:
+                DirectedReadOptions;
             /**
              * 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
@@ -714,6 +769,14 @@ declare namespace gapi.client {
             requestedPolicyVersion?:
                 number;
         }
+        interface IncludeReplicas {
+            /** If true, Spanner will not route requests to a replica outside the include_replicas list when all of the specified replicas are unavailable or unhealthy. Default value is `false`. */
+            autoFailoverDisabled?:
+                boolean;
+            /** The directed read replica selector. */
+            replicaSelections?:
+                ReplicaSelection[];
+        }
         interface IndexAdvice {
             /** Optional. DDL statements to add new indexes that will improve the query. */
             ddl?:
@@ -736,6 +799,12 @@ declare namespace gapi.client {
                 { [P in string]: KeyRangeInfos };
         }
         interface Instance {
+            /**
+             * Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields
+             * and reflect the current compute capacity allocated to the instance.
+             */
+            autoscalingConfig?:
+                AutoscalingConfig;
             /** Required. The name of the instance's configuration. Values are of the form `projects//instanceConfigs/`. See also InstanceConfig and ListInstanceConfigs. */
             config?:
                 string;
@@ -1458,6 +1527,9 @@ declare namespace gapi.client {
              */
             dataBoostEnabled?:
                 boolean;
+            /** Directed read options for this request. */
+            directedReadOptions?:
+                DirectedReadOptions;
             /**
              * If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further
              * information.
@@ -1516,6 +1588,14 @@ declare namespace gapi.client {
             type?:
                 string;
         }
+        interface ReplicaSelection {
+            /** The location or region of the serving requests, e.g. "us-east1". */
+            location?:
+                string;
+            /** The type of replica. */
+            type?:
+                string;
+        }
         interface RequestOptions {
             /** Priority for the request. */
             priority?:
@@ -2252,6 +2332,185 @@ declare namespace gapi.client {
                     string;
             }): Request<ListOperationsResponse>;
         }
+        interface OperationsResource {
+            /**
+             * 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`.
+             */
+            cancel(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;
+                /** The name of the operation resource to be cancelled. */
+                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<{}>;
+            /**
+             * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't
+             * support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+             */
+            delete(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;
+                /** The name of the operation resource to be deleted. */
+                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<{}>;
+            /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
+            get(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;
+                /** The name of the operation resource. */
+                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<Operation>;
+            /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
+            list(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;
+                /** The standard list filter. */
+                filter?:
+                    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;
+                /** The name of the operation's parent resource. */
+                name:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** The standard list page size. */
+                pageSize?:
+                    number;
+                /** The standard list page token. */
+                pageToken?:
+                    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<ListOperationsResponse>;
+        }
+        interface SsdCachesResource {
+            operations:
+                OperationsResource;
+        }
         interface InstanceConfigsResource {
             /**
              * Creates an instance config 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
@@ -2571,6 +2830,8 @@ declare namespace gapi.client {
             body: UpdateInstanceConfigRequest): Request<Operation>;
             operations:
                 OperationsResource;
+            ssdCaches:
+                SsdCachesResource;
         }
         interface BackupOperationsResource {
             /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.spanner-v1",
-  "version": "0.0.20231023",
+  "version": "0.0.20231101",
   "description": "TypeScript typings for Cloud Spanner API v1",
   "license": "MIT",
   "author": {

package/tests.ts

@@ -3,7 +3,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
 
-// Revision: 20231023
+// Revision: 20231101
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -181,6 +181,33 @@ gapi.load('client', async () => {
             pageSize: 42,
             pageToken: "Test string",
         });
+        /**
+         * 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`.
+         */
+        await gapi.client.spanner.projects.instanceConfigs.ssdCaches.operations.cancel({
+            name: "Test string",
+        });
+        /**
+         * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support
+         * this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+         */
+        await gapi.client.spanner.projects.instanceConfigs.ssdCaches.operations.delete({
+            name: "Test string",
+        });
+        /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
+        await gapi.client.spanner.projects.instanceConfigs.ssdCaches.operations.get({
+            name: "Test string",
+        });
+        /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
+        await gapi.client.spanner.projects.instanceConfigs.ssdCaches.operations.list({
+            filter: "Test string",
+            name: "Test string",
+            pageSize: 42,
+            pageToken: "Test string",
+        });
         /**
          * Creates an instance and begins preparing it to begin serving. The returned long-running operation can be used to track the progress of preparing the new instance. The instance name is
          * assigned by the caller. If the named instance already exists, `CreateInstance` returns `ALREADY_EXISTS`. Immediately upon completion of this request: * The instance is readable via the
@@ -194,6 +221,18 @@ gapi.load('client', async () => {
             parent: "Test string",
         }, {
             instance: {
+                autoscalingConfig: {
+                    autoscalingLimits: {
+                        maxNodes: 42,
+                        maxProcessingUnits: 42,
+                        minNodes: 42,
+                        minProcessingUnits: 42,
+                    },
+                    autoscalingTargets: {
+                        highPriorityCpuUtilizationPercent: 42,
+                        storageUtilizationPercent: 42,
+                    },
+                },
                 config: "Test string",
                 createTime: "Test string",
                 displayName: "Test string",
@@ -264,6 +303,18 @@ gapi.load('client', async () => {
         }, {
             fieldMask: "Test string",
             instance: {
+                autoscalingConfig: {
+                    autoscalingLimits: {
+                        maxNodes: 42,
+                        maxProcessingUnits: 42,
+                        minNodes: 42,
+                        minProcessingUnits: 42,
+                    },
+                    autoscalingTargets: {
+                        highPriorityCpuUtilizationPercent: 42,
+                        storageUtilizationPercent: 42,
+                    },
+                },
                 config: "Test string",
                 createTime: "Test string",
                 displayName: "Test string",
@@ -1090,6 +1141,25 @@ gapi.load('client', async () => {
             session: "Test string",
         }, {
             dataBoostEnabled: true,
+            directedReadOptions: {
+                excludeReplicas: {
+                    replicaSelections: [
+                        {
+                            location: "Test string",
+                            type: "Test string",
+                        }
+                    ],
+                },
+                includeReplicas: {
+                    autoFailoverDisabled: true,
+                    replicaSelections: [
+                        {
+                            location: "Test string",
+                            type: "Test string",
+                        }
+                    ],
+                },
+            },
             params: {
                 A: 42
             },
@@ -1165,6 +1235,25 @@ gapi.load('client', async () => {
             session: "Test string",
         }, {
             dataBoostEnabled: true,
+            directedReadOptions: {
+                excludeReplicas: {
+                    replicaSelections: [
+                        {
+                            location: "Test string",
+                            type: "Test string",
+                        }
+                    ],
+                },
+                includeReplicas: {
+                    autoFailoverDisabled: true,
+                    replicaSelections: [
+                        {
+                            location: "Test string",
+                            type: "Test string",
+                        }
+                    ],
+                },
+            },
             params: {
                 A: 42
             },
@@ -1399,6 +1488,25 @@ gapi.load('client', async () => {
                 "Test string"
             ],
             dataBoostEnabled: true,
+            directedReadOptions: {
+                excludeReplicas: {
+                    replicaSelections: [
+                        {
+                            location: "Test string",
+                            type: "Test string",
+                        }
+                    ],
+                },
+                includeReplicas: {
+                    autoFailoverDisabled: true,
+                    replicaSelections: [
+                        {
+                            location: "Test string",
+                            type: "Test string",
+                        }
+                    ],
+                },
+            },
             index: "Test string",
             keySet: {
                 all: true,
@@ -1488,6 +1596,25 @@ gapi.load('client', async () => {
                 "Test string"
             ],
             dataBoostEnabled: true,
+            directedReadOptions: {
+                excludeReplicas: {
+                    replicaSelections: [
+                        {
+                            location: "Test string",
+                            type: "Test string",
+                        }
+                    ],
+                },
+                includeReplicas: {
+                    autoFailoverDisabled: true,
+                    replicaSelections: [
+                        {
+                            location: "Test string",
+                            type: "Test string",
+                        }
+                    ],
+                },
+            },
             index: "Test string",
             keySet: {
                 all: true,