@maxim_mazurok/gapi.client.sqladmin-v1beta4 0.1.20250904 → 0.1.20250915
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 +123 -3
- package/package.json +1 -1
- package/readme.md +10 -2
package/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/* Type definitions for non-npm package Cloud SQL Admin API v1beta4 0.0 */
|
|
2
|
-
// Project: https://
|
|
2
|
+
// Project: https://cloud.google.com/sql/docs
|
|
3
3
|
// Definitions by: Maxim Mazurok <https://github.com/Maxim-Mazurok>
|
|
4
4
|
// Nick Amoscato <https://github.com/namoscato>
|
|
5
5
|
// Declan Vong <https://github.com/declanvong>
|
|
@@ -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: 20250915
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -829,6 +829,10 @@ declare namespace gapi.client {
|
|
|
829
829
|
/** List of server certificates for the instance, signed by the corresponding CA from the `ca_certs` list. */
|
|
830
830
|
serverCerts?: SslCert[];
|
|
831
831
|
}
|
|
832
|
+
interface InstancesPreCheckMajorVersionUpgradeRequest {
|
|
833
|
+
/** Required. Contains details about the pre-check major version upgrade operation. */
|
|
834
|
+
preCheckMajorVersionUpgradeContext?: PreCheckMajorVersionUpgradeContext;
|
|
835
|
+
}
|
|
832
836
|
interface InstancesReencryptRequest {
|
|
833
837
|
/** Configuration specific to backup re-encryption */
|
|
834
838
|
backupReencryptionConfig?: BackupReencryptionConfig;
|
|
@@ -923,6 +927,12 @@ declare namespace gapi.client {
|
|
|
923
927
|
/** Maintenance timing settings: `canary`, `stable`, or `week5`. For more information, see [About maintenance on Cloud SQL instances](https://cloud.google.com/sql/docs/mysql/maintenance). */
|
|
924
928
|
updateTrack?: string;
|
|
925
929
|
}
|
|
930
|
+
interface Message {
|
|
931
|
+
/** The full message string. For PostgreSQL, this is a formatted string that may include severity, code, and the notice/warning message. For MySQL, this contains the warning message. */
|
|
932
|
+
message?: string;
|
|
933
|
+
/** The severity of the message (e.g., "NOTICE" for PostgreSQL, "WARNING" for MySQL). */
|
|
934
|
+
severity?: string;
|
|
935
|
+
}
|
|
926
936
|
interface Metadata {
|
|
927
937
|
/** The time taken to execute the SQL statements. */
|
|
928
938
|
sqlStatementExecutionTime?: string;
|
|
@@ -1002,6 +1012,8 @@ declare namespace gapi.client {
|
|
|
1002
1012
|
name?: string;
|
|
1003
1013
|
/** The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE` */
|
|
1004
1014
|
operationType?: string;
|
|
1015
|
+
/** The context for pre-check major version upgrade operation, if applicable. This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found). */
|
|
1016
|
+
preCheckMajorVersionUpgradeContext?: PreCheckMajorVersionUpgradeContext;
|
|
1005
1017
|
/** The URI of this resource. */
|
|
1006
1018
|
selfLink?: string;
|
|
1007
1019
|
/** The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. */
|
|
@@ -1112,6 +1124,22 @@ declare namespace gapi.client {
|
|
|
1112
1124
|
/** Output only. The current state of the read pool node. */
|
|
1113
1125
|
state?: string;
|
|
1114
1126
|
}
|
|
1127
|
+
interface PreCheckMajorVersionUpgradeContext {
|
|
1128
|
+
/** Optional. This is always `sql#preCheckMajorVersionUpgradeContext`. */
|
|
1129
|
+
kind?: string;
|
|
1130
|
+
/** Output only. The responses from the precheck operation. */
|
|
1131
|
+
preCheckResponse?: PreCheckResponse[];
|
|
1132
|
+
/** Required. The target database version to upgrade to. */
|
|
1133
|
+
targetDatabaseVersion?: string;
|
|
1134
|
+
}
|
|
1135
|
+
interface PreCheckResponse {
|
|
1136
|
+
/** The actions that the user needs to take. Use repeated for multiple actions. */
|
|
1137
|
+
actionsRequired?: string[];
|
|
1138
|
+
/** The message to be displayed to the user. */
|
|
1139
|
+
message?: string;
|
|
1140
|
+
/** The type of message whether it is an info, warning, or error. */
|
|
1141
|
+
messageType?: string;
|
|
1142
|
+
}
|
|
1115
1143
|
interface PscAutoConnectionConfig {
|
|
1116
1144
|
/** Optional. 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. */
|
|
1117
1145
|
consumerNetwork?: string;
|
|
@@ -1144,6 +1172,22 @@ declare namespace gapi.client {
|
|
|
1144
1172
|
/** Rows returned by the SQL statement. */
|
|
1145
1173
|
rows?: Row[];
|
|
1146
1174
|
}
|
|
1175
|
+
interface ReadPoolAutoScaleConfig {
|
|
1176
|
+
/** Indicates whether read pool auto scaling supports scale in operations (removing nodes). */
|
|
1177
|
+
disableScaleIn?: boolean;
|
|
1178
|
+
/** Indicates whether read pool auto scaling is enabled. */
|
|
1179
|
+
enabled?: boolean;
|
|
1180
|
+
/** Maximum number of read pool nodes to be maintained. */
|
|
1181
|
+
maxNodeCount?: number;
|
|
1182
|
+
/** Minimum number of read pool nodes to be maintained. */
|
|
1183
|
+
minNodeCount?: number;
|
|
1184
|
+
/** The cooldown period for scale in operations. */
|
|
1185
|
+
scaleInCooldownSeconds?: number;
|
|
1186
|
+
/** The cooldown period for scale out operations. */
|
|
1187
|
+
scaleOutCooldownSeconds?: number;
|
|
1188
|
+
/** Optional. Target metrics for read pool auto scaling. */
|
|
1189
|
+
targetMetrics?: TargetMetric[];
|
|
1190
|
+
}
|
|
1147
1191
|
interface ReplicaConfiguration {
|
|
1148
1192
|
/** Optional. Specifies if a SQL Server replica is a cascadable replica. A cascadable replica is a SQL Server cross region replica that supports replica(s) under it. */
|
|
1149
1193
|
cascadableReplica?: boolean;
|
|
@@ -1259,6 +1303,8 @@ declare namespace gapi.client {
|
|
|
1259
1303
|
passwordValidationPolicy?: PasswordValidationPolicy;
|
|
1260
1304
|
/** The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances. */
|
|
1261
1305
|
pricingPlan?: string;
|
|
1306
|
+
/** Optional. The read pool auto-scale configuration for the instance. */
|
|
1307
|
+
readPoolAutoScaleConfig?: ReadPoolAutoScaleConfig;
|
|
1262
1308
|
/** Optional. Configuration value for recreation of replica after certain replication lag. */
|
|
1263
1309
|
replicationLagMaxSeconds?: number;
|
|
1264
1310
|
/** The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances. */
|
|
@@ -1307,6 +1353,8 @@ declare namespace gapi.client {
|
|
|
1307
1353
|
operationId?: string;
|
|
1308
1354
|
}
|
|
1309
1355
|
interface SqlInstancesExecuteSqlResponse {
|
|
1356
|
+
/** A list of notices and warnings generated during query execution. For PostgreSQL, this includes all notices and warnings. For MySQL, this includes warnings generated by the last executed statement. To retrieve all warnings for a multi-statement query, `SHOW WARNINGS` must be executed after each statement. */
|
|
1357
|
+
messages?: Message[];
|
|
1310
1358
|
/** The additional metadata information regarding the execution of the SQL statements. */
|
|
1311
1359
|
metadata?: Metadata;
|
|
1312
1360
|
/** The list of results after executing all the SQL statements. */
|
|
@@ -1474,6 +1522,12 @@ declare namespace gapi.client {
|
|
|
1474
1522
|
/** The value of the flag. This field must be omitted if the flag doesn't take a value. */
|
|
1475
1523
|
value?: string;
|
|
1476
1524
|
}
|
|
1525
|
+
interface TargetMetric {
|
|
1526
|
+
/** The metric name to be used for auto scaling. */
|
|
1527
|
+
metric?: string;
|
|
1528
|
+
/** The target value for the metric. */
|
|
1529
|
+
targetValue?: number;
|
|
1530
|
+
}
|
|
1477
1531
|
interface Tier {
|
|
1478
1532
|
/** The maximum disk size of this tier in bytes. */
|
|
1479
1533
|
DiskQuota?: string;
|
|
@@ -1505,6 +1559,8 @@ declare namespace gapi.client {
|
|
|
1505
1559
|
etag?: string;
|
|
1506
1560
|
/** Optional. The host from which the user can connect. For `insert` operations, host defaults to an empty string. For `update` operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional. */
|
|
1507
1561
|
host?: string;
|
|
1562
|
+
/** Indicates if a group is active or inactive for IAM database authentication. */
|
|
1563
|
+
iamStatus?: string;
|
|
1508
1564
|
/** The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for *update* because it is already specified on the URL. */
|
|
1509
1565
|
instance?: string;
|
|
1510
1566
|
/** This is always `sql#user`. */
|
|
@@ -3218,6 +3274,68 @@ declare namespace gapi.client {
|
|
|
3218
3274
|
},
|
|
3219
3275
|
body: PointInTimeRestoreContext,
|
|
3220
3276
|
): Request<Operation>;
|
|
3277
|
+
/** Execute MVU Pre-checks */
|
|
3278
|
+
preCheckMajorVersionUpgrade(request: {
|
|
3279
|
+
/** V1 error format. */
|
|
3280
|
+
'$.xgafv'?: string;
|
|
3281
|
+
/** OAuth access token. */
|
|
3282
|
+
access_token?: string;
|
|
3283
|
+
/** Data format for response. */
|
|
3284
|
+
alt?: string;
|
|
3285
|
+
/** JSONP */
|
|
3286
|
+
callback?: string;
|
|
3287
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3288
|
+
fields?: string;
|
|
3289
|
+
/** Required. Cloud SQL instance ID. This does not include the project ID. */
|
|
3290
|
+
instance: string;
|
|
3291
|
+
/** 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. */
|
|
3292
|
+
key?: string;
|
|
3293
|
+
/** OAuth 2.0 token for the current user. */
|
|
3294
|
+
oauth_token?: string;
|
|
3295
|
+
/** Returns response with indentations and line breaks. */
|
|
3296
|
+
prettyPrint?: boolean;
|
|
3297
|
+
/** Required. Project ID of the project that contains the instance. */
|
|
3298
|
+
project: string;
|
|
3299
|
+
/** 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. */
|
|
3300
|
+
quotaUser?: string;
|
|
3301
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3302
|
+
upload_protocol?: string;
|
|
3303
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3304
|
+
uploadType?: string;
|
|
3305
|
+
/** Request body */
|
|
3306
|
+
resource: InstancesPreCheckMajorVersionUpgradeRequest;
|
|
3307
|
+
}): Request<Operation>;
|
|
3308
|
+
preCheckMajorVersionUpgrade(
|
|
3309
|
+
request: {
|
|
3310
|
+
/** V1 error format. */
|
|
3311
|
+
'$.xgafv'?: string;
|
|
3312
|
+
/** OAuth access token. */
|
|
3313
|
+
access_token?: string;
|
|
3314
|
+
/** Data format for response. */
|
|
3315
|
+
alt?: string;
|
|
3316
|
+
/** JSONP */
|
|
3317
|
+
callback?: string;
|
|
3318
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3319
|
+
fields?: string;
|
|
3320
|
+
/** Required. Cloud SQL instance ID. This does not include the project ID. */
|
|
3321
|
+
instance: string;
|
|
3322
|
+
/** 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. */
|
|
3323
|
+
key?: string;
|
|
3324
|
+
/** OAuth 2.0 token for the current user. */
|
|
3325
|
+
oauth_token?: string;
|
|
3326
|
+
/** Returns response with indentations and line breaks. */
|
|
3327
|
+
prettyPrint?: boolean;
|
|
3328
|
+
/** Required. Project ID of the project that contains the instance. */
|
|
3329
|
+
project: string;
|
|
3330
|
+
/** 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. */
|
|
3331
|
+
quotaUser?: string;
|
|
3332
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3333
|
+
upload_protocol?: string;
|
|
3334
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3335
|
+
uploadType?: string;
|
|
3336
|
+
},
|
|
3337
|
+
body: InstancesPreCheckMajorVersionUpgradeRequest,
|
|
3338
|
+
): Request<Operation>;
|
|
3221
3339
|
/** Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart. */
|
|
3222
3340
|
promoteReplica(request?: {
|
|
3223
3341
|
/** V1 error format. */
|
|
@@ -3356,6 +3474,8 @@ declare namespace gapi.client {
|
|
|
3356
3474
|
instance: string;
|
|
3357
3475
|
/** 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. */
|
|
3358
3476
|
key?: string;
|
|
3477
|
+
/** Optional. Reset SSL mode to use. */
|
|
3478
|
+
mode?: string;
|
|
3359
3479
|
/** OAuth 2.0 token for the current user. */
|
|
3360
3480
|
oauth_token?: string;
|
|
3361
3481
|
/** Returns response with indentations and line breaks. */
|
|
@@ -3799,7 +3919,7 @@ declare namespace gapi.client {
|
|
|
3799
3919
|
): Request<Operation>;
|
|
3800
3920
|
}
|
|
3801
3921
|
interface OperationsResource {
|
|
3802
|
-
/** Cancels an instance operation that has been performed on an instance. */
|
|
3922
|
+
/** Cancels an instance operation that has been performed on an instance. Ordinarily, this method name should be `CancelSqlOperation`. */
|
|
3803
3923
|
cancel(request?: {
|
|
3804
3924
|
/** V1 error format. */
|
|
3805
3925
|
'$.xgafv'?: string;
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# TypeScript typings for Cloud SQL Admin API v1beta4
|
|
2
2
|
|
|
3
3
|
API for Cloud SQL database instance management
|
|
4
|
-
For detailed description please check [documentation](https://
|
|
4
|
+
For detailed description please check [documentation](https://cloud.google.com/sql/docs).
|
|
5
5
|
|
|
6
6
|
## Installing
|
|
7
7
|
|
|
@@ -333,6 +333,14 @@ Point in time restore for an instance managed by Google Cloud Backup and Disaste
|
|
|
333
333
|
*/
|
|
334
334
|
await gapi.client.sql.instances.pointInTimeRestore({parent: 'parent'});
|
|
335
335
|
|
|
336
|
+
/*
|
|
337
|
+
Execute MVU Pre-checks
|
|
338
|
+
*/
|
|
339
|
+
await gapi.client.sql.instances.preCheckMajorVersionUpgrade({
|
|
340
|
+
instance: 'instance',
|
|
341
|
+
project: 'project',
|
|
342
|
+
});
|
|
343
|
+
|
|
336
344
|
/*
|
|
337
345
|
Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart.
|
|
338
346
|
*/
|
|
@@ -438,7 +446,7 @@ await gapi.client.sql.instances.update({
|
|
|
438
446
|
});
|
|
439
447
|
|
|
440
448
|
/*
|
|
441
|
-
Cancels an instance operation that has been performed on an instance.
|
|
449
|
+
Cancels an instance operation that has been performed on an instance. Ordinarily, this method name should be `CancelSqlOperation`.
|
|
442
450
|
*/
|
|
443
451
|
await gapi.client.sql.operations.cancel({
|
|
444
452
|
operation: 'operation',
|