@googleapis/sqladmin 33.0.0 → 34.2.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/v1.ts CHANGED
@@ -550,7 +550,7 @@ export namespace sqladmin_v1 {
550
550
  */
551
551
  databaseNames?: string[] | null;
552
552
  /**
553
- * Name of the Cloud SQL instance to be created as a clone.
553
+ * Required. Name of the Cloud SQL instance to be created as a clone.
554
554
  */
555
555
  destinationInstanceName?: string | null;
556
556
  /**
@@ -1139,7 +1139,7 @@ export namespace sqladmin_v1 {
1139
1139
  */
1140
1140
  database?: string | null;
1141
1141
  /**
1142
- * Optional. Controls how the API should respond when the SQL execution result exceeds 10 MB. The default mode is to throw an error.
1142
+ * Optional. Controls how the API should respond when the SQL execution result is incomplete due to the size limit or another error. The default mode is to throw an error.
1143
1143
  */
1144
1144
  partialResultMode?: string | null;
1145
1145
  /**
@@ -1512,7 +1512,7 @@ export namespace sqladmin_v1 {
1512
1512
  */
1513
1513
  export interface Schema$InstancesCloneRequest {
1514
1514
  /**
1515
- * Contains details about the clone operation.
1515
+ * Required. Contains details about the clone operation.
1516
1516
  */
1517
1517
  cloneContext?: Schema$CloneContext;
1518
1518
  }
@@ -1561,6 +1561,23 @@ export namespace sqladmin_v1 {
1561
1561
  */
1562
1562
  importContext?: Schema$ImportContext;
1563
1563
  }
1564
+ /**
1565
+ * Instances ListEntraIdCertificates response.
1566
+ */
1567
+ export interface Schema$InstancesListEntraIdCertificatesResponse {
1568
+ /**
1569
+ * The `sha1_fingerprint` of the active certificate from `certs`.
1570
+ */
1571
+ activeVersion?: string | null;
1572
+ /**
1573
+ * List of Entra ID certificates for the instance.
1574
+ */
1575
+ certs?: Schema$SslCert[];
1576
+ /**
1577
+ * This is always `sql#instancesListEntraIdCertificates`.
1578
+ */
1579
+ kind?: string | null;
1580
+ }
1564
1581
  /**
1565
1582
  * Database instances list response.
1566
1583
  */
@@ -1660,6 +1677,15 @@ export namespace sqladmin_v1 {
1660
1677
  */
1661
1678
  restoreInstanceSettings?: Schema$DatabaseInstance;
1662
1679
  }
1680
+ /**
1681
+ * Rotate Entra ID certificate request.
1682
+ */
1683
+ export interface Schema$InstancesRotateEntraIdCertificateRequest {
1684
+ /**
1685
+ * Optional. Contains details about the rotate server certificate operation.
1686
+ */
1687
+ rotateEntraIdCertificateContext?: Schema$RotateEntraIdCertificateContext;
1688
+ }
1663
1689
  /**
1664
1690
  * Rotate server CA request.
1665
1691
  */
@@ -1744,6 +1770,10 @@ export namespace sqladmin_v1 {
1744
1770
  * Optional. The resource name of the server CA pool for an instance with `CUSTOMER_MANAGED_CAS_CA` as the `server_ca_mode`. Format: projects/{PROJECT\}/locations/{REGION\}/caPools/{CA_POOL_ID\}
1745
1771
  */
1746
1772
  serverCaPool?: string | null;
1773
+ /**
1774
+ * Optional. Controls the automatic server certificate rotation feature. This feature is disabled by default. When enabled, the server certificate will be automatically rotated during Cloud SQL scheduled maintenance or self-service maintenance updates up to six months before it expires. This setting can only be set if server_ca_mode is either GOOGLE_MANAGED_CAS_CA or CUSTOMER_MANAGED_CAS_CA.
1775
+ */
1776
+ serverCertificateRotationMode?: string | null;
1747
1777
  /**
1748
1778
  * 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.
1749
1779
  */
@@ -2172,7 +2202,7 @@ export namespace sqladmin_v1 {
2172
2202
  targetSizeGb?: string | null;
2173
2203
  }
2174
2204
  /**
2175
- * The context to perform a point-in-time recovery of an instance managed by Google Cloud Backup and Disaster Recovery.
2205
+ * The context to perform a point-in-time recovery of an instance managed by Backup and Disaster Recovery (DR) Service.
2176
2206
  */
2177
2207
  export interface Schema$PointInTimeRestoreContext {
2178
2208
  /**
@@ -2180,7 +2210,7 @@ export namespace sqladmin_v1 {
2180
2210
  */
2181
2211
  allocatedIpRange?: string | null;
2182
2212
  /**
2183
- * The Google Cloud Backup and Disaster Recovery Datasource URI. Format: projects/{project\}/locations/{region\}/backupVaults/{backupvault\}/dataSources/{datasource\}.
2213
+ * The Backup and Disaster Recovery (DR) Service Datasource URI. Format: projects/{project\}/locations/{region\}/backupVaults/{backupvault\}/dataSources/{datasource\}.
2184
2214
  */
2185
2215
  datasource?: string | null;
2186
2216
  /**
@@ -2326,13 +2356,17 @@ export namespace sqladmin_v1 {
2326
2356
  */
2327
2357
  message?: string | null;
2328
2358
  /**
2329
- * Set to true if the SQL execution's result is truncated due to size limits.
2359
+ * Set to true if the SQL execution's result is truncated due to size limits or an error retrieving results.
2330
2360
  */
2331
2361
  partialResult?: boolean | null;
2332
2362
  /**
2333
2363
  * Rows returned by the SQL statement.
2334
2364
  */
2335
2365
  rows?: Schema$Row[];
2366
+ /**
2367
+ * If results were truncated due to an error, details of that error.
2368
+ */
2369
+ status?: Schema$Status;
2336
2370
  }
2337
2371
  /**
2338
2372
  * The read pool auto-scale configuration.
@@ -2436,6 +2470,19 @@ export namespace sqladmin_v1 {
2436
2470
  */
2437
2471
  project?: string | null;
2438
2472
  }
2473
+ /**
2474
+ * Instance rotate Entra ID certificate context.
2475
+ */
2476
+ export interface Schema$RotateEntraIdCertificateContext {
2477
+ /**
2478
+ * Optional. This is always `sql#rotateEntraIdCertificateContext`.
2479
+ */
2480
+ kind?: string | null;
2481
+ /**
2482
+ * Optional. The fingerprint of the next version to be rotated to. If left unspecified, will be rotated to the most recently added server certificate version.
2483
+ */
2484
+ nextVersion?: string | null;
2485
+ }
2439
2486
  /**
2440
2487
  * Instance rotate server CA context.
2441
2488
  */
@@ -2500,6 +2547,10 @@ export namespace sqladmin_v1 {
2500
2547
  * The App Engine app IDs that can access this instance. (Deprecated) Applied to First Generation instances only.
2501
2548
  */
2502
2549
  authorizedGaeApplications?: string[] | null;
2550
+ /**
2551
+ * Optional. Cloud SQL for MySQL auto-upgrade configuration. When this parameter is set to true, auto-upgrade is enabled for MySQL 8.0 minor versions. The MySQL version must be 8.0.35 or higher.
2552
+ */
2553
+ autoUpgradeEnabled?: boolean | null;
2503
2554
  /**
2504
2555
  * Availability type. Potential values: * `ZONAL`: The instance serves data from only one zone. Outages in that zone affect data accessibility. * `REGIONAL`: The instance can serve data from more than one zone in a region (it is highly available)./ For more information, see [Overview of the High Availability Configuration](https://cloud.google.com/sql/docs/mysql/high-availability).
2505
2556
  */
@@ -2524,6 +2575,10 @@ export namespace sqladmin_v1 {
2524
2575
  * Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
2525
2576
  */
2526
2577
  crashSafeReplicationEnabled?: boolean | null;
2578
+ /**
2579
+ * This parameter controls whether to allow using ExecuteSql API to connect to the instance. Not allowed by default.
2580
+ */
2581
+ dataApiAccess?: string | null;
2527
2582
  /**
2528
2583
  * The database flags passed to the instance at startup.
2529
2584
  */
@@ -2572,6 +2627,10 @@ export namespace sqladmin_v1 {
2572
2627
  * 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.
2573
2628
  */
2574
2629
  enableGoogleMlIntegration?: boolean | null;
2630
+ /**
2631
+ * Optional. The Microsoft Entra ID configuration for the SQL Server instance.
2632
+ */
2633
+ entraidConfig?: Schema$SqlServerEntraIdConfig;
2575
2634
  /**
2576
2635
  * Optional. The final backup configuration for the instance.
2577
2636
  */
@@ -2720,6 +2779,10 @@ export namespace sqladmin_v1 {
2720
2779
  * The list of results after executing all the SQL statements.
2721
2780
  */
2722
2781
  results?: Schema$QueryResult[];
2782
+ /**
2783
+ * Contains the error from the database if the SQL execution failed.
2784
+ */
2785
+ status?: Schema$Status;
2723
2786
  }
2724
2787
  /**
2725
2788
  * Instance get disk shrink config response.
@@ -2921,6 +2984,23 @@ export namespace sqladmin_v1 {
2921
2984
  */
2922
2985
  recoveryModel?: string | null;
2923
2986
  }
2987
+ /**
2988
+ * SQL Server Entra ID configuration.
2989
+ */
2990
+ export interface Schema$SqlServerEntraIdConfig {
2991
+ /**
2992
+ * Optional. The application ID for the Entra ID configuration.
2993
+ */
2994
+ applicationId?: string | null;
2995
+ /**
2996
+ * Output only. This is always sql#sqlServerEntraIdConfig
2997
+ */
2998
+ kind?: string | null;
2999
+ /**
3000
+ * Optional. The tenant ID for the Entra ID configuration.
3001
+ */
3002
+ tenantId?: string | null;
3003
+ }
2924
3004
  /**
2925
3005
  * Represents a Sql Server user on the Cloud SQL instance.
2926
3006
  */
@@ -3053,6 +3133,23 @@ export namespace sqladmin_v1 {
3053
3133
  */
3054
3134
  kind?: string | null;
3055
3135
  }
3136
+ /**
3137
+ * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
3138
+ */
3139
+ export interface Schema$Status {
3140
+ /**
3141
+ * The status code, which should be an enum value of google.rpc.Code.
3142
+ */
3143
+ code?: number | null;
3144
+ /**
3145
+ * A list of messages that carry the error details. There is a common set of message types for APIs to use.
3146
+ */
3147
+ details?: Array<{[key: string]: any}> | null;
3148
+ /**
3149
+ * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
3150
+ */
3151
+ message?: string | null;
3152
+ }
3056
3153
  /**
3057
3154
  * Initial sync flags for certain Cloud SQL APIs. Currently used for the MySQL external server initial dump.
3058
3155
  */
@@ -3134,6 +3231,10 @@ export namespace sqladmin_v1 {
3134
3231
  * A Cloud SQL user resource.
3135
3232
  */
3136
3233
  export interface Schema$User {
3234
+ /**
3235
+ * Optional. Role memberships of the user
3236
+ */
3237
+ databaseRoles?: string[] | null;
3137
3238
  /**
3138
3239
  * Dual password status for the user.
3139
3240
  */
@@ -3146,6 +3247,10 @@ export namespace sqladmin_v1 {
3146
3247
  * Optional. The host from which the user can connect. For `insert` operations, host defaults to an empty string. For `update` operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.
3147
3248
  */
3148
3249
  host?: string | null;
3250
+ /**
3251
+ * Optional. The full email for an IAM user. For normal database users, this will not be filled. Only applicable to MySQL database users.
3252
+ */
3253
+ iamEmail?: string | null;
3149
3254
  /**
3150
3255
  * Indicates if a group is active or inactive for IAM database authentication.
3151
3256
  */
@@ -6996,9 +7101,9 @@ export namespace sqladmin_v1 {
6996
7101
  *
6997
7102
  * // Do the magic
6998
7103
  * const res = await sql.instances.clone({
6999
- * // The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID.
7104
+ * // Required. The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID.
7000
7105
  * instance: 'placeholder-value',
7001
- * // Project ID of the source as well as the clone Cloud SQL instance.
7106
+ * // Required. Project ID of the source as well as the clone Cloud SQL instance.
7002
7107
  * project: 'placeholder-value',
7003
7108
  *
7004
7109
  * // Request body metadata
@@ -7690,7 +7795,8 @@ export namespace sqladmin_v1 {
7690
7795
  * // {
7691
7796
  * // "messages": [],
7692
7797
  * // "metadata": {},
7693
- * // "results": []
7798
+ * // "results": [],
7799
+ * // "status": {}
7694
7800
  * // }
7695
7801
  * }
7696
7802
  *
@@ -8160,9 +8266,9 @@ export namespace sqladmin_v1 {
8160
8266
  *
8161
8267
  * // Do the magic
8162
8268
  * const res = await sql.instances.get({
8163
- * // Database instance ID. This does not include the project ID.
8269
+ * // Required. Database instance ID. This does not include the project ID.
8164
8270
  * instance: 'placeholder-value',
8165
- * // Project ID of the project that contains the instance.
8271
+ * // Required. Project ID of the project that contains the instance.
8166
8272
  * project: 'placeholder-value',
8167
8273
  * });
8168
8274
  * console.log(res.data);
@@ -8846,6 +8952,160 @@ export namespace sqladmin_v1 {
8846
8952
  }
8847
8953
  }
8848
8954
 
8955
+ /**
8956
+ * Lists all versions of EntraID certificates for the specified instance. There can be up to three sets of certificates listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out.
8957
+ * @example
8958
+ * ```js
8959
+ * // Before running the sample:
8960
+ * // - Enable the API at:
8961
+ * // https://console.developers.google.com/apis/api/sqladmin.googleapis.com
8962
+ * // - Login into gcloud by running:
8963
+ * // ```sh
8964
+ * // $ gcloud auth application-default login
8965
+ * // ```
8966
+ * // - Install the npm module by running:
8967
+ * // ```sh
8968
+ * // $ npm install googleapis
8969
+ * // ```
8970
+ *
8971
+ * const {google} = require('googleapis');
8972
+ * const sqladmin = google.sqladmin('v1');
8973
+ *
8974
+ * async function main() {
8975
+ * const auth = new google.auth.GoogleAuth({
8976
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
8977
+ * scopes: [
8978
+ * 'https://www.googleapis.com/auth/cloud-platform',
8979
+ * 'https://www.googleapis.com/auth/sqlservice.admin',
8980
+ * ],
8981
+ * });
8982
+ *
8983
+ * // Acquire an auth client, and bind it to all future calls
8984
+ * const authClient = await auth.getClient();
8985
+ * google.options({auth: authClient});
8986
+ *
8987
+ * // Do the magic
8988
+ * const res = await sql.instances.ListEntraIdCertificates({
8989
+ * // Required. Cloud SQL instance ID. This does not include the project ID.
8990
+ * instance: 'placeholder-value',
8991
+ * // Required. Project ID of the project that contains the instance.
8992
+ * project: 'placeholder-value',
8993
+ * });
8994
+ * console.log(res.data);
8995
+ *
8996
+ * // Example response
8997
+ * // {
8998
+ * // "activeVersion": "my_activeVersion",
8999
+ * // "certs": [],
9000
+ * // "kind": "my_kind"
9001
+ * // }
9002
+ * }
9003
+ *
9004
+ * main().catch(e => {
9005
+ * console.error(e);
9006
+ * throw e;
9007
+ * });
9008
+ *
9009
+ * ```
9010
+ *
9011
+ * @param params - Parameters for request
9012
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
9013
+ * @param callback - Optional callback that handles the response.
9014
+ * @returns A promise if used with async/await, or void if used with a callback.
9015
+ */
9016
+ ListEntraIdCertificates(
9017
+ params: Params$Resource$Instances$Listentraidcertificates,
9018
+ options: StreamMethodOptions
9019
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
9020
+ ListEntraIdCertificates(
9021
+ params?: Params$Resource$Instances$Listentraidcertificates,
9022
+ options?: MethodOptions
9023
+ ): Promise<
9024
+ GaxiosResponseWithHTTP2<Schema$InstancesListEntraIdCertificatesResponse>
9025
+ >;
9026
+ ListEntraIdCertificates(
9027
+ params: Params$Resource$Instances$Listentraidcertificates,
9028
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
9029
+ callback: BodyResponseCallback<Readable>
9030
+ ): void;
9031
+ ListEntraIdCertificates(
9032
+ params: Params$Resource$Instances$Listentraidcertificates,
9033
+ options:
9034
+ | MethodOptions
9035
+ | BodyResponseCallback<Schema$InstancesListEntraIdCertificatesResponse>,
9036
+ callback: BodyResponseCallback<Schema$InstancesListEntraIdCertificatesResponse>
9037
+ ): void;
9038
+ ListEntraIdCertificates(
9039
+ params: Params$Resource$Instances$Listentraidcertificates,
9040
+ callback: BodyResponseCallback<Schema$InstancesListEntraIdCertificatesResponse>
9041
+ ): void;
9042
+ ListEntraIdCertificates(
9043
+ callback: BodyResponseCallback<Schema$InstancesListEntraIdCertificatesResponse>
9044
+ ): void;
9045
+ ListEntraIdCertificates(
9046
+ paramsOrCallback?:
9047
+ | Params$Resource$Instances$Listentraidcertificates
9048
+ | BodyResponseCallback<Schema$InstancesListEntraIdCertificatesResponse>
9049
+ | BodyResponseCallback<Readable>,
9050
+ optionsOrCallback?:
9051
+ | MethodOptions
9052
+ | StreamMethodOptions
9053
+ | BodyResponseCallback<Schema$InstancesListEntraIdCertificatesResponse>
9054
+ | BodyResponseCallback<Readable>,
9055
+ callback?:
9056
+ | BodyResponseCallback<Schema$InstancesListEntraIdCertificatesResponse>
9057
+ | BodyResponseCallback<Readable>
9058
+ ):
9059
+ | void
9060
+ | Promise<
9061
+ GaxiosResponseWithHTTP2<Schema$InstancesListEntraIdCertificatesResponse>
9062
+ >
9063
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
9064
+ let params = (paramsOrCallback ||
9065
+ {}) as Params$Resource$Instances$Listentraidcertificates;
9066
+ let options = (optionsOrCallback || {}) as MethodOptions;
9067
+
9068
+ if (typeof paramsOrCallback === 'function') {
9069
+ callback = paramsOrCallback;
9070
+ params = {} as Params$Resource$Instances$Listentraidcertificates;
9071
+ options = {};
9072
+ }
9073
+
9074
+ if (typeof optionsOrCallback === 'function') {
9075
+ callback = optionsOrCallback;
9076
+ options = {};
9077
+ }
9078
+
9079
+ const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/';
9080
+ const parameters = {
9081
+ options: Object.assign(
9082
+ {
9083
+ url: (
9084
+ rootUrl +
9085
+ '/v1/projects/{project}/instances/{instance}/listEntraIdCertificates'
9086
+ ).replace(/([^:]\/)\/+/g, '$1'),
9087
+ method: 'GET',
9088
+ apiVersion: '',
9089
+ },
9090
+ options
9091
+ ),
9092
+ params,
9093
+ requiredParams: ['project', 'instance'],
9094
+ pathParams: ['instance', 'project'],
9095
+ context: this.context,
9096
+ };
9097
+ if (callback) {
9098
+ createAPIRequest<Schema$InstancesListEntraIdCertificatesResponse>(
9099
+ parameters,
9100
+ callback as BodyResponseCallback<unknown>
9101
+ );
9102
+ } else {
9103
+ return createAPIRequest<Schema$InstancesListEntraIdCertificatesResponse>(
9104
+ parameters
9105
+ );
9106
+ }
9107
+ }
9108
+
8849
9109
  /**
8850
9110
  * Lists all of the trusted Certificate Authorities (CAs) for the specified instance. There can be up to three CAs listed: the CA that was used to sign the certificate that is currently in use, a CA that has been added but not yet used to sign a certificate, and a CA used to sign a certificate that has previously rotated out.
8851
9111
  * @example
@@ -10691,6 +10951,177 @@ export namespace sqladmin_v1 {
10691
10951
  }
10692
10952
  }
10693
10953
 
10954
+ /**
10955
+ * Rotates the server certificate version to one previously added with the addEntraIdCertificate method.
10956
+ * @example
10957
+ * ```js
10958
+ * // Before running the sample:
10959
+ * // - Enable the API at:
10960
+ * // https://console.developers.google.com/apis/api/sqladmin.googleapis.com
10961
+ * // - Login into gcloud by running:
10962
+ * // ```sh
10963
+ * // $ gcloud auth application-default login
10964
+ * // ```
10965
+ * // - Install the npm module by running:
10966
+ * // ```sh
10967
+ * // $ npm install googleapis
10968
+ * // ```
10969
+ *
10970
+ * const {google} = require('googleapis');
10971
+ * const sqladmin = google.sqladmin('v1');
10972
+ *
10973
+ * async function main() {
10974
+ * const auth = new google.auth.GoogleAuth({
10975
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
10976
+ * scopes: [
10977
+ * 'https://www.googleapis.com/auth/cloud-platform',
10978
+ * 'https://www.googleapis.com/auth/sqlservice.admin',
10979
+ * ],
10980
+ * });
10981
+ *
10982
+ * // Acquire an auth client, and bind it to all future calls
10983
+ * const authClient = await auth.getClient();
10984
+ * google.options({auth: authClient});
10985
+ *
10986
+ * // Do the magic
10987
+ * const res = await sql.instances.RotateEntraIdCertificate({
10988
+ * // Required. Cloud SQL instance ID. This does not include the project ID.
10989
+ * instance: 'placeholder-value',
10990
+ * // Required. Project ID of the project that contains the instance.
10991
+ * project: 'placeholder-value',
10992
+ *
10993
+ * // Request body metadata
10994
+ * requestBody: {
10995
+ * // request body parameters
10996
+ * // {
10997
+ * // "rotateEntraIdCertificateContext": {}
10998
+ * // }
10999
+ * },
11000
+ * });
11001
+ * console.log(res.data);
11002
+ *
11003
+ * // Example response
11004
+ * // {
11005
+ * // "acquireSsrsLeaseContext": {},
11006
+ * // "apiWarning": {},
11007
+ * // "backupContext": {},
11008
+ * // "endTime": "my_endTime",
11009
+ * // "error": {},
11010
+ * // "exportContext": {},
11011
+ * // "importContext": {},
11012
+ * // "insertTime": "my_insertTime",
11013
+ * // "kind": "my_kind",
11014
+ * // "name": "my_name",
11015
+ * // "operationType": "my_operationType",
11016
+ * // "preCheckMajorVersionUpgradeContext": {},
11017
+ * // "selfLink": "my_selfLink",
11018
+ * // "startTime": "my_startTime",
11019
+ * // "status": "my_status",
11020
+ * // "subOperationType": {},
11021
+ * // "targetId": "my_targetId",
11022
+ * // "targetLink": "my_targetLink",
11023
+ * // "targetProject": "my_targetProject",
11024
+ * // "user": "my_user"
11025
+ * // }
11026
+ * }
11027
+ *
11028
+ * main().catch(e => {
11029
+ * console.error(e);
11030
+ * throw e;
11031
+ * });
11032
+ *
11033
+ * ```
11034
+ *
11035
+ * @param params - Parameters for request
11036
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
11037
+ * @param callback - Optional callback that handles the response.
11038
+ * @returns A promise if used with async/await, or void if used with a callback.
11039
+ */
11040
+ RotateEntraIdCertificate(
11041
+ params: Params$Resource$Instances$Rotateentraidcertificate,
11042
+ options: StreamMethodOptions
11043
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
11044
+ RotateEntraIdCertificate(
11045
+ params?: Params$Resource$Instances$Rotateentraidcertificate,
11046
+ options?: MethodOptions
11047
+ ): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
11048
+ RotateEntraIdCertificate(
11049
+ params: Params$Resource$Instances$Rotateentraidcertificate,
11050
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
11051
+ callback: BodyResponseCallback<Readable>
11052
+ ): void;
11053
+ RotateEntraIdCertificate(
11054
+ params: Params$Resource$Instances$Rotateentraidcertificate,
11055
+ options: MethodOptions | BodyResponseCallback<Schema$Operation>,
11056
+ callback: BodyResponseCallback<Schema$Operation>
11057
+ ): void;
11058
+ RotateEntraIdCertificate(
11059
+ params: Params$Resource$Instances$Rotateentraidcertificate,
11060
+ callback: BodyResponseCallback<Schema$Operation>
11061
+ ): void;
11062
+ RotateEntraIdCertificate(
11063
+ callback: BodyResponseCallback<Schema$Operation>
11064
+ ): void;
11065
+ RotateEntraIdCertificate(
11066
+ paramsOrCallback?:
11067
+ | Params$Resource$Instances$Rotateentraidcertificate
11068
+ | BodyResponseCallback<Schema$Operation>
11069
+ | BodyResponseCallback<Readable>,
11070
+ optionsOrCallback?:
11071
+ | MethodOptions
11072
+ | StreamMethodOptions
11073
+ | BodyResponseCallback<Schema$Operation>
11074
+ | BodyResponseCallback<Readable>,
11075
+ callback?:
11076
+ | BodyResponseCallback<Schema$Operation>
11077
+ | BodyResponseCallback<Readable>
11078
+ ):
11079
+ | void
11080
+ | Promise<GaxiosResponseWithHTTP2<Schema$Operation>>
11081
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
11082
+ let params = (paramsOrCallback ||
11083
+ {}) as Params$Resource$Instances$Rotateentraidcertificate;
11084
+ let options = (optionsOrCallback || {}) as MethodOptions;
11085
+
11086
+ if (typeof paramsOrCallback === 'function') {
11087
+ callback = paramsOrCallback;
11088
+ params = {} as Params$Resource$Instances$Rotateentraidcertificate;
11089
+ options = {};
11090
+ }
11091
+
11092
+ if (typeof optionsOrCallback === 'function') {
11093
+ callback = optionsOrCallback;
11094
+ options = {};
11095
+ }
11096
+
11097
+ const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/';
11098
+ const parameters = {
11099
+ options: Object.assign(
11100
+ {
11101
+ url: (
11102
+ rootUrl +
11103
+ '/v1/projects/{project}/instances/{instance}/rotateEntraIdCertificate'
11104
+ ).replace(/([^:]\/)\/+/g, '$1'),
11105
+ method: 'POST',
11106
+ apiVersion: '',
11107
+ },
11108
+ options
11109
+ ),
11110
+ params,
11111
+ requiredParams: ['project', 'instance'],
11112
+ pathParams: ['instance', 'project'],
11113
+ context: this.context,
11114
+ };
11115
+ if (callback) {
11116
+ createAPIRequest<Schema$Operation>(
11117
+ parameters,
11118
+ callback as BodyResponseCallback<unknown>
11119
+ );
11120
+ } else {
11121
+ return createAPIRequest<Schema$Operation>(parameters);
11122
+ }
11123
+ }
11124
+
10694
11125
  /**
10695
11126
  * Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, use RotateServerCertificate to rotate the server certificate.
10696
11127
  * @example
@@ -11942,11 +12373,11 @@ export namespace sqladmin_v1 {
11942
12373
  }
11943
12374
  export interface Params$Resource$Instances$Clone extends StandardParameters {
11944
12375
  /**
11945
- * The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID.
12376
+ * Required. The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID.
11946
12377
  */
11947
12378
  instance?: string;
11948
12379
  /**
11949
- * Project ID of the source as well as the clone Cloud SQL instance.
12380
+ * Required. Project ID of the source as well as the clone Cloud SQL instance.
11950
12381
  */
11951
12382
  project?: string;
11952
12383
 
@@ -12061,11 +12492,11 @@ export namespace sqladmin_v1 {
12061
12492
  }
12062
12493
  export interface Params$Resource$Instances$Get extends StandardParameters {
12063
12494
  /**
12064
- * Database instance ID. This does not include the project ID.
12495
+ * Required. Database instance ID. This does not include the project ID.
12065
12496
  */
12066
12497
  instance?: string;
12067
12498
  /**
12068
- * Project ID of the project that contains the instance.
12499
+ * Required. Project ID of the project that contains the instance.
12069
12500
  */
12070
12501
  project?: string;
12071
12502
  }
@@ -12113,6 +12544,17 @@ export namespace sqladmin_v1 {
12113
12544
  */
12114
12545
  project?: string;
12115
12546
  }
12547
+ export interface Params$Resource$Instances$Listentraidcertificates
12548
+ extends StandardParameters {
12549
+ /**
12550
+ * Required. Cloud SQL instance ID. This does not include the project ID.
12551
+ */
12552
+ instance?: string;
12553
+ /**
12554
+ * Required. Project ID of the project that contains the instance.
12555
+ */
12556
+ project?: string;
12557
+ }
12116
12558
  export interface Params$Resource$Instances$Listservercas
12117
12559
  extends StandardParameters {
12118
12560
  /**
@@ -12262,6 +12704,22 @@ export namespace sqladmin_v1 {
12262
12704
  */
12263
12705
  requestBody?: Schema$InstancesRestoreBackupRequest;
12264
12706
  }
12707
+ export interface Params$Resource$Instances$Rotateentraidcertificate
12708
+ extends StandardParameters {
12709
+ /**
12710
+ * Required. Cloud SQL instance ID. This does not include the project ID.
12711
+ */
12712
+ instance?: string;
12713
+ /**
12714
+ * Required. Project ID of the project that contains the instance.
12715
+ */
12716
+ project?: string;
12717
+
12718
+ /**
12719
+ * Request body metadata
12720
+ */
12721
+ requestBody?: Schema$InstancesRotateEntraIdCertificateRequest;
12722
+ }
12265
12723
  export interface Params$Resource$Instances$Rotateserverca
12266
12724
  extends StandardParameters {
12267
12725
  /**
@@ -12542,9 +13000,9 @@ export namespace sqladmin_v1 {
12542
13000
  *
12543
13001
  * // Do the magic
12544
13002
  * const res = await sql.operations.get({
12545
- * // Instance operation ID.
13003
+ * // Required. Instance operation ID.
12546
13004
  * operation: 'placeholder-value',
12547
- * // Project ID of the project that contains the instance.
13005
+ * // Required. Project ID of the project that contains the instance.
12548
13006
  * project: 'placeholder-value',
12549
13007
  * });
12550
13008
  * console.log(res.data);
@@ -12830,11 +13288,11 @@ export namespace sqladmin_v1 {
12830
13288
  }
12831
13289
  export interface Params$Resource$Operations$Get extends StandardParameters {
12832
13290
  /**
12833
- * Instance operation ID.
13291
+ * Required. Instance operation ID.
12834
13292
  */
12835
13293
  operation?: string;
12836
13294
  /**
12837
- * Project ID of the project that contains the instance.
13295
+ * Required. Project ID of the project that contains the instance.
12838
13296
  */
12839
13297
  project?: string;
12840
13298
  }
@@ -15355,9 +15813,11 @@ export namespace sqladmin_v1 {
15355
15813
  *
15356
15814
  * // Example response
15357
15815
  * // {
15816
+ * // "databaseRoles": [],
15358
15817
  * // "dualPasswordType": "my_dualPasswordType",
15359
15818
  * // "etag": "my_etag",
15360
15819
  * // "host": "my_host",
15820
+ * // "iamEmail": "my_iamEmail",
15361
15821
  * // "iamStatus": "my_iamStatus",
15362
15822
  * // "instance": "my_instance",
15363
15823
  * // "kind": "my_kind",
@@ -15507,9 +15967,11 @@ export namespace sqladmin_v1 {
15507
15967
  * requestBody: {
15508
15968
  * // request body parameters
15509
15969
  * // {
15970
+ * // "databaseRoles": [],
15510
15971
  * // "dualPasswordType": "my_dualPasswordType",
15511
15972
  * // "etag": "my_etag",
15512
15973
  * // "host": "my_host",
15974
+ * // "iamEmail": "my_iamEmail",
15513
15975
  * // "iamStatus": "my_iamStatus",
15514
15976
  * // "instance": "my_instance",
15515
15977
  * // "kind": "my_kind",
@@ -15818,6 +16280,8 @@ export namespace sqladmin_v1 {
15818
16280
  *
15819
16281
  * // Do the magic
15820
16282
  * const res = await sql.users.update({
16283
+ * // Optional. List of database roles to grant to the user. body.database_roles will be ignored for update request.
16284
+ * databaseRoles: 'placeholder-value',
15821
16285
  * // Optional. Host of the user in the instance.
15822
16286
  * host: 'placeholder-value',
15823
16287
  * // Database instance ID. This does not include the project ID.
@@ -15831,9 +16295,11 @@ export namespace sqladmin_v1 {
15831
16295
  * requestBody: {
15832
16296
  * // request body parameters
15833
16297
  * // {
16298
+ * // "databaseRoles": [],
15834
16299
  * // "dualPasswordType": "my_dualPasswordType",
15835
16300
  * // "etag": "my_etag",
15836
16301
  * // "host": "my_host",
16302
+ * // "iamEmail": "my_iamEmail",
15837
16303
  * // "iamStatus": "my_iamStatus",
15838
16304
  * // "instance": "my_instance",
15839
16305
  * // "kind": "my_kind",
@@ -16029,6 +16495,10 @@ export namespace sqladmin_v1 {
16029
16495
  project?: string;
16030
16496
  }
16031
16497
  export interface Params$Resource$Users$Update extends StandardParameters {
16498
+ /**
16499
+ * Optional. List of database roles to grant to the user. body.database_roles will be ignored for update request.
16500
+ */
16501
+ databaseRoles?: string[];
16032
16502
  /**
16033
16503
  * Optional. Host of the user in the instance.
16034
16504
  */