@maxim_mazurok/gapi.client.sqladmin-v1 0.0.20240412 → 0.0.20240507

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=v1
-// Revision: 20240412
+// Revision: 20240507
 
 /// <reference types="gapi.client" />
 
@@ -73,7 +73,7 @@ declare namespace gapi.client {
       replicationLogArchivingEnabled?: boolean;
       /** Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`. */
       startTime?: string;
-      /** Output only. This value contains the storage location of transactional logs for the database for point-in-time recovery. */
+      /** Output only. This value contains the storage location of transactional logs used to perform point-in-time recovery (PITR) for the database. */
       transactionalLogStorageState?: string;
       /** The number of days of transaction logs we retain for point in time restore, from 1-7. */
       transactionLogRetentionDays?: number;
@@ -241,7 +241,7 @@ declare namespace gapi.client {
       };
       /** The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance. */
       gceZone?: string;
-      /** Gemini configuration. */
+      /** Gemini instance configuration. */
       geminiConfig?: GeminiInstanceConfig;
       /** The instance type. */
       instanceType?: string;
@@ -275,11 +275,11 @@ declare namespace gapi.client {
       replicaConfiguration?: ReplicaConfiguration;
       /** The replicas of the instance. */
       replicaNames?: string[];
-      /** Optional. The pair of a primary instance and disaster recovery (DR) replica. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance has regional failure. */
+      /** Optional. A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Only applicable to MySQL. */
       replicationCluster?: ReplicationCluster;
       /** Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances. */
       rootPassword?: string;
-      /** The status indicating if instance satisfiesPzs. Reserved for future use. */
+      /** This status indicates whether the instance satisfies PZS. The status is reserved for future use. */
       satisfiesPzs?: boolean;
       /** The start time of any upcoming scheduled maintenance for this instance. */
       scheduledMaintenance?: SqlScheduledMaintenance;
@@ -459,17 +459,17 @@ declare namespace gapi.client {
       kind?: string;
     }
     interface GeminiInstanceConfig {
-      /** Output only. Whether active query is enabled. */
+      /** Output only. Whether the active query is enabled. */
       activeQueryEnabled?: boolean;
-      /** Output only. Whether gemini is enabled. */
+      /** Output only. Whether Gemini is enabled. */
       entitled?: boolean;
-      /** Output only. Whether flag recommender is enabled. */
+      /** Output only. Whether the flag recommender is enabled. */
       flagRecommenderEnabled?: boolean;
-      /** Output only. Whether vacuum management is enabled. */
+      /** Output only. Whether the vacuum management is enabled. */
       googleVacuumMgmtEnabled?: boolean;
-      /** Output only. Whether index advisor is enabled. */
+      /** Output only. Whether the index advisor is enabled. */
       indexAdvisorEnabled?: boolean;
-      /** Output only. Whether oom session cancel is enabled. */
+      /** Output only. Whether canceling the out-of-memory (OOM) session is enabled. */
       oomSessionCancelEnabled?: boolean;
     }
     interface GenerateEphemeralCertRequest {
@@ -639,7 +639,7 @@ declare namespace gapi.client {
       pscConfig?: PscConfig;
       /** Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then 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, then use the `ssl_mode` flag instead of the `require_ssl` flag. */
       requireSsl?: boolean;
-      /** Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` gets priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, the `ssl_mode=ENCRYPTED_ONLY` means only accept SSL connections, while the `require_ssl=false` means accept both non-SSL and SSL connections. MySQL and PostgreSQL databases respect `ssl_mode` in this case and accept only SSL connections. */
+      /** Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. */
       sslMode?: string;
     }
     interface IpMapping {
@@ -836,10 +836,12 @@ declare namespace gapi.client {
       mysqlReplicaConfiguration?: MySqlReplicaConfiguration;
     }
     interface ReplicationCluster {
-      /** Output only. read-only field that indicates if the replica is a dr_replica; not set for a primary. */
+      /** Output only. Read-only field that indicates whether the replica is a DR replica. This field is not set if the instance is a primary instance. */
       drReplica?: boolean;
-      /** Optional. If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. A DR replica is an optional configuration for Enterprise Plus edition instances. If the instance is a read replica, then the field is not set. Users can set this field to set a designated DR replica for a primary. Removing this field removes the DR replica. */
+      /** Optional. If the instance is a primary instance, then this field identifies the disaster recovery (DR) replica. A DR replica is an optional configuration for Enterprise Plus edition instances. If the instance is a read replica, then the field is not set. Set this field to a replica name to designate a DR replica for a primary instance. Remove the replica name to remove the DR replica designation. */
       failoverDrReplicaName?: string;
+      /** Output only. If set, it indicates this instance has a private service access (PSA) dns endpoint that is pointing to the primary instance of the cluster. If this instance is the primary, the dns should be pointing to this instance. After Switchover or Replica failover, this DNS endpoint points to the promoted instance. This is a read-only field, returned to the user as information. This field can exist even if a standalone instance does not yet have a replica, or had a DR replica that was deleted. */
+      psaWriteEndpoint?: string;
     }
     interface Reschedule {
       /** Required. The type of the reschedule. */
@@ -973,7 +975,7 @@ declare namespace gapi.client {
     }
     interface SqlInstancesResetReplicaSizeRequest {}
     interface SqlInstancesStartExternalSyncRequest {
-      /** Optional. MigrationType decides if the migration is a physical file based migration or logical migration. */
+      /** Optional. MigrationType configures the migration to use physical files or logical dump files. If not set, then the logical dump file configuration is used. Valid values are `LOGICAL` or `PHYSICAL`. Only applicable to MySQL. */
       migrationType?: string;
       /** MySQL-specific settings for start external sync. */
       mysqlSyncConfig?: MySqlSyncConfig;
@@ -985,13 +987,13 @@ declare namespace gapi.client {
       syncParallelLevel?: string;
     }
     interface SqlInstancesVerifyExternalSyncSettingsRequest {
-      /** Optional. MigrationType decides if the migration is a physical file based migration or logical migration */
+      /** Optional. MigrationType configures the migration to use physical files or logical dump files. If not set, then the logical dump file configuration is used. Valid values are `LOGICAL` or `PHYSICAL`. Only applicable to MySQL. */
       migrationType?: string;
       /** Optional. MySQL-specific settings for start external sync. */
       mysqlSyncConfig?: MySqlSyncConfig;
       /** External sync mode */
       syncMode?: string;
-      /** Optional. Parallel level for initial data sync. Currently only applicable for PostgreSQL. */
+      /** Optional. Parallel level for initial data sync. Only applicable for PostgreSQL. */
       syncParallelLevel?: string;
       /** Flag to enable verifying connection only */
       verifyConnectionOnly?: boolean;
@@ -2442,7 +2444,7 @@ declare namespace gapi.client {
         },
         body: DatabaseInstance
       ): Request<Operation>;
-      /** Promotes the read replica instance to be a stand-alone Cloud SQL instance. Using this operation might cause your instance to restart. */
+      /** Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart. */
       promoteReplica(request?: {
         /** V1 error format. */
         '$.xgafv'?: string;
@@ -2452,7 +2454,7 @@ declare namespace gapi.client {
         alt?: string;
         /** 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. */
+        /** Set to true to invoke a replica failover to the designated DR replica. As part of replica failover, the promote operation attempts to add the original primary instance as a replica of the promoted DR replica when the original primary instance comes back online. If set to false or not specified, then the original primary instance becomes an independent Cloud SQL primary instance. Only applicable to MySQL. */
         failover?: boolean;
         /** Selector specifying which fields to include in a partial response. */
         fields?: string;
@@ -2804,7 +2806,7 @@ declare namespace gapi.client {
         /** Legacy upload protocol for media (e.g. "media", "multipart"). */
         uploadType?: string;
       }): Request<Operation>;
-      /** Switches over from the primary instance to the replica instance. */
+      /** Switches over from the primary instance to the designated DR replica instance. */
       switchover(request?: {
         /** V1 error format. */
         '$.xgafv'?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.sqladmin-v1",
-  "version": "0.0.20240412",
+  "version": "0.0.20240507",
   "description": "TypeScript typings for Cloud SQL Admin API v1",
   "repository": {
     "type": "git",

package/readme.md

@@ -280,7 +280,7 @@ await gapi.client.sql.instances.patch({
 });
 
 /*
-Promotes the read replica instance to be a stand-alone Cloud SQL instance. Using this operation might cause your instance to restart.
+Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart.
 */
 await gapi.client.sql.instances.promoteReplica({
   instance: 'instance',
@@ -352,7 +352,7 @@ await gapi.client.sql.instances.stopReplica({
 });
 
 /*
-Switches over from the primary instance to the replica instance.
+Switches over from the primary instance to the designated DR replica instance.
 */
 await gapi.client.sql.instances.switchover({
   instance: 'instance',