@googleapis/sqladmin 17.0.0 → 17.1.0

package/v1.ts

@@ -210,6 +210,23 @@ export namespace sqladmin_v1 {
      */
     region?: string | null;
   }
+  /**
+   * An available database version. It can be a major or a minor version.
+   */
+  export interface Schema$AvailableDatabaseVersion {
+    /**
+     * The database version's display name.
+     */
+    displayName?: string | null;
+    /**
+     * The version's major version name.
+     */
+    majorVersion?: string | null;
+    /**
+     * The database version name. For MySQL 8.0, this string provides the database major and minor version.
+     */
+    name?: string | null;
+  }
   /**
    * Database instance backup configuration.
    */
@@ -247,7 +264,7 @@ export namespace sqladmin_v1 {
      */
     startTime?: string | null;
     /**
-     * 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 | null;
     /**
@@ -434,7 +451,7 @@ export namespace sqladmin_v1 {
      */
     pointInTime?: string | null;
     /**
-     * Optional. (Point-in-time recovery for PostgreSQL only) Clone to an instance in the specified zone. If no zone is specified, clone to the same zone as the source instance.
+     * Optional. Copy clone and point-in-time recovery clone of an instance to the specified zone. If no zone is specified, clone to the same primary zone as the source instance. This field applies to all DB types.
      */
     preferredZone?: string | null;
   }
@@ -583,7 +600,7 @@ export namespace sqladmin_v1 {
      */
     gceZone?: string | null;
     /**
-     * Gemini configuration.
+     * Gemini instance configuration.
      */
     geminiConfig?: Schema$GeminiInstanceConfig;
     /**
@@ -651,7 +668,7 @@ export namespace sqladmin_v1 {
      */
     replicaNames?: string[] | null;
     /**
-     * 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?: Schema$ReplicationCluster;
     /**
@@ -659,7 +676,7 @@ export namespace sqladmin_v1 {
      */
     rootPassword?: string | null;
     /**
-     * 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 | null;
     /**
@@ -695,6 +712,10 @@ export namespace sqladmin_v1 {
      * If the instance state is SUSPENDED, the reason for the suspension.
      */
     suspensionReason?: string[] | null;
+    /**
+     * Output only. All database versions that are available for upgrade.
+     */
+    upgradableDatabaseVersions?: Schema$AvailableDatabaseVersion[];
     /**
      * Output only. The dns name of the primary instance in a replication group.
      */
@@ -976,31 +997,31 @@ export namespace sqladmin_v1 {
     kind?: string | null;
   }
   /**
-   * Gemini configuration.
+   * Gemini instance configuration.
    */
   export interface Schema$GeminiInstanceConfig {
     /**
-     * Output only. Whether active query is enabled.
+     * Output only. Whether the active query is enabled.
      */
     activeQueryEnabled?: boolean | null;
     /**
-     * Output only. Whether gemini is enabled.
+     * Output only. Whether Gemini is enabled.
      */
     entitled?: boolean | null;
     /**
-     * Output only. Whether flag recommender is enabled.
+     * Output only. Whether the flag recommender is enabled.
      */
     flagRecommenderEnabled?: boolean | null;
     /**
-     * Output only. Whether vacuum management is enabled.
+     * Output only. Whether the vacuum management is enabled.
      */
     googleVacuumMgmtEnabled?: boolean | null;
     /**
-     * Output only. Whether index advisor is enabled.
+     * Output only. Whether the index advisor is enabled.
      */
     indexAdvisorEnabled?: boolean | null;
     /**
-     * Output only. Whether oom session cancel is enabled.
+     * Output only. Whether canceling the out-of-memory (OOM) session is enabled.
      */
     oomSessionCancelEnabled?: boolean | null;
   }
@@ -1299,7 +1320,7 @@ export namespace sqladmin_v1 {
      */
     requireSsl?: boolean | null;
     /**
-     * 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 | null;
   }
@@ -1705,17 +1726,21 @@ export namespace sqladmin_v1 {
     mysqlReplicaConfiguration?: Schema$MySqlReplicaConfiguration;
   }
   /**
-   * Primary-DR replica pair
+   * 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.
    */
   export interface Schema$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 | null;
     /**
-     * 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 | null;
+    /**
+     * 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 | null;
   }
   export interface Schema$Reschedule {
     /**
@@ -1774,7 +1799,7 @@ export namespace sqladmin_v1 {
      */
     activeDirectoryConfig?: Schema$SqlActiveDirectoryConfig;
     /**
-     * Specifies advance machine configuration for the instance relevant only for SQL Server.
+     * Specifies advanced machine configuration for the instances relevant only for SQL Server.
      */
     advancedMachineFeatures?: Schema$AdvancedMachineFeatures;
     /**
@@ -1994,7 +2019,7 @@ export namespace sqladmin_v1 {
    */
   export interface Schema$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 | null;
     /**
@@ -2019,7 +2044,7 @@ export namespace sqladmin_v1 {
    */
   export interface Schema$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 | null;
     /**
@@ -2031,7 +2056,7 @@ export namespace sqladmin_v1 {
      */
     syncMode?: string | null;
     /**
-     * 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 | null;
     /**
@@ -5017,7 +5042,7 @@ export namespace sqladmin_v1 {
     }
 
     /**
-     * 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.
      *
      * @param params - Parameters for request
      * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5816,7 +5841,7 @@ export namespace sqladmin_v1 {
     }
 
     /**
-     * Switches over from the primary instance to the replica instance.
+     * Switches over from the primary instance to the designated DR replica instance.
      *
      * @param params - Parameters for request
      * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6274,7 +6299,7 @@ export namespace sqladmin_v1 {
   export interface Params$Resource$Instances$Promotereplica
     extends StandardParameters {
     /**
-     * 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;
     /**

package/v1beta4.ts

@@ -210,6 +210,23 @@ export namespace sqladmin_v1beta4 {
      */
     region?: string | null;
   }
+  /**
+   * An available database version. It can be a major or a minor version.
+   */
+  export interface Schema$AvailableDatabaseVersion {
+    /**
+     * The database version's display name.
+     */
+    displayName?: string | null;
+    /**
+     * The version's major version name.
+     */
+    majorVersion?: string | null;
+    /**
+     * The database version name. For MySQL 8.0, this string provides the database major and minor version.
+     */
+    name?: string | null;
+  }
   /**
    * Database instance backup configuration.
    */
@@ -434,7 +451,11 @@ export namespace sqladmin_v1beta4 {
      */
     pointInTime?: string | null;
     /**
-     * Optional. (Point-in-time recovery for PostgreSQL only) Clone to an instance in the specified zone. If no zone is specified, clone to the same zone as the source instance.
+     * Optional. Copy clone and point-in-time recovery clone of a regional instance in the specified zones. If not specified, clone to the same secondary zone as the source instance. This value cannot be the same as the preferred_zone field.
+     */
+    preferredSecondaryZone?: string | null;
+    /**
+     * Optional. Copy clone and point-in-time recovery clone of an instance to the specified zone. If no zone is specified, clone to the same primary zone as the source instance.
      */
     preferredZone?: string | null;
   }
@@ -651,7 +672,7 @@ export namespace sqladmin_v1beta4 {
      */
     replicaNames?: string[] | null;
     /**
-     * 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.
+     * 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?: Schema$ReplicationCluster;
     /**
@@ -659,7 +680,7 @@ export namespace sqladmin_v1beta4 {
      */
     rootPassword?: string | null;
     /**
-     * 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 | null;
     /**
@@ -698,6 +719,10 @@ export namespace sqladmin_v1beta4 {
      * If the instance state is SUSPENDED, the reason for the suspension.
      */
     suspensionReason?: string[] | null;
+    /**
+     * Output only. All database versions that are available for upgrade.
+     */
+    upgradableDatabaseVersions?: Schema$AvailableDatabaseVersion[];
     /**
      * Output only. The dns name of the primary instance in a replication group.
      */
@@ -979,11 +1004,11 @@ export namespace sqladmin_v1beta4 {
     kind?: string | null;
   }
   /**
-   * Gemini configuration.
+   * Gemini instance configuration.
    */
   export interface Schema$GeminiInstanceConfig {
     /**
-     * Output only. Whether active query is enabled.
+     * Output only. Whether the active query is enabled.
      */
     activeQueryEnabled?: boolean | null;
     /**
@@ -991,19 +1016,19 @@ export namespace sqladmin_v1beta4 {
      */
     entitled?: boolean | null;
     /**
-     * Output only. Whether flag recommender is enabled.
+     * Output only. Whether the flag recommender is enabled.
      */
     flagRecommenderEnabled?: boolean | null;
     /**
-     * Output only. Whether vacuum management is enabled.
+     * Output only. Whether the vacuum management is enabled.
      */
     googleVacuumMgmtEnabled?: boolean | null;
     /**
-     * Output only. Whether index advisor is enabled.
+     * Output only. Whether the index advisor is enabled.
      */
     indexAdvisorEnabled?: boolean | null;
     /**
-     * Output only. Whether oom session cancel is enabled.
+     * Output only. Whether canceling the out-of-memory (OOM) session is enabled.
      */
     oomSessionCancelEnabled?: boolean | null;
   }
@@ -1302,7 +1327,7 @@ export namespace sqladmin_v1beta4 {
      */
     requireSsl?: boolean | null;
     /**
-     * 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 | null;
   }
@@ -1708,17 +1733,21 @@ export namespace sqladmin_v1beta4 {
     mysqlReplicaConfiguration?: Schema$MySqlReplicaConfiguration;
   }
   /**
-   * Primary-DR replica pair
+   * 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 has regional failure. Only applicable to MySQL.
    */
   export interface Schema$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 | null;
     /**
-     * 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 | null;
+    /**
+     * 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 | null;
   }
   export interface Schema$Reschedule {
     /**
@@ -1777,7 +1806,7 @@ export namespace sqladmin_v1beta4 {
      */
     activeDirectoryConfig?: Schema$SqlActiveDirectoryConfig;
     /**
-     * Specifies advance machine configuration for the instance relevant only for SQL Server.
+     * Specifies advanced machine configuration for the instances relevant only for SQL Server.
      */
     advancedMachineFeatures?: Schema$AdvancedMachineFeatures;
     /**
@@ -1994,7 +2023,7 @@ export namespace sqladmin_v1beta4 {
   export interface Schema$SqlInstancesResetReplicaSizeRequest {}
   export interface Schema$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 | null;
     /**
@@ -2016,7 +2045,7 @@ export namespace sqladmin_v1beta4 {
   }
   export interface Schema$SqlInstancesVerifyExternalSyncSettingsRequest {
     /**
-     * Optional. MigrationType field 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 | null;
     /**
@@ -2028,7 +2057,7 @@ export namespace sqladmin_v1beta4 {
      */
     syncMode?: string | null;
     /**
-     * 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 | null;
     /**
@@ -5021,7 +5050,7 @@ export namespace sqladmin_v1beta4 {
     }
 
     /**
-     * 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.
      *
      * @param params - Parameters for request
      * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5822,7 +5851,7 @@ export namespace sqladmin_v1beta4 {
     }
 
     /**
-     * Switches over from the primary instance to a replica instance.
+     * Switches over from the primary instance to the designated DR replica instance.
      *
      * @param params - Parameters for request
      * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6281,7 +6310,7 @@ export namespace sqladmin_v1beta4 {
   export interface Params$Resource$Instances$Promotereplica
     extends StandardParameters {
     /**
-     * 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;
     /**