@maxim_mazurok/gapi.client.sqladmin-v1 0.0.20250216 → 0.0.20250310
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 +99 -7
- package/package.json +1 -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: 20250310
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -71,6 +71,8 @@ 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 when this backup was made. */
|
|
75
|
+
databaseVersion?: string;
|
|
74
76
|
/** The description of this backup. */
|
|
75
77
|
description?: string;
|
|
76
78
|
/** Output only. Information about why the backup operation fails (for example, when the backup state fails). */
|
|
@@ -79,6 +81,10 @@ declare namespace gapi.client {
|
|
|
79
81
|
expiryTime?: string;
|
|
80
82
|
/** The name of the source database instance. */
|
|
81
83
|
instance?: string;
|
|
84
|
+
/** Optional. Output only. Timestamp in UTC of when the instance associated with this backup is deleted. */
|
|
85
|
+
instanceDeletionTime?: string;
|
|
86
|
+
/** Optional. Output only. The instance setting of the source instance that's associated with this backup. */
|
|
87
|
+
instanceSettings?: DatabaseInstance;
|
|
82
88
|
/** Output only. This is always `sql#backup`. */
|
|
83
89
|
kind?: string;
|
|
84
90
|
/** Output only. This output contains the encryption configuration for a backup and the resource name of the KMS key for disk encryption. */
|
|
@@ -101,7 +107,7 @@ declare namespace gapi.client {
|
|
|
101
107
|
state?: string;
|
|
102
108
|
/** 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 the restore to the instance doesn't happen. */
|
|
103
109
|
timeZone?: string;
|
|
104
|
-
/** Input only. The time-to-live (TTL) interval for this resource (in days). For example: ttlDays:7 means 7 days. */
|
|
110
|
+
/** Input only. The time-to-live (TTL) interval for this resource (in days). For example: ttlDays:7, means 7 days from the current time. The expiration time can't exceed 365 days from the time that the backup is created. */
|
|
105
111
|
ttlDays?: string;
|
|
106
112
|
/** Output only. The type of this backup. The type can be "AUTOMATED", "ON_DEMAND" or “FINAL”. */
|
|
107
113
|
type?: string;
|
|
@@ -151,6 +157,8 @@ declare namespace gapi.client {
|
|
|
151
157
|
interface BackupRun {
|
|
152
158
|
/** Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT. */
|
|
153
159
|
backupKind?: string;
|
|
160
|
+
/** Output only. The instance database version when this backup was made. */
|
|
161
|
+
databaseVersion?: string;
|
|
154
162
|
/** The description of this run, only applicable to on-demand backups. */
|
|
155
163
|
description?: string;
|
|
156
164
|
/** Encryption configuration specific to a backup. */
|
|
@@ -222,6 +230,40 @@ declare namespace gapi.client {
|
|
|
222
230
|
/** Optional. Copy clone and point-in-time recovery clone of an instance to the specified zone. If no zone is specified, clone to the same primary zone as the source instance. This field applies to all DB types. */
|
|
223
231
|
preferredZone?: string;
|
|
224
232
|
}
|
|
233
|
+
interface ConnectionPoolConfig {
|
|
234
|
+
/** Client idle timeout. */
|
|
235
|
+
clientConnectionIdleTimeout?: string;
|
|
236
|
+
/** Whether managed connection pooling is enabled. */
|
|
237
|
+
connectionPoolingEnabled?: boolean;
|
|
238
|
+
/** Managed connection pool size. */
|
|
239
|
+
connPoolSize?: number;
|
|
240
|
+
/** Optional. List of connection pool configuration flags */
|
|
241
|
+
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
|
+
}
|
|
251
|
+
interface ConnectionPoolFlags {
|
|
252
|
+
/** Required. The name of the flag. */
|
|
253
|
+
name?: string;
|
|
254
|
+
/** Required. The value of the flag. Boolean flags are set to `on` for true and `off` for false. This field must be omitted if the flag doesn't take a value. */
|
|
255
|
+
value?: string;
|
|
256
|
+
}
|
|
257
|
+
interface ConnectPoolNodeConfig {
|
|
258
|
+
/** Output only. The DNS name of the node. */
|
|
259
|
+
dnsName?: string;
|
|
260
|
+
/** Output only. The list of DNS names used by this node. */
|
|
261
|
+
dnsNames?: DnsNameMapping[];
|
|
262
|
+
/** Output only. Mappings containing IP addresses that can be used to connect to the node. */
|
|
263
|
+
ipAddresses?: IpMapping[];
|
|
264
|
+
/** Output only. The name of the node. Doesn't include the project ID. */
|
|
265
|
+
name?: string;
|
|
266
|
+
}
|
|
225
267
|
interface ConnectSettings {
|
|
226
268
|
/** `SECOND_GEN`: Cloud SQL database instance. `EXTERNAL`: A database server that is not managed by Google. This property is read-only; use the `tier` property in the `settings` object to determine the database type. */
|
|
227
269
|
backendType?: string;
|
|
@@ -231,10 +273,16 @@ declare namespace gapi.client {
|
|
|
231
273
|
databaseVersion?: string;
|
|
232
274
|
/** The dns name of the instance. */
|
|
233
275
|
dnsName?: string;
|
|
276
|
+
/** Output only. The list of DNS names used by this instance. */
|
|
277
|
+
dnsNames?: DnsNameMapping[];
|
|
234
278
|
/** The assigned IP addresses for the instance. */
|
|
235
279
|
ipAddresses?: IpMapping[];
|
|
236
280
|
/** This is always `sql#connectSettings`. */
|
|
237
281
|
kind?: string;
|
|
282
|
+
/** The number of nodes in a read pool. */
|
|
283
|
+
nodeCount?: number;
|
|
284
|
+
/** Output only. Entries containing information about each node of the read pool. */
|
|
285
|
+
nodes?: ConnectPoolNodeConfig[];
|
|
238
286
|
/** Whether PSC connectivity is enabled for this instance. */
|
|
239
287
|
pscEnabled?: boolean;
|
|
240
288
|
/** The cloud region for the instance. For example, `us-central1`, `europe-west1`. The region cannot be changed after instance creation. */
|
|
@@ -290,6 +338,8 @@ declare namespace gapi.client {
|
|
|
290
338
|
diskEncryptionStatus?: DiskEncryptionStatus;
|
|
291
339
|
/** Output only. The dns name of the instance. */
|
|
292
340
|
dnsName?: string;
|
|
341
|
+
/** Output only. The list of DNS names used by this instance. */
|
|
342
|
+
dnsNames?: DnsNameMapping[];
|
|
293
343
|
/** This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead. */
|
|
294
344
|
etag?: string;
|
|
295
345
|
/** The name and status of the failover replica. */
|
|
@@ -321,6 +371,10 @@ declare namespace gapi.client {
|
|
|
321
371
|
maxDiskSize?: string;
|
|
322
372
|
/** Name of the Cloud SQL instance. This does not include the project ID. */
|
|
323
373
|
name?: string;
|
|
374
|
+
/** The number of nodes in a read pool. */
|
|
375
|
+
nodeCount?: number;
|
|
376
|
+
/** Output only. Entries containing information about each node of the read pool. */
|
|
377
|
+
nodes?: PoolNodeConfig[];
|
|
324
378
|
/** Configuration specific to on-premises instances. */
|
|
325
379
|
onPremisesConfiguration?: OnPremisesConfiguration;
|
|
326
380
|
/** This field represents the report generated by the proactive database wellness job for OutOfDisk issues. * Writers: * the proactive database wellness job for OOD. * Readers: * the proactive database wellness job */
|
|
@@ -439,6 +493,14 @@ declare namespace gapi.client {
|
|
|
439
493
|
/** KMS key version used to encrypt the Cloud SQL instance resource */
|
|
440
494
|
kmsKeyVersionName?: string;
|
|
441
495
|
}
|
|
496
|
+
interface DnsNameMapping {
|
|
497
|
+
/** Output only. The connection type of the DNS name. */
|
|
498
|
+
connectionType?: string;
|
|
499
|
+
/** Output only. The scope that the DNS name applies to. */
|
|
500
|
+
dnsScope?: string;
|
|
501
|
+
/** The DNS name. */
|
|
502
|
+
name?: string;
|
|
503
|
+
}
|
|
442
504
|
interface Empty {}
|
|
443
505
|
interface ExportContext {
|
|
444
506
|
/** Options for exporting BAK files (SQL Server-only) */
|
|
@@ -471,7 +533,7 @@ declare namespace gapi.client {
|
|
|
471
533
|
/** The select query used to extract the data. */
|
|
472
534
|
selectQuery?: string;
|
|
473
535
|
};
|
|
474
|
-
/** Databases to be exported. `MySQL instances:` If `fileType` is `SQL` and no database is specified, all databases are exported, except for the `mysql` system database. If `fileType` is `CSV`, you can specify one database, either by using this property or by using the `csvExportOptions.selectQuery` property, which takes precedence over this property. `PostgreSQL instances:`
|
|
536
|
+
/** Databases to be exported. `MySQL instances:` If `fileType` is `SQL` and no database is specified, all databases are exported, except for the `mysql` system database. If `fileType` is `CSV`, you can specify one database, either by using this property or by using the `csvExportOptions.selectQuery` property, which takes precedence over this property. `PostgreSQL instances:` If you don't specify a database by name, all user databases in the instance are exported. This excludes system databases and Cloud SQL databases used to manage internal operations. Exporting all user databases is only available for directory-formatted parallel export. If `fileType` is `CSV`, this database must match the one specified in the `csvExportOptions.selectQuery` property. `SQL Server instances:` You must specify one database to be exported, and the `fileType` must be `BAK`. */
|
|
475
537
|
databases?: string[];
|
|
476
538
|
/** The file type for the specified uri. */
|
|
477
539
|
fileType?: string;
|
|
@@ -533,6 +595,8 @@ declare namespace gapi.client {
|
|
|
533
595
|
allowedStringValues?: string[];
|
|
534
596
|
/** The database version this flag applies to. Can be MySQL instances: `MYSQL_8_0`, `MYSQL_8_0_18`, `MYSQL_8_0_26`, `MYSQL_5_7`, or `MYSQL_5_6`. PostgreSQL instances: `POSTGRES_9_6`, `POSTGRES_10`, `POSTGRES_11` or `POSTGRES_12`. SQL Server instances: `SQLSERVER_2017_STANDARD`, `SQLSERVER_2017_ENTERPRISE`, `SQLSERVER_2017_EXPRESS`, `SQLSERVER_2017_WEB`, `SQLSERVER_2019_STANDARD`, `SQLSERVER_2019_ENTERPRISE`, `SQLSERVER_2019_EXPRESS`, or `SQLSERVER_2019_WEB`. See [the complete list](/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). */
|
|
535
597
|
appliesTo?: string[];
|
|
598
|
+
/** Scope of flag. */
|
|
599
|
+
flagScope?: string;
|
|
536
600
|
/** Whether or not the flag is considered in beta. */
|
|
537
601
|
inBeta?: boolean;
|
|
538
602
|
/** This is always `sql#flag`. */
|
|
@@ -543,6 +607,10 @@ declare namespace gapi.client {
|
|
|
543
607
|
minValue?: string;
|
|
544
608
|
/** This is the name of the flag. Flag names always use underscores, not hyphens, for example: `max_allowed_packet` */
|
|
545
609
|
name?: string;
|
|
610
|
+
/** Recommended int value in integer format for UI display. */
|
|
611
|
+
recommendedIntValue?: string;
|
|
612
|
+
/** Recommended string value in string format for UI display. */
|
|
613
|
+
recommendedStringValue?: string;
|
|
546
614
|
/** Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances. */
|
|
547
615
|
requiresRestart?: boolean;
|
|
548
616
|
/** The type of the flag. Flags are typed to being `BOOLEAN`, `STRING`, `INTEGER` or `NONE`. `NONE` is used for flags that do not take a value, such as `skip_grant_tables`. */
|
|
@@ -623,7 +691,7 @@ declare namespace gapi.client {
|
|
|
623
691
|
/** The table to which CSV data is imported. */
|
|
624
692
|
table?: string;
|
|
625
693
|
};
|
|
626
|
-
/** The target database for the import. If `fileType` is `SQL`, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If `fileType` is `CSV`, one database must be specified. */
|
|
694
|
+
/** The target database for the import. If `fileType` is `SQL`, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. For entire instance parallel import operations, the database is overridden by the database name stored in subdirectory name. If `fileType` is `CSV`, one database must be specified. */
|
|
627
695
|
database?: string;
|
|
628
696
|
/** The file type for the specified uri.\`SQL`: The file contains SQL statements. \`CSV`: The file contains CSV data. */
|
|
629
697
|
fileType?: string;
|
|
@@ -743,7 +811,7 @@ declare namespace gapi.client {
|
|
|
743
811
|
backup?: string;
|
|
744
812
|
/** Parameters required to perform the restore backup operation. */
|
|
745
813
|
restoreBackupContext?: RestoreBackupContext;
|
|
746
|
-
/** Optional. By using this parameter, Cloud SQL overrides
|
|
814
|
+
/** 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. */
|
|
747
815
|
restoreInstanceSettings?: DatabaseInstance;
|
|
748
816
|
}
|
|
749
817
|
interface InstancesRotateServerCaRequest {
|
|
@@ -783,7 +851,7 @@ declare namespace gapi.client {
|
|
|
783
851
|
requireSsl?: boolean;
|
|
784
852
|
/** Specify what type of CA is used for the server certificate. */
|
|
785
853
|
serverCaMode?: string;
|
|
786
|
-
/** Optional. The resource name of the server CA pool for an instance with `CUSTOMER_MANAGED_CAS_CA` as the `server_ca_mode`. Format: projects
|
|
854
|
+
/** 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} */
|
|
787
855
|
serverCaPool?: string;
|
|
788
856
|
/** 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. */
|
|
789
857
|
sslMode?: string;
|
|
@@ -979,6 +1047,20 @@ declare namespace gapi.client {
|
|
|
979
1047
|
/** The target disk shrink size in GigaBytes. */
|
|
980
1048
|
targetSizeGb?: string;
|
|
981
1049
|
}
|
|
1050
|
+
interface PoolNodeConfig {
|
|
1051
|
+
/** Output only. The DNS name of the node. */
|
|
1052
|
+
dnsName?: string;
|
|
1053
|
+
/** Output only. The list of DNS names used by this node. */
|
|
1054
|
+
dnsNames?: DnsNameMapping[];
|
|
1055
|
+
/** Output only. The serving zone of the node. */
|
|
1056
|
+
gceZone?: string;
|
|
1057
|
+
/** Output only. Mappings containing IP addresses that can be used to connect to the node. */
|
|
1058
|
+
ipAddresses?: IpMapping[];
|
|
1059
|
+
/** Output only. The name of the node, to be used for retrieving metrics and logs for the node. */
|
|
1060
|
+
name?: string;
|
|
1061
|
+
/** Output only. The current state of the node. */
|
|
1062
|
+
state?: string;
|
|
1063
|
+
}
|
|
982
1064
|
interface PscAutoConnectionConfig {
|
|
983
1065
|
/** The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. */
|
|
984
1066
|
consumerNetwork?: string;
|
|
@@ -1064,6 +1146,8 @@ declare namespace gapi.client {
|
|
|
1064
1146
|
backupConfiguration?: BackupConfiguration;
|
|
1065
1147
|
/** The name of server Instance collation. */
|
|
1066
1148
|
collation?: string;
|
|
1149
|
+
/** Optional. The managed connection pooling configuration for the instance. */
|
|
1150
|
+
connectionPoolConfig?: ConnectionPoolConfig;
|
|
1067
1151
|
/** Specifies if connections must use Cloud SQL connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL instances can be connected without Cloud SQL Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL Connectors). Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance. */
|
|
1068
1152
|
connectorEnforcement?: string;
|
|
1069
1153
|
/** 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. */
|
|
@@ -1074,6 +1158,10 @@ declare namespace gapi.client {
|
|
|
1074
1158
|
databaseReplicationEnabled?: boolean;
|
|
1075
1159
|
/** Configuration for data cache. */
|
|
1076
1160
|
dataCacheConfig?: DataCacheConfig;
|
|
1161
|
+
/** Optional. Provisioned number of I/O operations per second for the data disk. This field is only used for hyperdisk-balanced disk types. */
|
|
1162
|
+
dataDiskProvisionedIops?: string;
|
|
1163
|
+
/** Optional. Provisioned throughput measured in MiB per second for the data disk. This field is only used for hyperdisk-balanced disk types. */
|
|
1164
|
+
dataDiskProvisionedThroughput?: string;
|
|
1077
1165
|
/** The size of data disk, in GB. The data disk size minimum is 10GB. */
|
|
1078
1166
|
dataDiskSizeGb?: string;
|
|
1079
1167
|
/** The type of data disk: `PD_SSD` (default) or `PD_HDD`. Not used for First Generation instances. */
|
|
@@ -1106,6 +1194,8 @@ declare namespace gapi.client {
|
|
|
1106
1194
|
replicationLagMaxSeconds?: number;
|
|
1107
1195
|
/** The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances. */
|
|
1108
1196
|
replicationType?: string;
|
|
1197
|
+
/** Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting. */
|
|
1198
|
+
retainBackupsOnDelete?: boolean;
|
|
1109
1199
|
/** The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value. */
|
|
1110
1200
|
settingsVersion?: string;
|
|
1111
1201
|
/** SQL Server specific audit configuration. */
|
|
@@ -1648,7 +1738,7 @@ declare namespace gapi.client {
|
|
|
1648
1738
|
callback?: string;
|
|
1649
1739
|
/** Selector specifying which fields to include in a partial response. */
|
|
1650
1740
|
fields?: string;
|
|
1651
|
-
/** Multiple filter queries are separated by spaces. For example, 'instance:abc type:FINAL. You can filter by type, instance
|
|
1741
|
+
/** Multiple filter queries are separated by spaces. For example, 'instance:abc AND type:FINAL, 'location:us', 'backupInterval.startTime>=1950-01-01T01:01:25.771Z'. You can filter by type, instance, backupInterval.startTime (creation time), or location. */
|
|
1652
1742
|
filter?: string;
|
|
1653
1743
|
/** 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. */
|
|
1654
1744
|
key?: string;
|
|
@@ -2129,6 +2219,8 @@ declare namespace gapi.client {
|
|
|
2129
2219
|
databaseVersion?: string;
|
|
2130
2220
|
/** Selector specifying which fields to include in a partial response. */
|
|
2131
2221
|
fields?: string;
|
|
2222
|
+
/** Optional. Specify the scope of flags to be returned by SqlFlagsListService. Return list of database flags if unspecified. */
|
|
2223
|
+
flagScope?: string;
|
|
2132
2224
|
/** 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. */
|
|
2133
2225
|
key?: string;
|
|
2134
2226
|
/** OAuth 2.0 token for the current user. */
|