@googleapis/sqladmin 28.0.0 → 29.0.0

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,18 @@
1
1
  # Changelog
2
2
 
3
+ ## [29.0.0](https://github.com/googleapis/google-api-nodejs-client/compare/sqladmin-v28.0.0...sqladmin-v29.0.0) (2025-05-05)
4
+
5
+
6
+ ### ⚠ BREAKING CHANGES
7
+
8
+ * **sqladmin:** This release has breaking changes.
9
+ * **sqladmin:** This release has breaking changes.
10
+
11
+ ### Features
12
+
13
+ * **sqladmin:** update the API ([9755a1f](https://github.com/googleapis/google-api-nodejs-client/commit/9755a1f1636059eb3dc7764d06e070ac6889100d))
14
+ * **sqladmin:** update the API ([0a3a02e](https://github.com/googleapis/google-api-nodejs-client/commit/0a3a02e9b423dd32b85f564f62dbe16811843789))
15
+
3
16
  ## [28.0.0](https://github.com/googleapis/google-api-nodejs-client/compare/sqladmin-v27.0.0...sqladmin-v28.0.0) (2025-04-18)
4
17
 
5
18
 
package/build/v1.d.ts CHANGED
@@ -167,7 +167,7 @@ export declare namespace sqladmin_v1 {
167
167
  name?: string | null;
168
168
  }
169
169
  /**
170
- * A backup resource.
170
+ * A backup resource. Next ID: 30
171
171
  */
172
172
  export interface Schema$Backup {
173
173
  /**
@@ -183,7 +183,7 @@ export declare namespace sqladmin_v1 {
183
183
  */
184
184
  backupRun?: string | null;
185
185
  /**
186
- * Output only. The database version of the instance of when this backup was made.
186
+ * Output only. The database version of the instance of at the time this backup was made.
187
187
  */
188
188
  databaseVersion?: string | null;
189
189
  /**
@@ -271,6 +271,10 @@ export declare namespace sqladmin_v1 {
271
271
  * Backup retention settings.
272
272
  */
273
273
  backupRetentionSettings?: Schema$BackupRetentionSettings;
274
+ /**
275
+ * Output only. Backup tier that manages the backups for the instance.
276
+ */
277
+ backupTier?: string | null;
274
278
  /**
275
279
  * (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.
276
280
  */
@@ -360,7 +364,7 @@ export declare namespace sqladmin_v1 {
360
364
  */
361
365
  backupKind?: string | null;
362
366
  /**
363
- * Output only. The instance database version when this backup was made.
367
+ * Output only. The instance database version at the time this backup was made.
364
368
  */
365
369
  databaseVersion?: string | null;
366
370
  /**
@@ -511,38 +515,14 @@ export declare namespace sqladmin_v1 {
511
515
  * The managed connection pooling configuration.
512
516
  */
513
517
  export interface Schema$ConnectionPoolConfig {
514
- /**
515
- * Client idle timeout.
516
- */
517
- clientConnectionIdleTimeout?: string | null;
518
518
  /**
519
519
  * Whether managed connection pooling is enabled.
520
520
  */
521
521
  connectionPoolingEnabled?: boolean | null;
522
- /**
523
- * Managed connection pool size.
524
- */
525
- connPoolSize?: number | null;
526
522
  /**
527
523
  * Optional. List of connection pool configuration flags
528
524
  */
529
525
  flags?: Schema$ConnectionPoolFlags[];
530
- /**
531
- * Maximum number of client connections in connection pool.
532
- */
533
- maxClientConnections?: number | null;
534
- /**
535
- * The managed connection pool mode for the instance.
536
- */
537
- poolMode?: string | null;
538
- /**
539
- * Query wait timeout.
540
- */
541
- queryWaitTimeout?: string | null;
542
- /**
543
- * Server idle timeout.
544
- */
545
- serverConnectionIdleTimeout?: string | null;
546
526
  }
547
527
  /**
548
528
  * Connection pool flags for Cloud SQL instances managed connection pool configuration.
@@ -558,23 +538,23 @@ export declare namespace sqladmin_v1 {
558
538
  value?: string | null;
559
539
  }
560
540
  /**
561
- * Details of a single node of a read pool.
541
+ * Details of a single read pool node of a read pool.
562
542
  */
563
543
  export interface Schema$ConnectPoolNodeConfig {
564
544
  /**
565
- * Output only. The DNS name of the node.
545
+ * Output only. The DNS name of the read pool node.
566
546
  */
567
547
  dnsName?: string | null;
568
548
  /**
569
- * Output only. The list of DNS names used by this node.
549
+ * Output only. The list of DNS names used by this read pool node.
570
550
  */
571
551
  dnsNames?: Schema$DnsNameMapping[];
572
552
  /**
573
- * Output only. Mappings containing IP addresses that can be used to connect to the node.
553
+ * Output only. Mappings containing IP addresses that can be used to connect to the read pool node.
574
554
  */
575
555
  ipAddresses?: Schema$IpMapping[];
576
556
  /**
577
- * Output only. The name of the node. Doesn't include the project ID.
557
+ * Output only. The name of the read pool node. Doesn't include the project ID.
578
558
  */
579
559
  name?: string | null;
580
560
  }
@@ -611,11 +591,11 @@ export declare namespace sqladmin_v1 {
611
591
  */
612
592
  kind?: string | null;
613
593
  /**
614
- * The number of nodes in a read pool.
594
+ * The number of read pool nodes in a read pool.
615
595
  */
616
596
  nodeCount?: number | null;
617
597
  /**
618
- * Output only. Entries containing information about each node of the read pool.
598
+ * Output only. Entries containing information about each read pool node of the read pool.
619
599
  */
620
600
  nodes?: Schema$ConnectPoolNodeConfig[];
621
601
  /**
@@ -790,11 +770,11 @@ export declare namespace sqladmin_v1 {
790
770
  */
791
771
  name?: string | null;
792
772
  /**
793
- * The number of nodes in a read pool.
773
+ * The number of read pool nodes in a read pool.
794
774
  */
795
775
  nodeCount?: number | null;
796
776
  /**
797
- * Output only. Entries containing information about each node of the read pool.
777
+ * Output only. Entries containing information about each read pool node of the read pool.
798
778
  */
799
779
  nodes?: Schema$PoolNodeConfig[];
800
780
  /**
@@ -1103,7 +1083,7 @@ export declare namespace sqladmin_v1 {
1103
1083
  */
1104
1084
  kind?: string | null;
1105
1085
  /**
1106
- * Option for export offload.
1086
+ * Whether to perform a serverless export.
1107
1087
  */
1108
1088
  offload?: boolean | null;
1109
1089
  /**
@@ -1538,6 +1518,10 @@ export declare namespace sqladmin_v1 {
1538
1518
  * The name of the backup that's used to restore a Cloud SQL instance: Format: projects/{project-id\}/backups/{backup-uid\}. Only one of restore_backup_context, backup, backupdr_backup can be passed to the input.
1539
1519
  */
1540
1520
  backup?: string | null;
1521
+ /**
1522
+ * The name of the backup that's used to restore a Cloud SQL instance: Format: "projects/{project-id\}/locations/{location\}/backupVaults/{backupvault\}/dataSources/{datasource\}/backups/{backup-uid\}". Only one of restore_backup_context, backup, backupdr_backup can be passed to the input.
1523
+ */
1524
+ backupdrBackup?: string | null;
1541
1525
  /**
1542
1526
  * Parameters required to perform the restore backup operation.
1543
1527
  */
@@ -2033,31 +2017,64 @@ export declare namespace sqladmin_v1 {
2033
2017
  targetSizeGb?: string | null;
2034
2018
  }
2035
2019
  /**
2036
- * Details of a single node of a read pool.
2020
+ * The context to perform a point-in-time recovery of an instance managed by Google Cloud Backup and Disaster Recovery.
2021
+ */
2022
+ export interface Schema$PointInTimeRestoreContext {
2023
+ /**
2024
+ * Optional. The name of the allocated IP range for the internal IP Cloud SQL instance. For example: "google-managed-services-default". If you set this, then Cloud SQL creates the IP address for the cloned instance in the allocated range. This range must comply with [RFC 1035](https://tools.ietf.org/html/rfc1035) standards. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?. Reserved for future use. http://go/speckle-subnet-picker-clone
2025
+ */
2026
+ allocatedIpRange?: string | null;
2027
+ /**
2028
+ * The Google Cloud Backup and Disaster Recovery Datasource URI. Format: projects/{project\}/locations/{region\}/backupVaults/{backupvault\}/dataSources/{datasource\}.
2029
+ */
2030
+ datasource?: string | null;
2031
+ /**
2032
+ * Required. The date and time to which you want to restore the instance.
2033
+ */
2034
+ pointInTime?: string | null;
2035
+ /**
2036
+ * Optional. Point-in-time recovery 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.
2037
+ */
2038
+ preferredSecondaryZone?: string | null;
2039
+ /**
2040
+ * Optional. Point-in-time recovery of an instance to the specified zone. If no zone is specified, then clone to the same primary zone as the source instance.
2041
+ */
2042
+ preferredZone?: string | null;
2043
+ /**
2044
+ * Optional. The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, `/projects/myProject/global/networks/default`.
2045
+ */
2046
+ privateNetwork?: string | null;
2047
+ /**
2048
+ * Target instance name.
2049
+ */
2050
+ targetInstance?: string | null;
2051
+ }
2052
+ /**
2053
+ * Details of a single read pool node of a read pool.
2037
2054
  */
2038
2055
  export interface Schema$PoolNodeConfig {
2039
2056
  /**
2040
- * Output only. The DNS name of the node.
2057
+ * Output only. The DNS name of the read pool node.
2041
2058
  */
2042
2059
  dnsName?: string | null;
2043
2060
  /**
2044
- * Output only. The list of DNS names used by this node.
2061
+ * Output only. The list of DNS names used by this read pool node.
2045
2062
  */
2046
2063
  dnsNames?: Schema$DnsNameMapping[];
2047
2064
  /**
2048
- * Output only. The serving zone of the node.
2065
+ * Output only. The zone of the read pool node.
2049
2066
  */
2050
2067
  gceZone?: string | null;
2051
2068
  /**
2052
- * Output only. Mappings containing IP addresses that can be used to connect to the node.
2069
+ * Output only. Mappings containing IP addresses that can be used to connect to the read pool node.
2053
2070
  */
2054
2071
  ipAddresses?: Schema$IpMapping[];
2055
2072
  /**
2056
- * Output only. The name of the node, to be used for retrieving metrics and logs for the node.
2073
+ * Output only. The name of the read pool node, to be used for retrieving metrics and logs.
2057
2074
  */
2058
2075
  name?: string | null;
2059
2076
  /**
2060
- * Output only. The current state of the node.
2077
+ * Output only. The current state of the read pool node.
2061
2078
  */
2062
2079
  state?: string | null;
2063
2080
  }
@@ -2296,7 +2313,7 @@ export declare namespace sqladmin_v1 {
2296
2313
  */
2297
2314
  enableDataplexIntegration?: boolean | null;
2298
2315
  /**
2299
- * Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for PostgreSQL instances.
2316
+ * Optional. When this parameter is set to true, Cloud SQL instances can connect to Vertex AI to pass requests for real-time predictions and insights to the AI. The default value is false. This applies only to Cloud SQL for MySQL and Cloud SQL for PostgreSQL instances.
2300
2317
  */
2301
2318
  enableGoogleMlIntegration?: boolean | null;
2302
2319
  /**
@@ -3066,7 +3083,7 @@ export declare namespace sqladmin_v1 {
3066
3083
  ListBackups(params: Params$Resource$Backups$Listbackups, callback: BodyResponseCallback<Schema$ListBackupsResponse>): void;
3067
3084
  ListBackups(callback: BodyResponseCallback<Schema$ListBackupsResponse>): void;
3068
3085
  /**
3069
- * Updates the retention period and description of the backup. You can use this API to update final backups only.
3086
+ * This API updates the following: 1- retention period and description of backup in case of final backups only. 2- gcbdr_soft_delete_status of backup in case of GCBDR managed backups only.
3070
3087
  *
3071
3088
  * @param params - Parameters for request
3072
3089
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3126,7 +3143,7 @@ export declare namespace sqladmin_v1 {
3126
3143
  */
3127
3144
  name?: string;
3128
3145
  /**
3129
- * The list of fields that you can update. You can update only the description and retention period of the final backup.
3146
+ * The list of fields that you can update. 1- You can update only the description and retention period for a final backup. 2- You can update only the gcbdr_soft_delete_status for GCBDR managed backup.
3130
3147
  */
3131
3148
  updateMask?: string;
3132
3149
  /**
@@ -3625,6 +3642,20 @@ export declare namespace sqladmin_v1 {
3625
3642
  patch(params: Params$Resource$Instances$Patch, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
3626
3643
  patch(params: Params$Resource$Instances$Patch, callback: BodyResponseCallback<Schema$Operation>): void;
3627
3644
  patch(callback: BodyResponseCallback<Schema$Operation>): void;
3645
+ /**
3646
+ * Point in time restore for an instance managed by Google Cloud Backup and Disaster Recovery.
3647
+ *
3648
+ * @param params - Parameters for request
3649
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
3650
+ * @param callback - Optional callback that handles the response.
3651
+ * @returns A promise if used with async/await, or void if used with a callback.
3652
+ */
3653
+ pointInTimeRestore(params: Params$Resource$Instances$Pointintimerestore, options: StreamMethodOptions): GaxiosPromise<Readable>;
3654
+ pointInTimeRestore(params?: Params$Resource$Instances$Pointintimerestore, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
3655
+ pointInTimeRestore(params: Params$Resource$Instances$Pointintimerestore, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
3656
+ pointInTimeRestore(params: Params$Resource$Instances$Pointintimerestore, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
3657
+ pointInTimeRestore(params: Params$Resource$Instances$Pointintimerestore, callback: BodyResponseCallback<Schema$Operation>): void;
3658
+ pointInTimeRestore(callback: BodyResponseCallback<Schema$Operation>): void;
3628
3659
  /**
3629
3660
  * Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart.
3630
3661
  *
@@ -4024,6 +4055,16 @@ export declare namespace sqladmin_v1 {
4024
4055
  */
4025
4056
  requestBody?: Schema$DatabaseInstance;
4026
4057
  }
4058
+ export interface Params$Resource$Instances$Pointintimerestore extends StandardParameters {
4059
+ /**
4060
+ * Required. The parent resource where you created this instance. Format: projects/{project\}
4061
+ */
4062
+ parent?: string;
4063
+ /**
4064
+ * Request body metadata
4065
+ */
4066
+ requestBody?: Schema$PointInTimeRestoreContext;
4067
+ }
4027
4068
  export interface Params$Resource$Instances$Promotereplica extends StandardParameters {
4028
4069
  /**
4029
4070
  * Set to true to invoke a replica failover to the 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.
package/build/v1.js CHANGED
@@ -1169,6 +1169,38 @@ var sqladmin_v1;
1169
1169
  return (0, googleapis_common_1.createAPIRequest)(parameters);
1170
1170
  }
1171
1171
  }
1172
+ pointInTimeRestore(paramsOrCallback, optionsOrCallback, callback) {
1173
+ let params = (paramsOrCallback ||
1174
+ {});
1175
+ let options = (optionsOrCallback || {});
1176
+ if (typeof paramsOrCallback === 'function') {
1177
+ callback = paramsOrCallback;
1178
+ params = {};
1179
+ options = {};
1180
+ }
1181
+ if (typeof optionsOrCallback === 'function') {
1182
+ callback = optionsOrCallback;
1183
+ options = {};
1184
+ }
1185
+ const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/';
1186
+ const parameters = {
1187
+ options: Object.assign({
1188
+ url: (rootUrl + '/v1/{+parent}:pointInTimeRestore').replace(/([^:]\/)\/+/g, '$1'),
1189
+ method: 'POST',
1190
+ apiVersion: '',
1191
+ }, options),
1192
+ params,
1193
+ requiredParams: ['parent'],
1194
+ pathParams: ['parent'],
1195
+ context: this.context,
1196
+ };
1197
+ if (callback) {
1198
+ (0, googleapis_common_1.createAPIRequest)(parameters, callback);
1199
+ }
1200
+ else {
1201
+ return (0, googleapis_common_1.createAPIRequest)(parameters);
1202
+ }
1203
+ }
1172
1204
  promoteReplica(paramsOrCallback, optionsOrCallback, callback) {
1173
1205
  let params = (paramsOrCallback ||
1174
1206
  {});