@googleapis/sqladmin 16.1.0 → 17.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,28 @@
1
1
  # Changelog
2
2
 
3
+ ## [17.0.1](https://github.com/googleapis/google-api-nodejs-client/compare/sqladmin-v17.0.0...sqladmin-v17.0.1) (2024-05-07)
4
+
5
+
6
+ ### Bug Fixes
7
+
8
+ * **sqladmin:** update the API ([975e692](https://github.com/googleapis/google-api-nodejs-client/commit/975e6928315d2b380b565d81d09356e6819988c4))
9
+
10
+ ## [17.0.0](https://github.com/googleapis/google-api-nodejs-client/compare/sqladmin-v16.1.0...sqladmin-v17.0.0) (2024-05-02)
11
+
12
+
13
+ ### ⚠ BREAKING CHANGES
14
+
15
+ * This release has breaking changes.
16
+ * This release has breaking changes.
17
+
18
+ ### Features
19
+
20
+ * run the generator ([#3434](https://github.com/googleapis/google-api-nodejs-client/issues/3434)) ([f0db524](https://github.com/googleapis/google-api-nodejs-client/commit/f0db524bb26f05cea3dec4c0ed66b496399e3857))
21
+ * run the generator ([#3456](https://github.com/googleapis/google-api-nodejs-client/issues/3456)) ([a865e81](https://github.com/googleapis/google-api-nodejs-client/commit/a865e81539b315d3b321650663ba0b2555b1e5a1))
22
+ * **sqladmin:** update the API ([7cc6d5e](https://github.com/googleapis/google-api-nodejs-client/commit/7cc6d5e1283e44228e54acf2bdb10bbe5436996c))
23
+ * **sqladmin:** update the API ([f17c99a](https://github.com/googleapis/google-api-nodejs-client/commit/f17c99aed62a4d186e4d56756b9fa24b038552e8))
24
+ * **sqladmin:** update the API ([a80b25a](https://github.com/googleapis/google-api-nodejs-client/commit/a80b25a55667abdc7afeca561b5744ddd55eca3b))
25
+
3
26
  ## [16.1.0](https://github.com/googleapis/google-api-nodejs-client/compare/sqladmin-v16.0.0...sqladmin-v16.1.0) (2024-05-02)
4
27
 
5
28
 
package/build/v1.d.ts CHANGED
@@ -185,7 +185,7 @@ export declare namespace sqladmin_v1 {
185
185
  */
186
186
  startTime?: string | null;
187
187
  /**
188
- * Output only. This value contains the storage location of transactional logs for the database for point-in-time recovery.
188
+ * Output only. This value contains the storage location of transactional logs used to perform point-in-time recovery (PITR) for the database.
189
189
  */
190
190
  transactionalLogStorageState?: string | null;
191
191
  /**
@@ -524,7 +524,7 @@ export declare namespace sqladmin_v1 {
524
524
  */
525
525
  gceZone?: string | null;
526
526
  /**
527
- * Gemini configuration.
527
+ * Gemini instance configuration.
528
528
  */
529
529
  geminiConfig?: Schema$GeminiInstanceConfig;
530
530
  /**
@@ -592,7 +592,7 @@ export declare namespace sqladmin_v1 {
592
592
  */
593
593
  replicaNames?: string[] | null;
594
594
  /**
595
- * 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.
595
+ * 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.
596
596
  */
597
597
  replicationCluster?: Schema$ReplicationCluster;
598
598
  /**
@@ -920,31 +920,31 @@ export declare namespace sqladmin_v1 {
920
920
  kind?: string | null;
921
921
  }
922
922
  /**
923
- * Gemini configuration.
923
+ * Gemini instance configuration.
924
924
  */
925
925
  export interface Schema$GeminiInstanceConfig {
926
926
  /**
927
- * Output only. Whether active query is enabled.
927
+ * Output only. Whether the active query is enabled.
928
928
  */
929
929
  activeQueryEnabled?: boolean | null;
930
930
  /**
931
- * Output only. Whether gemini is enabled.
931
+ * Output only. Whether Gemini is enabled.
932
932
  */
933
933
  entitled?: boolean | null;
934
934
  /**
935
- * Output only. Whether flag recommender is enabled.
935
+ * Output only. Whether the flag recommender is enabled.
936
936
  */
937
937
  flagRecommenderEnabled?: boolean | null;
938
938
  /**
939
- * Output only. Whether vacuum management is enabled.
939
+ * Output only. Whether the vacuum management is enabled.
940
940
  */
941
941
  googleVacuumMgmtEnabled?: boolean | null;
942
942
  /**
943
- * Output only. Whether index advisor is enabled.
943
+ * Output only. Whether the index advisor is enabled.
944
944
  */
945
945
  indexAdvisorEnabled?: boolean | null;
946
946
  /**
947
- * Output only. Whether oom session cancel is enabled.
947
+ * Output only. Whether canceling the out-of-memory (OOM) session is enabled.
948
948
  */
949
949
  oomSessionCancelEnabled?: boolean | null;
950
950
  }
@@ -1246,7 +1246,7 @@ export declare namespace sqladmin_v1 {
1246
1246
  */
1247
1247
  requireSsl?: boolean | null;
1248
1248
  /**
1249
- * 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.
1249
+ * 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.
1250
1250
  */
1251
1251
  sslMode?: string | null;
1252
1252
  }
@@ -1652,15 +1652,15 @@ export declare namespace sqladmin_v1 {
1652
1652
  mysqlReplicaConfiguration?: Schema$MySqlReplicaConfiguration;
1653
1653
  }
1654
1654
  /**
1655
- * Primary-DR replica pair
1655
+ * 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.
1656
1656
  */
1657
1657
  export interface Schema$ReplicationCluster {
1658
1658
  /**
1659
- * Output only. read-only field that indicates if the replica is a dr_replica; not set for a primary.
1659
+ * 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.
1660
1660
  */
1661
1661
  drReplica?: boolean | null;
1662
1662
  /**
1663
- * 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.
1663
+ * 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.
1664
1664
  */
1665
1665
  failoverDrReplicaName?: string | null;
1666
1666
  }
@@ -1944,7 +1944,7 @@ export declare namespace sqladmin_v1 {
1944
1944
  */
1945
1945
  export interface Schema$SqlInstancesStartExternalSyncRequest {
1946
1946
  /**
1947
- * Optional. MigrationType decides if the migration is a physical file based migration or logical migration.
1947
+ * 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.
1948
1948
  */
1949
1949
  migrationType?: string | null;
1950
1950
  /**
@@ -1969,7 +1969,7 @@ export declare namespace sqladmin_v1 {
1969
1969
  */
1970
1970
  export interface Schema$SqlInstancesVerifyExternalSyncSettingsRequest {
1971
1971
  /**
1972
- * Optional. MigrationType decides if the migration is a physical file based migration or logical migration
1972
+ * 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.
1973
1973
  */
1974
1974
  migrationType?: string | null;
1975
1975
  /**
@@ -1981,7 +1981,7 @@ export declare namespace sqladmin_v1 {
1981
1981
  */
1982
1982
  syncMode?: string | null;
1983
1983
  /**
1984
- * Optional. Parallel level for initial data sync. Currently only applicable for PostgreSQL.
1984
+ * Optional. Parallel level for initial data sync. Only applicable for PostgreSQL.
1985
1985
  */
1986
1986
  syncParallelLevel?: string | null;
1987
1987
  /**
@@ -2930,7 +2930,7 @@ export declare namespace sqladmin_v1 {
2930
2930
  patch(params: Params$Resource$Instances$Patch, callback: BodyResponseCallback<Schema$Operation>): void;
2931
2931
  patch(callback: BodyResponseCallback<Schema$Operation>): void;
2932
2932
  /**
2933
- * Promotes the read replica instance to be a stand-alone Cloud SQL instance. Using this operation might cause your instance to restart.
2933
+ * Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart.
2934
2934
  *
2935
2935
  * @param params - Parameters for request
2936
2936
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3056,7 +3056,7 @@ export declare namespace sqladmin_v1 {
3056
3056
  stopReplica(params: Params$Resource$Instances$Stopreplica, callback: BodyResponseCallback<Schema$Operation>): void;
3057
3057
  stopReplica(callback: BodyResponseCallback<Schema$Operation>): void;
3058
3058
  /**
3059
- * Switches over from the primary instance to the replica instance.
3059
+ * Switches over from the primary instance to the designated DR replica instance.
3060
3060
  *
3061
3061
  * @param params - Parameters for request
3062
3062
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3280,7 +3280,7 @@ export declare namespace sqladmin_v1 {
3280
3280
  }
3281
3281
  export interface Params$Resource$Instances$Promotereplica extends StandardParameters {
3282
3282
  /**
3283
- * 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.
3283
+ * 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.
3284
3284
  */
3285
3285
  failover?: boolean;
3286
3286
  /**
@@ -592,7 +592,7 @@ export declare namespace sqladmin_v1beta4 {
592
592
  */
593
593
  replicaNames?: string[] | null;
594
594
  /**
595
- * 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.
595
+ * 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.
596
596
  */
597
597
  replicationCluster?: Schema$ReplicationCluster;
598
598
  /**
@@ -923,11 +923,11 @@ export declare namespace sqladmin_v1beta4 {
923
923
  kind?: string | null;
924
924
  }
925
925
  /**
926
- * Gemini configuration.
926
+ * Gemini instance configuration.
927
927
  */
928
928
  export interface Schema$GeminiInstanceConfig {
929
929
  /**
930
- * Output only. Whether active query is enabled.
930
+ * Output only. Whether the active query is enabled.
931
931
  */
932
932
  activeQueryEnabled?: boolean | null;
933
933
  /**
@@ -935,19 +935,19 @@ export declare namespace sqladmin_v1beta4 {
935
935
  */
936
936
  entitled?: boolean | null;
937
937
  /**
938
- * Output only. Whether flag recommender is enabled.
938
+ * Output only. Whether the flag recommender is enabled.
939
939
  */
940
940
  flagRecommenderEnabled?: boolean | null;
941
941
  /**
942
- * Output only. Whether vacuum management is enabled.
942
+ * Output only. Whether the vacuum management is enabled.
943
943
  */
944
944
  googleVacuumMgmtEnabled?: boolean | null;
945
945
  /**
946
- * Output only. Whether index advisor is enabled.
946
+ * Output only. Whether the index advisor is enabled.
947
947
  */
948
948
  indexAdvisorEnabled?: boolean | null;
949
949
  /**
950
- * Output only. Whether oom session cancel is enabled.
950
+ * Output only. Whether canceling the out-of-memory (OOM) session is enabled.
951
951
  */
952
952
  oomSessionCancelEnabled?: boolean | null;
953
953
  }
@@ -1249,7 +1249,7 @@ export declare namespace sqladmin_v1beta4 {
1249
1249
  */
1250
1250
  requireSsl?: boolean | null;
1251
1251
  /**
1252
- * 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.
1252
+ * 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.
1253
1253
  */
1254
1254
  sslMode?: string | null;
1255
1255
  }
@@ -1655,15 +1655,15 @@ export declare namespace sqladmin_v1beta4 {
1655
1655
  mysqlReplicaConfiguration?: Schema$MySqlReplicaConfiguration;
1656
1656
  }
1657
1657
  /**
1658
- * Primary-DR replica pair
1658
+ * 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.
1659
1659
  */
1660
1660
  export interface Schema$ReplicationCluster {
1661
1661
  /**
1662
- * Output only. read-only field that indicates if the replica is a dr_replica; not set for a primary.
1662
+ * 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.
1663
1663
  */
1664
1664
  drReplica?: boolean | null;
1665
1665
  /**
1666
- * 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.
1666
+ * 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.
1667
1667
  */
1668
1668
  failoverDrReplicaName?: string | null;
1669
1669
  }
@@ -1944,7 +1944,7 @@ export declare namespace sqladmin_v1beta4 {
1944
1944
  }
1945
1945
  export interface Schema$SqlInstancesStartExternalSyncRequest {
1946
1946
  /**
1947
- * Optional. MigrationType decides if the migration is a physical file based migration or logical migration.
1947
+ * 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.
1948
1948
  */
1949
1949
  migrationType?: string | null;
1950
1950
  /**
@@ -1966,7 +1966,7 @@ export declare namespace sqladmin_v1beta4 {
1966
1966
  }
1967
1967
  export interface Schema$SqlInstancesVerifyExternalSyncSettingsRequest {
1968
1968
  /**
1969
- * Optional. MigrationType field decides if the migration is a physical file based migration or logical migration
1969
+ * 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.
1970
1970
  */
1971
1971
  migrationType?: string | null;
1972
1972
  /**
@@ -1978,7 +1978,7 @@ export declare namespace sqladmin_v1beta4 {
1978
1978
  */
1979
1979
  syncMode?: string | null;
1980
1980
  /**
1981
- * Optional. Parallel level for initial data sync. Currently only applicable for PostgreSQL.
1981
+ * Optional. Parallel level for initial data sync. Only applicable for PostgreSQL.
1982
1982
  */
1983
1983
  syncParallelLevel?: string | null;
1984
1984
  /**
@@ -2927,7 +2927,7 @@ export declare namespace sqladmin_v1beta4 {
2927
2927
  patch(params: Params$Resource$Instances$Patch, callback: BodyResponseCallback<Schema$Operation>): void;
2928
2928
  patch(callback: BodyResponseCallback<Schema$Operation>): void;
2929
2929
  /**
2930
- * Promotes the read replica instance to be a stand-alone Cloud SQL instance. Using this operation might cause your instance to restart.
2930
+ * Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart.
2931
2931
  *
2932
2932
  * @param params - Parameters for request
2933
2933
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3053,7 +3053,7 @@ export declare namespace sqladmin_v1beta4 {
3053
3053
  stopReplica(params: Params$Resource$Instances$Stopreplica, callback: BodyResponseCallback<Schema$Operation>): void;
3054
3054
  stopReplica(callback: BodyResponseCallback<Schema$Operation>): void;
3055
3055
  /**
3056
- * Switches over from the primary instance to a replica instance.
3056
+ * Switches over from the primary instance to the designated DR replica instance.
3057
3057
  *
3058
3058
  * @param params - Parameters for request
3059
3059
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3277,7 +3277,7 @@ export declare namespace sqladmin_v1beta4 {
3277
3277
  }
3278
3278
  export interface Params$Resource$Instances$Promotereplica extends StandardParameters {
3279
3279
  /**
3280
- * 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.
3280
+ * 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.
3281
3281
  */
3282
3282
  failover?: boolean;
3283
3283
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@googleapis/sqladmin",
3
- "version": "16.1.0",
3
+ "version": "17.0.1",
4
4
  "description": "sqladmin",
5
5
  "main": "build/index.js",
6
6
  "types": "build/index.d.ts",
package/v1.ts CHANGED
@@ -247,7 +247,7 @@ export namespace sqladmin_v1 {
247
247
  */
248
248
  startTime?: string | null;
249
249
  /**
250
- * Output only. This value contains the storage location of transactional logs for the database for point-in-time recovery.
250
+ * Output only. This value contains the storage location of transactional logs used to perform point-in-time recovery (PITR) for the database.
251
251
  */
252
252
  transactionalLogStorageState?: string | null;
253
253
  /**
@@ -583,7 +583,7 @@ export namespace sqladmin_v1 {
583
583
  */
584
584
  gceZone?: string | null;
585
585
  /**
586
- * Gemini configuration.
586
+ * Gemini instance configuration.
587
587
  */
588
588
  geminiConfig?: Schema$GeminiInstanceConfig;
589
589
  /**
@@ -651,7 +651,7 @@ export namespace sqladmin_v1 {
651
651
  */
652
652
  replicaNames?: string[] | null;
653
653
  /**
654
- * 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.
654
+ * 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.
655
655
  */
656
656
  replicationCluster?: Schema$ReplicationCluster;
657
657
  /**
@@ -976,31 +976,31 @@ export namespace sqladmin_v1 {
976
976
  kind?: string | null;
977
977
  }
978
978
  /**
979
- * Gemini configuration.
979
+ * Gemini instance configuration.
980
980
  */
981
981
  export interface Schema$GeminiInstanceConfig {
982
982
  /**
983
- * Output only. Whether active query is enabled.
983
+ * Output only. Whether the active query is enabled.
984
984
  */
985
985
  activeQueryEnabled?: boolean | null;
986
986
  /**
987
- * Output only. Whether gemini is enabled.
987
+ * Output only. Whether Gemini is enabled.
988
988
  */
989
989
  entitled?: boolean | null;
990
990
  /**
991
- * Output only. Whether flag recommender is enabled.
991
+ * Output only. Whether the flag recommender is enabled.
992
992
  */
993
993
  flagRecommenderEnabled?: boolean | null;
994
994
  /**
995
- * Output only. Whether vacuum management is enabled.
995
+ * Output only. Whether the vacuum management is enabled.
996
996
  */
997
997
  googleVacuumMgmtEnabled?: boolean | null;
998
998
  /**
999
- * Output only. Whether index advisor is enabled.
999
+ * Output only. Whether the index advisor is enabled.
1000
1000
  */
1001
1001
  indexAdvisorEnabled?: boolean | null;
1002
1002
  /**
1003
- * Output only. Whether oom session cancel is enabled.
1003
+ * Output only. Whether canceling the out-of-memory (OOM) session is enabled.
1004
1004
  */
1005
1005
  oomSessionCancelEnabled?: boolean | null;
1006
1006
  }
@@ -1299,7 +1299,7 @@ export namespace sqladmin_v1 {
1299
1299
  */
1300
1300
  requireSsl?: boolean | null;
1301
1301
  /**
1302
- * 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.
1302
+ * 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.
1303
1303
  */
1304
1304
  sslMode?: string | null;
1305
1305
  }
@@ -1705,15 +1705,15 @@ export namespace sqladmin_v1 {
1705
1705
  mysqlReplicaConfiguration?: Schema$MySqlReplicaConfiguration;
1706
1706
  }
1707
1707
  /**
1708
- * Primary-DR replica pair
1708
+ * 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.
1709
1709
  */
1710
1710
  export interface Schema$ReplicationCluster {
1711
1711
  /**
1712
- * Output only. read-only field that indicates if the replica is a dr_replica; not set for a primary.
1712
+ * 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.
1713
1713
  */
1714
1714
  drReplica?: boolean | null;
1715
1715
  /**
1716
- * 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.
1716
+ * 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.
1717
1717
  */
1718
1718
  failoverDrReplicaName?: string | null;
1719
1719
  }
@@ -1994,7 +1994,7 @@ export namespace sqladmin_v1 {
1994
1994
  */
1995
1995
  export interface Schema$SqlInstancesStartExternalSyncRequest {
1996
1996
  /**
1997
- * Optional. MigrationType decides if the migration is a physical file based migration or logical migration.
1997
+ * 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.
1998
1998
  */
1999
1999
  migrationType?: string | null;
2000
2000
  /**
@@ -2019,7 +2019,7 @@ export namespace sqladmin_v1 {
2019
2019
  */
2020
2020
  export interface Schema$SqlInstancesVerifyExternalSyncSettingsRequest {
2021
2021
  /**
2022
- * Optional. MigrationType decides if the migration is a physical file based migration or logical migration
2022
+ * 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.
2023
2023
  */
2024
2024
  migrationType?: string | null;
2025
2025
  /**
@@ -2031,7 +2031,7 @@ export namespace sqladmin_v1 {
2031
2031
  */
2032
2032
  syncMode?: string | null;
2033
2033
  /**
2034
- * Optional. Parallel level for initial data sync. Currently only applicable for PostgreSQL.
2034
+ * Optional. Parallel level for initial data sync. Only applicable for PostgreSQL.
2035
2035
  */
2036
2036
  syncParallelLevel?: string | null;
2037
2037
  /**
@@ -5017,7 +5017,7 @@ export namespace sqladmin_v1 {
5017
5017
  }
5018
5018
 
5019
5019
  /**
5020
- * Promotes the read replica instance to be a stand-alone Cloud SQL instance. Using this operation might cause your instance to restart.
5020
+ * Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart.
5021
5021
  *
5022
5022
  * @param params - Parameters for request
5023
5023
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5816,7 +5816,7 @@ export namespace sqladmin_v1 {
5816
5816
  }
5817
5817
 
5818
5818
  /**
5819
- * Switches over from the primary instance to the replica instance.
5819
+ * Switches over from the primary instance to the designated DR replica instance.
5820
5820
  *
5821
5821
  * @param params - Parameters for request
5822
5822
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6274,7 +6274,7 @@ export namespace sqladmin_v1 {
6274
6274
  export interface Params$Resource$Instances$Promotereplica
6275
6275
  extends StandardParameters {
6276
6276
  /**
6277
- * 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.
6277
+ * 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.
6278
6278
  */
6279
6279
  failover?: boolean;
6280
6280
  /**
package/v1beta4.ts CHANGED
@@ -651,7 +651,7 @@ export namespace sqladmin_v1beta4 {
651
651
  */
652
652
  replicaNames?: string[] | null;
653
653
  /**
654
- * 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.
654
+ * 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.
655
655
  */
656
656
  replicationCluster?: Schema$ReplicationCluster;
657
657
  /**
@@ -979,11 +979,11 @@ export namespace sqladmin_v1beta4 {
979
979
  kind?: string | null;
980
980
  }
981
981
  /**
982
- * Gemini configuration.
982
+ * Gemini instance configuration.
983
983
  */
984
984
  export interface Schema$GeminiInstanceConfig {
985
985
  /**
986
- * Output only. Whether active query is enabled.
986
+ * Output only. Whether the active query is enabled.
987
987
  */
988
988
  activeQueryEnabled?: boolean | null;
989
989
  /**
@@ -991,19 +991,19 @@ export namespace sqladmin_v1beta4 {
991
991
  */
992
992
  entitled?: boolean | null;
993
993
  /**
994
- * Output only. Whether flag recommender is enabled.
994
+ * Output only. Whether the flag recommender is enabled.
995
995
  */
996
996
  flagRecommenderEnabled?: boolean | null;
997
997
  /**
998
- * Output only. Whether vacuum management is enabled.
998
+ * Output only. Whether the vacuum management is enabled.
999
999
  */
1000
1000
  googleVacuumMgmtEnabled?: boolean | null;
1001
1001
  /**
1002
- * Output only. Whether index advisor is enabled.
1002
+ * Output only. Whether the index advisor is enabled.
1003
1003
  */
1004
1004
  indexAdvisorEnabled?: boolean | null;
1005
1005
  /**
1006
- * Output only. Whether oom session cancel is enabled.
1006
+ * Output only. Whether canceling the out-of-memory (OOM) session is enabled.
1007
1007
  */
1008
1008
  oomSessionCancelEnabled?: boolean | null;
1009
1009
  }
@@ -1302,7 +1302,7 @@ export namespace sqladmin_v1beta4 {
1302
1302
  */
1303
1303
  requireSsl?: boolean | null;
1304
1304
  /**
1305
- * 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.
1305
+ * 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.
1306
1306
  */
1307
1307
  sslMode?: string | null;
1308
1308
  }
@@ -1708,15 +1708,15 @@ export namespace sqladmin_v1beta4 {
1708
1708
  mysqlReplicaConfiguration?: Schema$MySqlReplicaConfiguration;
1709
1709
  }
1710
1710
  /**
1711
- * Primary-DR replica pair
1711
+ * 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.
1712
1712
  */
1713
1713
  export interface Schema$ReplicationCluster {
1714
1714
  /**
1715
- * Output only. read-only field that indicates if the replica is a dr_replica; not set for a primary.
1715
+ * 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.
1716
1716
  */
1717
1717
  drReplica?: boolean | null;
1718
1718
  /**
1719
- * 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.
1719
+ * 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.
1720
1720
  */
1721
1721
  failoverDrReplicaName?: string | null;
1722
1722
  }
@@ -1994,7 +1994,7 @@ export namespace sqladmin_v1beta4 {
1994
1994
  export interface Schema$SqlInstancesResetReplicaSizeRequest {}
1995
1995
  export interface Schema$SqlInstancesStartExternalSyncRequest {
1996
1996
  /**
1997
- * Optional. MigrationType decides if the migration is a physical file based migration or logical migration.
1997
+ * 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.
1998
1998
  */
1999
1999
  migrationType?: string | null;
2000
2000
  /**
@@ -2016,7 +2016,7 @@ export namespace sqladmin_v1beta4 {
2016
2016
  }
2017
2017
  export interface Schema$SqlInstancesVerifyExternalSyncSettingsRequest {
2018
2018
  /**
2019
- * Optional. MigrationType field decides if the migration is a physical file based migration or logical migration
2019
+ * 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.
2020
2020
  */
2021
2021
  migrationType?: string | null;
2022
2022
  /**
@@ -2028,7 +2028,7 @@ export namespace sqladmin_v1beta4 {
2028
2028
  */
2029
2029
  syncMode?: string | null;
2030
2030
  /**
2031
- * Optional. Parallel level for initial data sync. Currently only applicable for PostgreSQL.
2031
+ * Optional. Parallel level for initial data sync. Only applicable for PostgreSQL.
2032
2032
  */
2033
2033
  syncParallelLevel?: string | null;
2034
2034
  /**
@@ -5021,7 +5021,7 @@ export namespace sqladmin_v1beta4 {
5021
5021
  }
5022
5022
 
5023
5023
  /**
5024
- * Promotes the read replica instance to be a stand-alone Cloud SQL instance. Using this operation might cause your instance to restart.
5024
+ * Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart.
5025
5025
  *
5026
5026
  * @param params - Parameters for request
5027
5027
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5822,7 +5822,7 @@ export namespace sqladmin_v1beta4 {
5822
5822
  }
5823
5823
 
5824
5824
  /**
5825
- * Switches over from the primary instance to a replica instance.
5825
+ * Switches over from the primary instance to the designated DR replica instance.
5826
5826
  *
5827
5827
  * @param params - Parameters for request
5828
5828
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6281,7 +6281,7 @@ export namespace sqladmin_v1beta4 {
6281
6281
  export interface Params$Resource$Instances$Promotereplica
6282
6282
  extends StandardParameters {
6283
6283
  /**
6284
- * 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.
6284
+ * 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.
6285
6285
  */
6286
6286
  failover?: boolean;
6287
6287
  /**