@maxim_mazurok/gapi.client.sqladmin-v1beta4 0.0.20250610 → 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 -16
- 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=v1beta4
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20250628
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -235,6 +235,14 @@ 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. */
|
|
@@ -316,8 +324,6 @@ declare namespace gapi.client {
|
|
|
316
324
|
availableMaintenanceVersions?: string[];
|
|
317
325
|
/** 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
326
|
backendType?: string;
|
|
319
|
-
/** Clears private network settings when the instance is restored. */
|
|
320
|
-
clearNetwork?: boolean;
|
|
321
327
|
/** Connection name of the Cloud SQL instance used in connection strings. */
|
|
322
328
|
connectionName?: string;
|
|
323
329
|
/** 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`. */
|
|
@@ -375,8 +381,6 @@ declare namespace gapi.client {
|
|
|
375
381
|
onPremisesConfiguration?: OnPremisesConfiguration;
|
|
376
382
|
/** 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 */
|
|
377
383
|
outOfDiskReport?: SqlOutOfDiskReport;
|
|
378
|
-
/** Input only. PITR related fields added for Instance Independent PITR. */
|
|
379
|
-
pitrFields?: PITRFields;
|
|
380
384
|
/** Output only. DEPRECATED: please use write_endpoint instead. */
|
|
381
385
|
primaryDnsName?: string;
|
|
382
386
|
/** The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. */
|
|
@@ -501,6 +505,16 @@ declare namespace gapi.client {
|
|
|
501
505
|
name?: string;
|
|
502
506
|
}
|
|
503
507
|
interface Empty {}
|
|
508
|
+
interface ExecuteSqlPayload {
|
|
509
|
+
/** 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. */
|
|
510
|
+
autoIamAuthn?: boolean;
|
|
511
|
+
/** Optional. Name of the database on which the statement will be executed. */
|
|
512
|
+
database?: string;
|
|
513
|
+
/** Optional. The maximum number of rows returned per SQL statement. */
|
|
514
|
+
rowLimit?: string;
|
|
515
|
+
/** Required. SQL statement to run on the database. It can be a single statement or a sequence of statements separated by semicolons. */
|
|
516
|
+
sqlStatement?: string;
|
|
517
|
+
}
|
|
504
518
|
interface ExportContext {
|
|
505
519
|
/** Options for exporting BAK files (SQL Server-only) */
|
|
506
520
|
bakExportOptions?: {
|
|
@@ -893,6 +907,10 @@ declare namespace gapi.client {
|
|
|
893
907
|
/** 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). */
|
|
894
908
|
updateTrack?: string;
|
|
895
909
|
}
|
|
910
|
+
interface Metadata {
|
|
911
|
+
/** The time taken to execute the sql statement. */
|
|
912
|
+
sqlStatementExecutionTime?: string;
|
|
913
|
+
}
|
|
896
914
|
interface MySqlReplicaConfiguration {
|
|
897
915
|
/** PEM representation of the trusted CA's x509 certificate. */
|
|
898
916
|
caCertificate?: string;
|
|
@@ -1048,18 +1066,8 @@ declare namespace gapi.client {
|
|
|
1048
1066
|
/** The target disk shrink size in GigaBytes. */
|
|
1049
1067
|
targetSizeGb?: string;
|
|
1050
1068
|
}
|
|
1051
|
-
interface PITRFields {
|
|
1052
|
-
/** The enablement setting for PITR for MySQL. */
|
|
1053
|
-
enableBinLog?: boolean;
|
|
1054
|
-
/** The enablement setting for PITR for PostgreSQL. */
|
|
1055
|
-
replicationLogArchivingEnabled?: boolean;
|
|
1056
|
-
/** The enablement setting for PITR for SQL Server. */
|
|
1057
|
-
sqlserverPitrEnabled?: boolean;
|
|
1058
|
-
/** The number of transaction log days to retain for PITR */
|
|
1059
|
-
transactionLogRetentionDays?: number;
|
|
1060
|
-
}
|
|
1061
1069
|
interface PointInTimeRestoreContext {
|
|
1062
|
-
/** 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.
|
|
1070
|
+
/** 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. */
|
|
1063
1071
|
allocatedIpRange?: string;
|
|
1064
1072
|
/** The Google Cloud Backup and Disaster Recovery Datasource URI. Format: projects/{project}/locations/{region}/backupVaults/{backupvault}/dataSources/{datasource}. */
|
|
1065
1073
|
datasource?: string;
|
|
@@ -1110,6 +1118,16 @@ declare namespace gapi.client {
|
|
|
1110
1118
|
/** Whether PSC connectivity is enabled for this instance. */
|
|
1111
1119
|
pscEnabled?: boolean;
|
|
1112
1120
|
}
|
|
1121
|
+
interface QueryResult {
|
|
1122
|
+
/** List of columns included in the result. This also includes the data type of the column. */
|
|
1123
|
+
columns?: Column[];
|
|
1124
|
+
/** Message related to the SQL execution result. */
|
|
1125
|
+
message?: string;
|
|
1126
|
+
/** Set to true if a partial result of the SQL execution is returned. */
|
|
1127
|
+
partialResult?: boolean;
|
|
1128
|
+
/** Rows returned by the SQL statement. */
|
|
1129
|
+
rows?: Row[];
|
|
1130
|
+
}
|
|
1113
1131
|
interface ReplicaConfiguration {
|
|
1114
1132
|
/** 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. */
|
|
1115
1133
|
cascadableReplica?: boolean;
|
|
@@ -1156,6 +1174,10 @@ declare namespace gapi.client {
|
|
|
1156
1174
|
/** 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. */
|
|
1157
1175
|
nextVersion?: string;
|
|
1158
1176
|
}
|
|
1177
|
+
interface Row {
|
|
1178
|
+
/** The values for the row. */
|
|
1179
|
+
values?: Value[];
|
|
1180
|
+
}
|
|
1159
1181
|
interface SelectedObjects {
|
|
1160
1182
|
/** Required. The name of the database to migrate. */
|
|
1161
1183
|
database?: string;
|
|
@@ -1241,10 +1263,18 @@ declare namespace gapi.client {
|
|
|
1241
1263
|
userLabels?: {[P in string]: string};
|
|
1242
1264
|
}
|
|
1243
1265
|
interface SqlActiveDirectoryConfig {
|
|
1266
|
+
/** Optional. The secret manager key storing the administrator credential. (e.g., projects/{project}/secrets/{secret}). */
|
|
1267
|
+
adminCredentialSecretName?: string;
|
|
1268
|
+
/** Optional. Domain controller IPv4 addresses used to bootstrap Active Directory. */
|
|
1269
|
+
dnsServers?: string[];
|
|
1244
1270
|
/** The name of the domain (e.g., mydomain.com). */
|
|
1245
1271
|
domain?: string;
|
|
1246
1272
|
/** This is always sql#activeDirectoryConfig. */
|
|
1247
1273
|
kind?: string;
|
|
1274
|
+
/** Optional. The mode of the Active Directory configuration. */
|
|
1275
|
+
mode?: string;
|
|
1276
|
+
/** Optional. The organizational unit distinguished name. This is the full hierarchical path to the organizational unit. */
|
|
1277
|
+
organizationalUnit?: string;
|
|
1248
1278
|
}
|
|
1249
1279
|
interface SqlExternalSyncSettingError {
|
|
1250
1280
|
/** Additional information about the error encountered. */
|
|
@@ -1258,6 +1288,16 @@ declare namespace gapi.client {
|
|
|
1258
1288
|
/** The unique identifier for this operation. */
|
|
1259
1289
|
operationId?: string;
|
|
1260
1290
|
}
|
|
1291
|
+
interface SqlInstancesExecuteSqlResponse {
|
|
1292
|
+
/** Message related to the SQL execution result. */
|
|
1293
|
+
message?: string;
|
|
1294
|
+
/** The additional metadata information regarding the execution of the SQL statement. */
|
|
1295
|
+
metadata?: Metadata;
|
|
1296
|
+
/** Set to true if a partial result of the SQL execution is returned. */
|
|
1297
|
+
partialResult?: boolean;
|
|
1298
|
+
/** The list of results after executing all the SQL statements. */
|
|
1299
|
+
results?: QueryResult[];
|
|
1300
|
+
}
|
|
1261
1301
|
interface SqlInstancesGetDiskShrinkConfigResponse {
|
|
1262
1302
|
/** This is always `sql#getDiskShrinkConfig`. */
|
|
1263
1303
|
kind?: string;
|
|
@@ -1483,6 +1523,12 @@ declare namespace gapi.client {
|
|
|
1483
1523
|
/** Unused. */
|
|
1484
1524
|
nextPageToken?: string;
|
|
1485
1525
|
}
|
|
1526
|
+
interface Value {
|
|
1527
|
+
/** If cell value is null, then this flag will be set to true. */
|
|
1528
|
+
nullValue?: boolean;
|
|
1529
|
+
/** The cell value represented in string format. */
|
|
1530
|
+
value?: string;
|
|
1531
|
+
}
|
|
1486
1532
|
interface BackupRunsResource {
|
|
1487
1533
|
/** Deletes the backup taken by a backup run. */
|
|
1488
1534
|
delete(request?: {
|
|
@@ -2608,6 +2654,68 @@ declare namespace gapi.client {
|
|
|
2608
2654
|
},
|
|
2609
2655
|
body: InstancesDemoteMasterRequest,
|
|
2610
2656
|
): Request<Operation>;
|
|
2657
|
+
/** Runs a SQL statement in a database that's inside of a Cloud SQL instance. */
|
|
2658
|
+
executeSql(request: {
|
|
2659
|
+
/** V1 error format. */
|
|
2660
|
+
'$.xgafv'?: string;
|
|
2661
|
+
/** OAuth access token. */
|
|
2662
|
+
access_token?: string;
|
|
2663
|
+
/** Data format for response. */
|
|
2664
|
+
alt?: string;
|
|
2665
|
+
/** JSONP */
|
|
2666
|
+
callback?: string;
|
|
2667
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2668
|
+
fields?: string;
|
|
2669
|
+
/** Required. Database instance ID. This does not include the project ID. */
|
|
2670
|
+
instance: string;
|
|
2671
|
+
/** 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. */
|
|
2672
|
+
key?: string;
|
|
2673
|
+
/** OAuth 2.0 token for the current user. */
|
|
2674
|
+
oauth_token?: string;
|
|
2675
|
+
/** Returns response with indentations and line breaks. */
|
|
2676
|
+
prettyPrint?: boolean;
|
|
2677
|
+
/** Required. Project ID of the project that contains the instance. */
|
|
2678
|
+
project: string;
|
|
2679
|
+
/** 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. */
|
|
2680
|
+
quotaUser?: string;
|
|
2681
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2682
|
+
upload_protocol?: string;
|
|
2683
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2684
|
+
uploadType?: string;
|
|
2685
|
+
/** Request body */
|
|
2686
|
+
resource: ExecuteSqlPayload;
|
|
2687
|
+
}): Request<SqlInstancesExecuteSqlResponse>;
|
|
2688
|
+
executeSql(
|
|
2689
|
+
request: {
|
|
2690
|
+
/** V1 error format. */
|
|
2691
|
+
'$.xgafv'?: string;
|
|
2692
|
+
/** OAuth access token. */
|
|
2693
|
+
access_token?: string;
|
|
2694
|
+
/** Data format for response. */
|
|
2695
|
+
alt?: string;
|
|
2696
|
+
/** JSONP */
|
|
2697
|
+
callback?: string;
|
|
2698
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
2699
|
+
fields?: string;
|
|
2700
|
+
/** Required. Database instance ID. This does not include the project ID. */
|
|
2701
|
+
instance: string;
|
|
2702
|
+
/** 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. */
|
|
2703
|
+
key?: string;
|
|
2704
|
+
/** OAuth 2.0 token for the current user. */
|
|
2705
|
+
oauth_token?: string;
|
|
2706
|
+
/** Returns response with indentations and line breaks. */
|
|
2707
|
+
prettyPrint?: boolean;
|
|
2708
|
+
/** Required. Project ID of the project that contains the instance. */
|
|
2709
|
+
project: string;
|
|
2710
|
+
/** 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. */
|
|
2711
|
+
quotaUser?: string;
|
|
2712
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
2713
|
+
upload_protocol?: string;
|
|
2714
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
2715
|
+
uploadType?: string;
|
|
2716
|
+
},
|
|
2717
|
+
body: ExecuteSqlPayload,
|
|
2718
|
+
): Request<SqlInstancesExecuteSqlResponse>;
|
|
2611
2719
|
/** Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file. */
|
|
2612
2720
|
export(request: {
|
|
2613
2721
|
/** V1 error format. */
|
|
@@ -3819,6 +3927,8 @@ declare namespace gapi.client {
|
|
|
3819
3927
|
project: string;
|
|
3820
3928
|
/** 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. */
|
|
3821
3929
|
quotaUser?: string;
|
|
3930
|
+
/** The timestamp used to identify the time when the source instance is deleted. If this instance is deleted, then you must set the timestamp. */
|
|
3931
|
+
sourceInstanceDeletionTime?: string;
|
|
3822
3932
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3823
3933
|
upload_protocol?: string;
|
|
3824
3934
|
/** 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
|
*/
|