@googleapis/sqladmin 35.2.0 → 37.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/build/v1.d.ts CHANGED
@@ -489,6 +489,14 @@ export declare namespace sqladmin_v1 {
489
489
  * Required. Name of the Cloud SQL instance to be created as a clone.
490
490
  */
491
491
  destinationInstanceName?: string | null;
492
+ /**
493
+ * Optional. The fully qualified URI of the VPC network to which the cloned instance will be connected via Private Services Access for private IP. For example:`projects/my-network-project/global/networks/my-network`. This field is only required for cross-project cloning.
494
+ */
495
+ destinationNetwork?: string | null;
496
+ /**
497
+ * Optional. The project ID of the destination project where the cloned instance will be created. To perform a cross-project clone, this field is required. If not specified, the clone is created in the same project as the source instance.
498
+ */
499
+ destinationProject?: string | null;
492
500
  /**
493
501
  * This is always `sql#cloneContext`.
494
502
  */
@@ -1081,7 +1089,7 @@ export declare namespace sqladmin_v1 {
1081
1089
  */
1082
1090
  application?: string | null;
1083
1091
  /**
1084
- * Optional. When set to true, the API caller identity associated with the request is used for database authentication. The API caller must be an IAM user in the database.
1092
+ * Optional. When set to `true`, the API caller identity associated with the request is used for database authentication. The API caller must be an IAM user in the database.
1085
1093
  */
1086
1094
  autoIamAuthn?: boolean | null;
1087
1095
  /**
@@ -2155,31 +2163,31 @@ export declare namespace sqladmin_v1 {
2155
2163
  reuseInterval?: number | null;
2156
2164
  }
2157
2165
  /**
2158
- * Performance Capture configuration.
2166
+ * Performance capture configuration.
2159
2167
  */
2160
2168
  export interface Schema$PerformanceCaptureConfig {
2161
2169
  /**
2162
- * Optional. Enable or disable the Performance Capture feature.
2170
+ * Optional. Enables or disables the performance capture feature.
2163
2171
  */
2164
2172
  enabled?: boolean | null;
2165
2173
  /**
2166
- * Optional. The minimum number of consecutive readings above threshold that triggers instance state capture.
2174
+ * Optional. Specifies the minimum number of consecutive probe threshold that triggers performance capture.
2167
2175
  */
2168
2176
  probeThreshold?: number | null;
2169
2177
  /**
2170
- * Optional. The time interval in seconds between any two probes.
2178
+ * Optional. Specifies the interval in seconds between consecutive probes that check if any trigger condition thresholds have been reached.
2171
2179
  */
2172
2180
  probingIntervalSeconds?: number | null;
2173
2181
  /**
2174
- * Optional. The minimum number of server threads running to trigger the capture on primary.
2182
+ * Optional. Specifies the minimum number of MySQL `Threads_running` to trigger the performance capture on the primary instance.
2175
2183
  */
2176
2184
  runningThreadsThreshold?: number | null;
2177
2185
  /**
2178
- * Optional. The minimum number of seconds replica must be lagging behind primary to trigger capture on replica.
2186
+ * Optional. Specifies the minimum number of seconds replica must be lagging behind primary instance to trigger the performance capture on replica.
2179
2187
  */
2180
2188
  secondsBehindSourceThreshold?: number | null;
2181
2189
  /**
2182
- * Optional. The amount of time in seconds that a transaction needs to have been open before the watcher starts recording it.
2190
+ * Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts recording it.
2183
2191
  */
2184
2192
  transactionDurationThreshold?: number | null;
2185
2193
  }
@@ -2220,10 +2228,22 @@ export declare namespace sqladmin_v1 {
2220
2228
  * 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`.
2221
2229
  */
2222
2230
  privateNetwork?: string | null;
2231
+ /**
2232
+ * Optional. The region of the target instance where the datasource will be restored. For example: "us-central1".
2233
+ */
2234
+ region?: string | null;
2223
2235
  /**
2224
2236
  * Target instance name.
2225
2237
  */
2226
2238
  targetInstance?: string | null;
2239
+ /**
2240
+ * Optional. Specifies the instance settings that will be cleared from the source instance. This field is only applicable for cross project PITRs.
2241
+ */
2242
+ targetInstanceClearSettingsFieldNames?: string[] | null;
2243
+ /**
2244
+ * Optional. Specifies the instance settings that will be overridden from the source instance. This field is only applicable for cross project PITRs.
2245
+ */
2246
+ targetInstanceSettings?: Schema$DatabaseInstance;
2227
2247
  }
2228
2248
  /**
2229
2249
  * Details of a single read pool node of a read pool.
@@ -2309,7 +2329,7 @@ export declare namespace sqladmin_v1 {
2309
2329
  */
2310
2330
  consumerNetworkStatus?: string | null;
2311
2331
  /**
2312
- * Optional. This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network.
2332
+ * Optional. This is the project ID of consumer service project of this consumer endpoint. This is only applicable if `consumer_network` is a shared VPC network.
2313
2333
  */
2314
2334
  consumerProject?: string | null;
2315
2335
  /**
@@ -2337,10 +2357,18 @@ export declare namespace sqladmin_v1 {
2337
2357
  * Optional. The list of settings for requested Private Service Connect consumer endpoints that can be used to connect to this Cloud SQL instance.
2338
2358
  */
2339
2359
  pscAutoConnections?: Schema$PscAutoConnectionConfig[];
2360
+ /**
2361
+ * Optional. Indicates whether PSC DNS automation is enabled for this instance. When enabled, Cloud SQL provisions a universal DNS record across all networks configured with Private Service Connect (PSC) auto-connections. This will default to true for new instances when Private Service Connect is enabled.
2362
+ */
2363
+ pscAutoDnsEnabled?: boolean | null;
2340
2364
  /**
2341
2365
  * Whether PSC connectivity is enabled for this instance.
2342
2366
  */
2343
2367
  pscEnabled?: boolean | null;
2368
+ /**
2369
+ * Optional. Indicates whether PSC write endpoint DNS automation is enabled for this instance. When enabled, Cloud SQL provisions a universal global DNS record across all networks configured with Private Service Connect (PSC) auto-connections that always points to the cluster primary instance. This feature is only supported for Enterprise Plus edition. This will default to true for new Enterprise Plus instances when `psc_auto_dns_enabled` is enabled.
2370
+ */
2371
+ pscWriteEndpointDnsEnabled?: boolean | null;
2344
2372
  }
2345
2373
  /**
2346
2374
  * QueryResult contains the result of executing a single SQL statement.
@@ -2530,6 +2558,10 @@ export declare namespace sqladmin_v1 {
2530
2558
  * Database instance settings.
2531
2559
  */
2532
2560
  export interface Schema$Settings {
2561
+ /**
2562
+ * Optional. Whether the replica is in accelerated mode. This feature is in private preview and requires allowlisting to take effect.
2563
+ */
2564
+ acceleratedReplicaMode?: boolean | null;
2533
2565
  /**
2534
2566
  * The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. Valid values: * `ALWAYS`: The instance is on, and remains so even in the absence of connection requests. * `NEVER`: The instance is off; it is not activated, even if a connection request arrives.
2535
2567
  */
@@ -2615,7 +2647,7 @@ export declare namespace sqladmin_v1 {
2615
2647
  */
2616
2648
  denyMaintenancePeriods?: Schema$DenyMaintenancePeriod[];
2617
2649
  /**
2618
- * Optional. The edition of the instance.
2650
+ * Optional. The edition type of the Cloud SQL instance.
2619
2651
  */
2620
2652
  edition?: string | null;
2621
2653
  /**
@@ -2846,23 +2878,6 @@ export declare namespace sqladmin_v1 {
2846
2878
  */
2847
2879
  export interface Schema$SqlInstancesResetReplicaSizeRequest {
2848
2880
  }
2849
- /**
2850
- * Instance restore backup request for MCP.
2851
- */
2852
- export interface Schema$SqlInstancesRestoreBackupMcpRequest {
2853
- /**
2854
- * Required. The identifier of the backup to restore. This will be one of the following: 1. An int64 containing a backup_run_id. 2. A backup name of the format 'projects/{project\}/backups/{backup-uid\}'. 3. A backupDR name of the format 'projects/{project\}/locations/{location\}/backupVaults/{backupvault\}/dataSources/{datasource\}/backups/{backup-uid\}'.
2855
- */
2856
- backupId?: string | null;
2857
- /**
2858
- * Optional. The Cloud SQL instance ID of the source instance containing the backup. Only necessary if the backup_id is a backup_run_id.
2859
- */
2860
- sourceInstance?: string | null;
2861
- /**
2862
- * Required. The project ID of the source instance containing the backup.
2863
- */
2864
- sourceProject?: string | null;
2865
- }
2866
2881
  /**
2867
2882
  * Instance start external sync request.
2868
2883
  */
@@ -5558,7 +5573,7 @@ export declare namespace sqladmin_v1 {
5558
5573
  * const res = await sql.instances.clone({
5559
5574
  * // Required. The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID.
5560
5575
  * instance: 'placeholder-value',
5561
- * // Required. Project ID of the source as well as the clone Cloud SQL instance.
5576
+ * // Required. Project ID of the source Cloud SQL instance.
5562
5577
  * project: 'placeholder-value',
5563
5578
  *
5564
5579
  * // Request body metadata
@@ -6960,7 +6975,10 @@ export declare namespace sqladmin_v1 {
6960
6975
  * // "preferredSecondaryZone": "my_preferredSecondaryZone",
6961
6976
  * // "preferredZone": "my_preferredZone",
6962
6977
  * // "privateNetwork": "my_privateNetwork",
6963
- * // "targetInstance": "my_targetInstance"
6978
+ * // "region": "my_region",
6979
+ * // "targetInstance": "my_targetInstance",
6980
+ * // "targetInstanceClearSettingsFieldNames": [],
6981
+ * // "targetInstanceSettings": {}
6964
6982
  * // }
6965
6983
  * },
6966
6984
  * });
@@ -7610,100 +7628,6 @@ export declare namespace sqladmin_v1 {
7610
7628
  restoreBackup(params: Params$Resource$Instances$Restorebackup, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
7611
7629
  restoreBackup(params: Params$Resource$Instances$Restorebackup, callback: BodyResponseCallback<Schema$Operation>): void;
7612
7630
  restoreBackup(callback: BodyResponseCallback<Schema$Operation>): void;
7613
- /**
7614
- * Restores a backup of a Cloud SQL instance for Model Context Protocol (MCP) server.
7615
- * @example
7616
- * ```js
7617
- * // Before running the sample:
7618
- * // - Enable the API at:
7619
- * // https://console.developers.google.com/apis/api/sqladmin.googleapis.com
7620
- * // - Login into gcloud by running:
7621
- * // ```sh
7622
- * // $ gcloud auth application-default login
7623
- * // ```
7624
- * // - Install the npm module by running:
7625
- * // ```sh
7626
- * // $ npm install googleapis
7627
- * // ```
7628
- *
7629
- * const {google} = require('googleapis');
7630
- * const sqladmin = google.sqladmin('v1');
7631
- *
7632
- * async function main() {
7633
- * const auth = new google.auth.GoogleAuth({
7634
- * // Scopes can be specified either as an array or as a single, space-delimited string.
7635
- * scopes: [
7636
- * 'https://www.googleapis.com/auth/cloud-platform',
7637
- * 'https://www.googleapis.com/auth/sqlservice.admin',
7638
- * ],
7639
- * });
7640
- *
7641
- * // Acquire an auth client, and bind it to all future calls
7642
- * const authClient = await auth.getClient();
7643
- * google.options({auth: authClient});
7644
- *
7645
- * // Do the magic
7646
- * const res = await sql.instances.restoreBackupMcp({
7647
- * // Required. Cloud SQL instance ID of the target. This does not include the project ID.
7648
- * targetInstance: 'placeholder-value',
7649
- * // Required. Project ID of the target project.
7650
- * targetProject: 'placeholder-value',
7651
- *
7652
- * // Request body metadata
7653
- * requestBody: {
7654
- * // request body parameters
7655
- * // {
7656
- * // "backupId": "my_backupId",
7657
- * // "sourceInstance": "my_sourceInstance",
7658
- * // "sourceProject": "my_sourceProject"
7659
- * // }
7660
- * },
7661
- * });
7662
- * console.log(res.data);
7663
- *
7664
- * // Example response
7665
- * // {
7666
- * // "acquireSsrsLeaseContext": {},
7667
- * // "apiWarning": {},
7668
- * // "backupContext": {},
7669
- * // "endTime": "my_endTime",
7670
- * // "error": {},
7671
- * // "exportContext": {},
7672
- * // "importContext": {},
7673
- * // "insertTime": "my_insertTime",
7674
- * // "kind": "my_kind",
7675
- * // "name": "my_name",
7676
- * // "operationType": "my_operationType",
7677
- * // "preCheckMajorVersionUpgradeContext": {},
7678
- * // "selfLink": "my_selfLink",
7679
- * // "startTime": "my_startTime",
7680
- * // "status": "my_status",
7681
- * // "subOperationType": {},
7682
- * // "targetId": "my_targetId",
7683
- * // "targetLink": "my_targetLink",
7684
- * // "targetProject": "my_targetProject",
7685
- * // "user": "my_user"
7686
- * // }
7687
- * }
7688
- *
7689
- * main().catch(e => {
7690
- * console.error(e);
7691
- * throw e;
7692
- * });
7693
- *
7694
- * ```
7695
- *
7696
- * @param params - Parameters for request
7697
- * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
7698
- * @param callback - Optional callback that handles the response.
7699
- * @returns A promise if used with async/await, or void if used with a callback.
7700
- */
7701
- restoreBackupMcp(params: Params$Resource$Instances$Restorebackupmcp, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
7702
- restoreBackupMcp(params?: Params$Resource$Instances$Restorebackupmcp, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
7703
- restoreBackupMcp(params: Params$Resource$Instances$Restorebackupmcp, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
7704
- restoreBackupMcp(params: Params$Resource$Instances$Restorebackupmcp, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
7705
- restoreBackupMcp(params: Params$Resource$Instances$Restorebackupmcp, callback: BodyResponseCallback<Schema$Operation>): void;
7706
- restoreBackupMcp(callback: BodyResponseCallback<Schema$Operation>): void;
7707
7631
  /**
7708
7632
  * Rotates the server certificate version to one previously added with the addEntraIdCertificate method.
7709
7633
  * @example
@@ -8519,7 +8443,7 @@ export declare namespace sqladmin_v1 {
8519
8443
  */
8520
8444
  instance?: string;
8521
8445
  /**
8522
- * Required. Project ID of the source as well as the clone Cloud SQL instance.
8446
+ * Required. Project ID of the source Cloud SQL instance.
8523
8447
  */
8524
8448
  project?: string;
8525
8449
  /**
@@ -8819,20 +8743,6 @@ export declare namespace sqladmin_v1 {
8819
8743
  */
8820
8744
  requestBody?: Schema$InstancesRestoreBackupRequest;
8821
8745
  }
8822
- export interface Params$Resource$Instances$Restorebackupmcp extends StandardParameters {
8823
- /**
8824
- * Required. Cloud SQL instance ID of the target. This does not include the project ID.
8825
- */
8826
- targetInstance?: string;
8827
- /**
8828
- * Required. Project ID of the target project.
8829
- */
8830
- targetProject?: string;
8831
- /**
8832
- * Request body metadata
8833
- */
8834
- requestBody?: Schema$SqlInstancesRestoreBackupMcpRequest;
8835
- }
8836
8746
  export interface Params$Resource$Instances$Rotateentraidcertificate extends StandardParameters {
8837
8747
  /**
8838
8748
  * Required. Cloud SQL instance ID. This does not include the project ID.
@@ -10806,6 +10716,8 @@ export declare namespace sqladmin_v1 {
10806
10716
  * name: 'placeholder-value',
10807
10717
  * // Project ID of the project that contains the instance.
10808
10718
  * project: 'placeholder-value',
10719
+ * // Optional. Specifies whether to revoke existing roles that are not present in the `database_roles` field. If `false` or unset, the database roles specified in `database_roles` are added to the user's existing roles.
10720
+ * revokeExistingRoles: 'placeholder-value',
10809
10721
  *
10810
10722
  * // Request body metadata
10811
10723
  * requestBody: {
@@ -10955,6 +10867,10 @@ export declare namespace sqladmin_v1 {
10955
10867
  * Project ID of the project that contains the instance.
10956
10868
  */
10957
10869
  project?: string;
10870
+ /**
10871
+ * Optional. Specifies whether to revoke existing roles that are not present in the `database_roles` field. If `false` or unset, the database roles specified in `database_roles` are added to the user's existing roles.
10872
+ */
10873
+ revokeExistingRoles?: boolean;
10958
10874
  /**
10959
10875
  * Request body metadata
10960
10876
  */
package/build/v1.js CHANGED
@@ -1546,39 +1546,6 @@ var sqladmin_v1;
1546
1546
  return (0, googleapis_common_1.createAPIRequest)(parameters);
1547
1547
  }
1548
1548
  }
1549
- restoreBackupMcp(paramsOrCallback, optionsOrCallback, callback) {
1550
- let params = (paramsOrCallback ||
1551
- {});
1552
- let options = (optionsOrCallback || {});
1553
- if (typeof paramsOrCallback === 'function') {
1554
- callback = paramsOrCallback;
1555
- params = {};
1556
- options = {};
1557
- }
1558
- if (typeof optionsOrCallback === 'function') {
1559
- callback = optionsOrCallback;
1560
- options = {};
1561
- }
1562
- const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/';
1563
- const parameters = {
1564
- options: Object.assign({
1565
- url: (rootUrl +
1566
- '/v1/projects/{targetProject}/instances/{targetInstance}:restoreBackupMcp').replace(/([^:]\/)\/+/g, '$1'),
1567
- method: 'POST',
1568
- apiVersion: '',
1569
- }, options),
1570
- params,
1571
- requiredParams: ['targetProject', 'targetInstance'],
1572
- pathParams: ['targetInstance', 'targetProject'],
1573
- context: this.context,
1574
- };
1575
- if (callback) {
1576
- (0, googleapis_common_1.createAPIRequest)(parameters, callback);
1577
- }
1578
- else {
1579
- return (0, googleapis_common_1.createAPIRequest)(parameters);
1580
- }
1581
- }
1582
1549
  RotateEntraIdCertificate(paramsOrCallback, optionsOrCallback, callback) {
1583
1550
  let params = (paramsOrCallback ||
1584
1551
  {});