@maxim_mazurok/gapi.client.sqladmin-v1beta4 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=v1beta4
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20250310
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -75,6 +75,8 @@ 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 when this backup was made. */
|
|
79
|
+
databaseVersion?: string;
|
|
78
80
|
/** The description of this backup. */
|
|
79
81
|
description?: string;
|
|
80
82
|
/** Output only. Information about why the backup operation fails (for example, when the backup state fails). */
|
|
@@ -83,6 +85,10 @@ declare namespace gapi.client {
|
|
|
83
85
|
expiryTime?: string;
|
|
84
86
|
/** The name of the database instance. */
|
|
85
87
|
instance?: string;
|
|
88
|
+
/** Optional. Output only. Timestamp in UTC of when the instance associated with this backup is deleted. */
|
|
89
|
+
instanceDeletionTime?: string;
|
|
90
|
+
/** Optional. Output only. Instance setting of the source instance that's associated with this backup. */
|
|
91
|
+
instanceSettings?: DatabaseInstance;
|
|
86
92
|
/** Output only. This is always `sql#backup`. */
|
|
87
93
|
kind?: string;
|
|
88
94
|
/** Output only. This output contains the encryption configuration for a backup and the resource name of the KMS key for disk encryption. */
|
|
@@ -105,7 +111,7 @@ declare namespace gapi.client {
|
|
|
105
111
|
state?: string;
|
|
106
112
|
/** 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. */
|
|
107
113
|
timeZone?: string;
|
|
108
|
-
/** Input only. The time-to-live (TTL) interval for this resource (in days). For example: ttlDays:7 means 7 days. */
|
|
114
|
+
/** 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. */
|
|
109
115
|
ttlDays?: string;
|
|
110
116
|
/** Output only. The type of this backup. The type can be "AUTOMATED", "ON_DEMAND", or “FINAL”. */
|
|
111
117
|
type?: string;
|
|
@@ -155,6 +161,8 @@ declare namespace gapi.client {
|
|
|
155
161
|
interface BackupRun {
|
|
156
162
|
/** Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT. */
|
|
157
163
|
backupKind?: string;
|
|
164
|
+
/** Output only. The instance database version when this backup was made. */
|
|
165
|
+
databaseVersion?: string;
|
|
158
166
|
/** The description of this run, only applicable to on-demand backups. */
|
|
159
167
|
description?: string;
|
|
160
168
|
/** Encryption configuration specific to a backup. */
|
|
@@ -226,6 +234,40 @@ declare namespace gapi.client {
|
|
|
226
234
|
/** 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. */
|
|
227
235
|
preferredZone?: string;
|
|
228
236
|
}
|
|
237
|
+
interface ConnectionPoolConfig {
|
|
238
|
+
/** Client idle timeout. */
|
|
239
|
+
clientConnectionIdleTimeout?: string;
|
|
240
|
+
/** Whether managed connection pooling is enabled. */
|
|
241
|
+
connectionPoolingEnabled?: boolean;
|
|
242
|
+
/** Managed connection pool size. */
|
|
243
|
+
connPoolSize?: number;
|
|
244
|
+
/** Optional. List of connection pool configuration flags */
|
|
245
|
+
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
|
+
}
|
|
255
|
+
interface ConnectionPoolFlags {
|
|
256
|
+
/** Required. The name of the flag. */
|
|
257
|
+
name?: string;
|
|
258
|
+
/** 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. */
|
|
259
|
+
value?: string;
|
|
260
|
+
}
|
|
261
|
+
interface ConnectPoolNodeConfig {
|
|
262
|
+
/** Output only. The DNS name of the node. */
|
|
263
|
+
dnsName?: string;
|
|
264
|
+
/** Output only. The list of DNS names used by this instance. */
|
|
265
|
+
dnsNames?: DnsNameMapping[];
|
|
266
|
+
/** Output only. Mappings containing IP addresses that can be used to connect to the node. */
|
|
267
|
+
ipAddresses?: IpMapping[];
|
|
268
|
+
/** Output only. The name of the node. Doesn't include the project ID. */
|
|
269
|
+
name?: string;
|
|
270
|
+
}
|
|
229
271
|
interface ConnectSettings {
|
|
230
272
|
/** `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. */
|
|
231
273
|
backendType?: string;
|
|
@@ -235,10 +277,16 @@ declare namespace gapi.client {
|
|
|
235
277
|
databaseVersion?: string;
|
|
236
278
|
/** The dns name of the instance. */
|
|
237
279
|
dnsName?: string;
|
|
280
|
+
/** Output only. The list of DNS names used by this instance. */
|
|
281
|
+
dnsNames?: DnsNameMapping[];
|
|
238
282
|
/** The assigned IP addresses for the instance. */
|
|
239
283
|
ipAddresses?: IpMapping[];
|
|
240
284
|
/** This is always `sql#connectSettings`. */
|
|
241
285
|
kind?: string;
|
|
286
|
+
/** The number of nodes in a read pool. */
|
|
287
|
+
nodeCount?: number;
|
|
288
|
+
/** Output only. Entries containing information about each node of the read pool. */
|
|
289
|
+
nodes?: ConnectPoolNodeConfig[];
|
|
242
290
|
/** Whether PSC connectivity is enabled for this instance. */
|
|
243
291
|
pscEnabled?: boolean;
|
|
244
292
|
/** The cloud region for the instance. e.g. `us-central1`, `europe-west1`. The region cannot be changed after instance creation. */
|
|
@@ -294,6 +342,8 @@ declare namespace gapi.client {
|
|
|
294
342
|
diskEncryptionStatus?: DiskEncryptionStatus;
|
|
295
343
|
/** Output only. The dns name of the instance. */
|
|
296
344
|
dnsName?: string;
|
|
345
|
+
/** Output only. The list of DNS names used by this instance. */
|
|
346
|
+
dnsNames?: DnsNameMapping[];
|
|
297
347
|
/** This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead. */
|
|
298
348
|
etag?: string;
|
|
299
349
|
/** The name and status of the failover replica. */
|
|
@@ -325,6 +375,10 @@ declare namespace gapi.client {
|
|
|
325
375
|
maxDiskSize?: string;
|
|
326
376
|
/** Name of the Cloud SQL instance. This does not include the project ID. */
|
|
327
377
|
name?: string;
|
|
378
|
+
/** The number of nodes in a read pool. */
|
|
379
|
+
nodeCount?: number;
|
|
380
|
+
/** Output only. Entries containing information about each node of the read pool. */
|
|
381
|
+
nodes?: PoolNodeConfig[];
|
|
328
382
|
/** Configuration specific to on-premises instances. */
|
|
329
383
|
onPremisesConfiguration?: OnPremisesConfiguration;
|
|
330
384
|
/** 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 */
|
|
@@ -444,6 +498,14 @@ declare namespace gapi.client {
|
|
|
444
498
|
/** KMS key version used to encrypt the Cloud SQL instance resource */
|
|
445
499
|
kmsKeyVersionName?: string;
|
|
446
500
|
}
|
|
501
|
+
interface DnsNameMapping {
|
|
502
|
+
/** Output only. The connection type of the DNS name. */
|
|
503
|
+
connectionType?: string;
|
|
504
|
+
/** Output only. The scope that the DNS name applies to. */
|
|
505
|
+
dnsScope?: string;
|
|
506
|
+
/** The DNS name. */
|
|
507
|
+
name?: string;
|
|
508
|
+
}
|
|
447
509
|
interface Empty {}
|
|
448
510
|
interface ExportContext {
|
|
449
511
|
/** Options for exporting BAK files (SQL Server-only) */
|
|
@@ -476,7 +538,7 @@ declare namespace gapi.client {
|
|
|
476
538
|
/** The select query used to extract the data. */
|
|
477
539
|
selectQuery?: string;
|
|
478
540
|
};
|
|
479
|
-
/** 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:`
|
|
541
|
+
/** 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`. */
|
|
480
542
|
databases?: string[];
|
|
481
543
|
/** The file type for the specified uri. */
|
|
482
544
|
fileType?: string;
|
|
@@ -538,6 +600,8 @@ declare namespace gapi.client {
|
|
|
538
600
|
allowedStringValues?: string[];
|
|
539
601
|
/** 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). */
|
|
540
602
|
appliesTo?: string[];
|
|
603
|
+
/** Scope of flag. */
|
|
604
|
+
flagScope?: string;
|
|
541
605
|
/** Whether or not the flag is considered in beta. */
|
|
542
606
|
inBeta?: boolean;
|
|
543
607
|
/** This is always `sql#flag`. */
|
|
@@ -548,6 +612,10 @@ declare namespace gapi.client {
|
|
|
548
612
|
minValue?: string;
|
|
549
613
|
/** This is the name of the flag. Flag names always use underscores, not hyphens, for example: `max_allowed_packet` */
|
|
550
614
|
name?: string;
|
|
615
|
+
/** Recommended flag value in integer format for UI display. */
|
|
616
|
+
recommendedIntValue?: string;
|
|
617
|
+
/** Recommended flag value in string format for UI display. */
|
|
618
|
+
recommendedStringValue?: string;
|
|
551
619
|
/** Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances. */
|
|
552
620
|
requiresRestart?: boolean;
|
|
553
621
|
/** The type of the flag. Flags are typed to being `BOOLEAN`, `STRING`, `INTEGER` or `NONE`. `NONE` is used for flags which do not take a value, such as `skip_grant_tables`. */
|
|
@@ -628,7 +696,7 @@ declare namespace gapi.client {
|
|
|
628
696
|
/** The table to which CSV data is imported. */
|
|
629
697
|
table?: string;
|
|
630
698
|
};
|
|
631
|
-
/** 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. */
|
|
699
|
+
/** 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. */
|
|
632
700
|
database?: string;
|
|
633
701
|
/** The file type for the specified uri. * `SQL`: The file contains SQL statements. * `CSV`: The file contains CSV data. * `BAK`: The file contains backup data for a SQL Server instance. */
|
|
634
702
|
fileType?: string;
|
|
@@ -748,7 +816,7 @@ declare namespace gapi.client {
|
|
|
748
816
|
backup?: string;
|
|
749
817
|
/** Parameters required to perform the restore backup operation. */
|
|
750
818
|
restoreBackupContext?: RestoreBackupContext;
|
|
751
|
-
/** Optional. By using this parameter, Cloud SQL overrides any instance settings
|
|
819
|
+
/** 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. */
|
|
752
820
|
restoreInstanceSettings?: DatabaseInstance;
|
|
753
821
|
}
|
|
754
822
|
interface InstancesRotateServerCaRequest {
|
|
@@ -788,7 +856,7 @@ declare namespace gapi.client {
|
|
|
788
856
|
requireSsl?: boolean;
|
|
789
857
|
/** Specify what type of CA is used for the server certificate. */
|
|
790
858
|
serverCaMode?: string;
|
|
791
|
-
/** Optional. The resource name of the server CA pool for an instance with `CUSTOMER_MANAGED_CAS_CA` as the `server_ca_mode`. Format: projects
|
|
859
|
+
/** 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} */
|
|
792
860
|
serverCaPool?: string;
|
|
793
861
|
/** 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. */
|
|
794
862
|
sslMode?: string;
|
|
@@ -984,6 +1052,20 @@ declare namespace gapi.client {
|
|
|
984
1052
|
/** The target disk shrink size in GigaBytes. */
|
|
985
1053
|
targetSizeGb?: string;
|
|
986
1054
|
}
|
|
1055
|
+
interface PoolNodeConfig {
|
|
1056
|
+
/** Output only. The DNS name of the node. */
|
|
1057
|
+
dnsName?: string;
|
|
1058
|
+
/** Output only. The list of DNS names used by this node. */
|
|
1059
|
+
dnsNames?: DnsNameMapping[];
|
|
1060
|
+
/** Output only. The serving zone of the node. */
|
|
1061
|
+
gceZone?: string;
|
|
1062
|
+
/** Output only. Mappings containing IP addresses that can be used to connect to the node. */
|
|
1063
|
+
ipAddresses?: IpMapping[];
|
|
1064
|
+
/** Output only. The name of the node, to be used for retrieving metrics and logs for the node. */
|
|
1065
|
+
name?: string;
|
|
1066
|
+
/** Output only. The current state of the node. */
|
|
1067
|
+
state?: string;
|
|
1068
|
+
}
|
|
987
1069
|
interface PscAutoConnectionConfig {
|
|
988
1070
|
/** 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. */
|
|
989
1071
|
consumerNetwork?: string;
|
|
@@ -1069,6 +1151,8 @@ declare namespace gapi.client {
|
|
|
1069
1151
|
backupConfiguration?: BackupConfiguration;
|
|
1070
1152
|
/** The name of server Instance collation. */
|
|
1071
1153
|
collation?: string;
|
|
1154
|
+
/** Optional. The managed connection pooling configuration for the instance. */
|
|
1155
|
+
connectionPoolConfig?: ConnectionPoolConfig;
|
|
1072
1156
|
/** 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. */
|
|
1073
1157
|
connectorEnforcement?: string;
|
|
1074
1158
|
/** 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. */
|
|
@@ -1079,6 +1163,10 @@ declare namespace gapi.client {
|
|
|
1079
1163
|
databaseReplicationEnabled?: boolean;
|
|
1080
1164
|
/** Configuration for data cache. */
|
|
1081
1165
|
dataCacheConfig?: DataCacheConfig;
|
|
1166
|
+
/** Optional. Provisioned number of I/O operations per second for the data disk. This field is only used for hyperdisk-balanced disk types. */
|
|
1167
|
+
dataDiskProvisionedIops?: string;
|
|
1168
|
+
/** Optional. Provisioned throughput measured in MiB per second for the data disk. This field is only used for hyperdisk-balanced disk types. */
|
|
1169
|
+
dataDiskProvisionedThroughput?: string;
|
|
1082
1170
|
/** The size of data disk, in GB. The data disk size minimum is 10GB. */
|
|
1083
1171
|
dataDiskSizeGb?: string;
|
|
1084
1172
|
/** The type of data disk: `PD_SSD` (default) or `PD_HDD`. Not used for First Generation instances. */
|
|
@@ -1111,6 +1199,8 @@ declare namespace gapi.client {
|
|
|
1111
1199
|
replicationLagMaxSeconds?: number;
|
|
1112
1200
|
/** The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances. */
|
|
1113
1201
|
replicationType?: string;
|
|
1202
|
+
/** 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. */
|
|
1203
|
+
retainBackupsOnDelete?: boolean;
|
|
1114
1204
|
/** 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. */
|
|
1115
1205
|
settingsVersion?: string;
|
|
1116
1206
|
/** SQL Server specific audit configuration. */
|
|
@@ -1653,7 +1743,7 @@ declare namespace gapi.client {
|
|
|
1653
1743
|
callback?: string;
|
|
1654
1744
|
/** Selector specifying which fields to include in a partial response. */
|
|
1655
1745
|
fields?: string;
|
|
1656
|
-
/** Multiple filter queries are separated by spaces. For example, 'instance:abc type:FINAL. You can filter by type, instance
|
|
1746
|
+
/** 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. */
|
|
1657
1747
|
filter?: string;
|
|
1658
1748
|
/** 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. */
|
|
1659
1749
|
key?: string;
|
|
@@ -2134,6 +2224,8 @@ declare namespace gapi.client {
|
|
|
2134
2224
|
databaseVersion?: string;
|
|
2135
2225
|
/** Selector specifying which fields to include in a partial response. */
|
|
2136
2226
|
fields?: string;
|
|
2227
|
+
/** Optional. Specify the scope of flags to be returned by SqlFlagsListService. Return list of database flags if unspecified. */
|
|
2228
|
+
flagScope?: string;
|
|
2137
2229
|
/** 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. */
|
|
2138
2230
|
key?: string;
|
|
2139
2231
|
/** OAuth 2.0 token for the current user. */
|