@maxim_mazurok/gapi.client.sqladmin-v1 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=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20250427
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -71,7 +71,7 @@ declare namespace gapi.client {
|
|
|
71
71
|
backupKind?: string;
|
|
72
72
|
/** Output only. The mapping to backup run resource used for IAM validations. */
|
|
73
73
|
backupRun?: string;
|
|
74
|
-
/** Output only. The database version of the instance of
|
|
74
|
+
/** Output only. The database version of the instance of at the time this backup was made. */
|
|
75
75
|
databaseVersion?: string;
|
|
76
76
|
/** The description of this backup. */
|
|
77
77
|
description?: string;
|
|
@@ -115,6 +115,8 @@ declare namespace gapi.client {
|
|
|
115
115
|
interface BackupConfiguration {
|
|
116
116
|
/** Backup retention settings. */
|
|
117
117
|
backupRetentionSettings?: BackupRetentionSettings;
|
|
118
|
+
/** Output only. Backup tier that manages the backups for the instance. */
|
|
119
|
+
backupTier?: string;
|
|
118
120
|
/** (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well. */
|
|
119
121
|
binaryLogEnabled?: boolean;
|
|
120
122
|
/** Whether this configuration is enabled. */
|
|
@@ -157,7 +159,7 @@ declare namespace gapi.client {
|
|
|
157
159
|
interface BackupRun {
|
|
158
160
|
/** Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT. */
|
|
159
161
|
backupKind?: string;
|
|
160
|
-
/** Output only. The instance database version
|
|
162
|
+
/** Output only. The instance database version at the time this backup was made. */
|
|
161
163
|
databaseVersion?: string;
|
|
162
164
|
/** The description of this run, only applicable to on-demand backups. */
|
|
163
165
|
description?: string;
|
|
@@ -231,22 +233,10 @@ declare namespace gapi.client {
|
|
|
231
233
|
preferredZone?: string;
|
|
232
234
|
}
|
|
233
235
|
interface ConnectionPoolConfig {
|
|
234
|
-
/** Client idle timeout. */
|
|
235
|
-
clientConnectionIdleTimeout?: string;
|
|
236
236
|
/** Whether managed connection pooling is enabled. */
|
|
237
237
|
connectionPoolingEnabled?: boolean;
|
|
238
|
-
/** Managed connection pool size. */
|
|
239
|
-
connPoolSize?: number;
|
|
240
238
|
/** Optional. List of connection pool configuration flags */
|
|
241
239
|
flags?: ConnectionPoolFlags[];
|
|
242
|
-
/** Maximum number of client connections in connection pool. */
|
|
243
|
-
maxClientConnections?: number;
|
|
244
|
-
/** The managed connection pool mode for the instance. */
|
|
245
|
-
poolMode?: string;
|
|
246
|
-
/** Query wait timeout. */
|
|
247
|
-
queryWaitTimeout?: string;
|
|
248
|
-
/** Server idle timeout. */
|
|
249
|
-
serverConnectionIdleTimeout?: string;
|
|
250
240
|
}
|
|
251
241
|
interface ConnectionPoolFlags {
|
|
252
242
|
/** Required. The name of the flag. */
|
|
@@ -255,13 +245,13 @@ declare namespace gapi.client {
|
|
|
255
245
|
value?: string;
|
|
256
246
|
}
|
|
257
247
|
interface ConnectPoolNodeConfig {
|
|
258
|
-
/** Output only. The DNS name of the node. */
|
|
248
|
+
/** Output only. The DNS name of the read pool node. */
|
|
259
249
|
dnsName?: string;
|
|
260
|
-
/** Output only. The list of DNS names used by this node. */
|
|
250
|
+
/** Output only. The list of DNS names used by this read pool node. */
|
|
261
251
|
dnsNames?: DnsNameMapping[];
|
|
262
|
-
/** Output only. Mappings containing IP addresses that can be used to connect to the node. */
|
|
252
|
+
/** Output only. Mappings containing IP addresses that can be used to connect to the read pool node. */
|
|
263
253
|
ipAddresses?: IpMapping[];
|
|
264
|
-
/** Output only. The name of the node. Doesn't include the project ID. */
|
|
254
|
+
/** Output only. The name of the read pool node. Doesn't include the project ID. */
|
|
265
255
|
name?: string;
|
|
266
256
|
}
|
|
267
257
|
interface ConnectSettings {
|
|
@@ -279,9 +269,9 @@ declare namespace gapi.client {
|
|
|
279
269
|
ipAddresses?: IpMapping[];
|
|
280
270
|
/** This is always `sql#connectSettings`. */
|
|
281
271
|
kind?: string;
|
|
282
|
-
/** The number of nodes in a read pool. */
|
|
272
|
+
/** The number of read pool nodes in a read pool. */
|
|
283
273
|
nodeCount?: number;
|
|
284
|
-
/** Output only. Entries containing information about each node of the read pool. */
|
|
274
|
+
/** Output only. Entries containing information about each read pool node of the read pool. */
|
|
285
275
|
nodes?: ConnectPoolNodeConfig[];
|
|
286
276
|
/** Whether PSC connectivity is enabled for this instance. */
|
|
287
277
|
pscEnabled?: boolean;
|
|
@@ -371,9 +361,9 @@ declare namespace gapi.client {
|
|
|
371
361
|
maxDiskSize?: string;
|
|
372
362
|
/** Name of the Cloud SQL instance. This does not include the project ID. */
|
|
373
363
|
name?: string;
|
|
374
|
-
/** The number of nodes in a read pool. */
|
|
364
|
+
/** The number of read pool nodes in a read pool. */
|
|
375
365
|
nodeCount?: number;
|
|
376
|
-
/** Output only. Entries containing information about each node of the read pool. */
|
|
366
|
+
/** Output only. Entries containing information about each read pool node of the read pool. */
|
|
377
367
|
nodes?: PoolNodeConfig[];
|
|
378
368
|
/** Configuration specific to on-premises instances. */
|
|
379
369
|
onPremisesConfiguration?: OnPremisesConfiguration;
|
|
@@ -539,7 +529,7 @@ declare namespace gapi.client {
|
|
|
539
529
|
fileType?: string;
|
|
540
530
|
/** This is always `sql#exportContext`. */
|
|
541
531
|
kind?: string;
|
|
542
|
-
/**
|
|
532
|
+
/** Whether to perform a serverless export. */
|
|
543
533
|
offload?: boolean;
|
|
544
534
|
/** Options for exporting data as SQL statements. */
|
|
545
535
|
sqlExportOptions?: {
|
|
@@ -552,7 +542,7 @@ declare namespace gapi.client {
|
|
|
552
542
|
parallel?: boolean;
|
|
553
543
|
/** Options for exporting from a Cloud SQL for PostgreSQL instance. */
|
|
554
544
|
postgresExportOptions?: {
|
|
555
|
-
/** Optional. Use this option to include DROP SQL statements.
|
|
545
|
+
/** Optional. Use this option to include DROP <object> SQL statements. Use these statements to delete database objects before running the import operation. */
|
|
556
546
|
clean?: boolean;
|
|
557
547
|
/** Optional. Option to include an IF EXISTS SQL statement with each DROP statement produced by clean. */
|
|
558
548
|
ifExists?: boolean;
|
|
@@ -809,6 +799,8 @@ declare namespace gapi.client {
|
|
|
809
799
|
interface InstancesRestoreBackupRequest {
|
|
810
800
|
/** 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. */
|
|
811
801
|
backup?: string;
|
|
802
|
+
/** 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. */
|
|
803
|
+
backupdrBackup?: string;
|
|
812
804
|
/** Parameters required to perform the restore backup operation. */
|
|
813
805
|
restoreBackupContext?: RestoreBackupContext;
|
|
814
806
|
/** 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. */
|
|
@@ -1047,18 +1039,34 @@ declare namespace gapi.client {
|
|
|
1047
1039
|
/** The target disk shrink size in GigaBytes. */
|
|
1048
1040
|
targetSizeGb?: string;
|
|
1049
1041
|
}
|
|
1042
|
+
interface PointInTimeRestoreContext {
|
|
1043
|
+
/** 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 */
|
|
1044
|
+
allocatedIpRange?: string;
|
|
1045
|
+
/** The Google Cloud Backup and Disaster Recovery Datasource URI. Format: projects/{project}/locations/{region}/backupVaults/{backupvault}/dataSources/{datasource}. */
|
|
1046
|
+
datasource?: string;
|
|
1047
|
+
/** Required. The date and time to which you want to restore the instance. */
|
|
1048
|
+
pointInTime?: string;
|
|
1049
|
+
/** 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. */
|
|
1050
|
+
preferredSecondaryZone?: string;
|
|
1051
|
+
/** 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. */
|
|
1052
|
+
preferredZone?: string;
|
|
1053
|
+
/** 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`. */
|
|
1054
|
+
privateNetwork?: string;
|
|
1055
|
+
/** Target instance name. */
|
|
1056
|
+
targetInstance?: string;
|
|
1057
|
+
}
|
|
1050
1058
|
interface PoolNodeConfig {
|
|
1051
|
-
/** Output only. The DNS name of the node. */
|
|
1059
|
+
/** Output only. The DNS name of the read pool node. */
|
|
1052
1060
|
dnsName?: string;
|
|
1053
|
-
/** Output only. The list of DNS names used by this node. */
|
|
1061
|
+
/** Output only. The list of DNS names used by this read pool node. */
|
|
1054
1062
|
dnsNames?: DnsNameMapping[];
|
|
1055
|
-
/** Output only. The
|
|
1063
|
+
/** Output only. The zone of the read pool node. */
|
|
1056
1064
|
gceZone?: string;
|
|
1057
|
-
/** Output only. Mappings containing IP addresses that can be used to connect to the node. */
|
|
1065
|
+
/** Output only. Mappings containing IP addresses that can be used to connect to the read pool node. */
|
|
1058
1066
|
ipAddresses?: IpMapping[];
|
|
1059
|
-
/** Output only. The name of the node, to be used for retrieving metrics and logs
|
|
1067
|
+
/** Output only. The name of the read pool node, to be used for retrieving metrics and logs. */
|
|
1060
1068
|
name?: string;
|
|
1061
|
-
/** Output only. The current state of the node. */
|
|
1069
|
+
/** Output only. The current state of the read pool node. */
|
|
1062
1070
|
state?: string;
|
|
1063
1071
|
}
|
|
1064
1072
|
interface PscAutoConnectionConfig {
|
|
@@ -1174,7 +1182,7 @@ declare namespace gapi.client {
|
|
|
1174
1182
|
edition?: string;
|
|
1175
1183
|
/** 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. */
|
|
1176
1184
|
enableDataplexIntegration?: boolean;
|
|
1177
|
-
/** 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. */
|
|
1185
|
+
/** 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. */
|
|
1178
1186
|
enableGoogleMlIntegration?: boolean;
|
|
1179
1187
|
/** Insights configuration, for now relevant only for Postgres. */
|
|
1180
1188
|
insightsConfig?: InsightsConfig;
|
|
@@ -1759,7 +1767,7 @@ declare namespace gapi.client {
|
|
|
1759
1767
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1760
1768
|
uploadType?: string;
|
|
1761
1769
|
}): Request<ListBackupsResponse>;
|
|
1762
|
-
/**
|
|
1770
|
+
/** 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. */
|
|
1763
1771
|
UpdateBackup(request: {
|
|
1764
1772
|
/** V1 error format. */
|
|
1765
1773
|
'$.xgafv'?: string;
|
|
@@ -1781,7 +1789,7 @@ declare namespace gapi.client {
|
|
|
1781
1789
|
prettyPrint?: boolean;
|
|
1782
1790
|
/** 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. */
|
|
1783
1791
|
quotaUser?: string;
|
|
1784
|
-
/** The list of fields that you can update. You can update only the description and retention period
|
|
1792
|
+
/** 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. */
|
|
1785
1793
|
updateMask?: string;
|
|
1786
1794
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1787
1795
|
upload_protocol?: string;
|
|
@@ -1812,7 +1820,7 @@ declare namespace gapi.client {
|
|
|
1812
1820
|
prettyPrint?: boolean;
|
|
1813
1821
|
/** 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. */
|
|
1814
1822
|
quotaUser?: string;
|
|
1815
|
-
/** The list of fields that you can update. You can update only the description and retention period
|
|
1823
|
+
/** 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. */
|
|
1816
1824
|
updateMask?: string;
|
|
1817
1825
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1818
1826
|
upload_protocol?: string;
|
|
@@ -3005,6 +3013,64 @@ declare namespace gapi.client {
|
|
|
3005
3013
|
},
|
|
3006
3014
|
body: DatabaseInstance,
|
|
3007
3015
|
): Request<Operation>;
|
|
3016
|
+
/** Point in time restore for an instance managed by Google Cloud Backup and Disaster Recovery. */
|
|
3017
|
+
pointInTimeRestore(request: {
|
|
3018
|
+
/** V1 error format. */
|
|
3019
|
+
'$.xgafv'?: string;
|
|
3020
|
+
/** OAuth access token. */
|
|
3021
|
+
access_token?: string;
|
|
3022
|
+
/** Data format for response. */
|
|
3023
|
+
alt?: string;
|
|
3024
|
+
/** JSONP */
|
|
3025
|
+
callback?: string;
|
|
3026
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3027
|
+
fields?: string;
|
|
3028
|
+
/** 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. */
|
|
3029
|
+
key?: string;
|
|
3030
|
+
/** OAuth 2.0 token for the current user. */
|
|
3031
|
+
oauth_token?: string;
|
|
3032
|
+
/** Required. The parent resource where you created this instance. Format: projects/{project} */
|
|
3033
|
+
parent: string;
|
|
3034
|
+
/** Returns response with indentations and line breaks. */
|
|
3035
|
+
prettyPrint?: boolean;
|
|
3036
|
+
/** 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. */
|
|
3037
|
+
quotaUser?: string;
|
|
3038
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3039
|
+
upload_protocol?: string;
|
|
3040
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3041
|
+
uploadType?: string;
|
|
3042
|
+
/** Request body */
|
|
3043
|
+
resource: PointInTimeRestoreContext;
|
|
3044
|
+
}): Request<Operation>;
|
|
3045
|
+
pointInTimeRestore(
|
|
3046
|
+
request: {
|
|
3047
|
+
/** V1 error format. */
|
|
3048
|
+
'$.xgafv'?: string;
|
|
3049
|
+
/** OAuth access token. */
|
|
3050
|
+
access_token?: string;
|
|
3051
|
+
/** Data format for response. */
|
|
3052
|
+
alt?: string;
|
|
3053
|
+
/** JSONP */
|
|
3054
|
+
callback?: string;
|
|
3055
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3056
|
+
fields?: string;
|
|
3057
|
+
/** 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. */
|
|
3058
|
+
key?: string;
|
|
3059
|
+
/** OAuth 2.0 token for the current user. */
|
|
3060
|
+
oauth_token?: string;
|
|
3061
|
+
/** Required. The parent resource where you created this instance. Format: projects/{project} */
|
|
3062
|
+
parent: string;
|
|
3063
|
+
/** Returns response with indentations and line breaks. */
|
|
3064
|
+
prettyPrint?: boolean;
|
|
3065
|
+
/** 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. */
|
|
3066
|
+
quotaUser?: string;
|
|
3067
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3068
|
+
upload_protocol?: string;
|
|
3069
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3070
|
+
uploadType?: string;
|
|
3071
|
+
},
|
|
3072
|
+
body: PointInTimeRestoreContext,
|
|
3073
|
+
): Request<Operation>;
|
|
3008
3074
|
/** Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart. */
|
|
3009
3075
|
promoteReplica(request?: {
|
|
3010
3076
|
/** 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
|
*/
|