@maxim_mazurok/gapi.client.sqladmin-v1beta4 0.0.20250310 → 0.0.20250427
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/index.d.ts +101 -35
- package/package.json +1 -1
- package/readme.md +6 -1
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:
|
|
12
|
+
// Revision: 20250427
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -75,7 +75,7 @@ declare namespace gapi.client {
|
|
|
75
75
|
backupKind?: string;
|
|
76
76
|
/** Output only. The mapping to backup run resource used for IAM validations. */
|
|
77
77
|
backupRun?: string;
|
|
78
|
-
/** Output only. The database version of the instance of
|
|
78
|
+
/** Output only. The database version of the instance of at the time this backup was made. */
|
|
79
79
|
databaseVersion?: string;
|
|
80
80
|
/** The description of this backup. */
|
|
81
81
|
description?: string;
|
|
@@ -119,6 +119,8 @@ declare namespace gapi.client {
|
|
|
119
119
|
interface BackupConfiguration {
|
|
120
120
|
/** Backup retention settings. */
|
|
121
121
|
backupRetentionSettings?: BackupRetentionSettings;
|
|
122
|
+
/** Output only. Backup tier that manages the backups for the instance. */
|
|
123
|
+
backupTier?: string;
|
|
122
124
|
/** (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well. */
|
|
123
125
|
binaryLogEnabled?: boolean;
|
|
124
126
|
/** Whether this configuration is enabled. */
|
|
@@ -161,7 +163,7 @@ declare namespace gapi.client {
|
|
|
161
163
|
interface BackupRun {
|
|
162
164
|
/** Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT. */
|
|
163
165
|
backupKind?: string;
|
|
164
|
-
/** Output only. The instance database version
|
|
166
|
+
/** Output only. The instance database version at the time this backup was made. */
|
|
165
167
|
databaseVersion?: string;
|
|
166
168
|
/** The description of this run, only applicable to on-demand backups. */
|
|
167
169
|
description?: string;
|
|
@@ -235,22 +237,10 @@ declare namespace gapi.client {
|
|
|
235
237
|
preferredZone?: string;
|
|
236
238
|
}
|
|
237
239
|
interface ConnectionPoolConfig {
|
|
238
|
-
/** Client idle timeout. */
|
|
239
|
-
clientConnectionIdleTimeout?: string;
|
|
240
240
|
/** Whether managed connection pooling is enabled. */
|
|
241
241
|
connectionPoolingEnabled?: boolean;
|
|
242
|
-
/** Managed connection pool size. */
|
|
243
|
-
connPoolSize?: number;
|
|
244
242
|
/** Optional. List of connection pool configuration flags */
|
|
245
243
|
flags?: ConnectionPoolFlags[];
|
|
246
|
-
/** Maximum number of client connections in connection pool. */
|
|
247
|
-
maxClientConnections?: number;
|
|
248
|
-
/** The managed connection pool mode for the instance. */
|
|
249
|
-
poolMode?: string;
|
|
250
|
-
/** Query wait timeout. */
|
|
251
|
-
queryWaitTimeout?: string;
|
|
252
|
-
/** Server idle timeout. */
|
|
253
|
-
serverConnectionIdleTimeout?: string;
|
|
254
244
|
}
|
|
255
245
|
interface ConnectionPoolFlags {
|
|
256
246
|
/** Required. The name of the flag. */
|
|
@@ -259,13 +249,13 @@ declare namespace gapi.client {
|
|
|
259
249
|
value?: string;
|
|
260
250
|
}
|
|
261
251
|
interface ConnectPoolNodeConfig {
|
|
262
|
-
/** Output only. The DNS name of the node. */
|
|
252
|
+
/** Output only. The DNS name of the read pool node. */
|
|
263
253
|
dnsName?: string;
|
|
264
|
-
/** Output only. The list of DNS names used by this
|
|
254
|
+
/** Output only. The list of DNS names used by this read pool node. */
|
|
265
255
|
dnsNames?: DnsNameMapping[];
|
|
266
|
-
/** Output only. Mappings containing IP addresses that can be used to connect to the node. */
|
|
256
|
+
/** Output only. Mappings containing IP addresses that can be used to connect to the read pool node. */
|
|
267
257
|
ipAddresses?: IpMapping[];
|
|
268
|
-
/** Output only. The name of the node. Doesn't include the project ID. */
|
|
258
|
+
/** Output only. The name of the read pool node. Doesn't include the project ID. */
|
|
269
259
|
name?: string;
|
|
270
260
|
}
|
|
271
261
|
interface ConnectSettings {
|
|
@@ -283,9 +273,9 @@ declare namespace gapi.client {
|
|
|
283
273
|
ipAddresses?: IpMapping[];
|
|
284
274
|
/** This is always `sql#connectSettings`. */
|
|
285
275
|
kind?: string;
|
|
286
|
-
/** The number of nodes in a read pool. */
|
|
276
|
+
/** The number of read pool nodes in a read pool. */
|
|
287
277
|
nodeCount?: number;
|
|
288
|
-
/** Output only. Entries containing information about each node of the read pool. */
|
|
278
|
+
/** Output only. Entries containing information about each read pool node of the read pool. */
|
|
289
279
|
nodes?: ConnectPoolNodeConfig[];
|
|
290
280
|
/** Whether PSC connectivity is enabled for this instance. */
|
|
291
281
|
pscEnabled?: boolean;
|
|
@@ -375,9 +365,9 @@ declare namespace gapi.client {
|
|
|
375
365
|
maxDiskSize?: string;
|
|
376
366
|
/** Name of the Cloud SQL instance. This does not include the project ID. */
|
|
377
367
|
name?: string;
|
|
378
|
-
/** The number of nodes in a read pool. */
|
|
368
|
+
/** The number of read pool nodes in a read pool. */
|
|
379
369
|
nodeCount?: number;
|
|
380
|
-
/** Output only. Entries containing information about each node of the read pool. */
|
|
370
|
+
/** Output only. Entries containing information about each read pool node of the read pool. */
|
|
381
371
|
nodes?: PoolNodeConfig[];
|
|
382
372
|
/** Configuration specific to on-premises instances. */
|
|
383
373
|
onPremisesConfiguration?: OnPremisesConfiguration;
|
|
@@ -544,7 +534,7 @@ declare namespace gapi.client {
|
|
|
544
534
|
fileType?: string;
|
|
545
535
|
/** This is always `sql#exportContext`. */
|
|
546
536
|
kind?: string;
|
|
547
|
-
/**
|
|
537
|
+
/** Whether to perform a serverless export. */
|
|
548
538
|
offload?: boolean;
|
|
549
539
|
/** Options for exporting data as SQL statements. */
|
|
550
540
|
sqlExportOptions?: {
|
|
@@ -557,7 +547,7 @@ declare namespace gapi.client {
|
|
|
557
547
|
parallel?: boolean;
|
|
558
548
|
/** Options for exporting from a Cloud SQL for PostgreSQL instance. */
|
|
559
549
|
postgresExportOptions?: {
|
|
560
|
-
/** Optional. Use this option to include DROP SQL statements.
|
|
550
|
+
/** Optional. Use this option to include DROP <object> SQL statements. Use these statements to delete database objects before running the import operation. */
|
|
561
551
|
clean?: boolean;
|
|
562
552
|
/** Optional. Option to include an IF EXISTS SQL statement with each DROP statement produced by clean. */
|
|
563
553
|
ifExists?: boolean;
|
|
@@ -814,6 +804,8 @@ declare namespace gapi.client {
|
|
|
814
804
|
interface InstancesRestoreBackupRequest {
|
|
815
805
|
/** 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. */
|
|
816
806
|
backup?: string;
|
|
807
|
+
/** The name of the backup that's used to restore a Cloud SQL instance: Format: "projects/{project-id}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}/backups/{backup-uid}". Only one of restore_backup_context, backup, backupdr_backup can be passed to the input. */
|
|
808
|
+
backupdrBackup?: string;
|
|
817
809
|
/** Parameters required to perform the restore backup operation. */
|
|
818
810
|
restoreBackupContext?: RestoreBackupContext;
|
|
819
811
|
/** 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. */
|
|
@@ -1052,18 +1044,34 @@ declare namespace gapi.client {
|
|
|
1052
1044
|
/** The target disk shrink size in GigaBytes. */
|
|
1053
1045
|
targetSizeGb?: string;
|
|
1054
1046
|
}
|
|
1047
|
+
interface PointInTimeRestoreContext {
|
|
1048
|
+
/** 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. http://go/speckle-subnet-picker-clone */
|
|
1049
|
+
allocatedIpRange?: string;
|
|
1050
|
+
/** The Google Cloud Backup and Disaster Recovery Datasource URI. Format: projects/{project}/locations/{region}/backupVaults/{backupvault}/dataSources/{datasource}. */
|
|
1051
|
+
datasource?: string;
|
|
1052
|
+
/** Required. The date and time to which you want to restore the instance. */
|
|
1053
|
+
pointInTime?: string;
|
|
1054
|
+
/** Optional. Point-in-time recovery of a regional instance in the specified zones. If not specified, clone to the same secondary zone as the source instance. This value cannot be the same as the preferred_zone field. */
|
|
1055
|
+
preferredSecondaryZone?: string;
|
|
1056
|
+
/** Optional. Point-in-time recovery of an instance to the specified zone. If no zone is specified, then clone to the same primary zone as the source instance. */
|
|
1057
|
+
preferredZone?: string;
|
|
1058
|
+
/** Optional. The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, `/projects/myProject/global/networks/default`. */
|
|
1059
|
+
privateNetwork?: string;
|
|
1060
|
+
/** Target instance name. */
|
|
1061
|
+
targetInstance?: string;
|
|
1062
|
+
}
|
|
1055
1063
|
interface PoolNodeConfig {
|
|
1056
|
-
/** Output only. The DNS name of the node. */
|
|
1064
|
+
/** Output only. The DNS name of the read pool node. */
|
|
1057
1065
|
dnsName?: string;
|
|
1058
|
-
/** Output only. The list of DNS names used by this node. */
|
|
1066
|
+
/** Output only. The list of DNS names used by this read pool node. */
|
|
1059
1067
|
dnsNames?: DnsNameMapping[];
|
|
1060
|
-
/** Output only. The
|
|
1068
|
+
/** Output only. The zone of the read pool node. */
|
|
1061
1069
|
gceZone?: string;
|
|
1062
|
-
/** Output only. Mappings containing IP addresses that can be used to connect to the node. */
|
|
1070
|
+
/** Output only. Mappings containing IP addresses that can be used to connect to the read pool node. */
|
|
1063
1071
|
ipAddresses?: IpMapping[];
|
|
1064
|
-
/** Output only. The name of the node, to be used for retrieving metrics and logs
|
|
1072
|
+
/** Output only. The name of the read pool node, to be used for retrieving metrics and logs. */
|
|
1065
1073
|
name?: string;
|
|
1066
|
-
/** Output only. The current state of the node. */
|
|
1074
|
+
/** Output only. The current state of the read pool node. */
|
|
1067
1075
|
state?: string;
|
|
1068
1076
|
}
|
|
1069
1077
|
interface PscAutoConnectionConfig {
|
|
@@ -1179,7 +1187,7 @@ declare namespace gapi.client {
|
|
|
1179
1187
|
edition?: string;
|
|
1180
1188
|
/** Optional. By default, Cloud SQL instances have schema extraction disabled for Dataplex. When this parameter is set to true, schema extraction for Dataplex on Cloud SQL instances is activated. */
|
|
1181
1189
|
enableDataplexIntegration?: boolean;
|
|
1182
|
-
/** 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 PostgreSQL instances. */
|
|
1190
|
+
/** 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. */
|
|
1183
1191
|
enableGoogleMlIntegration?: boolean;
|
|
1184
1192
|
/** Insights configuration, for now relevant only for Postgres. */
|
|
1185
1193
|
insightsConfig?: InsightsConfig;
|
|
@@ -1764,7 +1772,7 @@ declare namespace gapi.client {
|
|
|
1764
1772
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1765
1773
|
uploadType?: string;
|
|
1766
1774
|
}): Request<ListBackupsResponse>;
|
|
1767
|
-
/**
|
|
1775
|
+
/** This API updates the following: 1- retention period and description of backup in case of final backups only. 2- gcbdr_soft_delete_status of backup in case of GCBDR managed backups only. */
|
|
1768
1776
|
updateBackup(request: {
|
|
1769
1777
|
/** V1 error format. */
|
|
1770
1778
|
'$.xgafv'?: string;
|
|
@@ -1786,7 +1794,7 @@ declare namespace gapi.client {
|
|
|
1786
1794
|
prettyPrint?: boolean;
|
|
1787
1795
|
/** 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. */
|
|
1788
1796
|
quotaUser?: string;
|
|
1789
|
-
/** The list of fields that you can update. You can update only the description and retention period
|
|
1797
|
+
/** The list of fields that you can update. 1- You can update only the description and retention period for a final backup. 2- You can update only the gcbdr_soft_delete_status for GCBDR managed backup. */
|
|
1790
1798
|
updateMask?: string;
|
|
1791
1799
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1792
1800
|
upload_protocol?: string;
|
|
@@ -1817,7 +1825,7 @@ declare namespace gapi.client {
|
|
|
1817
1825
|
prettyPrint?: boolean;
|
|
1818
1826
|
/** 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. */
|
|
1819
1827
|
quotaUser?: string;
|
|
1820
|
-
/** The list of fields that you can update. You can update only the description and retention period
|
|
1828
|
+
/** The list of fields that you can update. 1- You can update only the description and retention period for a final backup. 2- You can update only the gcbdr_soft_delete_status for GCBDR managed backup. */
|
|
1821
1829
|
updateMask?: string;
|
|
1822
1830
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1823
1831
|
upload_protocol?: string;
|
|
@@ -3010,6 +3018,64 @@ declare namespace gapi.client {
|
|
|
3010
3018
|
},
|
|
3011
3019
|
body: DatabaseInstance,
|
|
3012
3020
|
): Request<Operation>;
|
|
3021
|
+
/** Point in time restore for an instance managed by Google Cloud Backup and Disaster Recovery. */
|
|
3022
|
+
pointInTimeRestore(request: {
|
|
3023
|
+
/** V1 error format. */
|
|
3024
|
+
'$.xgafv'?: string;
|
|
3025
|
+
/** OAuth access token. */
|
|
3026
|
+
access_token?: string;
|
|
3027
|
+
/** Data format for response. */
|
|
3028
|
+
alt?: string;
|
|
3029
|
+
/** JSONP */
|
|
3030
|
+
callback?: string;
|
|
3031
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3032
|
+
fields?: string;
|
|
3033
|
+
/** 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. */
|
|
3034
|
+
key?: string;
|
|
3035
|
+
/** OAuth 2.0 token for the current user. */
|
|
3036
|
+
oauth_token?: string;
|
|
3037
|
+
/** Required. The parent resource where you created this instance. Format: projects/{project} */
|
|
3038
|
+
parent: string;
|
|
3039
|
+
/** Returns response with indentations and line breaks. */
|
|
3040
|
+
prettyPrint?: boolean;
|
|
3041
|
+
/** 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. */
|
|
3042
|
+
quotaUser?: string;
|
|
3043
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3044
|
+
upload_protocol?: string;
|
|
3045
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3046
|
+
uploadType?: string;
|
|
3047
|
+
/** Request body */
|
|
3048
|
+
resource: PointInTimeRestoreContext;
|
|
3049
|
+
}): Request<Operation>;
|
|
3050
|
+
pointInTimeRestore(
|
|
3051
|
+
request: {
|
|
3052
|
+
/** V1 error format. */
|
|
3053
|
+
'$.xgafv'?: string;
|
|
3054
|
+
/** OAuth access token. */
|
|
3055
|
+
access_token?: string;
|
|
3056
|
+
/** Data format for response. */
|
|
3057
|
+
alt?: string;
|
|
3058
|
+
/** JSONP */
|
|
3059
|
+
callback?: string;
|
|
3060
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3061
|
+
fields?: string;
|
|
3062
|
+
/** 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. */
|
|
3063
|
+
key?: string;
|
|
3064
|
+
/** OAuth 2.0 token for the current user. */
|
|
3065
|
+
oauth_token?: string;
|
|
3066
|
+
/** Required. The parent resource where you created this instance. Format: projects/{project} */
|
|
3067
|
+
parent: string;
|
|
3068
|
+
/** Returns response with indentations and line breaks. */
|
|
3069
|
+
prettyPrint?: boolean;
|
|
3070
|
+
/** 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. */
|
|
3071
|
+
quotaUser?: string;
|
|
3072
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3073
|
+
upload_protocol?: string;
|
|
3074
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3075
|
+
uploadType?: string;
|
|
3076
|
+
},
|
|
3077
|
+
body: PointInTimeRestoreContext,
|
|
3078
|
+
): Request<Operation>;
|
|
3013
3079
|
/** Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart. */
|
|
3014
3080
|
promoteReplica(request?: {
|
|
3015
3081
|
/** V1 error format. */
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -127,7 +127,7 @@ Lists all backups associated with the project.
|
|
|
127
127
|
await gapi.client.sql.backups.listBackups({parent: 'parent'});
|
|
128
128
|
|
|
129
129
|
/*
|
|
130
|
-
|
|
130
|
+
This API updates the following: 1- retention period and description of backup in case of final backups only. 2- gcbdr_soft_delete_status of backup in case of GCBDR managed backups only.
|
|
131
131
|
*/
|
|
132
132
|
await gapi.client.sql.backups.updateBackup({name: 'name'});
|
|
133
133
|
|
|
@@ -320,6 +320,11 @@ await gapi.client.sql.instances.patch({
|
|
|
320
320
|
project: 'project',
|
|
321
321
|
});
|
|
322
322
|
|
|
323
|
+
/*
|
|
324
|
+
Point in time restore for an instance managed by Google Cloud Backup and Disaster Recovery.
|
|
325
|
+
*/
|
|
326
|
+
await gapi.client.sql.instances.pointInTimeRestore({parent: 'parent'});
|
|
327
|
+
|
|
323
328
|
/*
|
|
324
329
|
Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart.
|
|
325
330
|
*/
|