@maxim_mazurok/gapi.client.sqladmin-v1 0.0.20250613 → 0.0.20250628
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 +126 -4
- package/package.json +1 -1
- package/readme.md +8 -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=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20250628
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -231,6 +231,14 @@ declare namespace gapi.client {
|
|
|
231
231
|
preferredSecondaryZone?: string;
|
|
232
232
|
/** 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. */
|
|
233
233
|
preferredZone?: string;
|
|
234
|
+
/** The timestamp used to identify the time when the source instance is deleted. If this instance is deleted, then you must set the timestamp. */
|
|
235
|
+
sourceInstanceDeletionTime?: string;
|
|
236
|
+
}
|
|
237
|
+
interface Column {
|
|
238
|
+
/** Name of the column. */
|
|
239
|
+
name?: string;
|
|
240
|
+
/** Datatype of the column. */
|
|
241
|
+
type?: string;
|
|
234
242
|
}
|
|
235
243
|
interface ConnectionPoolConfig {
|
|
236
244
|
/** Whether managed connection pooling is enabled. */
|
|
@@ -312,8 +320,6 @@ declare namespace gapi.client {
|
|
|
312
320
|
availableMaintenanceVersions?: string[];
|
|
313
321
|
/** 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. */
|
|
314
322
|
backendType?: string;
|
|
315
|
-
/** Clears private network settings when the instance is restored. */
|
|
316
|
-
clearNetwork?: boolean;
|
|
317
323
|
/** Connection name of the Cloud SQL instance used in connection strings. */
|
|
318
324
|
connectionName?: string;
|
|
319
325
|
/** 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`. */
|
|
@@ -494,6 +500,16 @@ declare namespace gapi.client {
|
|
|
494
500
|
name?: string;
|
|
495
501
|
}
|
|
496
502
|
interface Empty {}
|
|
503
|
+
interface ExecuteSqlPayload {
|
|
504
|
+
/** 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. */
|
|
505
|
+
autoIamAuthn?: boolean;
|
|
506
|
+
/** Optional. Name of the database on which the statement will be executed. */
|
|
507
|
+
database?: string;
|
|
508
|
+
/** Optional. The maximum number of rows returned per SQL statement. */
|
|
509
|
+
rowLimit?: string;
|
|
510
|
+
/** Required. SQL statement to run on the database. It can be a single statement or a sequence of statements separated by semicolons. */
|
|
511
|
+
sqlStatement?: string;
|
|
512
|
+
}
|
|
497
513
|
interface ExportContext {
|
|
498
514
|
/** Options for exporting BAK files (SQL Server-only) */
|
|
499
515
|
bakExportOptions?: {
|
|
@@ -886,6 +902,10 @@ declare namespace gapi.client {
|
|
|
886
902
|
/** 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). */
|
|
887
903
|
updateTrack?: string;
|
|
888
904
|
}
|
|
905
|
+
interface Metadata {
|
|
906
|
+
/** The time taken to execute the sql statement. */
|
|
907
|
+
sqlStatementExecutionTime?: string;
|
|
908
|
+
}
|
|
889
909
|
interface MySqlReplicaConfiguration {
|
|
890
910
|
/** PEM representation of the trusted CA's x509 certificate. */
|
|
891
911
|
caCertificate?: string;
|
|
@@ -1042,7 +1062,7 @@ declare namespace gapi.client {
|
|
|
1042
1062
|
targetSizeGb?: string;
|
|
1043
1063
|
}
|
|
1044
1064
|
interface PointInTimeRestoreContext {
|
|
1045
|
-
/** 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.
|
|
1065
|
+
/** 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. */
|
|
1046
1066
|
allocatedIpRange?: string;
|
|
1047
1067
|
/** The Google Cloud Backup and Disaster Recovery Datasource URI. Format: projects/{project}/locations/{region}/backupVaults/{backupvault}/dataSources/{datasource}. */
|
|
1048
1068
|
datasource?: string;
|
|
@@ -1093,6 +1113,16 @@ declare namespace gapi.client {
|
|
|
1093
1113
|
/** Whether PSC connectivity is enabled for this instance. */
|
|
1094
1114
|
pscEnabled?: boolean;
|
|
1095
1115
|
}
|
|
1116
|
+
interface QueryResult {
|
|
1117
|
+
/** List of columns included in the result. This also includes the data type of the column. */
|
|
1118
|
+
columns?: Column[];
|
|
1119
|
+
/** Message related to the SQL execution result. */
|
|
1120
|
+
message?: string;
|
|
1121
|
+
/** Set to true if a partial result of the SQL execution is returned. */
|
|
1122
|
+
partialResult?: boolean;
|
|
1123
|
+
/** Rows returned by the SQL statement. */
|
|
1124
|
+
rows?: Row[];
|
|
1125
|
+
}
|
|
1096
1126
|
interface ReplicaConfiguration {
|
|
1097
1127
|
/** 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. */
|
|
1098
1128
|
cascadableReplica?: boolean;
|
|
@@ -1139,6 +1169,10 @@ declare namespace gapi.client {
|
|
|
1139
1169
|
/** The fingerprint of the next version to be rotated to. If left unspecified, will be rotated to the most recently added server certificate version. */
|
|
1140
1170
|
nextVersion?: string;
|
|
1141
1171
|
}
|
|
1172
|
+
interface Row {
|
|
1173
|
+
/** The values for the row. */
|
|
1174
|
+
values?: Value[];
|
|
1175
|
+
}
|
|
1142
1176
|
interface SelectedObjects {
|
|
1143
1177
|
/** Required. The name of the database to migrate. */
|
|
1144
1178
|
database?: string;
|
|
@@ -1224,10 +1258,18 @@ declare namespace gapi.client {
|
|
|
1224
1258
|
userLabels?: {[P in string]: string};
|
|
1225
1259
|
}
|
|
1226
1260
|
interface SqlActiveDirectoryConfig {
|
|
1261
|
+
/** Optional. The secret manager key storing the administrator credential. (e.g., projects/{project}/secrets/{secret}). */
|
|
1262
|
+
adminCredentialSecretName?: string;
|
|
1263
|
+
/** Optional. Domain controller IPv4 addresses used to bootstrap Active Directory. */
|
|
1264
|
+
dnsServers?: string[];
|
|
1227
1265
|
/** The name of the domain (e.g., mydomain.com). */
|
|
1228
1266
|
domain?: string;
|
|
1229
1267
|
/** This is always sql#activeDirectoryConfig. */
|
|
1230
1268
|
kind?: string;
|
|
1269
|
+
/** Optional. The mode of the Active Directory configuration. */
|
|
1270
|
+
mode?: string;
|
|
1271
|
+
/** Optional. The organizational unit distinguished name. This is the full hierarchical path to the organizational unit. */
|
|
1272
|
+
organizationalUnit?: string;
|
|
1231
1273
|
}
|
|
1232
1274
|
interface SqlExternalSyncSettingError {
|
|
1233
1275
|
/** Additional information about the error encountered. */
|
|
@@ -1241,6 +1283,16 @@ declare namespace gapi.client {
|
|
|
1241
1283
|
/** The unique identifier for this operation. */
|
|
1242
1284
|
operationId?: string;
|
|
1243
1285
|
}
|
|
1286
|
+
interface SqlInstancesExecuteSqlResponse {
|
|
1287
|
+
/** Message related to the SQL execution result. */
|
|
1288
|
+
message?: string;
|
|
1289
|
+
/** The additional metadata information regarding the execution of the SQL statement. */
|
|
1290
|
+
metadata?: Metadata;
|
|
1291
|
+
/** Set to true if a partial result of the SQL execution is returned. */
|
|
1292
|
+
partialResult?: boolean;
|
|
1293
|
+
/** The list of results after executing all the SQL statements. */
|
|
1294
|
+
results?: QueryResult[];
|
|
1295
|
+
}
|
|
1244
1296
|
interface SqlInstancesGetDiskShrinkConfigResponse {
|
|
1245
1297
|
/** This is always `sql#getDiskShrinkConfig`. */
|
|
1246
1298
|
kind?: string;
|
|
@@ -1466,6 +1518,12 @@ declare namespace gapi.client {
|
|
|
1466
1518
|
/** Unused. */
|
|
1467
1519
|
nextPageToken?: string;
|
|
1468
1520
|
}
|
|
1521
|
+
interface Value {
|
|
1522
|
+
/** If cell value is null, then this flag will be set to true. */
|
|
1523
|
+
nullValue?: boolean;
|
|
1524
|
+
/** The cell value in string format. */
|
|
1525
|
+
value?: string;
|
|
1526
|
+
}
|
|
1469
1527
|
interface BackupRunsResource {
|
|
1470
1528
|
/** Deletes the backup taken by a backup run. */
|
|
1471
1529
|
delete(request?: {
|
|
@@ -2591,6 +2649,68 @@ declare namespace gapi.client {
|
|
|
2591
2649
|
},
|
|
2592
2650
|
body: InstancesDemoteMasterRequest,
|
|
2593
2651
|
): Request<Operation>;
|
|
2652
|
+
/** Runs a SQL statement in a database that's inside of a Cloud SQL instance. */
|
|
2653
|
+
executeSql(request: {
|
|
2654
|
+
/** V1 error format. */
|
|
2655
|
+
'$.xgafv'?: string;
|
|
2656
|
+
/** OAuth access token. */
|
|
2657
|
+
access_token?: string;
|
|
2658
|
+
/** Data format for response. */
|
|
2659
|
+
alt?: string;
|
|
2660
|
+
/** JSONP */
|
|
2661
|
+
callback?: string;
|
|
2662
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2663
|
+
fields?: string;
|
|
2664
|
+
/** Required. Database instance ID. This does not include the project ID. */
|
|
2665
|
+
instance: string;
|
|
2666
|
+
/** 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. */
|
|
2667
|
+
key?: string;
|
|
2668
|
+
/** OAuth 2.0 token for the current user. */
|
|
2669
|
+
oauth_token?: string;
|
|
2670
|
+
/** Returns response with indentations and line breaks. */
|
|
2671
|
+
prettyPrint?: boolean;
|
|
2672
|
+
/** Required. Project ID of the project that contains the instance. */
|
|
2673
|
+
project: string;
|
|
2674
|
+
/** 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. */
|
|
2675
|
+
quotaUser?: string;
|
|
2676
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2677
|
+
upload_protocol?: string;
|
|
2678
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2679
|
+
uploadType?: string;
|
|
2680
|
+
/** Request body */
|
|
2681
|
+
resource: ExecuteSqlPayload;
|
|
2682
|
+
}): Request<SqlInstancesExecuteSqlResponse>;
|
|
2683
|
+
executeSql(
|
|
2684
|
+
request: {
|
|
2685
|
+
/** V1 error format. */
|
|
2686
|
+
'$.xgafv'?: string;
|
|
2687
|
+
/** OAuth access token. */
|
|
2688
|
+
access_token?: string;
|
|
2689
|
+
/** Data format for response. */
|
|
2690
|
+
alt?: string;
|
|
2691
|
+
/** JSONP */
|
|
2692
|
+
callback?: string;
|
|
2693
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2694
|
+
fields?: string;
|
|
2695
|
+
/** Required. Database instance ID. This does not include the project ID. */
|
|
2696
|
+
instance: string;
|
|
2697
|
+
/** 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. */
|
|
2698
|
+
key?: string;
|
|
2699
|
+
/** OAuth 2.0 token for the current user. */
|
|
2700
|
+
oauth_token?: string;
|
|
2701
|
+
/** Returns response with indentations and line breaks. */
|
|
2702
|
+
prettyPrint?: boolean;
|
|
2703
|
+
/** Required. Project ID of the project that contains the instance. */
|
|
2704
|
+
project: string;
|
|
2705
|
+
/** 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. */
|
|
2706
|
+
quotaUser?: string;
|
|
2707
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2708
|
+
upload_protocol?: string;
|
|
2709
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2710
|
+
uploadType?: string;
|
|
2711
|
+
},
|
|
2712
|
+
body: ExecuteSqlPayload,
|
|
2713
|
+
): Request<SqlInstancesExecuteSqlResponse>;
|
|
2594
2714
|
/** Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file. */
|
|
2595
2715
|
export(request: {
|
|
2596
2716
|
/** V1 error format. */
|
|
@@ -3802,6 +3922,8 @@ declare namespace gapi.client {
|
|
|
3802
3922
|
project: string;
|
|
3803
3923
|
/** 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. */
|
|
3804
3924
|
quotaUser?: string;
|
|
3925
|
+
/** The timestamp used to identify the time when the source instance is deleted. If this instance is deleted, then you must set the timestamp. */
|
|
3926
|
+
sourceInstanceDeletionTime?: string;
|
|
3805
3927
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3806
3928
|
upload_protocol?: string;
|
|
3807
3929
|
/** 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
|
+
Runs a SQL statement in a database that's inside of a Cloud SQL instance.
|
|
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
|
*/
|