@maxim_mazurok/gapi.client.sqladmin-v1beta4 0.0.20250117 → 0.0.20250205

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 +342 -35
  2. package/package.json +1 -1
  3. package/readme.md +27 -2
package/index.d.ts CHANGED
@@ -9,14 +9,14 @@
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: 20250117
12
+ // Revision: 20250205
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
16
16
  declare namespace gapi.client {
17
17
  /** Load Cloud SQL Admin API v1beta4 */
18
18
  function load(
19
- urlOrObject: 'https://sqladmin.googleapis.com/$discovery/rest?version=v1beta4'
19
+ urlOrObject: 'https://sqladmin.googleapis.com/$discovery/rest?version=v1beta4',
20
20
  ): Promise<void>;
21
21
  /** @deprecated Please load APIs with discovery documents. */
22
22
  function load(name: 'sqladmin', version: 'v1beta4'): Promise<void>;
@@ -24,7 +24,7 @@ declare namespace gapi.client {
24
24
  function load(
25
25
  name: 'sqladmin',
26
26
  version: 'v1beta4',
27
- callback: () => any
27
+ callback: () => any,
28
28
  ): void;
29
29
 
30
30
  namespace sql {
@@ -68,6 +68,48 @@ declare namespace gapi.client {
68
68
  /** The database version name. For MySQL 8.0, this string provides the database major and minor version. */
69
69
  name?: string;
70
70
  }
71
+ interface Backup {
72
+ /** Output only. This output contains the following values: start_time: All database writes up to this time are available. end_time: Any database writes after this time aren't available. */
73
+ backupInterval?: Interval;
74
+ /** Output only. Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT. */
75
+ backupKind?: string;
76
+ /** Output only. The mapping to backup run resource used for IAM validations. */
77
+ backupRun?: string;
78
+ /** The description of this backup. */
79
+ description?: string;
80
+ /** Output only. Information about why the backup operation fails (for example, when the backup state fails). */
81
+ error?: OperationError;
82
+ /** Backup expiration time. A UTC timestamp of when this resource expired. */
83
+ expiryTime?: string;
84
+ /** The name of the database instance. */
85
+ instance?: string;
86
+ /** Output only. This is always `sql#backup`. */
87
+ kind?: string;
88
+ /** Output only. This output contains the encryption configuration for a backup and the resource name of the KMS key for disk encryption. */
89
+ kmsKey?: string;
90
+ /** Output only. This output contains the encryption status for a backup and the version of the KMS key that's used to encrypt the Cloud SQL instance. */
91
+ kmsKeyVersion?: string;
92
+ /** The storage location of the backups. The location can be multi-regional. */
93
+ location?: string;
94
+ /** Output only. The maximum chargeable bytes for the backup. */
95
+ maxChargeableBytes?: string;
96
+ /** Output only. The resource name of the backup. Format: projects/{project}/backups/{backup} */
97
+ name?: string;
98
+ /** Output only. This status indicates whether the backup satisfies PZI. The status is reserved for future use. */
99
+ satisfiesPzi?: boolean;
100
+ /** Output only. This status indicates whether the backup satisfies PZS. The status is reserved for future use. */
101
+ satisfiesPzs?: boolean;
102
+ /** Output only. The URI of this resource. */
103
+ selfLink?: string;
104
+ /** Output only. The state of this backup. */
105
+ state?: string;
106
+ /** Output only. This output contains a backup time zone. If a Cloud SQL for SQL Server instance has a different time zone from the backup's time zone, then restores to the instance won't happen. */
107
+ timeZone?: string;
108
+ /** Input only. The time-to-live (TTL) interval for this resource (in days). For example: ttlDays:7 means 7 days. */
109
+ ttlDays?: string;
110
+ /** Output only. The type of this backup. The type can be "AUTOMATED", "ON_DEMAND", or “FINAL”. */
111
+ type?: string;
112
+ }
71
113
  interface BackupConfiguration {
72
114
  /** Backup retention settings. */
73
115
  backupRetentionSettings?: BackupRetentionSettings;
@@ -95,6 +137,8 @@ declare namespace gapi.client {
95
137
  backupId?: string;
96
138
  /** This is always `sql#backupContext`. */
97
139
  kind?: string;
140
+ /** The name of the backup. Format: projects/{project}/backups/{backup} */
141
+ name?: string;
98
142
  }
99
143
  interface BackupReencryptionConfig {
100
144
  /** Backup re-encryption limit */
@@ -263,6 +307,8 @@ declare namespace gapi.client {
263
307
  gceZone?: string;
264
308
  /** Gemini instance configuration. */
265
309
  geminiConfig?: GeminiInstanceConfig;
310
+ /** Input only. Determines whether an in-place major version upgrade of replicas happens when an in-place major version upgrade of a primary instance is initiated. */
311
+ includeReplicasForMajorVersionUpgrade?: boolean;
266
312
  /** The instance type. */
267
313
  instanceType?: string;
268
314
  /** The assigned IP addresses for the instance. */
@@ -369,7 +415,7 @@ declare namespace gapi.client {
369
415
  caCertificate?: string;
370
416
  /** PEM representation of the replica's x509 certificate. */
371
417
  clientCertificate?: string;
372
- /** PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. The format of the replica's private key can be either PKCS #1 or PKCS #8. */
418
+ /** PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. The format of the replica's private key can be either PKCS #1 or PKCS #8. */
373
419
  clientKey?: string;
374
420
  /** This is always `sql#demoteMasterMysqlReplicaConfiguration`. */
375
421
  kind?: string;
@@ -461,6 +507,17 @@ declare namespace gapi.client {
461
507
  /** Optional. The number of threads to use for parallel export. */
462
508
  threads?: number;
463
509
  };
510
+ /** Optional. Export parameters specific to SQL Server TDE certificates */
511
+ tdeExportOptions?: {
512
+ /** Required. Path to the TDE certificate public key in the form gs://bucketName/fileName. The instance must have write access to the location. Applicable only for SQL Server instances. */
513
+ certificatePath?: string;
514
+ /** Required. Certificate name. Applicable only for SQL Server instances. */
515
+ name?: string;
516
+ /** Required. Password that encrypts the private key. */
517
+ privateKeyPassword?: string;
518
+ /** Required. Path to the TDE certificate private key in the form gs://bucketName/fileName. The instance must have write access to the location. Applicable only for SQL Server instances. */
519
+ privateKeyPath?: string;
520
+ };
464
521
  /** The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form `gs://bucketName/fileName`. If the file already exists, the request succeeds, but the operation fails. If `fileType` is `SQL` and the filename ends with .gz, the contents are compressed. */
465
522
  uri?: string;
466
523
  }
@@ -538,6 +595,8 @@ declare namespace gapi.client {
538
595
  encryptionOptions?: {
539
596
  /** Path to the Certificate (.cer) in Cloud Storage, in the form `gs://bucketName/fileName`. The instance must have write permissions to the bucket and read access to the file. */
540
597
  certPath?: string;
598
+ /** Optional. Whether the imported file remains encrypted. */
599
+ keepEncrypted?: boolean;
541
600
  /** Password that encrypts the private key */
542
601
  pvkPassword?: string;
543
602
  /** 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. */
@@ -591,6 +650,17 @@ declare namespace gapi.client {
591
650
  /** Optional. The number of threads to use for parallel import. */
592
651
  threads?: number;
593
652
  };
653
+ /** Optional. Import parameters specific to SQL Server .TDE files Import parameters specific to SQL Server TDE certificates */
654
+ tdeImportOptions?: {
655
+ /** Required. Path to the TDE certificate public key in the form gs://bucketName/fileName. The instance must have read access to the file. Applicable only for SQL Server instances. */
656
+ certificatePath?: string;
657
+ /** Required. Certificate name. Applicable only for SQL Server instances. */
658
+ name?: string;
659
+ /** Required. Password that encrypts the private key. */
660
+ privateKeyPassword?: string;
661
+ /** Required. Path to the TDE certificate private key in the form gs://bucketName/fileName. The instance must have read access to the file. Applicable only for SQL Server instances. */
662
+ privateKeyPath?: string;
663
+ };
594
664
  /** Path to the import file in Cloud Storage, in the form `gs://bucketName/fileName`. Compressed gzip files (.gz) are supported when `fileType` is `SQL`. The instance must have write permissions to the bucket and read access to the file. */
595
665
  uri?: string;
596
666
  }
@@ -674,8 +744,12 @@ declare namespace gapi.client {
674
744
  backupReencryptionConfig?: BackupReencryptionConfig;
675
745
  }
676
746
  interface InstancesRestoreBackupRequest {
747
+ /** The name of the backup that's used to restore a Cloud SQL instance: Format: projects/{project-id}/backups/{backup-uid}. Only one of restore_backup_context, backup, backupdr_backup can be passed to the input. */
748
+ backup?: string;
677
749
  /** Parameters required to perform the restore backup operation. */
678
750
  restoreBackupContext?: RestoreBackupContext;
751
+ /** Optional. By using this parameter, Cloud SQL overrides any instance settings that it stored with the instance settings that you want to restore. 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. */
752
+ restoreInstanceSettings?: DatabaseInstance;
679
753
  }
680
754
  interface InstancesRotateServerCaRequest {
681
755
  /** Contains details about the rotate server CA operation. */
@@ -689,6 +763,12 @@ declare namespace gapi.client {
689
763
  /** Contains details about the truncate log operation. */
690
764
  truncateLogContext?: TruncateLogContext;
691
765
  }
766
+ interface Interval {
767
+ /** Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. */
768
+ endTime?: string;
769
+ /** Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. */
770
+ startTime?: string;
771
+ }
692
772
  interface IpConfiguration {
693
773
  /** The name of the allocated ip range for the private ip Cloud SQL instance. For example: "google-managed-services-default". If set, the instance ip will be created in the allocated range. The range name must comply with [RFC 1035](https://tools.ietf.org/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?.` */
694
774
  allocatedIpRange?: string;
@@ -721,6 +801,14 @@ declare namespace gapi.client {
721
801
  /** The type of this IP address. A `PRIMARY` address is a public address that can accept incoming connections. A `PRIVATE` address is a private address that can accept incoming connections. An `OUTGOING` address is the source address of connections originating from the instance, if supported. */
722
802
  type?: string;
723
803
  }
804
+ interface ListBackupsResponse {
805
+ /** A list of backups. */
806
+ backups?: Backup[];
807
+ /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, then there aren't subsequent pages. */
808
+ nextPageToken?: string;
809
+ /** If a region isn't unavailable or if an unknown error occurs, then a warning message is returned. */
810
+ warnings?: ApiWarning[];
811
+ }
724
812
  interface LocationPreference {
725
813
  /** The App Engine application to follow, it must be in the same region as the Cloud SQL instance. WARNING: Changing this might restart the instance. */
726
814
  followGaeApplication?: string;
@@ -746,7 +834,7 @@ declare namespace gapi.client {
746
834
  caCertificate?: string;
747
835
  /** PEM representation of the replica's x509 certificate. */
748
836
  clientCertificate?: string;
749
- /** PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. */
837
+ /** PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. */
750
838
  clientKey?: string;
751
839
  /** Seconds to wait between connect retries. MySQL's default is 60 seconds. */
752
840
  connectRetryInterval?: number;
@@ -774,7 +862,7 @@ declare namespace gapi.client {
774
862
  caCertificate?: string;
775
863
  /** PEM representation of the replica's x509 certificate. */
776
864
  clientCertificate?: string;
777
- /** PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. */
865
+ /** PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. */
778
866
  clientKey?: string;
779
867
  /** The dump file to create the Cloud SQL replica. */
780
868
  dumpFilePath?: string;
@@ -1403,7 +1491,7 @@ declare namespace gapi.client {
1403
1491
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1404
1492
  uploadType?: string;
1405
1493
  },
1406
- body: BackupRun
1494
+ body: BackupRun,
1407
1495
  ): Request<Operation>;
1408
1496
  /** Lists all backup runs associated with the project or a given instance and configuration in the reverse chronological order of the backup initiation time. */
1409
1497
  list(request?: {
@@ -1439,6 +1527,215 @@ declare namespace gapi.client {
1439
1527
  uploadType?: string;
1440
1528
  }): Request<BackupRunsListResponse>;
1441
1529
  }
1530
+ interface BackupsResource {
1531
+ /** Creates a backup for a Cloud SQL instance. This API can be used only to create on-demand backups. */
1532
+ createBackup(request: {
1533
+ /** V1 error format. */
1534
+ '$.xgafv'?: string;
1535
+ /** OAuth access token. */
1536
+ access_token?: string;
1537
+ /** Data format for response. */
1538
+ alt?: string;
1539
+ /** JSONP */
1540
+ callback?: string;
1541
+ /** Selector specifying which fields to include in a partial response. */
1542
+ fields?: string;
1543
+ /** 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. */
1544
+ key?: string;
1545
+ /** OAuth 2.0 token for the current user. */
1546
+ oauth_token?: string;
1547
+ /** Required. The parent resource where this backup is created. Format: projects/{project} */
1548
+ parent: string;
1549
+ /** Returns response with indentations and line breaks. */
1550
+ prettyPrint?: boolean;
1551
+ /** 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. */
1552
+ quotaUser?: string;
1553
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1554
+ upload_protocol?: string;
1555
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1556
+ uploadType?: string;
1557
+ /** Request body */
1558
+ resource: Backup;
1559
+ }): Request<Operation>;
1560
+ createBackup(
1561
+ request: {
1562
+ /** V1 error format. */
1563
+ '$.xgafv'?: string;
1564
+ /** OAuth access token. */
1565
+ access_token?: string;
1566
+ /** Data format for response. */
1567
+ alt?: string;
1568
+ /** JSONP */
1569
+ callback?: string;
1570
+ /** Selector specifying which fields to include in a partial response. */
1571
+ fields?: string;
1572
+ /** 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. */
1573
+ key?: string;
1574
+ /** OAuth 2.0 token for the current user. */
1575
+ oauth_token?: string;
1576
+ /** Required. The parent resource where this backup is created. Format: projects/{project} */
1577
+ parent: string;
1578
+ /** Returns response with indentations and line breaks. */
1579
+ prettyPrint?: boolean;
1580
+ /** 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. */
1581
+ quotaUser?: string;
1582
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1583
+ upload_protocol?: string;
1584
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1585
+ uploadType?: string;
1586
+ },
1587
+ body: Backup,
1588
+ ): Request<Operation>;
1589
+ /** Deletes the backup. */
1590
+ deleteBackup(request?: {
1591
+ /** V1 error format. */
1592
+ '$.xgafv'?: string;
1593
+ /** OAuth access token. */
1594
+ access_token?: string;
1595
+ /** Data format for response. */
1596
+ alt?: string;
1597
+ /** JSONP */
1598
+ callback?: string;
1599
+ /** Selector specifying which fields to include in a partial response. */
1600
+ fields?: string;
1601
+ /** 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. */
1602
+ key?: string;
1603
+ /** Required. The name of the backup to delete. Format: projects/{project}/backups/{backup} */
1604
+ name: string;
1605
+ /** OAuth 2.0 token for the current user. */
1606
+ oauth_token?: string;
1607
+ /** Returns response with indentations and line breaks. */
1608
+ prettyPrint?: boolean;
1609
+ /** 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. */
1610
+ quotaUser?: string;
1611
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1612
+ upload_protocol?: string;
1613
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1614
+ uploadType?: string;
1615
+ }): Request<Operation>;
1616
+ /** Retrieves a resource containing information about a backup. */
1617
+ getBackup(request?: {
1618
+ /** V1 error format. */
1619
+ '$.xgafv'?: string;
1620
+ /** OAuth access token. */
1621
+ access_token?: string;
1622
+ /** Data format for response. */
1623
+ alt?: string;
1624
+ /** JSONP */
1625
+ callback?: string;
1626
+ /** Selector specifying which fields to include in a partial response. */
1627
+ fields?: string;
1628
+ /** 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. */
1629
+ key?: string;
1630
+ /** Required. The name of the backup to retrieve. Format: projects/{project}/backups/{backup} */
1631
+ name: string;
1632
+ /** OAuth 2.0 token for the current user. */
1633
+ oauth_token?: string;
1634
+ /** Returns response with indentations and line breaks. */
1635
+ prettyPrint?: boolean;
1636
+ /** 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. */
1637
+ quotaUser?: string;
1638
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1639
+ upload_protocol?: string;
1640
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1641
+ uploadType?: string;
1642
+ }): Request<Backup>;
1643
+ /** Lists all backups associated with the project. */
1644
+ listBackups(request?: {
1645
+ /** V1 error format. */
1646
+ '$.xgafv'?: string;
1647
+ /** OAuth access token. */
1648
+ access_token?: string;
1649
+ /** Data format for response. */
1650
+ alt?: string;
1651
+ /** JSONP */
1652
+ callback?: string;
1653
+ /** Selector specifying which fields to include in a partial response. */
1654
+ fields?: string;
1655
+ /** Multiple filter queries are separated by spaces. For example, 'instance:abc type:FINAL. You can filter by type, instance name, creation time, or location. */
1656
+ filter?: string;
1657
+ /** 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. */
1658
+ key?: string;
1659
+ /** OAuth 2.0 token for the current user. */
1660
+ oauth_token?: string;
1661
+ /** The maximum number of backups to return per response. The service might return fewer backups than this value. If a value for this parameter isn't specified, then, at most, 500 backups are returned. The maximum value is 2,000. Any values that you set, which are greater than 2,000, are changed to 2,000. */
1662
+ pageSize?: number;
1663
+ /** A page token, received from a previous `ListBackups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBackups` must match the call that provided the page token. */
1664
+ pageToken?: string;
1665
+ /** Required. The parent that owns this collection of backups. Format: projects/{project} */
1666
+ parent: string;
1667
+ /** Returns response with indentations and line breaks. */
1668
+ prettyPrint?: boolean;
1669
+ /** 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. */
1670
+ quotaUser?: string;
1671
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1672
+ upload_protocol?: string;
1673
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1674
+ uploadType?: string;
1675
+ }): Request<ListBackupsResponse>;
1676
+ /** Updates the retention period and the description of the backup. You can use this API to update final backups only. */
1677
+ updateBackup(request: {
1678
+ /** V1 error format. */
1679
+ '$.xgafv'?: string;
1680
+ /** OAuth access token. */
1681
+ access_token?: string;
1682
+ /** Data format for response. */
1683
+ alt?: string;
1684
+ /** JSONP */
1685
+ callback?: string;
1686
+ /** Selector specifying which fields to include in a partial response. */
1687
+ fields?: string;
1688
+ /** 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. */
1689
+ key?: string;
1690
+ /** Output only. The resource name of the backup. Format: projects/{project}/backups/{backup} */
1691
+ name: string;
1692
+ /** OAuth 2.0 token for the current user. */
1693
+ oauth_token?: string;
1694
+ /** Returns response with indentations and line breaks. */
1695
+ prettyPrint?: boolean;
1696
+ /** 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. */
1697
+ quotaUser?: string;
1698
+ /** The list of fields that you can update. You can update only the description and retention period of the final backup. */
1699
+ updateMask?: string;
1700
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1701
+ upload_protocol?: string;
1702
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1703
+ uploadType?: string;
1704
+ /** Request body */
1705
+ resource: Backup;
1706
+ }): Request<Operation>;
1707
+ updateBackup(
1708
+ request: {
1709
+ /** V1 error format. */
1710
+ '$.xgafv'?: string;
1711
+ /** OAuth access token. */
1712
+ access_token?: string;
1713
+ /** Data format for response. */
1714
+ alt?: string;
1715
+ /** JSONP */
1716
+ callback?: string;
1717
+ /** Selector specifying which fields to include in a partial response. */
1718
+ fields?: string;
1719
+ /** 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. */
1720
+ key?: string;
1721
+ /** Output only. The resource name of the backup. Format: projects/{project}/backups/{backup} */
1722
+ name: string;
1723
+ /** OAuth 2.0 token for the current user. */
1724
+ oauth_token?: string;
1725
+ /** Returns response with indentations and line breaks. */
1726
+ prettyPrint?: boolean;
1727
+ /** 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. */
1728
+ quotaUser?: string;
1729
+ /** The list of fields that you can update. You can update only the description and retention period of the final backup. */
1730
+ updateMask?: string;
1731
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1732
+ upload_protocol?: string;
1733
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1734
+ uploadType?: string;
1735
+ },
1736
+ body: Backup,
1737
+ ): Request<Operation>;
1738
+ }
1442
1739
  interface ConnectResource {
1443
1740
  /** Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database. */
1444
1741
  generateEphemeralCert(request: {
@@ -1500,7 +1797,7 @@ declare namespace gapi.client {
1500
1797
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1501
1798
  uploadType?: string;
1502
1799
  },
1503
- body: GenerateEphemeralCertRequest
1800
+ body: GenerateEphemeralCertRequest,
1504
1801
  ): Request<GenerateEphemeralCertResponse>;
1505
1802
  /** Retrieves connect settings about a Cloud SQL instance. */
1506
1803
  get(request?: {
@@ -1657,7 +1954,7 @@ declare namespace gapi.client {
1657
1954
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1658
1955
  uploadType?: string;
1659
1956
  },
1660
- body: Database
1957
+ body: Database,
1661
1958
  ): Request<Operation>;
1662
1959
  /** Lists databases in the specified Cloud SQL instance. */
1663
1960
  list(request?: {
@@ -1752,7 +2049,7 @@ declare namespace gapi.client {
1752
2049
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1753
2050
  uploadType?: string;
1754
2051
  },
1755
- body: Database
2052
+ body: Database,
1756
2053
  ): Request<Operation>;
1757
2054
  /** Updates a resource containing information about a database inside a Cloud SQL instance. */
1758
2055
  update(request: {
@@ -1818,7 +2115,7 @@ declare namespace gapi.client {
1818
2115
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1819
2116
  uploadType?: string;
1820
2117
  },
1821
- body: Database
2118
+ body: Database,
1822
2119
  ): Request<Operation>;
1823
2120
  }
1824
2121
  interface FlagsResource {
@@ -1911,7 +2208,7 @@ declare namespace gapi.client {
1911
2208
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1912
2209
  uploadType?: string;
1913
2210
  },
1914
- body: InstancesAcquireSsrsLeaseRequest
2211
+ body: InstancesAcquireSsrsLeaseRequest,
1915
2212
  ): Request<SqlInstancesAcquireSsrsLeaseResponse>;
1916
2213
  /** 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. */
1917
2214
  addServerCa(request?: {
@@ -2031,7 +2328,7 @@ declare namespace gapi.client {
2031
2328
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2032
2329
  uploadType?: string;
2033
2330
  },
2034
- body: InstancesCloneRequest
2331
+ body: InstancesCloneRequest,
2035
2332
  ): Request<Operation>;
2036
2333
  /** Deletes a Cloud SQL instance. */
2037
2334
  delete(request?: {
@@ -2043,8 +2340,16 @@ declare namespace gapi.client {
2043
2340
  alt?: string;
2044
2341
  /** JSONP */
2045
2342
  callback?: string;
2343
+ /** Flag to opt-in for final backup. By default, it is turned off. */
2344
+ enableFinalBackup?: boolean;
2046
2345
  /** Selector specifying which fields to include in a partial response. */
2047
2346
  fields?: string;
2347
+ /** Optional. The description of the final backup. */
2348
+ finalBackupDescription?: string;
2349
+ /** Optional. Final Backup expiration time. Timestamp in UTC of when this resource is considered expired. */
2350
+ finalBackupExpiryTime?: string;
2351
+ /** Optional. Retention period of the final backup. */
2352
+ finalBackupTtlDays?: string;
2048
2353
  /** Cloud SQL instance ID. This does not include the project ID. */
2049
2354
  instance: string;
2050
2355
  /** 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. */
@@ -2122,7 +2427,7 @@ declare namespace gapi.client {
2122
2427
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2123
2428
  uploadType?: string;
2124
2429
  },
2125
- body: InstancesDemoteRequest
2430
+ body: InstancesDemoteRequest,
2126
2431
  ): Request<Operation>;
2127
2432
  /** Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server. */
2128
2433
  demoteMaster(request: {
@@ -2184,7 +2489,7 @@ declare namespace gapi.client {
2184
2489
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2185
2490
  uploadType?: string;
2186
2491
  },
2187
- body: InstancesDemoteMasterRequest
2492
+ body: InstancesDemoteMasterRequest,
2188
2493
  ): Request<Operation>;
2189
2494
  /** Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file. */
2190
2495
  export(request: {
@@ -2246,7 +2551,7 @@ declare namespace gapi.client {
2246
2551
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2247
2552
  uploadType?: string;
2248
2553
  },
2249
- body: InstancesExportRequest
2554
+ body: InstancesExportRequest,
2250
2555
  ): Request<Operation>;
2251
2556
  /** Initiates a manual failover of a high availability (HA) primary instance to a standby instance, which becomes the primary instance. Users are then rerouted to the new primary. For more information, see the [Overview of high availability](https://cloud.google.com/sql/docs/mysql/high-availability) page in the Cloud SQL documentation. If using Legacy HA (MySQL only), this causes the instance to failover to its failover replica instance. */
2252
2557
  failover(request: {
@@ -2308,7 +2613,7 @@ declare namespace gapi.client {
2308
2613
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2309
2614
  uploadType?: string;
2310
2615
  },
2311
- body: InstancesFailoverRequest
2616
+ body: InstancesFailoverRequest,
2312
2617
  ): Request<Operation>;
2313
2618
  /** Retrieves a resource containing information about a Cloud SQL instance. */
2314
2619
  get(request?: {
@@ -2399,7 +2704,7 @@ declare namespace gapi.client {
2399
2704
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2400
2705
  uploadType?: string;
2401
2706
  },
2402
- body: InstancesImportRequest
2707
+ body: InstancesImportRequest,
2403
2708
  ): Request<Operation>;
2404
2709
  /** Creates a new Cloud SQL instance. */
2405
2710
  insert(request: {
@@ -2457,7 +2762,7 @@ declare namespace gapi.client {
2457
2762
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2458
2763
  uploadType?: string;
2459
2764
  },
2460
- body: DatabaseInstance
2765
+ body: DatabaseInstance,
2461
2766
  ): Request<Operation>;
2462
2767
  /** Lists instances under a given project. */
2463
2768
  list(request?: {
@@ -2610,7 +2915,7 @@ declare namespace gapi.client {
2610
2915
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2611
2916
  uploadType?: string;
2612
2917
  },
2613
- body: DatabaseInstance
2918
+ body: DatabaseInstance,
2614
2919
  ): Request<Operation>;
2615
2920
  /** Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart. */
2616
2921
  promoteReplica(request?: {
@@ -2703,7 +3008,7 @@ declare namespace gapi.client {
2703
3008
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2704
3009
  uploadType?: string;
2705
3010
  },
2706
- body: InstancesReencryptRequest
3011
+ body: InstancesReencryptRequest,
2707
3012
  ): Request<Operation>;
2708
3013
  /** Release a lease for the setup of SQL Server Reporting Services (SSRS). */
2709
3014
  releaseSsrsLease(request?: {
@@ -2852,7 +3157,7 @@ declare namespace gapi.client {
2852
3157
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2853
3158
  uploadType?: string;
2854
3159
  },
2855
- body: InstancesRestoreBackupRequest
3160
+ body: InstancesRestoreBackupRequest,
2856
3161
  ): Request<Operation>;
2857
3162
  /** 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. */
2858
3163
  rotateServerCa(request: {
@@ -2914,7 +3219,7 @@ declare namespace gapi.client {
2914
3219
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2915
3220
  uploadType?: string;
2916
3221
  },
2917
- body: InstancesRotateServerCaRequest
3222
+ body: InstancesRotateServerCaRequest,
2918
3223
  ): Request<Operation>;
2919
3224
  /** Rotates the server certificate version to one previously added with the addServerCertificate method. For instances not using Certificate Authority Service (CAS) server CA, use RotateServerCa instead. */
2920
3225
  RotateServerCertificate(request: {
@@ -2976,7 +3281,7 @@ declare namespace gapi.client {
2976
3281
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2977
3282
  uploadType?: string;
2978
3283
  },
2979
- body: InstancesRotateServerCertificateRequest
3284
+ body: InstancesRotateServerCertificateRequest,
2980
3285
  ): Request<Operation>;
2981
3286
  /** Starts the replication in the read replica instance. */
2982
3287
  startReplica(request?: {
@@ -3127,7 +3432,7 @@ declare namespace gapi.client {
3127
3432
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3128
3433
  uploadType?: string;
3129
3434
  },
3130
- body: InstancesTruncateLogRequest
3435
+ body: InstancesTruncateLogRequest,
3131
3436
  ): Request<Operation>;
3132
3437
  /** Updates settings of a Cloud SQL instance. Using this operation might cause your instance to restart. */
3133
3438
  update(request: {
@@ -3189,7 +3494,7 @@ declare namespace gapi.client {
3189
3494
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3190
3495
  uploadType?: string;
3191
3496
  },
3192
- body: DatabaseInstance
3497
+ body: DatabaseInstance,
3193
3498
  ): Request<Operation>;
3194
3499
  }
3195
3500
  interface OperationsResource {
@@ -3404,7 +3709,7 @@ declare namespace gapi.client {
3404
3709
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3405
3710
  uploadType?: string;
3406
3711
  },
3407
- body: PerformDiskShrinkContext
3712
+ body: PerformDiskShrinkContext,
3408
3713
  ): Request<Operation>;
3409
3714
  /** Reschedules the maintenance on the given instance. */
3410
3715
  rescheduleMaintenance(request: {
@@ -3466,7 +3771,7 @@ declare namespace gapi.client {
3466
3771
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3467
3772
  uploadType?: string;
3468
3773
  },
3469
- body: SqlInstancesRescheduleMaintenanceRequestBody
3774
+ body: SqlInstancesRescheduleMaintenanceRequestBody,
3470
3775
  ): Request<Operation>;
3471
3776
  /** Reset Replica Size to primary instance disk size. */
3472
3777
  resetReplicaSize(request: {
@@ -3528,7 +3833,7 @@ declare namespace gapi.client {
3528
3833
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3529
3834
  uploadType?: string;
3530
3835
  },
3531
- body: SqlInstancesResetReplicaSizeRequest
3836
+ body: SqlInstancesResetReplicaSizeRequest,
3532
3837
  ): Request<Operation>;
3533
3838
  /** Start External primary instance migration. */
3534
3839
  startExternalSync(request: {
@@ -3590,7 +3895,7 @@ declare namespace gapi.client {
3590
3895
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3591
3896
  uploadType?: string;
3592
3897
  },
3593
- body: SqlInstancesStartExternalSyncRequest
3898
+ body: SqlInstancesStartExternalSyncRequest,
3594
3899
  ): Request<Operation>;
3595
3900
  /** Verify External primary instance external sync settings. */
3596
3901
  verifyExternalSyncSettings(request: {
@@ -3652,7 +3957,7 @@ declare namespace gapi.client {
3652
3957
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3653
3958
  uploadType?: string;
3654
3959
  },
3655
- body: SqlInstancesVerifyExternalSyncSettingsRequest
3960
+ body: SqlInstancesVerifyExternalSyncSettingsRequest,
3656
3961
  ): Request<SqlInstancesVerifyExternalSyncSettingsResponse>;
3657
3962
  }
3658
3963
  interface ProjectsResource {
@@ -3719,7 +4024,7 @@ declare namespace gapi.client {
3719
4024
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3720
4025
  uploadType?: string;
3721
4026
  },
3722
- body: SslCertsCreateEphemeralRequest
4027
+ body: SslCertsCreateEphemeralRequest,
3723
4028
  ): Request<SslCert>;
3724
4029
  /** Deletes the SSL certificate. For First Generation instances, the certificate remains valid until the instance is restarted. */
3725
4030
  delete(request?: {
@@ -3843,7 +4148,7 @@ declare namespace gapi.client {
3843
4148
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3844
4149
  uploadType?: string;
3845
4150
  },
3846
- body: SslCertsInsertRequest
4151
+ body: SslCertsInsertRequest,
3847
4152
  ): Request<SslCertsInsertResponse>;
3848
4153
  /** Lists all of the current SSL certificates for the instance. */
3849
4154
  list(request?: {
@@ -4031,7 +4336,7 @@ declare namespace gapi.client {
4031
4336
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4032
4337
  uploadType?: string;
4033
4338
  },
4034
- body: User
4339
+ body: User,
4035
4340
  ): Request<Operation>;
4036
4341
  /** Lists users in the specified Cloud SQL instance. */
4037
4342
  list(request?: {
@@ -4130,12 +4435,14 @@ declare namespace gapi.client {
4130
4435
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4131
4436
  uploadType?: string;
4132
4437
  },
4133
- body: User
4438
+ body: User,
4134
4439
  ): Request<Operation>;
4135
4440
  }
4136
4441
 
4137
4442
  const backupRuns: BackupRunsResource;
4138
4443
 
4444
+ const backups: BackupsResource;
4445
+
4139
4446
  const connect: ConnectResource;
4140
4447
 
4141
4448
  const databases: DatabasesResource;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.sqladmin-v1beta4",
3
- "version": "0.0.20250117",
3
+ "version": "0.0.20250205",
4
4
  "description": "TypeScript typings for Cloud SQL Admin API v1beta4",
5
5
  "repository": {
6
6
  "type": "git",
package/readme.md CHANGED
@@ -30,7 +30,7 @@ gapi.client.load(
30
30
  () => {
31
31
  // now we can use:
32
32
  // gapi.client.sql
33
- }
33
+ },
34
34
  );
35
35
  ```
36
36
 
@@ -65,7 +65,7 @@ gapi.auth.authorize(
65
65
  } else {
66
66
  /* handle authorization error */
67
67
  }
68
- }
68
+ },
69
69
  );
70
70
  ```
71
71
 
@@ -106,6 +106,31 @@ await gapi.client.sql.backupRuns.list({
106
106
  project: 'project',
107
107
  });
108
108
 
109
+ /*
110
+ Creates a backup for a Cloud SQL instance. This API can be used only to create on-demand backups.
111
+ */
112
+ await gapi.client.sql.backups.createBackup({parent: 'parent'});
113
+
114
+ /*
115
+ Deletes the backup.
116
+ */
117
+ await gapi.client.sql.backups.deleteBackup({name: 'name'});
118
+
119
+ /*
120
+ Retrieves a resource containing information about a backup.
121
+ */
122
+ await gapi.client.sql.backups.getBackup({name: 'name'});
123
+
124
+ /*
125
+ Lists all backups associated with the project.
126
+ */
127
+ await gapi.client.sql.backups.listBackups({parent: 'parent'});
128
+
129
+ /*
130
+ Updates the retention period and the description of the backup. You can use this API to update final backups only.
131
+ */
132
+ await gapi.client.sql.backups.updateBackup({name: 'name'});
133
+
109
134
  /*
110
135
  Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.
111
136
  */