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

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.
Files changed (3) hide show
  1. package/index.d.ts +19 -19
  2. package/package.json +1 -1
  3. package/readme.md +2 -2
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://sqladmin.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20240412
12
+ // Revision: 20240425
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -73,7 +73,7 @@ declare namespace gapi.client {
73
73
  replicationLogArchivingEnabled?: boolean;
74
74
  /** Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`. */
75
75
  startTime?: string;
76
- /** Output only. This value contains the storage location of transactional logs for the database for point-in-time recovery. */
76
+ /** Output only. This value contains the storage location of transactional logs used to perform point-in-time recovery (PITR) for the database. */
77
77
  transactionalLogStorageState?: string;
78
78
  /** The number of days of transaction logs we retain for point in time restore, from 1-7. */
79
79
  transactionLogRetentionDays?: number;
@@ -241,7 +241,7 @@ declare namespace gapi.client {
241
241
  };
242
242
  /** 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. */
243
243
  gceZone?: string;
244
- /** Gemini configuration. */
244
+ /** Gemini instance configuration. */
245
245
  geminiConfig?: GeminiInstanceConfig;
246
246
  /** The instance type. */
247
247
  instanceType?: string;
@@ -275,7 +275,7 @@ declare namespace gapi.client {
275
275
  replicaConfiguration?: ReplicaConfiguration;
276
276
  /** The replicas of the instance. */
277
277
  replicaNames?: string[];
278
- /** 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. */
278
+ /** 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. */
279
279
  replicationCluster?: ReplicationCluster;
280
280
  /** Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances. */
281
281
  rootPassword?: string;
@@ -459,17 +459,17 @@ declare namespace gapi.client {
459
459
  kind?: string;
460
460
  }
461
461
  interface GeminiInstanceConfig {
462
- /** Output only. Whether active query is enabled. */
462
+ /** Output only. Whether the active query is enabled. */
463
463
  activeQueryEnabled?: boolean;
464
- /** Output only. Whether gemini is enabled. */
464
+ /** Output only. Whether Gemini is enabled. */
465
465
  entitled?: boolean;
466
- /** Output only. Whether flag recommender is enabled. */
466
+ /** Output only. Whether the flag recommender is enabled. */
467
467
  flagRecommenderEnabled?: boolean;
468
- /** Output only. Whether vacuum management is enabled. */
468
+ /** Output only. Whether the vacuum management is enabled. */
469
469
  googleVacuumMgmtEnabled?: boolean;
470
- /** Output only. Whether index advisor is enabled. */
470
+ /** Output only. Whether the index advisor is enabled. */
471
471
  indexAdvisorEnabled?: boolean;
472
- /** Output only. Whether oom session cancel is enabled. */
472
+ /** Output only. Whether canceling the out-of-memory (OOM) session is enabled. */
473
473
  oomSessionCancelEnabled?: boolean;
474
474
  }
475
475
  interface GenerateEphemeralCertRequest {
@@ -639,7 +639,7 @@ declare namespace gapi.client {
639
639
  pscConfig?: PscConfig;
640
640
  /** 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. */
641
641
  requireSsl?: boolean;
642
- /** 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. */
642
+ /** 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. */
643
643
  sslMode?: string;
644
644
  }
645
645
  interface IpMapping {
@@ -836,9 +836,9 @@ declare namespace gapi.client {
836
836
  mysqlReplicaConfiguration?: MySqlReplicaConfiguration;
837
837
  }
838
838
  interface ReplicationCluster {
839
- /** Output only. read-only field that indicates if the replica is a dr_replica; not set for a primary. */
839
+ /** 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. */
840
840
  drReplica?: boolean;
841
- /** 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. */
841
+ /** 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. */
842
842
  failoverDrReplicaName?: string;
843
843
  }
844
844
  interface Reschedule {
@@ -973,7 +973,7 @@ declare namespace gapi.client {
973
973
  }
974
974
  interface SqlInstancesResetReplicaSizeRequest {}
975
975
  interface SqlInstancesStartExternalSyncRequest {
976
- /** Optional. MigrationType decides if the migration is a physical file based migration or logical migration. */
976
+ /** 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. */
977
977
  migrationType?: string;
978
978
  /** MySQL-specific settings for start external sync. */
979
979
  mysqlSyncConfig?: MySqlSyncConfig;
@@ -985,13 +985,13 @@ declare namespace gapi.client {
985
985
  syncParallelLevel?: string;
986
986
  }
987
987
  interface SqlInstancesVerifyExternalSyncSettingsRequest {
988
- /** Optional. MigrationType decides if the migration is a physical file based migration or logical migration */
988
+ /** 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. */
989
989
  migrationType?: string;
990
990
  /** Optional. MySQL-specific settings for start external sync. */
991
991
  mysqlSyncConfig?: MySqlSyncConfig;
992
992
  /** External sync mode */
993
993
  syncMode?: string;
994
- /** Optional. Parallel level for initial data sync. Currently only applicable for PostgreSQL. */
994
+ /** Optional. Parallel level for initial data sync. Only applicable for PostgreSQL. */
995
995
  syncParallelLevel?: string;
996
996
  /** Flag to enable verifying connection only */
997
997
  verifyConnectionOnly?: boolean;
@@ -2442,7 +2442,7 @@ declare namespace gapi.client {
2442
2442
  },
2443
2443
  body: DatabaseInstance
2444
2444
  ): Request<Operation>;
2445
- /** Promotes the read replica instance to be a stand-alone Cloud SQL instance. Using this operation might cause your instance to restart. */
2445
+ /** Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart. */
2446
2446
  promoteReplica(request?: {
2447
2447
  /** V1 error format. */
2448
2448
  '$.xgafv'?: string;
@@ -2452,7 +2452,7 @@ declare namespace gapi.client {
2452
2452
  alt?: string;
2453
2453
  /** JSONP */
2454
2454
  callback?: string;
2455
- /** 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. */
2455
+ /** 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. */
2456
2456
  failover?: boolean;
2457
2457
  /** Selector specifying which fields to include in a partial response. */
2458
2458
  fields?: string;
@@ -2804,7 +2804,7 @@ declare namespace gapi.client {
2804
2804
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2805
2805
  uploadType?: string;
2806
2806
  }): Request<Operation>;
2807
- /** Switches over from the primary instance to the replica instance. */
2807
+ /** Switches over from the primary instance to the designated DR replica instance. */
2808
2808
  switchover(request?: {
2809
2809
  /** V1 error format. */
2810
2810
  '$.xgafv'?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.sqladmin-v1",
3
- "version": "0.0.20240412",
3
+ "version": "0.0.20240425",
4
4
  "description": "TypeScript typings for Cloud SQL Admin API v1",
5
5
  "repository": {
6
6
  "type": "git",
package/readme.md CHANGED
@@ -280,7 +280,7 @@ await gapi.client.sql.instances.patch({
280
280
  });
281
281
 
282
282
  /*
283
- Promotes the read replica instance to be a stand-alone Cloud SQL instance. Using this operation might cause your instance to restart.
283
+ Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart.
284
284
  */
285
285
  await gapi.client.sql.instances.promoteReplica({
286
286
  instance: 'instance',
@@ -352,7 +352,7 @@ await gapi.client.sql.instances.stopReplica({
352
352
  });
353
353
 
354
354
  /*
355
- Switches over from the primary instance to the replica instance.
355
+ Switches over from the primary instance to the designated DR replica instance.
356
356
  */
357
357
  await gapi.client.sql.instances.switchover({
358
358
  instance: 'instance',