@maxim_mazurok/gapi.client.sqladmin-v1beta4 0.0.20230928 → 0.0.20231011

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://sqladmin.googleapis.com/$discovery/rest?version=v1beta4
-// Revision: 20230928
+// Revision: 20231011
 
 /// <reference types="gapi.client" />
 
@@ -378,7 +378,7 @@ declare namespace gapi.client {
              */
             outOfDiskReport?:
                 SqlOutOfDiskReport;
-            /** Output only. The dns name of the primary instance in a replication group. */
+            /** Output only. DEPRECATED: please use write_endpoint instead. */
             primaryDnsName?:
                 string;
             /** The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. */
@@ -432,6 +432,9 @@ declare namespace gapi.client {
             /** If the instance state is SUSPENDED, the reason for the suspension. */
             suspensionReason?:
                 string[];
+            /** Output only. The dns name of the primary instance in a replication group. */
+            writeEndpoint?:
+                string;
         }
         interface DatabasesListResponse {
             /** List of database resources in the instance. */
@@ -914,9 +917,24 @@ declare namespace gapi.client {
             /** PSC settings for this instance. */
             pscConfig?:
                 PscConfig;
-            /** Whether SSL connections over IP are enforced or not. */
+            /**
+             * LINT.IfChange(require_ssl_deprecate) Whether SSL/TLS connections over IP are enforced or not. If set to false, allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS
+             * connections, the client certificate will not be verified. If set to true, only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce
+             * SSL/TLS without enforcing the requirement for valid client certificates, use the `ssl_mode` flag instead of the legacy `require_ssl` flag.
+             * LINT.ThenChange(//depot/google3/java/com/google/storage/speckle/boss/admin/actions/InstanceUpdateAction.java:update_api_temp_fix)
+             */
             requireSsl?:
                 boolean;
+            /**
+             * Specify how SSL/TLS will be enforced in database connections. This flag is only supported for PostgreSQL. Use the legacy `require_ssl` flag for enforcing SSL/TLS in MySQL and SQL
+             * Server. But, for PostgreSQL, it is recommended to use the `ssl_mode` flag instead of the legacy `require_ssl` flag. To avoid the conflict between those flags in PostgreSQL, only the
+             * following value pairs are valid: ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED, require_ssl=false; ssl_mode=ENCRYPTED_ONLY, require_ssl=false;
+             * ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED, require_ssl=true; Note that the value of `ssl_mode` gets priority over the value of the legacy `require_ssl`. For example, for the pair
+             * `ssl_mode=ENCRYPTED_ONLY, require_ssl=false`, the `ssl_mode=ENCRYPTED_ONLY` means "only accepts SSL connection", while the `require_ssl=false` means "both non-SSL and SSL
+             * connections are allowed". The database will respect `ssl_mode` in this case and only accept SSL connections.
+             */
+            sslMode?:
+                string;
         }
         interface IpMapping {
             /** The IP address assigned. */
@@ -1155,6 +1173,9 @@ declare namespace gapi.client {
             /** The complexity of the password. */
             complexity?:
                 string;
+            /** Disallow credentials that have been previously compromised by a public data breach. */
+            disallowCompromisedCredentials?:
+                boolean;
             /** Disallow username as a part of the password. */
             disallowUsernameSubstring?:
                 boolean;
@@ -1178,8 +1199,8 @@ declare namespace gapi.client {
         }
         interface PscConfig {
             /**
-             * List of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer
-             * project in this list may be represented by a project number (numeric) or by a project id (alphanumeric).
+             * Optional. The list of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects.
+             * Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric).
              */
             allowedConsumerProjects?:
                 string[];
@@ -1188,6 +1209,9 @@ declare namespace gapi.client {
                 boolean;
         }
         interface ReplicaConfiguration {
+            /** Optional. Specifies if a SQL Server replica is a cascadable replica. A cascadable replica is a SQL Server cross region replica that supports replica(s) under it. */
+            cascadableReplica?:
+                boolean;
             /**
              * Specifies if the replica is the failover target. If the field is set to `true` the replica will be designated as a failover replica. In case the primary instance fails, the replica
              * instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance.
@@ -2770,7 +2794,7 @@ declare namespace gapi.client {
                 /** Selector specifying which fields to include in a partial response. */
                 fields?:
                     string;
-                /** Cloud SQL instance ID. This does not include the project ID. */
+                /** The Cloud SQL instance ID. This doesn't include the project ID. */
                 instance:
                     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. */
@@ -2814,7 +2838,7 @@ declare namespace gapi.client {
                 /** Selector specifying which fields to include in a partial response. */
                 fields?:
                     string;
-                /** Cloud SQL instance ID. This does not include the project ID. */
+                /** The Cloud SQL instance ID. This doesn't include the project ID. */
                 instance:
                     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. */
@@ -3342,6 +3366,12 @@ declare namespace gapi.client {
                 /** JSONP */
                 callback?:
                     string;
+                /**
+                 * Set to true if the promote operation should attempt to re-add the original primary as a replica when it comes back online. Otherwise, if this value is false or not set, the
+                 * original primary will be a standalone instance.
+                 */
+                failover?:
+                    boolean;
                 /** Selector specifying which fields to include in a partial response. */
                 fields?:
                     string;
@@ -3799,6 +3829,54 @@ declare namespace gapi.client {
                 uploadType?:
                     string;
             }): Request<Operation>;
+            /** Switches over from the primary instance to a replica instance. */
+            switchover(request?: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /**
+                 * Optional. (MySQL only) Cloud SQL instance operations timeout, which is a sum of all database operations. Default value is 10 minutes and can be modified to a maximum value of 24
+                 * hours.
+                 */
+                dbTimeout?:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** Cloud SQL read replica instance name. */
+                instance:
+                    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;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** ID of the project that contains the replica. */
+                project:
+                    string;
+                /** 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>;
             /** Truncate MySQL general and slow query log tables MySQL only. */
             truncateLog(request: {
                 /** V1 error format. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.sqladmin-v1beta4",
-  "version": "0.0.20230928",
+  "version": "0.0.20231011",
   "description": "TypeScript typings for Cloud SQL Admin API v1beta4",
   "license": "MIT",
   "author": {

package/readme.md

@@ -234,6 +234,11 @@ Stops the replication in the read replica instance.
 */
 await gapi.client.sql.instances.stopReplica({ instance: "instance", project: "project",  });
 
+/*
+Switches over from the primary instance to a replica instance.
+*/
+await gapi.client.sql.instances.switchover({ instance: "instance", project: "project",  });
+
 /*
 Truncate MySQL general and slow query log tables MySQL only.
 */

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: 20230928
+// Revision: 20231011
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -396,6 +396,7 @@ gapi.load('client', async () => {
             pscServiceAttachmentLink: "Test string",
             region: "Test string",
             replicaConfiguration: {
+                cascadableReplica: true,
                 failoverTarget: true,
                 kind: "Test string",
                 mysqlReplicaConfiguration: {
@@ -515,6 +516,7 @@ gapi.load('client', async () => {
                         pscEnabled: true,
                     },
                     requireSsl: true,
+                    sslMode: "Test string",
                 },
                 kind: "Test string",
                 locationPreference: {
@@ -531,6 +533,7 @@ gapi.load('client', async () => {
                 },
                 passwordValidationPolicy: {
                     complexity: "Test string",
+                    disallowCompromisedCredentials: true,
                     disallowUsernameSubstring: true,
                     enablePasswordPolicy: true,
                     minLength: 42,
@@ -558,6 +561,7 @@ gapi.load('client', async () => {
             suspensionReason: [
                 "Test string"
             ],
+            writeEndpoint: "Test string",
         });
         /** Lists instances under a given project. */
         await gapi.client.sql.instances.list({
@@ -641,6 +645,7 @@ gapi.load('client', async () => {
             pscServiceAttachmentLink: "Test string",
             region: "Test string",
             replicaConfiguration: {
+                cascadableReplica: true,
                 failoverTarget: true,
                 kind: "Test string",
                 mysqlReplicaConfiguration: {
@@ -760,6 +765,7 @@ gapi.load('client', async () => {
                         pscEnabled: true,
                     },
                     requireSsl: true,
+                    sslMode: "Test string",
                 },
                 kind: "Test string",
                 locationPreference: {
@@ -776,6 +782,7 @@ gapi.load('client', async () => {
                 },
                 passwordValidationPolicy: {
                     complexity: "Test string",
+                    disallowCompromisedCredentials: true,
                     disallowUsernameSubstring: true,
                     enablePasswordPolicy: true,
                     minLength: 42,
@@ -803,9 +810,11 @@ gapi.load('client', async () => {
             suspensionReason: [
                 "Test string"
             ],
+            writeEndpoint: "Test string",
         });
         /** Promotes the read replica instance to be a stand-alone Cloud SQL instance. Using this operation might cause your instance to restart. */
         await gapi.client.sql.instances.promoteReplica({
+            failover: true,
             instance: "Test string",
             project: "Test string",
         });
@@ -861,6 +870,12 @@ gapi.load('client', async () => {
             instance: "Test string",
             project: "Test string",
         });
+        /** Switches over from the primary instance to a replica instance. */
+        await gapi.client.sql.instances.switchover({
+            dbTimeout: "Test string",
+            instance: "Test string",
+            project: "Test string",
+        });
         /** Truncate MySQL general and slow query log tables MySQL only. */
         await gapi.client.sql.instances.truncateLog({
             instance: "Test string",
@@ -938,6 +953,7 @@ gapi.load('client', async () => {
             pscServiceAttachmentLink: "Test string",
             region: "Test string",
             replicaConfiguration: {
+                cascadableReplica: true,
                 failoverTarget: true,
                 kind: "Test string",
                 mysqlReplicaConfiguration: {
@@ -1057,6 +1073,7 @@ gapi.load('client', async () => {
                         pscEnabled: true,
                     },
                     requireSsl: true,
+                    sslMode: "Test string",
                 },
                 kind: "Test string",
                 locationPreference: {
@@ -1073,6 +1090,7 @@ gapi.load('client', async () => {
                 },
                 passwordValidationPolicy: {
                     complexity: "Test string",
+                    disallowCompromisedCredentials: true,
                     disallowUsernameSubstring: true,
                     enablePasswordPolicy: true,
                     minLength: 42,
@@ -1100,6 +1118,7 @@ gapi.load('client', async () => {
             suspensionReason: [
                 "Test string"
             ],
+            writeEndpoint: "Test string",
         });
         /** Cancels an instance operation that has been performed on an instance. */
         await gapi.client.sql.operations.cancel({