@googleapis/sqladmin 24.0.0 → 25.0.0
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/CHANGELOG.md +23 -0
- package/build/v1.d.ts +222 -10
- package/build/v1.js +99 -0
- package/build/v1.js.map +1 -1
- package/build/v1beta4.d.ts +222 -10
- package/build/v1beta4.js +99 -0
- package/build/v1beta4.js.map +1 -1
- package/package.json +1 -1
- package/v1.ts +459 -10
- package/v1beta4.ts +459 -10
package/v1.ts
CHANGED
|
@@ -471,6 +471,10 @@ export namespace sqladmin_v1 {
|
|
|
471
471
|
* `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.
|
|
472
472
|
*/
|
|
473
473
|
backendType?: string | null;
|
|
474
|
+
/**
|
|
475
|
+
* Custom subject alternative names for the server certificate.
|
|
476
|
+
*/
|
|
477
|
+
customSubjectAlternativeNames?: string[] | null;
|
|
474
478
|
/**
|
|
475
479
|
* The database engine type and version. The `databaseVersion` field cannot be changed after instance creation. MySQL instances: `MYSQL_8_0`, `MYSQL_5_7` (default), or `MYSQL_5_6`. PostgreSQL instances: `POSTGRES_9_6`, `POSTGRES_10`, `POSTGRES_11`, `POSTGRES_12` (default), `POSTGRES_13`, or `POSTGRES_14`. SQL Server instances: `SQLSERVER_2017_STANDARD` (default), `SQLSERVER_2017_ENTERPRISE`, `SQLSERVER_2017_EXPRESS`, `SQLSERVER_2017_WEB`, `SQLSERVER_2019_STANDARD`, `SQLSERVER_2019_ENTERPRISE`, `SQLSERVER_2019_EXPRESS`, or `SQLSERVER_2019_WEB`.
|
|
476
480
|
*/
|
|
@@ -680,7 +684,7 @@ export namespace sqladmin_v1 {
|
|
|
680
684
|
*/
|
|
681
685
|
replicaNames?: string[] | null;
|
|
682
686
|
/**
|
|
683
|
-
* Optional. A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure.
|
|
687
|
+
* Optional. A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Applicable to MySQL and PostgreSQL.
|
|
684
688
|
*/
|
|
685
689
|
replicationCluster?: Schema$ReplicationCluster;
|
|
686
690
|
/**
|
|
@@ -732,6 +736,10 @@ export namespace sqladmin_v1 {
|
|
|
732
736
|
* Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage.
|
|
733
737
|
*/
|
|
734
738
|
switchTransactionLogsToCloudStorageEnabled?: boolean | null;
|
|
739
|
+
/**
|
|
740
|
+
* Optional. Input only. Immutable. Tag keys and tag values that are bound to this instance. You must represent each item in the map as: `"" : ""`. For example, a single resource can have the following tags: ``` "123/environment": "production", "123/costCenter": "marketing", ``` For more information on tag creation and management, see https://cloud.google.com/resource-manager/docs/tags/tags-overview.
|
|
741
|
+
*/
|
|
742
|
+
tags?: {[key: string]: string} | null;
|
|
735
743
|
/**
|
|
736
744
|
* Output only. All database versions that are available for upgrade.
|
|
737
745
|
*/
|
|
@@ -901,6 +909,8 @@ export namespace sqladmin_v1 {
|
|
|
901
909
|
bakType?: string;
|
|
902
910
|
copyOnly?: boolean;
|
|
903
911
|
differentialBase?: boolean;
|
|
912
|
+
exportLogEndTime?: string;
|
|
913
|
+
exportLogStartTime?: string;
|
|
904
914
|
stripeCount?: number;
|
|
905
915
|
striped?: boolean;
|
|
906
916
|
} | null;
|
|
@@ -946,6 +956,15 @@ export namespace sqladmin_v1 {
|
|
|
946
956
|
*/
|
|
947
957
|
uri?: string | null;
|
|
948
958
|
}
|
|
959
|
+
/**
|
|
960
|
+
* The selected object that Cloud SQL migrates.
|
|
961
|
+
*/
|
|
962
|
+
export interface Schema$ExternalSyncSelectedObject {
|
|
963
|
+
/**
|
|
964
|
+
* The name of the database that Cloud SQL migrates.
|
|
965
|
+
*/
|
|
966
|
+
database?: string | null;
|
|
967
|
+
}
|
|
949
968
|
/**
|
|
950
969
|
* Database instance failover context.
|
|
951
970
|
*/
|
|
@@ -1276,6 +1295,27 @@ export namespace sqladmin_v1 {
|
|
|
1276
1295
|
*/
|
|
1277
1296
|
kind?: string | null;
|
|
1278
1297
|
}
|
|
1298
|
+
/**
|
|
1299
|
+
* Instances ListServerCertificates response.
|
|
1300
|
+
*/
|
|
1301
|
+
export interface Schema$InstancesListServerCertificatesResponse {
|
|
1302
|
+
/**
|
|
1303
|
+
* The `sha1_fingerprint` of the active certificate from `server_certs`.
|
|
1304
|
+
*/
|
|
1305
|
+
activeVersion?: string | null;
|
|
1306
|
+
/**
|
|
1307
|
+
* List of server CA certificates for the instance.
|
|
1308
|
+
*/
|
|
1309
|
+
caCerts?: Schema$SslCert[];
|
|
1310
|
+
/**
|
|
1311
|
+
* This is always `sql#instancesListServerCertificates`.
|
|
1312
|
+
*/
|
|
1313
|
+
kind?: string | null;
|
|
1314
|
+
/**
|
|
1315
|
+
* List of server certificates for the instance, signed by the corresponding CA from the `ca_certs` list.
|
|
1316
|
+
*/
|
|
1317
|
+
serverCerts?: Schema$SslCert[];
|
|
1318
|
+
}
|
|
1279
1319
|
/**
|
|
1280
1320
|
* Database Instance reencrypt request.
|
|
1281
1321
|
*/
|
|
@@ -1303,6 +1343,15 @@ export namespace sqladmin_v1 {
|
|
|
1303
1343
|
*/
|
|
1304
1344
|
rotateServerCaContext?: Schema$RotateServerCaContext;
|
|
1305
1345
|
}
|
|
1346
|
+
/**
|
|
1347
|
+
* Rotate server certificate request.
|
|
1348
|
+
*/
|
|
1349
|
+
export interface Schema$InstancesRotateServerCertificateRequest {
|
|
1350
|
+
/**
|
|
1351
|
+
* Optional. Contains details about the rotate server certificate operation.
|
|
1352
|
+
*/
|
|
1353
|
+
rotateServerCertificateContext?: Schema$RotateServerCertificateContext;
|
|
1354
|
+
}
|
|
1306
1355
|
/**
|
|
1307
1356
|
* Instance truncate log request.
|
|
1308
1357
|
*/
|
|
@@ -1324,6 +1373,10 @@ export namespace sqladmin_v1 {
|
|
|
1324
1373
|
* The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: `157.197.200.0/24`).
|
|
1325
1374
|
*/
|
|
1326
1375
|
authorizedNetworks?: Schema$AclEntry[];
|
|
1376
|
+
/**
|
|
1377
|
+
* Optional. Custom Subject Alternative Name(SAN)s for a Cloud SQL instance.
|
|
1378
|
+
*/
|
|
1379
|
+
customSubjectAlternativeNames?: string[] | null;
|
|
1327
1380
|
/**
|
|
1328
1381
|
* Controls connectivity to private IP instances from Google services, such as BigQuery.
|
|
1329
1382
|
*/
|
|
@@ -1348,6 +1401,10 @@ export namespace sqladmin_v1 {
|
|
|
1348
1401
|
* Specify what type of CA is used for the server certificate.
|
|
1349
1402
|
*/
|
|
1350
1403
|
serverCaMode?: string | null;
|
|
1404
|
+
/**
|
|
1405
|
+
* Optional. The resource name of the server CA pool for an instance with `CUSTOMER_MANAGED_CAS_CA` as the `server_ca_mode`. Format: projects//locations//caPools/
|
|
1406
|
+
*/
|
|
1407
|
+
serverCaPool?: string | null;
|
|
1351
1408
|
/**
|
|
1352
1409
|
* 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.
|
|
1353
1410
|
*/
|
|
@@ -1502,10 +1559,18 @@ export namespace sqladmin_v1 {
|
|
|
1502
1559
|
* The password for connecting to on-premises instance.
|
|
1503
1560
|
*/
|
|
1504
1561
|
password?: string | null;
|
|
1562
|
+
/**
|
|
1563
|
+
* Optional. A list of objects that the user selects for replication from an external source instance.
|
|
1564
|
+
*/
|
|
1565
|
+
selectedObjects?: Schema$SelectedObjects[];
|
|
1505
1566
|
/**
|
|
1506
1567
|
* The reference to Cloud SQL instance if the source is Cloud SQL.
|
|
1507
1568
|
*/
|
|
1508
1569
|
sourceInstance?: Schema$InstanceReference;
|
|
1570
|
+
/**
|
|
1571
|
+
* Optional. SSL option for replica connection to the on-premises source.
|
|
1572
|
+
*/
|
|
1573
|
+
sslOption?: string | null;
|
|
1509
1574
|
/**
|
|
1510
1575
|
* The username for connecting to on-premises instance.
|
|
1511
1576
|
*/
|
|
@@ -1572,8 +1637,9 @@ export namespace sqladmin_v1 {
|
|
|
1572
1637
|
*/
|
|
1573
1638
|
status?: string | null;
|
|
1574
1639
|
/**
|
|
1575
|
-
*
|
|
1640
|
+
* Optional. The sub operation based on the operation type.
|
|
1576
1641
|
*/
|
|
1642
|
+
subOperationType?: Schema$SqlSubOperationType;
|
|
1577
1643
|
targetId?: string | null;
|
|
1578
1644
|
targetLink?: string | null;
|
|
1579
1645
|
/**
|
|
@@ -1624,7 +1690,7 @@ export namespace sqladmin_v1 {
|
|
|
1624
1690
|
*/
|
|
1625
1691
|
apiVersion?: string | null;
|
|
1626
1692
|
/**
|
|
1627
|
-
* Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1
|
|
1693
|
+
* Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
|
|
1628
1694
|
*/
|
|
1629
1695
|
cancelRequested?: boolean | null;
|
|
1630
1696
|
/**
|
|
@@ -1720,6 +1786,31 @@ export namespace sqladmin_v1 {
|
|
|
1720
1786
|
*/
|
|
1721
1787
|
targetSizeGb?: string | null;
|
|
1722
1788
|
}
|
|
1789
|
+
/**
|
|
1790
|
+
* Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance.
|
|
1791
|
+
*/
|
|
1792
|
+
export interface Schema$PscAutoConnectionConfig {
|
|
1793
|
+
/**
|
|
1794
|
+
* 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.
|
|
1795
|
+
*/
|
|
1796
|
+
consumerNetwork?: string | null;
|
|
1797
|
+
/**
|
|
1798
|
+
* The connection policy status of the consumer network.
|
|
1799
|
+
*/
|
|
1800
|
+
consumerNetworkStatus?: string | null;
|
|
1801
|
+
/**
|
|
1802
|
+
* This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network.
|
|
1803
|
+
*/
|
|
1804
|
+
consumerProject?: string | null;
|
|
1805
|
+
/**
|
|
1806
|
+
* The IP address of the consumer endpoint.
|
|
1807
|
+
*/
|
|
1808
|
+
ipAddress?: string | null;
|
|
1809
|
+
/**
|
|
1810
|
+
* The connection status of the consumer endpoint.
|
|
1811
|
+
*/
|
|
1812
|
+
status?: string | null;
|
|
1813
|
+
}
|
|
1723
1814
|
/**
|
|
1724
1815
|
* PSC settings for a Cloud SQL instance.
|
|
1725
1816
|
*/
|
|
@@ -1728,6 +1819,10 @@ export namespace sqladmin_v1 {
|
|
|
1728
1819
|
* Optional. The list of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric).
|
|
1729
1820
|
*/
|
|
1730
1821
|
allowedConsumerProjects?: string[] | null;
|
|
1822
|
+
/**
|
|
1823
|
+
* Optional. The list of settings for requested Private Service Connect consumer endpoints that can be used to connect to this Cloud SQL instance.
|
|
1824
|
+
*/
|
|
1825
|
+
pscAutoConnections?: Schema$PscAutoConnectionConfig[];
|
|
1731
1826
|
/**
|
|
1732
1827
|
* Whether PSC connectivity is enabled for this instance.
|
|
1733
1828
|
*/
|
|
@@ -1755,7 +1850,7 @@ export namespace sqladmin_v1 {
|
|
|
1755
1850
|
mysqlReplicaConfiguration?: Schema$MySqlReplicaConfiguration;
|
|
1756
1851
|
}
|
|
1757
1852
|
/**
|
|
1758
|
-
* A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure.
|
|
1853
|
+
* A primary instance and disaster recovery (DR) replica pair. A DR replica is a cross-region replica that you designate for failover in the event that the primary instance experiences regional failure. Applicable to MySQL and PostgreSQL.
|
|
1759
1854
|
*/
|
|
1760
1855
|
export interface Schema$ReplicationCluster {
|
|
1761
1856
|
/**
|
|
@@ -1767,7 +1862,7 @@ export namespace sqladmin_v1 {
|
|
|
1767
1862
|
*/
|
|
1768
1863
|
failoverDrReplicaName?: string | null;
|
|
1769
1864
|
/**
|
|
1770
|
-
* Output only. If set,
|
|
1865
|
+
* Output only. If set, this field indicates this instance has a private service access (PSA) DNS endpoint that is pointing to the primary instance of the cluster. If this instance is the primary, then the DNS endpoint points to this instance. After a switchover or replica failover operation, this DNS endpoint points to the promoted instance. This is a read-only field, returned to the user as information. This field can exist even if a standalone instance doesn't have a DR replica yet or the DR replica is deleted.
|
|
1771
1866
|
*/
|
|
1772
1867
|
psaWriteEndpoint?: string | null;
|
|
1773
1868
|
}
|
|
@@ -1815,6 +1910,28 @@ export namespace sqladmin_v1 {
|
|
|
1815
1910
|
*/
|
|
1816
1911
|
nextVersion?: string | null;
|
|
1817
1912
|
}
|
|
1913
|
+
/**
|
|
1914
|
+
* Instance rotate server certificate context.
|
|
1915
|
+
*/
|
|
1916
|
+
export interface Schema$RotateServerCertificateContext {
|
|
1917
|
+
/**
|
|
1918
|
+
* Optional. This is always `sql#rotateServerCertificateContext`.
|
|
1919
|
+
*/
|
|
1920
|
+
kind?: string | null;
|
|
1921
|
+
/**
|
|
1922
|
+
* The fingerprint of the next version to be rotated to. If left unspecified, will be rotated to the most recently added server certificate version.
|
|
1923
|
+
*/
|
|
1924
|
+
nextVersion?: string | null;
|
|
1925
|
+
}
|
|
1926
|
+
/**
|
|
1927
|
+
* A list of objects that the user selects for replication from an external source instance.
|
|
1928
|
+
*/
|
|
1929
|
+
export interface Schema$SelectedObjects {
|
|
1930
|
+
/**
|
|
1931
|
+
* Required. The name of the database to migrate.
|
|
1932
|
+
*/
|
|
1933
|
+
database?: string | null;
|
|
1934
|
+
}
|
|
1818
1935
|
/**
|
|
1819
1936
|
* Database instance settings.
|
|
1820
1937
|
*/
|
|
@@ -1923,6 +2040,10 @@ export namespace sqladmin_v1 {
|
|
|
1923
2040
|
* The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances.
|
|
1924
2041
|
*/
|
|
1925
2042
|
pricingPlan?: string | null;
|
|
2043
|
+
/**
|
|
2044
|
+
* Optional. Configuration value for recreation of replica after certain replication lag
|
|
2045
|
+
*/
|
|
2046
|
+
replicationLagMaxSeconds?: number | null;
|
|
1926
2047
|
/**
|
|
1927
2048
|
* The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances.
|
|
1928
2049
|
*/
|
|
@@ -2084,6 +2205,10 @@ export namespace sqladmin_v1 {
|
|
|
2084
2205
|
* Optional. MySQL-specific settings for start external sync.
|
|
2085
2206
|
*/
|
|
2086
2207
|
mysqlSyncConfig?: Schema$MySqlSyncConfig;
|
|
2208
|
+
/**
|
|
2209
|
+
* Optional. Migrate only the specified objects from the source instance. If this field is empty, then migrate all objects.
|
|
2210
|
+
*/
|
|
2211
|
+
selectedObjects?: Schema$ExternalSyncSelectedObject[];
|
|
2087
2212
|
/**
|
|
2088
2213
|
* External sync mode
|
|
2089
2214
|
*/
|
|
@@ -2196,6 +2321,15 @@ export namespace sqladmin_v1 {
|
|
|
2196
2321
|
*/
|
|
2197
2322
|
serverRoles?: string[] | null;
|
|
2198
2323
|
}
|
|
2324
|
+
/**
|
|
2325
|
+
* The sub operation type based on the operation type.
|
|
2326
|
+
*/
|
|
2327
|
+
export interface Schema$SqlSubOperationType {
|
|
2328
|
+
/**
|
|
2329
|
+
* The type of maintenance to be performed on the instance.
|
|
2330
|
+
*/
|
|
2331
|
+
maintenanceType?: string | null;
|
|
2332
|
+
}
|
|
2199
2333
|
/**
|
|
2200
2334
|
* SslCerts Resource
|
|
2201
2335
|
*/
|
|
@@ -3934,7 +4068,7 @@ export namespace sqladmin_v1 {
|
|
|
3934
4068
|
}
|
|
3935
4069
|
|
|
3936
4070
|
/**
|
|
3937
|
-
* Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA,
|
|
4071
|
+
* Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, use AddServerCertificate to add a new server certificate.
|
|
3938
4072
|
*
|
|
3939
4073
|
* @param params - Parameters for request
|
|
3940
4074
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -4021,6 +4155,96 @@ export namespace sqladmin_v1 {
|
|
|
4021
4155
|
}
|
|
4022
4156
|
}
|
|
4023
4157
|
|
|
4158
|
+
/**
|
|
4159
|
+
* Add a new trusted server certificate version for the specified instance using Certificate Authority Service (CAS) server CA. Required to prepare for a certificate rotation. If a server certificate version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one certificate version waiting to be rotated in. For instances not using CAS server CA, use AddServerCa instead.
|
|
4160
|
+
*
|
|
4161
|
+
* @param params - Parameters for request
|
|
4162
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
4163
|
+
* @param callback - Optional callback that handles the response.
|
|
4164
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
4165
|
+
*/
|
|
4166
|
+
addServerCertificate(
|
|
4167
|
+
params: Params$Resource$Instances$Addservercertificate,
|
|
4168
|
+
options: StreamMethodOptions
|
|
4169
|
+
): GaxiosPromise<Readable>;
|
|
4170
|
+
addServerCertificate(
|
|
4171
|
+
params?: Params$Resource$Instances$Addservercertificate,
|
|
4172
|
+
options?: MethodOptions
|
|
4173
|
+
): GaxiosPromise<Schema$Operation>;
|
|
4174
|
+
addServerCertificate(
|
|
4175
|
+
params: Params$Resource$Instances$Addservercertificate,
|
|
4176
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
4177
|
+
callback: BodyResponseCallback<Readable>
|
|
4178
|
+
): void;
|
|
4179
|
+
addServerCertificate(
|
|
4180
|
+
params: Params$Resource$Instances$Addservercertificate,
|
|
4181
|
+
options: MethodOptions | BodyResponseCallback<Schema$Operation>,
|
|
4182
|
+
callback: BodyResponseCallback<Schema$Operation>
|
|
4183
|
+
): void;
|
|
4184
|
+
addServerCertificate(
|
|
4185
|
+
params: Params$Resource$Instances$Addservercertificate,
|
|
4186
|
+
callback: BodyResponseCallback<Schema$Operation>
|
|
4187
|
+
): void;
|
|
4188
|
+
addServerCertificate(
|
|
4189
|
+
callback: BodyResponseCallback<Schema$Operation>
|
|
4190
|
+
): void;
|
|
4191
|
+
addServerCertificate(
|
|
4192
|
+
paramsOrCallback?:
|
|
4193
|
+
| Params$Resource$Instances$Addservercertificate
|
|
4194
|
+
| BodyResponseCallback<Schema$Operation>
|
|
4195
|
+
| BodyResponseCallback<Readable>,
|
|
4196
|
+
optionsOrCallback?:
|
|
4197
|
+
| MethodOptions
|
|
4198
|
+
| StreamMethodOptions
|
|
4199
|
+
| BodyResponseCallback<Schema$Operation>
|
|
4200
|
+
| BodyResponseCallback<Readable>,
|
|
4201
|
+
callback?:
|
|
4202
|
+
| BodyResponseCallback<Schema$Operation>
|
|
4203
|
+
| BodyResponseCallback<Readable>
|
|
4204
|
+
): void | GaxiosPromise<Schema$Operation> | GaxiosPromise<Readable> {
|
|
4205
|
+
let params = (paramsOrCallback ||
|
|
4206
|
+
{}) as Params$Resource$Instances$Addservercertificate;
|
|
4207
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
4208
|
+
|
|
4209
|
+
if (typeof paramsOrCallback === 'function') {
|
|
4210
|
+
callback = paramsOrCallback;
|
|
4211
|
+
params = {} as Params$Resource$Instances$Addservercertificate;
|
|
4212
|
+
options = {};
|
|
4213
|
+
}
|
|
4214
|
+
|
|
4215
|
+
if (typeof optionsOrCallback === 'function') {
|
|
4216
|
+
callback = optionsOrCallback;
|
|
4217
|
+
options = {};
|
|
4218
|
+
}
|
|
4219
|
+
|
|
4220
|
+
const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/';
|
|
4221
|
+
const parameters = {
|
|
4222
|
+
options: Object.assign(
|
|
4223
|
+
{
|
|
4224
|
+
url: (
|
|
4225
|
+
rootUrl +
|
|
4226
|
+
'/v1/projects/{project}/instances/{instance}/addServerCertificate'
|
|
4227
|
+
).replace(/([^:]\/)\/+/g, '$1'),
|
|
4228
|
+
method: 'POST',
|
|
4229
|
+
apiVersion: '',
|
|
4230
|
+
},
|
|
4231
|
+
options
|
|
4232
|
+
),
|
|
4233
|
+
params,
|
|
4234
|
+
requiredParams: ['project', 'instance'],
|
|
4235
|
+
pathParams: ['instance', 'project'],
|
|
4236
|
+
context: this.context,
|
|
4237
|
+
};
|
|
4238
|
+
if (callback) {
|
|
4239
|
+
createAPIRequest<Schema$Operation>(
|
|
4240
|
+
parameters,
|
|
4241
|
+
callback as BodyResponseCallback<unknown>
|
|
4242
|
+
);
|
|
4243
|
+
} else {
|
|
4244
|
+
return createAPIRequest<Schema$Operation>(parameters);
|
|
4245
|
+
}
|
|
4246
|
+
}
|
|
4247
|
+
|
|
4024
4248
|
/**
|
|
4025
4249
|
* Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart.
|
|
4026
4250
|
*
|
|
@@ -4988,6 +5212,103 @@ export namespace sqladmin_v1 {
|
|
|
4988
5212
|
}
|
|
4989
5213
|
}
|
|
4990
5214
|
|
|
5215
|
+
/**
|
|
5216
|
+
* Lists all versions of server certificates and certificate authorities (CAs) for the specified instance. There can be up to three sets of certs listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out. For instances not using Certificate Authority Service (CAS) server CA, use ListServerCas instead.
|
|
5217
|
+
*
|
|
5218
|
+
* @param params - Parameters for request
|
|
5219
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
5220
|
+
* @param callback - Optional callback that handles the response.
|
|
5221
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
5222
|
+
*/
|
|
5223
|
+
ListServerCertificates(
|
|
5224
|
+
params: Params$Resource$Instances$Listservercertificates,
|
|
5225
|
+
options: StreamMethodOptions
|
|
5226
|
+
): GaxiosPromise<Readable>;
|
|
5227
|
+
ListServerCertificates(
|
|
5228
|
+
params?: Params$Resource$Instances$Listservercertificates,
|
|
5229
|
+
options?: MethodOptions
|
|
5230
|
+
): GaxiosPromise<Schema$InstancesListServerCertificatesResponse>;
|
|
5231
|
+
ListServerCertificates(
|
|
5232
|
+
params: Params$Resource$Instances$Listservercertificates,
|
|
5233
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
5234
|
+
callback: BodyResponseCallback<Readable>
|
|
5235
|
+
): void;
|
|
5236
|
+
ListServerCertificates(
|
|
5237
|
+
params: Params$Resource$Instances$Listservercertificates,
|
|
5238
|
+
options:
|
|
5239
|
+
| MethodOptions
|
|
5240
|
+
| BodyResponseCallback<Schema$InstancesListServerCertificatesResponse>,
|
|
5241
|
+
callback: BodyResponseCallback<Schema$InstancesListServerCertificatesResponse>
|
|
5242
|
+
): void;
|
|
5243
|
+
ListServerCertificates(
|
|
5244
|
+
params: Params$Resource$Instances$Listservercertificates,
|
|
5245
|
+
callback: BodyResponseCallback<Schema$InstancesListServerCertificatesResponse>
|
|
5246
|
+
): void;
|
|
5247
|
+
ListServerCertificates(
|
|
5248
|
+
callback: BodyResponseCallback<Schema$InstancesListServerCertificatesResponse>
|
|
5249
|
+
): void;
|
|
5250
|
+
ListServerCertificates(
|
|
5251
|
+
paramsOrCallback?:
|
|
5252
|
+
| Params$Resource$Instances$Listservercertificates
|
|
5253
|
+
| BodyResponseCallback<Schema$InstancesListServerCertificatesResponse>
|
|
5254
|
+
| BodyResponseCallback<Readable>,
|
|
5255
|
+
optionsOrCallback?:
|
|
5256
|
+
| MethodOptions
|
|
5257
|
+
| StreamMethodOptions
|
|
5258
|
+
| BodyResponseCallback<Schema$InstancesListServerCertificatesResponse>
|
|
5259
|
+
| BodyResponseCallback<Readable>,
|
|
5260
|
+
callback?:
|
|
5261
|
+
| BodyResponseCallback<Schema$InstancesListServerCertificatesResponse>
|
|
5262
|
+
| BodyResponseCallback<Readable>
|
|
5263
|
+
):
|
|
5264
|
+
| void
|
|
5265
|
+
| GaxiosPromise<Schema$InstancesListServerCertificatesResponse>
|
|
5266
|
+
| GaxiosPromise<Readable> {
|
|
5267
|
+
let params = (paramsOrCallback ||
|
|
5268
|
+
{}) as Params$Resource$Instances$Listservercertificates;
|
|
5269
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
5270
|
+
|
|
5271
|
+
if (typeof paramsOrCallback === 'function') {
|
|
5272
|
+
callback = paramsOrCallback;
|
|
5273
|
+
params = {} as Params$Resource$Instances$Listservercertificates;
|
|
5274
|
+
options = {};
|
|
5275
|
+
}
|
|
5276
|
+
|
|
5277
|
+
if (typeof optionsOrCallback === 'function') {
|
|
5278
|
+
callback = optionsOrCallback;
|
|
5279
|
+
options = {};
|
|
5280
|
+
}
|
|
5281
|
+
|
|
5282
|
+
const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/';
|
|
5283
|
+
const parameters = {
|
|
5284
|
+
options: Object.assign(
|
|
5285
|
+
{
|
|
5286
|
+
url: (
|
|
5287
|
+
rootUrl +
|
|
5288
|
+
'/v1/projects/{project}/instances/{instance}/listServerCertificates'
|
|
5289
|
+
).replace(/([^:]\/)\/+/g, '$1'),
|
|
5290
|
+
method: 'GET',
|
|
5291
|
+
apiVersion: '',
|
|
5292
|
+
},
|
|
5293
|
+
options
|
|
5294
|
+
),
|
|
5295
|
+
params,
|
|
5296
|
+
requiredParams: ['project', 'instance'],
|
|
5297
|
+
pathParams: ['instance', 'project'],
|
|
5298
|
+
context: this.context,
|
|
5299
|
+
};
|
|
5300
|
+
if (callback) {
|
|
5301
|
+
createAPIRequest<Schema$InstancesListServerCertificatesResponse>(
|
|
5302
|
+
parameters,
|
|
5303
|
+
callback as BodyResponseCallback<unknown>
|
|
5304
|
+
);
|
|
5305
|
+
} else {
|
|
5306
|
+
return createAPIRequest<Schema$InstancesListServerCertificatesResponse>(
|
|
5307
|
+
parameters
|
|
5308
|
+
);
|
|
5309
|
+
}
|
|
5310
|
+
}
|
|
5311
|
+
|
|
4991
5312
|
/**
|
|
4992
5313
|
* Partially updates settings of a Cloud SQL instance by merging the request with the current configuration. This method supports patch semantics.
|
|
4993
5314
|
*
|
|
@@ -5610,7 +5931,7 @@ export namespace sqladmin_v1 {
|
|
|
5610
5931
|
}
|
|
5611
5932
|
|
|
5612
5933
|
/**
|
|
5613
|
-
* Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA,
|
|
5934
|
+
* Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, use RotateServerCertificate to rotate the server certificate.
|
|
5614
5935
|
*
|
|
5615
5936
|
* @param params - Parameters for request
|
|
5616
5937
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -5697,6 +6018,96 @@ export namespace sqladmin_v1 {
|
|
|
5697
6018
|
}
|
|
5698
6019
|
}
|
|
5699
6020
|
|
|
6021
|
+
/**
|
|
6022
|
+
* Rotates the server certificate version to one previously added with the addServerCertificate method. For instances not using Certificate Authority Service (CAS) server CA, use RotateServerCa instead.
|
|
6023
|
+
*
|
|
6024
|
+
* @param params - Parameters for request
|
|
6025
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6026
|
+
* @param callback - Optional callback that handles the response.
|
|
6027
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6028
|
+
*/
|
|
6029
|
+
RotateServerCertificate(
|
|
6030
|
+
params: Params$Resource$Instances$Rotateservercertificate,
|
|
6031
|
+
options: StreamMethodOptions
|
|
6032
|
+
): GaxiosPromise<Readable>;
|
|
6033
|
+
RotateServerCertificate(
|
|
6034
|
+
params?: Params$Resource$Instances$Rotateservercertificate,
|
|
6035
|
+
options?: MethodOptions
|
|
6036
|
+
): GaxiosPromise<Schema$Operation>;
|
|
6037
|
+
RotateServerCertificate(
|
|
6038
|
+
params: Params$Resource$Instances$Rotateservercertificate,
|
|
6039
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
6040
|
+
callback: BodyResponseCallback<Readable>
|
|
6041
|
+
): void;
|
|
6042
|
+
RotateServerCertificate(
|
|
6043
|
+
params: Params$Resource$Instances$Rotateservercertificate,
|
|
6044
|
+
options: MethodOptions | BodyResponseCallback<Schema$Operation>,
|
|
6045
|
+
callback: BodyResponseCallback<Schema$Operation>
|
|
6046
|
+
): void;
|
|
6047
|
+
RotateServerCertificate(
|
|
6048
|
+
params: Params$Resource$Instances$Rotateservercertificate,
|
|
6049
|
+
callback: BodyResponseCallback<Schema$Operation>
|
|
6050
|
+
): void;
|
|
6051
|
+
RotateServerCertificate(
|
|
6052
|
+
callback: BodyResponseCallback<Schema$Operation>
|
|
6053
|
+
): void;
|
|
6054
|
+
RotateServerCertificate(
|
|
6055
|
+
paramsOrCallback?:
|
|
6056
|
+
| Params$Resource$Instances$Rotateservercertificate
|
|
6057
|
+
| BodyResponseCallback<Schema$Operation>
|
|
6058
|
+
| BodyResponseCallback<Readable>,
|
|
6059
|
+
optionsOrCallback?:
|
|
6060
|
+
| MethodOptions
|
|
6061
|
+
| StreamMethodOptions
|
|
6062
|
+
| BodyResponseCallback<Schema$Operation>
|
|
6063
|
+
| BodyResponseCallback<Readable>,
|
|
6064
|
+
callback?:
|
|
6065
|
+
| BodyResponseCallback<Schema$Operation>
|
|
6066
|
+
| BodyResponseCallback<Readable>
|
|
6067
|
+
): void | GaxiosPromise<Schema$Operation> | GaxiosPromise<Readable> {
|
|
6068
|
+
let params = (paramsOrCallback ||
|
|
6069
|
+
{}) as Params$Resource$Instances$Rotateservercertificate;
|
|
6070
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
6071
|
+
|
|
6072
|
+
if (typeof paramsOrCallback === 'function') {
|
|
6073
|
+
callback = paramsOrCallback;
|
|
6074
|
+
params = {} as Params$Resource$Instances$Rotateservercertificate;
|
|
6075
|
+
options = {};
|
|
6076
|
+
}
|
|
6077
|
+
|
|
6078
|
+
if (typeof optionsOrCallback === 'function') {
|
|
6079
|
+
callback = optionsOrCallback;
|
|
6080
|
+
options = {};
|
|
6081
|
+
}
|
|
6082
|
+
|
|
6083
|
+
const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/';
|
|
6084
|
+
const parameters = {
|
|
6085
|
+
options: Object.assign(
|
|
6086
|
+
{
|
|
6087
|
+
url: (
|
|
6088
|
+
rootUrl +
|
|
6089
|
+
'/v1/projects/{project}/instances/{instance}/rotateServerCertificate'
|
|
6090
|
+
).replace(/([^:]\/)\/+/g, '$1'),
|
|
6091
|
+
method: 'POST',
|
|
6092
|
+
apiVersion: '',
|
|
6093
|
+
},
|
|
6094
|
+
options
|
|
6095
|
+
),
|
|
6096
|
+
params,
|
|
6097
|
+
requiredParams: ['project', 'instance'],
|
|
6098
|
+
pathParams: ['instance', 'project'],
|
|
6099
|
+
context: this.context,
|
|
6100
|
+
};
|
|
6101
|
+
if (callback) {
|
|
6102
|
+
createAPIRequest<Schema$Operation>(
|
|
6103
|
+
parameters,
|
|
6104
|
+
callback as BodyResponseCallback<unknown>
|
|
6105
|
+
);
|
|
6106
|
+
} else {
|
|
6107
|
+
return createAPIRequest<Schema$Operation>(parameters);
|
|
6108
|
+
}
|
|
6109
|
+
}
|
|
6110
|
+
|
|
5700
6111
|
/**
|
|
5701
6112
|
* Starts the replication in the read replica instance.
|
|
5702
6113
|
*
|
|
@@ -5874,7 +6285,7 @@ export namespace sqladmin_v1 {
|
|
|
5874
6285
|
}
|
|
5875
6286
|
|
|
5876
6287
|
/**
|
|
5877
|
-
* Switches over from the primary instance to the
|
|
6288
|
+
* Switches over from the primary instance to the DR replica instance.
|
|
5878
6289
|
*
|
|
5879
6290
|
* @param params - Parameters for request
|
|
5880
6291
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -6162,6 +6573,17 @@ export namespace sqladmin_v1 {
|
|
|
6162
6573
|
*/
|
|
6163
6574
|
project?: string;
|
|
6164
6575
|
}
|
|
6576
|
+
export interface Params$Resource$Instances$Addservercertificate
|
|
6577
|
+
extends StandardParameters {
|
|
6578
|
+
/**
|
|
6579
|
+
* Cloud SQL instance ID. This does not include the project ID.
|
|
6580
|
+
*/
|
|
6581
|
+
instance?: string;
|
|
6582
|
+
/**
|
|
6583
|
+
* Project ID of the project that contains the instance.
|
|
6584
|
+
*/
|
|
6585
|
+
project?: string;
|
|
6586
|
+
}
|
|
6165
6587
|
export interface Params$Resource$Instances$Clone extends StandardParameters {
|
|
6166
6588
|
/**
|
|
6167
6589
|
* The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID.
|
|
@@ -6314,6 +6736,17 @@ export namespace sqladmin_v1 {
|
|
|
6314
6736
|
*/
|
|
6315
6737
|
project?: string;
|
|
6316
6738
|
}
|
|
6739
|
+
export interface Params$Resource$Instances$Listservercertificates
|
|
6740
|
+
extends StandardParameters {
|
|
6741
|
+
/**
|
|
6742
|
+
* Required. Cloud SQL instance ID. This does not include the project ID.
|
|
6743
|
+
*/
|
|
6744
|
+
instance?: string;
|
|
6745
|
+
/**
|
|
6746
|
+
* Required. Project ID of the project that contains the instance.
|
|
6747
|
+
*/
|
|
6748
|
+
project?: string;
|
|
6749
|
+
}
|
|
6317
6750
|
export interface Params$Resource$Instances$Patch extends StandardParameters {
|
|
6318
6751
|
/**
|
|
6319
6752
|
* Cloud SQL instance ID. This does not include the project ID.
|
|
@@ -6332,7 +6765,7 @@ export namespace sqladmin_v1 {
|
|
|
6332
6765
|
export interface Params$Resource$Instances$Promotereplica
|
|
6333
6766
|
extends StandardParameters {
|
|
6334
6767
|
/**
|
|
6335
|
-
* Set to true to invoke a replica failover to the
|
|
6768
|
+
* Set to true to invoke a replica failover to the DR replica. As part of replica failover, the promote operation attempts to add the original primary instance as a replica of the promoted DR replica when the original primary instance comes back online. If set to false or not specified, then the original primary instance becomes an independent Cloud SQL primary instance.
|
|
6336
6769
|
*/
|
|
6337
6770
|
failover?: boolean;
|
|
6338
6771
|
/**
|
|
@@ -6425,6 +6858,22 @@ export namespace sqladmin_v1 {
|
|
|
6425
6858
|
*/
|
|
6426
6859
|
requestBody?: Schema$InstancesRotateServerCaRequest;
|
|
6427
6860
|
}
|
|
6861
|
+
export interface Params$Resource$Instances$Rotateservercertificate
|
|
6862
|
+
extends StandardParameters {
|
|
6863
|
+
/**
|
|
6864
|
+
* Required. Cloud SQL instance ID. This does not include the project ID.
|
|
6865
|
+
*/
|
|
6866
|
+
instance?: string;
|
|
6867
|
+
/**
|
|
6868
|
+
* Required. Project ID of the project that contains the instance.
|
|
6869
|
+
*/
|
|
6870
|
+
project?: string;
|
|
6871
|
+
|
|
6872
|
+
/**
|
|
6873
|
+
* Request body metadata
|
|
6874
|
+
*/
|
|
6875
|
+
requestBody?: Schema$InstancesRotateServerCertificateRequest;
|
|
6876
|
+
}
|
|
6428
6877
|
export interface Params$Resource$Instances$Startreplica
|
|
6429
6878
|
extends StandardParameters {
|
|
6430
6879
|
/**
|
|
@@ -6450,7 +6899,7 @@ export namespace sqladmin_v1 {
|
|
|
6450
6899
|
export interface Params$Resource$Instances$Switchover
|
|
6451
6900
|
extends StandardParameters {
|
|
6452
6901
|
/**
|
|
6453
|
-
* Optional. (MySQL only) Cloud SQL instance operations timeout, which is a sum of all database operations. Default value is 10 minutes and can be modified to a maximum value of 24 hours.
|
|
6902
|
+
* Optional. (MySQL and PostgreSQL only) Cloud SQL instance operations timeout, which is a sum of all database operations. Default value is 10 minutes and can be modified to a maximum value of 24 hours.
|
|
6454
6903
|
*/
|
|
6455
6904
|
dbTimeout?: string;
|
|
6456
6905
|
/**
|