@maxim_mazurok/gapi.client.sqladmin-v1beta4 0.1.20251025 → 0.1.20251111

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 +168 -4
  2. package/package.json +1 -1
  3. package/readme.md +24 -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=v1beta4
12
- // Revision: 20251025
12
+ // Revision: 20251111
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -692,7 +692,7 @@ declare namespace gapi.client {
692
692
  /** 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. */
693
693
  pvkPath?: string;
694
694
  };
695
- /** Whether or not the backup importing will restore database with NORECOVERY option Applies only to Cloud SQL for SQL Server. */
695
+ /** Whether or not the backup importing will restore database with NORECOVERY option. Applies only to Cloud SQL for SQL Server. */
696
696
  noRecovery?: boolean;
697
697
  /** 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. */
698
698
  recoveryOnly?: boolean;
@@ -802,6 +802,14 @@ declare namespace gapi.client {
802
802
  /** Contains details about the import operation. */
803
803
  importContext?: ImportContext;
804
804
  }
805
+ interface InstancesListEntraIdCertificatesResponse {
806
+ /** The `sha1_fingerprint` of the active certificate from `certs`. */
807
+ activeVersion?: string;
808
+ /** List of Entra ID certificates for the instance. */
809
+ certs?: SslCert[];
810
+ /** This is always `sql#instancesListEntraIdCertificates`. */
811
+ kind?: string;
812
+ }
805
813
  interface InstancesListResponse {
806
814
  /** List of database instance resources. */
807
815
  items?: DatabaseInstance[];
@@ -849,6 +857,10 @@ declare namespace gapi.client {
849
857
  /** 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. */
850
858
  restoreInstanceSettings?: DatabaseInstance;
851
859
  }
860
+ interface InstancesRotateEntraIdCertificateRequest {
861
+ /** Optional. Contains details about the rotate Entra ID certificate operation. */
862
+ rotateEntraIdCertificateContext?: RotateEntraIdCertificateContext;
863
+ }
852
864
  interface InstancesRotateServerCaRequest {
853
865
  /** Contains details about the rotate server CA operation. */
854
866
  rotateServerCaContext?: RotateServerCaContext;
@@ -888,6 +900,8 @@ declare namespace gapi.client {
888
900
  serverCaMode?: string;
889
901
  /** 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} */
890
902
  serverCaPool?: string;
903
+ /** 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. */
904
+ serverCertificateRotationMode?: string;
891
905
  /** 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. */
892
906
  sslMode?: string;
893
907
  }
@@ -1097,7 +1111,7 @@ declare namespace gapi.client {
1097
1111
  interface PointInTimeRestoreContext {
1098
1112
  /** 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. */
1099
1113
  allocatedIpRange?: string;
1100
- /** The Google Cloud Backup and Disaster Recovery Datasource URI. Format: projects/{project}/locations/{region}/backupVaults/{backupvault}/dataSources/{datasource}. */
1114
+ /** The Backup and Disaster Recovery (DR) Service Datasource URI. Format: projects/{project}/locations/{region}/backupVaults/{backupvault}/dataSources/{datasource}. */
1101
1115
  datasource?: string;
1102
1116
  /** Required. The date and time to which you want to restore the instance. */
1103
1117
  pointInTime?: string;
@@ -1121,6 +1135,10 @@ declare namespace gapi.client {
1121
1135
  ipAddresses?: IpMapping[];
1122
1136
  /** Output only. The name of the read pool node, to be used for retrieving metrics and logs. */
1123
1137
  name?: string;
1138
+ /** Output only. The list of settings for requested automatically-setup Private Service Connect (PSC) consumer endpoints that can be used to connect to this read pool node. */
1139
+ pscAutoConnections?: PscAutoConnectionConfig[];
1140
+ /** Output only. The Private Service Connect (PSC) service attachment of the read pool node. */
1141
+ pscServiceAttachmentLink?: string;
1124
1142
  /** Output only. The current state of the read pool node. */
1125
1143
  state?: string;
1126
1144
  }
@@ -1224,6 +1242,12 @@ declare namespace gapi.client {
1224
1242
  /** The full project ID of the source instance. */
1225
1243
  project?: string;
1226
1244
  }
1245
+ interface RotateEntraIdCertificateContext {
1246
+ /** Optional. This is always `sql#rotateEntraIdCertificateContext`. */
1247
+ kind?: string;
1248
+ /** Optional. The fingerprint of the next version to be rotated to. If left unspecified, will be rotated to the most recently added Entra ID certificate version. */
1249
+ nextVersion?: string;
1250
+ }
1227
1251
  interface RotateServerCaContext {
1228
1252
  /** This is always `sql#rotateServerCaContext`. */
1229
1253
  kind?: string;
@@ -1267,7 +1291,7 @@ declare namespace gapi.client {
1267
1291
  connectorEnforcement?: string;
1268
1292
  /** 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. */
1269
1293
  crashSafeReplicationEnabled?: boolean;
1270
- /** This parameter controls whether to allow using Data API to connect to the instance. Not allowed by default. */
1294
+ /** This parameter controls whether to allow using ExecuteSql API to connect to the instance. Not allowed by default. */
1271
1295
  dataApiAccess?: string;
1272
1296
  /** The database flags passed to the instance at startup. */
1273
1297
  databaseFlags?: DatabaseFlags[];
@@ -1293,6 +1317,8 @@ declare namespace gapi.client {
1293
1317
  enableDataplexIntegration?: boolean;
1294
1318
  /** 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. */
1295
1319
  enableGoogleMlIntegration?: boolean;
1320
+ /** Optional. The Microsoft Entra ID configuration for the SQL Server instance. */
1321
+ entraidConfig?: SqlServerEntraIdConfig;
1296
1322
  /** Optional. The final backup configuration for the instance. */
1297
1323
  finalBackupConfig?: FinalBackupConfig;
1298
1324
  /** Insights configuration, for now relevant only for Postgres. */
@@ -1462,6 +1488,14 @@ declare namespace gapi.client {
1462
1488
  /** The recovery model of a SQL Server database */
1463
1489
  recoveryModel?: string;
1464
1490
  }
1491
+ interface SqlServerEntraIdConfig {
1492
+ /** Optional. The application ID for the Entra ID configuration. */
1493
+ applicationId?: string;
1494
+ /** Output only. This is always sql#sqlServerEntraIdConfig */
1495
+ kind?: string;
1496
+ /** Optional. The tenant ID for the Entra ID configuration. */
1497
+ tenantId?: string;
1498
+ }
1465
1499
  interface SqlServerUserDetails {
1466
1500
  /** If the user has been disabled */
1467
1501
  disabled?: boolean;
@@ -1569,6 +1603,8 @@ declare namespace gapi.client {
1569
1603
  logType?: string;
1570
1604
  }
1571
1605
  interface User {
1606
+ /** Optional. Role memberships of the user */
1607
+ databaseRoles?: string[];
1572
1608
  /** Dual password status for the user. */
1573
1609
  dualPasswordType?: string;
1574
1610
  /** This field is deprecated and will be removed from a future version of the API. */
@@ -2465,6 +2501,35 @@ declare namespace gapi.client {
2465
2501
  },
2466
2502
  body: InstancesAcquireSsrsLeaseRequest,
2467
2503
  ): Request<SqlInstancesAcquireSsrsLeaseResponse>;
2504
+ /** Adds a new Entra ID certificate for the specified instance. If an Entra ID certificate was previously added but never used in a certificate rotation, this operation replaces that version. */
2505
+ addEntraIdCertificate(request?: {
2506
+ /** V1 error format. */
2507
+ '$.xgafv'?: string;
2508
+ /** OAuth access token. */
2509
+ access_token?: string;
2510
+ /** Data format for response. */
2511
+ alt?: string;
2512
+ /** JSONP */
2513
+ callback?: string;
2514
+ /** Selector specifying which fields to include in a partial response. */
2515
+ fields?: string;
2516
+ /** Required. Cloud SQL instance ID. This does not include the project ID. */
2517
+ instance: string;
2518
+ /** 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. */
2519
+ key?: string;
2520
+ /** OAuth 2.0 token for the current user. */
2521
+ oauth_token?: string;
2522
+ /** Returns response with indentations and line breaks. */
2523
+ prettyPrint?: boolean;
2524
+ /** Required. Project ID of the project that contains the instance. */
2525
+ project: string;
2526
+ /** 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. */
2527
+ quotaUser?: string;
2528
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2529
+ upload_protocol?: string;
2530
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2531
+ uploadType?: string;
2532
+ }): Request<Operation>;
2468
2533
  /** Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, use AddServerCertificate to add a new server certificate. */
2469
2534
  addServerCa(request?: {
2470
2535
  /** V1 error format. */
@@ -3114,6 +3179,35 @@ declare namespace gapi.client {
3114
3179
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3115
3180
  uploadType?: string;
3116
3181
  }): Request<InstancesListResponse>;
3182
+ /** 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. */
3183
+ ListEntraIdCertificates(request?: {
3184
+ /** V1 error format. */
3185
+ '$.xgafv'?: string;
3186
+ /** OAuth access token. */
3187
+ access_token?: string;
3188
+ /** Data format for response. */
3189
+ alt?: string;
3190
+ /** JSONP */
3191
+ callback?: string;
3192
+ /** Selector specifying which fields to include in a partial response. */
3193
+ fields?: string;
3194
+ /** Required. Cloud SQL instance ID. This does not include the project ID. */
3195
+ instance: string;
3196
+ /** 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. */
3197
+ key?: string;
3198
+ /** OAuth 2.0 token for the current user. */
3199
+ oauth_token?: string;
3200
+ /** Returns response with indentations and line breaks. */
3201
+ prettyPrint?: boolean;
3202
+ /** Required. Project ID of the project that contains the instance. */
3203
+ project: string;
3204
+ /** 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. */
3205
+ quotaUser?: string;
3206
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3207
+ upload_protocol?: string;
3208
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3209
+ uploadType?: string;
3210
+ }): Request<InstancesListEntraIdCertificatesResponse>;
3117
3211
  /** 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. */
3118
3212
  listServerCas(request?: {
3119
3213
  /** V1 error format. */
@@ -3598,6 +3692,68 @@ declare namespace gapi.client {
3598
3692
  },
3599
3693
  body: InstancesRestoreBackupRequest,
3600
3694
  ): Request<Operation>;
3695
+ /** Rotates the Entra Id certificate version to one previously added with the addEntraIdCertificate method. */
3696
+ RotateEntraIdCertificate(request: {
3697
+ /** V1 error format. */
3698
+ '$.xgafv'?: string;
3699
+ /** OAuth access token. */
3700
+ access_token?: string;
3701
+ /** Data format for response. */
3702
+ alt?: string;
3703
+ /** JSONP */
3704
+ callback?: string;
3705
+ /** Selector specifying which fields to include in a partial response. */
3706
+ fields?: string;
3707
+ /** Required. Cloud SQL instance ID. This does not include the project ID. */
3708
+ instance: string;
3709
+ /** 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. */
3710
+ key?: string;
3711
+ /** OAuth 2.0 token for the current user. */
3712
+ oauth_token?: string;
3713
+ /** Returns response with indentations and line breaks. */
3714
+ prettyPrint?: boolean;
3715
+ /** Required. Project ID of the project that contains the instance. */
3716
+ project: string;
3717
+ /** 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. */
3718
+ quotaUser?: string;
3719
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3720
+ upload_protocol?: string;
3721
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3722
+ uploadType?: string;
3723
+ /** Request body */
3724
+ resource: InstancesRotateEntraIdCertificateRequest;
3725
+ }): Request<Operation>;
3726
+ RotateEntraIdCertificate(
3727
+ request: {
3728
+ /** V1 error format. */
3729
+ '$.xgafv'?: string;
3730
+ /** OAuth access token. */
3731
+ access_token?: string;
3732
+ /** Data format for response. */
3733
+ alt?: string;
3734
+ /** JSONP */
3735
+ callback?: string;
3736
+ /** Selector specifying which fields to include in a partial response. */
3737
+ fields?: string;
3738
+ /** Required. Cloud SQL instance ID. This does not include the project ID. */
3739
+ instance: string;
3740
+ /** 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. */
3741
+ key?: string;
3742
+ /** OAuth 2.0 token for the current user. */
3743
+ oauth_token?: string;
3744
+ /** Returns response with indentations and line breaks. */
3745
+ prettyPrint?: boolean;
3746
+ /** Required. Project ID of the project that contains the instance. */
3747
+ project: string;
3748
+ /** 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. */
3749
+ quotaUser?: string;
3750
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3751
+ upload_protocol?: string;
3752
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3753
+ uploadType?: string;
3754
+ },
3755
+ body: InstancesRotateEntraIdCertificateRequest,
3756
+ ): Request<Operation>;
3601
3757
  /** 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. */
3602
3758
  rotateServerCa(request: {
3603
3759
  /** V1 error format. */
@@ -4818,6 +4974,8 @@ declare namespace gapi.client {
4818
4974
  alt?: string;
4819
4975
  /** JSONP */
4820
4976
  callback?: string;
4977
+ /** Optional. List of database roles to grant to the user. body.database_roles will be ignored for update request. */
4978
+ databaseRoles?: string | string[];
4821
4979
  /** Selector specifying which fields to include in a partial response. */
4822
4980
  fields?: string;
4823
4981
  /** Optional. Host of the user in the instance. */
@@ -4836,6 +4994,8 @@ declare namespace gapi.client {
4836
4994
  project: string;
4837
4995
  /** 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. */
4838
4996
  quotaUser?: string;
4997
+ /** Optional. revoke the existing roles granted to the user. */
4998
+ revokeExistingRoles?: boolean;
4839
4999
  /** Upload protocol for media (e.g. "raw", "multipart"). */
4840
5000
  upload_protocol?: string;
4841
5001
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
@@ -4853,6 +5013,8 @@ declare namespace gapi.client {
4853
5013
  alt?: string;
4854
5014
  /** JSONP */
4855
5015
  callback?: string;
5016
+ /** Optional. List of database roles to grant to the user. body.database_roles will be ignored for update request. */
5017
+ databaseRoles?: string | string[];
4856
5018
  /** Selector specifying which fields to include in a partial response. */
4857
5019
  fields?: string;
4858
5020
  /** Optional. Host of the user in the instance. */
@@ -4871,6 +5033,8 @@ declare namespace gapi.client {
4871
5033
  project: string;
4872
5034
  /** 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. */
4873
5035
  quotaUser?: string;
5036
+ /** Optional. revoke the existing roles granted to the user. */
5037
+ revokeExistingRoles?: boolean;
4874
5038
  /** Upload protocol for media (e.g. "raw", "multipart"). */
4875
5039
  upload_protocol?: string;
4876
5040
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.sqladmin-v1beta4",
3
- "version": "0.1.20251025",
3
+ "version": "0.1.20251111",
4
4
  "description": "TypeScript typings for Cloud SQL Admin API v1beta4",
5
5
  "repository": {
6
6
  "type": "git",
package/readme.md CHANGED
@@ -209,6 +209,14 @@ await gapi.client.sql.instances.acquireSsrsLease({
209
209
  project: 'project',
210
210
  });
211
211
 
212
+ /*
213
+ Adds a new Entra ID certificate for the specified instance. If an Entra ID certificate was previously added but never used in a certificate rotation, this operation replaces that version.
214
+ */
215
+ await gapi.client.sql.instances.addEntraIdCertificate({
216
+ instance: 'instance',
217
+ project: 'project',
218
+ });
219
+
212
220
  /*
213
221
  Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, use AddServerCertificate to add a new server certificate.
214
222
  */
@@ -304,6 +312,14 @@ Lists instances under a given project.
304
312
  */
305
313
  await gapi.client.sql.instances.list({project: 'project'});
306
314
 
315
+ /*
316
+ 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.
317
+ */
318
+ await gapi.client.sql.instances.ListEntraIdCertificates({
319
+ instance: 'instance',
320
+ project: 'project',
321
+ });
322
+
307
323
  /*
308
324
  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
325
  */
@@ -389,6 +405,14 @@ await gapi.client.sql.instances.restoreBackup({
389
405
  project: 'project',
390
406
  });
391
407
 
408
+ /*
409
+ Rotates the Entra Id certificate version to one previously added with the addEntraIdCertificate method.
410
+ */
411
+ await gapi.client.sql.instances.RotateEntraIdCertificate({
412
+ instance: 'instance',
413
+ project: 'project',
414
+ });
415
+
392
416
  /*
393
417
  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
418
  */