@maxim_mazurok/gapi.client.sqladmin-v1 0.1.20251023 → 0.1.20251107

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 +131 -4
  2. package/package.json +1 -1
  3. package/readme.md +16 -0
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: 20251023
12
+ // Revision: 20251107
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -687,7 +687,7 @@ declare namespace gapi.client {
687
687
  /** Path to the Certificate Private Key (.pvk) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file. */
688
688
  pvkPath?: string;
689
689
  };
690
- /** Whether or not the backup importing will restore database with NORECOVERY option Applies only to Cloud SQL for SQL Server. */
690
+ /** Whether or not the backup importing will restore database with NORECOVERY option. Applies only to Cloud SQL for SQL Server. */
691
691
  noRecovery?: boolean;
692
692
  /** Whether or not the backup importing request will just bring database online without downloading Bak content only one of "no_recovery" and "recovery_only" can be true otherwise error will return. Applies only to Cloud SQL for SQL Server. */
693
693
  recoveryOnly?: boolean;
@@ -797,6 +797,14 @@ declare namespace gapi.client {
797
797
  /** Contains details about the import operation. */
798
798
  importContext?: ImportContext;
799
799
  }
800
+ interface InstancesListEntraIdCertificatesResponse {
801
+ /** The `sha1_fingerprint` of the active certificate from `certs`. */
802
+ activeVersion?: string;
803
+ /** List of Entra ID certificates for the instance. */
804
+ certs?: SslCert[];
805
+ /** This is always `sql#instancesListEntraIdCertificates`. */
806
+ kind?: string;
807
+ }
800
808
  interface InstancesListResponse {
801
809
  /** List of database instance resources. */
802
810
  items?: DatabaseInstance[];
@@ -844,6 +852,10 @@ declare namespace gapi.client {
844
852
  /** Optional. By using this parameter, Cloud SQL overrides any instance settings stored in the backup you are restoring from. You can't change the instance's major database version and you can only increase the disk size. You can use this field to restore new instances only. This field is not applicable for restore to existing instances. */
845
853
  restoreInstanceSettings?: DatabaseInstance;
846
854
  }
855
+ interface InstancesRotateEntraIdCertificateRequest {
856
+ /** Optional. Contains details about the rotate server certificate operation. */
857
+ rotateEntraIdCertificateContext?: RotateEntraIdCertificateContext;
858
+ }
847
859
  interface InstancesRotateServerCaRequest {
848
860
  /** Contains details about the rotate server CA operation. */
849
861
  rotateServerCaContext?: RotateServerCaContext;
@@ -883,6 +895,8 @@ declare namespace gapi.client {
883
895
  serverCaMode?: string;
884
896
  /** 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} */
885
897
  serverCaPool?: string;
898
+ /** 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. */
899
+ serverCertificateRotationMode?: string;
886
900
  /** 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. */
887
901
  sslMode?: string;
888
902
  }
@@ -1092,7 +1106,7 @@ declare namespace gapi.client {
1092
1106
  interface PointInTimeRestoreContext {
1093
1107
  /** 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. */
1094
1108
  allocatedIpRange?: string;
1095
- /** The Google Cloud Backup and Disaster Recovery Datasource URI. Format: projects/{project}/locations/{region}/backupVaults/{backupvault}/dataSources/{datasource}. */
1109
+ /** The Backup and Disaster Recovery (DR) Service Datasource URI. Format: projects/{project}/locations/{region}/backupVaults/{backupvault}/dataSources/{datasource}. */
1096
1110
  datasource?: string;
1097
1111
  /** Required. The date and time to which you want to restore the instance. */
1098
1112
  pointInTime?: string;
@@ -1219,6 +1233,12 @@ declare namespace gapi.client {
1219
1233
  /** The full project ID of the source instance. */
1220
1234
  project?: string;
1221
1235
  }
1236
+ interface RotateEntraIdCertificateContext {
1237
+ /** Optional. This is always `sql#rotateEntraIdCertificateContext`. */
1238
+ kind?: string;
1239
+ /** 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. */
1240
+ nextVersion?: string;
1241
+ }
1222
1242
  interface RotateServerCaContext {
1223
1243
  /** This is always `sql#rotateServerCaContext`. */
1224
1244
  kind?: string;
@@ -1262,7 +1282,7 @@ declare namespace gapi.client {
1262
1282
  connectorEnforcement?: string;
1263
1283
  /** 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. */
1264
1284
  crashSafeReplicationEnabled?: boolean;
1265
- /** This parameter controls whether to allow using Data API to connect to the instance. Not allowed by default. */
1285
+ /** This parameter controls whether to allow using ExecuteSql API to connect to the instance. Not allowed by default. */
1266
1286
  dataApiAccess?: string;
1267
1287
  /** The database flags passed to the instance at startup. */
1268
1288
  databaseFlags?: DatabaseFlags[];
@@ -1288,6 +1308,8 @@ declare namespace gapi.client {
1288
1308
  enableDataplexIntegration?: boolean;
1289
1309
  /** 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. */
1290
1310
  enableGoogleMlIntegration?: boolean;
1311
+ /** Optional. The Microsoft Entra ID configuration for the SQL Server instance. */
1312
+ entraidConfig?: SqlServerEntraIdConfig;
1291
1313
  /** Optional. The final backup configuration for the instance. */
1292
1314
  finalBackupConfig?: FinalBackupConfig;
1293
1315
  /** Insights configuration, for now relevant only for Postgres. */
@@ -1457,6 +1479,14 @@ declare namespace gapi.client {
1457
1479
  /** The recovery model of a SQL Server database */
1458
1480
  recoveryModel?: string;
1459
1481
  }
1482
+ interface SqlServerEntraIdConfig {
1483
+ /** Optional. The application ID for the Entra ID configuration. */
1484
+ applicationId?: string;
1485
+ /** Output only. This is always sql#sqlServerEntraIdConfig */
1486
+ kind?: string;
1487
+ /** Optional. The tenant ID for the Entra ID configuration. */
1488
+ tenantId?: string;
1489
+ }
1460
1490
  interface SqlServerUserDetails {
1461
1491
  /** If the user has been disabled */
1462
1492
  disabled?: boolean;
@@ -1564,6 +1594,8 @@ declare namespace gapi.client {
1564
1594
  logType?: string;
1565
1595
  }
1566
1596
  interface User {
1597
+ /** Optional. Role memberships of the user */
1598
+ databaseRoles?: string[];
1567
1599
  /** Dual password status for the user. */
1568
1600
  dualPasswordType?: string;
1569
1601
  /** This field is deprecated and will be removed from a future version of the API. */
@@ -3109,6 +3141,35 @@ declare namespace gapi.client {
3109
3141
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3110
3142
  uploadType?: string;
3111
3143
  }): Request<InstancesListResponse>;
3144
+ /** 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. */
3145
+ ListEntraIdCertificates(request?: {
3146
+ /** V1 error format. */
3147
+ '$.xgafv'?: string;
3148
+ /** OAuth access token. */
3149
+ access_token?: string;
3150
+ /** Data format for response. */
3151
+ alt?: string;
3152
+ /** JSONP */
3153
+ callback?: string;
3154
+ /** Selector specifying which fields to include in a partial response. */
3155
+ fields?: string;
3156
+ /** Required. Cloud SQL instance ID. This does not include the project ID. */
3157
+ instance: string;
3158
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3159
+ key?: string;
3160
+ /** OAuth 2.0 token for the current user. */
3161
+ oauth_token?: string;
3162
+ /** Returns response with indentations and line breaks. */
3163
+ prettyPrint?: boolean;
3164
+ /** Required. Project ID of the project that contains the instance. */
3165
+ project: string;
3166
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3167
+ quotaUser?: string;
3168
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3169
+ upload_protocol?: string;
3170
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3171
+ uploadType?: string;
3172
+ }): Request<InstancesListEntraIdCertificatesResponse>;
3112
3173
  /** 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. */
3113
3174
  listServerCas(request?: {
3114
3175
  /** V1 error format. */
@@ -3593,6 +3654,68 @@ declare namespace gapi.client {
3593
3654
  },
3594
3655
  body: InstancesRestoreBackupRequest,
3595
3656
  ): Request<Operation>;
3657
+ /** Rotates the server certificate version to one previously added with the addEntraIdCertificate method. */
3658
+ RotateEntraIdCertificate(request: {
3659
+ /** V1 error format. */
3660
+ '$.xgafv'?: string;
3661
+ /** OAuth access token. */
3662
+ access_token?: string;
3663
+ /** Data format for response. */
3664
+ alt?: string;
3665
+ /** JSONP */
3666
+ callback?: string;
3667
+ /** Selector specifying which fields to include in a partial response. */
3668
+ fields?: string;
3669
+ /** Required. Cloud SQL instance ID. This does not include the project ID. */
3670
+ instance: string;
3671
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3672
+ key?: string;
3673
+ /** OAuth 2.0 token for the current user. */
3674
+ oauth_token?: string;
3675
+ /** Returns response with indentations and line breaks. */
3676
+ prettyPrint?: boolean;
3677
+ /** Required. Project ID of the project that contains the instance. */
3678
+ project: string;
3679
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3680
+ quotaUser?: string;
3681
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3682
+ upload_protocol?: string;
3683
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3684
+ uploadType?: string;
3685
+ /** Request body */
3686
+ resource: InstancesRotateEntraIdCertificateRequest;
3687
+ }): Request<Operation>;
3688
+ RotateEntraIdCertificate(
3689
+ request: {
3690
+ /** V1 error format. */
3691
+ '$.xgafv'?: string;
3692
+ /** OAuth access token. */
3693
+ access_token?: string;
3694
+ /** Data format for response. */
3695
+ alt?: string;
3696
+ /** JSONP */
3697
+ callback?: string;
3698
+ /** Selector specifying which fields to include in a partial response. */
3699
+ fields?: string;
3700
+ /** Required. Cloud SQL instance ID. This does not include the project ID. */
3701
+ instance: string;
3702
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3703
+ key?: string;
3704
+ /** OAuth 2.0 token for the current user. */
3705
+ oauth_token?: string;
3706
+ /** Returns response with indentations and line breaks. */
3707
+ prettyPrint?: boolean;
3708
+ /** Required. Project ID of the project that contains the instance. */
3709
+ project: string;
3710
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3711
+ quotaUser?: string;
3712
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3713
+ upload_protocol?: string;
3714
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3715
+ uploadType?: string;
3716
+ },
3717
+ body: InstancesRotateEntraIdCertificateRequest,
3718
+ ): Request<Operation>;
3596
3719
  /** 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. */
3597
3720
  rotateServerCa(request: {
3598
3721
  /** V1 error format. */
@@ -4813,6 +4936,8 @@ declare namespace gapi.client {
4813
4936
  alt?: string;
4814
4937
  /** JSONP */
4815
4938
  callback?: string;
4939
+ /** Optional. List of database roles to grant to the user. body.database_roles will be ignored for update request. */
4940
+ databaseRoles?: string | string[];
4816
4941
  /** Selector specifying which fields to include in a partial response. */
4817
4942
  fields?: string;
4818
4943
  /** Optional. Host of the user in the instance. */
@@ -4848,6 +4973,8 @@ declare namespace gapi.client {
4848
4973
  alt?: string;
4849
4974
  /** JSONP */
4850
4975
  callback?: string;
4976
+ /** Optional. List of database roles to grant to the user. body.database_roles will be ignored for update request. */
4977
+ databaseRoles?: string | string[];
4851
4978
  /** Selector specifying which fields to include in a partial response. */
4852
4979
  fields?: string;
4853
4980
  /** Optional. Host of the user in the instance. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.sqladmin-v1",
3
- "version": "0.1.20251023",
3
+ "version": "0.1.20251107",
4
4
  "description": "TypeScript typings for Cloud SQL Admin API v1",
5
5
  "repository": {
6
6
  "type": "git",
package/readme.md CHANGED
@@ -304,6 +304,14 @@ Lists instances under a given project.
304
304
  */
305
305
  await gapi.client.sql.instances.list({project: 'project'});
306
306
 
307
+ /*
308
+ 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.
309
+ */
310
+ await gapi.client.sql.instances.ListEntraIdCertificates({
311
+ instance: 'instance',
312
+ project: 'project',
313
+ });
314
+
307
315
  /*
308
316
  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.
309
317
  */
@@ -389,6 +397,14 @@ await gapi.client.sql.instances.restoreBackup({
389
397
  project: 'project',
390
398
  });
391
399
 
400
+ /*
401
+ Rotates the server certificate version to one previously added with the addEntraIdCertificate method.
402
+ */
403
+ await gapi.client.sql.instances.RotateEntraIdCertificate({
404
+ instance: 'instance',
405
+ project: 'project',
406
+ });
407
+
392
408
  /*
393
409
  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.
394
410
  */