@maxim_mazurok/gapi.client.sqladmin-v1beta4 0.0.20250717 → 0.1.20250807
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 +138 -4
- package/package.json +1 -1
- package/readme.md +10 -0
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: 20250807
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -235,12 +235,22 @@ declare namespace gapi.client {
|
|
|
235
235
|
preferredSecondaryZone?: string;
|
|
236
236
|
/** 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. */
|
|
237
237
|
preferredZone?: string;
|
|
238
|
+
/** The timestamp used to identify the time when the source instance is deleted. If this instance is deleted, then you must set the timestamp. */
|
|
239
|
+
sourceInstanceDeletionTime?: string;
|
|
240
|
+
}
|
|
241
|
+
interface Column {
|
|
242
|
+
/** Name of the column. */
|
|
243
|
+
name?: string;
|
|
244
|
+
/** Datatype of the column. */
|
|
245
|
+
type?: string;
|
|
238
246
|
}
|
|
239
247
|
interface ConnectionPoolConfig {
|
|
240
248
|
/** Whether managed connection pooling is enabled. */
|
|
241
249
|
connectionPoolingEnabled?: boolean;
|
|
242
250
|
/** Optional. List of connection pool configuration flags. */
|
|
243
251
|
flags?: ConnectionPoolFlags[];
|
|
252
|
+
/** Output only. Number of connection poolers. */
|
|
253
|
+
poolerCount?: number;
|
|
244
254
|
}
|
|
245
255
|
interface ConnectionPoolFlags {
|
|
246
256
|
/** Required. The name of the flag. */
|
|
@@ -273,6 +283,8 @@ declare namespace gapi.client {
|
|
|
273
283
|
ipAddresses?: IpMapping[];
|
|
274
284
|
/** This is always `sql#connectSettings`. */
|
|
275
285
|
kind?: string;
|
|
286
|
+
/** Optional. Output only. mdx_protocol_support controls how the client uses metadata exchange when connecting to the instance. The values in the list representing parts of the MDX protocol that are supported by this instance. When the list is empty, the instance does not support MDX, so the client must not send an MDX request. The default is empty. */
|
|
287
|
+
mdxProtocolSupport?: string[];
|
|
276
288
|
/** The number of read pool nodes in a read pool. */
|
|
277
289
|
nodeCount?: number;
|
|
278
290
|
/** Output only. Entries containing information about each read pool node of the read pool. */
|
|
@@ -316,8 +328,6 @@ declare namespace gapi.client {
|
|
|
316
328
|
availableMaintenanceVersions?: string[];
|
|
317
329
|
/** The backend type. `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. */
|
|
318
330
|
backendType?: string;
|
|
319
|
-
/** Clears private network settings when the instance is restored. */
|
|
320
|
-
clearNetwork?: boolean;
|
|
321
331
|
/** Connection name of the Cloud SQL instance used in connection strings. */
|
|
322
332
|
connectionName?: string;
|
|
323
333
|
/** Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. */
|
|
@@ -499,6 +509,16 @@ declare namespace gapi.client {
|
|
|
499
509
|
name?: string;
|
|
500
510
|
}
|
|
501
511
|
interface Empty {}
|
|
512
|
+
interface ExecuteSqlPayload {
|
|
513
|
+
/** Optional. When set to true, the API caller identity associated with the request is used for database authentication. The API caller must be an IAM user in the database. */
|
|
514
|
+
autoIamAuthn?: boolean;
|
|
515
|
+
/** Optional. Name of the database on which the statement will be executed. */
|
|
516
|
+
database?: string;
|
|
517
|
+
/** Optional. The maximum number of rows returned per SQL statement. */
|
|
518
|
+
rowLimit?: string;
|
|
519
|
+
/** Required. SQL statements to run on the database. It can be a single statement or a sequence of statements separated by semicolons. */
|
|
520
|
+
sqlStatement?: string;
|
|
521
|
+
}
|
|
502
522
|
interface ExportContext {
|
|
503
523
|
/** Options for exporting BAK files (SQL Server-only) */
|
|
504
524
|
bakExportOptions?: {
|
|
@@ -585,6 +605,12 @@ declare namespace gapi.client {
|
|
|
585
605
|
/** The current settings version of this instance. Request will be rejected if this version doesn't match the current settings version. */
|
|
586
606
|
settingsVersion?: string;
|
|
587
607
|
}
|
|
608
|
+
interface FinalBackupConfig {
|
|
609
|
+
/** Whether the final backup is enabled for the instance. */
|
|
610
|
+
enabled?: boolean;
|
|
611
|
+
/** The number of days to retain the final backup after the instance deletion. The final backup will be purged at (time_of_instance_deletion + retention_days). */
|
|
612
|
+
retentionDays?: number;
|
|
613
|
+
}
|
|
588
614
|
interface Flag {
|
|
589
615
|
/** Use this field if only certain integers are accepted. Can be combined with min_value and max_value to add additional values. */
|
|
590
616
|
allowedIntValues?: string[];
|
|
@@ -810,6 +836,8 @@ declare namespace gapi.client {
|
|
|
810
836
|
backupdrBackup?: string;
|
|
811
837
|
/** Parameters required to perform the restore backup operation. */
|
|
812
838
|
restoreBackupContext?: RestoreBackupContext;
|
|
839
|
+
/** Optional. This field has the same purpose as restore_instance_settings, changes any instance settings stored in the backup you are restoring from. With the difference that these fields are cleared in the settings. */
|
|
840
|
+
restoreInstanceClearOverridesFieldNames?: string[];
|
|
813
841
|
/** 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. */
|
|
814
842
|
restoreInstanceSettings?: DatabaseInstance;
|
|
815
843
|
}
|
|
@@ -891,6 +919,10 @@ declare namespace gapi.client {
|
|
|
891
919
|
/** 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). */
|
|
892
920
|
updateTrack?: string;
|
|
893
921
|
}
|
|
922
|
+
interface Metadata {
|
|
923
|
+
/** The time taken to execute the SQL statements. */
|
|
924
|
+
sqlStatementExecutionTime?: string;
|
|
925
|
+
}
|
|
894
926
|
interface MySqlReplicaConfiguration {
|
|
895
927
|
/** PEM representation of the trusted CA's x509 certificate. */
|
|
896
928
|
caCertificate?: string;
|
|
@@ -1047,7 +1079,7 @@ declare namespace gapi.client {
|
|
|
1047
1079
|
targetSizeGb?: string;
|
|
1048
1080
|
}
|
|
1049
1081
|
interface PointInTimeRestoreContext {
|
|
1050
|
-
/** 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.
|
|
1082
|
+
/** 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. */
|
|
1051
1083
|
allocatedIpRange?: string;
|
|
1052
1084
|
/** The Google Cloud Backup and Disaster Recovery Datasource URI. Format: projects/{project}/locations/{region}/backupVaults/{backupvault}/dataSources/{datasource}. */
|
|
1053
1085
|
datasource?: string;
|
|
@@ -1098,6 +1130,16 @@ declare namespace gapi.client {
|
|
|
1098
1130
|
/** Whether PSC connectivity is enabled for this instance. */
|
|
1099
1131
|
pscEnabled?: boolean;
|
|
1100
1132
|
}
|
|
1133
|
+
interface QueryResult {
|
|
1134
|
+
/** List of columns included in the result. This also includes the data type of the column. */
|
|
1135
|
+
columns?: Column[];
|
|
1136
|
+
/** Message related to the SQL execution result. */
|
|
1137
|
+
message?: string;
|
|
1138
|
+
/** Set to true if the SQL execution's result is truncated due to size limits. */
|
|
1139
|
+
partialResult?: boolean;
|
|
1140
|
+
/** Rows returned by the SQL statement. */
|
|
1141
|
+
rows?: Row[];
|
|
1142
|
+
}
|
|
1101
1143
|
interface ReplicaConfiguration {
|
|
1102
1144
|
/** 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. */
|
|
1103
1145
|
cascadableReplica?: boolean;
|
|
@@ -1144,6 +1186,10 @@ declare namespace gapi.client {
|
|
|
1144
1186
|
/** Optional. The fingerprint of the next version to be rotated to. If left unspecified, will be rotated to the most recently added server certificate version. */
|
|
1145
1187
|
nextVersion?: string;
|
|
1146
1188
|
}
|
|
1189
|
+
interface Row {
|
|
1190
|
+
/** The values for the row. */
|
|
1191
|
+
values?: Value[];
|
|
1192
|
+
}
|
|
1147
1193
|
interface SelectedObjects {
|
|
1148
1194
|
/** Required. The name of the database to migrate. */
|
|
1149
1195
|
database?: string;
|
|
@@ -1193,6 +1239,8 @@ declare namespace gapi.client {
|
|
|
1193
1239
|
enableDataplexIntegration?: boolean;
|
|
1194
1240
|
/** 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. */
|
|
1195
1241
|
enableGoogleMlIntegration?: boolean;
|
|
1242
|
+
/** Optional. The final backup configuration for the instance. */
|
|
1243
|
+
finalBackupConfig?: FinalBackupConfig;
|
|
1196
1244
|
/** Insights configuration, for now relevant only for Postgres. */
|
|
1197
1245
|
insightsConfig?: InsightsConfig;
|
|
1198
1246
|
/** The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances. */
|
|
@@ -1229,10 +1277,18 @@ declare namespace gapi.client {
|
|
|
1229
1277
|
userLabels?: {[P in string]: string};
|
|
1230
1278
|
}
|
|
1231
1279
|
interface SqlActiveDirectoryConfig {
|
|
1280
|
+
/** Optional. The secret manager key storing the administrator credential. (e.g., projects/{project}/secrets/{secret}). */
|
|
1281
|
+
adminCredentialSecretName?: string;
|
|
1282
|
+
/** Optional. Domain controller IPv4 addresses used to bootstrap Active Directory. */
|
|
1283
|
+
dnsServers?: string[];
|
|
1232
1284
|
/** The name of the domain (e.g., mydomain.com). */
|
|
1233
1285
|
domain?: string;
|
|
1234
1286
|
/** This is always sql#activeDirectoryConfig. */
|
|
1235
1287
|
kind?: string;
|
|
1288
|
+
/** Optional. The mode of the Active Directory configuration. */
|
|
1289
|
+
mode?: string;
|
|
1290
|
+
/** Optional. The organizational unit distinguished name. This is the full hierarchical path to the organizational unit. */
|
|
1291
|
+
organizationalUnit?: string;
|
|
1236
1292
|
}
|
|
1237
1293
|
interface SqlExternalSyncSettingError {
|
|
1238
1294
|
/** Additional information about the error encountered. */
|
|
@@ -1246,6 +1302,12 @@ declare namespace gapi.client {
|
|
|
1246
1302
|
/** The unique identifier for this operation. */
|
|
1247
1303
|
operationId?: string;
|
|
1248
1304
|
}
|
|
1305
|
+
interface SqlInstancesExecuteSqlResponse {
|
|
1306
|
+
/** The additional metadata information regarding the execution of the SQL statements. */
|
|
1307
|
+
metadata?: Metadata;
|
|
1308
|
+
/** The list of results after executing all the SQL statements. */
|
|
1309
|
+
results?: QueryResult[];
|
|
1310
|
+
}
|
|
1249
1311
|
interface SqlInstancesGetDiskShrinkConfigResponse {
|
|
1250
1312
|
/** This is always `sql#getDiskShrinkConfig`. */
|
|
1251
1313
|
kind?: string;
|
|
@@ -1274,6 +1336,8 @@ declare namespace gapi.client {
|
|
|
1274
1336
|
migrationType?: string;
|
|
1275
1337
|
/** MySQL-specific settings for start external sync. */
|
|
1276
1338
|
mysqlSyncConfig?: MySqlSyncConfig;
|
|
1339
|
+
/** Optional. MySQL only. True if end-user has confirmed that this SES call will wipe replica databases overlapping with the proposed selected_objects. If this field is not set and there are both overlapping and additional databases proposed, an error will be returned. */
|
|
1340
|
+
replicaOverwriteEnabled?: boolean;
|
|
1277
1341
|
/** Whether to skip the verification step (VESS). */
|
|
1278
1342
|
skipVerification?: boolean;
|
|
1279
1343
|
/** External sync mode. */
|
|
@@ -1471,6 +1535,12 @@ declare namespace gapi.client {
|
|
|
1471
1535
|
/** Unused. */
|
|
1472
1536
|
nextPageToken?: string;
|
|
1473
1537
|
}
|
|
1538
|
+
interface Value {
|
|
1539
|
+
/** If cell value is null, then this flag will be set to true. */
|
|
1540
|
+
nullValue?: boolean;
|
|
1541
|
+
/** The cell value represented in string format. */
|
|
1542
|
+
value?: string;
|
|
1543
|
+
}
|
|
1474
1544
|
interface BackupRunsResource {
|
|
1475
1545
|
/** Deletes the backup taken by a backup run. */
|
|
1476
1546
|
delete(request?: {
|
|
@@ -2596,6 +2666,68 @@ declare namespace gapi.client {
|
|
|
2596
2666
|
},
|
|
2597
2667
|
body: InstancesDemoteMasterRequest,
|
|
2598
2668
|
): Request<Operation>;
|
|
2669
|
+
/** Execute SQL statements. */
|
|
2670
|
+
executeSql(request: {
|
|
2671
|
+
/** V1 error format. */
|
|
2672
|
+
'$.xgafv'?: string;
|
|
2673
|
+
/** OAuth access token. */
|
|
2674
|
+
access_token?: string;
|
|
2675
|
+
/** Data format for response. */
|
|
2676
|
+
alt?: string;
|
|
2677
|
+
/** JSONP */
|
|
2678
|
+
callback?: string;
|
|
2679
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2680
|
+
fields?: string;
|
|
2681
|
+
/** Required. Database instance ID. This does not include the project ID. */
|
|
2682
|
+
instance: string;
|
|
2683
|
+
/** 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. */
|
|
2684
|
+
key?: string;
|
|
2685
|
+
/** OAuth 2.0 token for the current user. */
|
|
2686
|
+
oauth_token?: string;
|
|
2687
|
+
/** Returns response with indentations and line breaks. */
|
|
2688
|
+
prettyPrint?: boolean;
|
|
2689
|
+
/** Required. Project ID of the project that contains the instance. */
|
|
2690
|
+
project: string;
|
|
2691
|
+
/** 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. */
|
|
2692
|
+
quotaUser?: string;
|
|
2693
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2694
|
+
upload_protocol?: string;
|
|
2695
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2696
|
+
uploadType?: string;
|
|
2697
|
+
/** Request body */
|
|
2698
|
+
resource: ExecuteSqlPayload;
|
|
2699
|
+
}): Request<SqlInstancesExecuteSqlResponse>;
|
|
2700
|
+
executeSql(
|
|
2701
|
+
request: {
|
|
2702
|
+
/** V1 error format. */
|
|
2703
|
+
'$.xgafv'?: string;
|
|
2704
|
+
/** OAuth access token. */
|
|
2705
|
+
access_token?: string;
|
|
2706
|
+
/** Data format for response. */
|
|
2707
|
+
alt?: string;
|
|
2708
|
+
/** JSONP */
|
|
2709
|
+
callback?: string;
|
|
2710
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2711
|
+
fields?: string;
|
|
2712
|
+
/** Required. Database instance ID. This does not include the project ID. */
|
|
2713
|
+
instance: string;
|
|
2714
|
+
/** 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. */
|
|
2715
|
+
key?: string;
|
|
2716
|
+
/** OAuth 2.0 token for the current user. */
|
|
2717
|
+
oauth_token?: string;
|
|
2718
|
+
/** Returns response with indentations and line breaks. */
|
|
2719
|
+
prettyPrint?: boolean;
|
|
2720
|
+
/** Required. Project ID of the project that contains the instance. */
|
|
2721
|
+
project: string;
|
|
2722
|
+
/** 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. */
|
|
2723
|
+
quotaUser?: string;
|
|
2724
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2725
|
+
upload_protocol?: string;
|
|
2726
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2727
|
+
uploadType?: string;
|
|
2728
|
+
},
|
|
2729
|
+
body: ExecuteSqlPayload,
|
|
2730
|
+
): Request<SqlInstancesExecuteSqlResponse>;
|
|
2599
2731
|
/** Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file. */
|
|
2600
2732
|
export(request: {
|
|
2601
2733
|
/** V1 error format. */
|
|
@@ -3807,6 +3939,8 @@ declare namespace gapi.client {
|
|
|
3807
3939
|
project: string;
|
|
3808
3940
|
/** 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. */
|
|
3809
3941
|
quotaUser?: string;
|
|
3942
|
+
/** The timestamp used to identify the time when the source instance is deleted. If this instance is deleted, then you must set the timestamp. */
|
|
3943
|
+
sourceInstanceDeletionTime?: string;
|
|
3810
3944
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3811
3945
|
upload_protocol?: string;
|
|
3812
3946
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -257,6 +257,14 @@ await gapi.client.sql.instances.demoteMaster({
|
|
|
257
257
|
project: 'project',
|
|
258
258
|
});
|
|
259
259
|
|
|
260
|
+
/*
|
|
261
|
+
Execute SQL statements.
|
|
262
|
+
*/
|
|
263
|
+
await gapi.client.sql.instances.executeSql({
|
|
264
|
+
instance: 'instance',
|
|
265
|
+
project: 'project',
|
|
266
|
+
});
|
|
267
|
+
|
|
260
268
|
/*
|
|
261
269
|
Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file.
|
|
262
270
|
*/
|
|
@@ -523,3 +531,5 @@ Updates an existing user in a Cloud SQL instance.
|
|
|
523
531
|
*/
|
|
524
532
|
await gapi.client.sql.users.update({instance: 'instance', project: 'project'});
|
|
525
533
|
```
|
|
534
|
+
|
|
535
|
+
For provenance information see [Provenance section on NPM](https://www.npmjs.com/package/@maxim_mazurok/gapi.client.sqladmin-v1beta4#Provenance:~:text=none-,Provenance,-Built%20and%20signed)
|