@googleapis/sqladmin 25.0.0 → 26.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/build/v1.d.ts CHANGED
@@ -69,6 +69,7 @@ export declare namespace sqladmin_v1 {
69
69
  export class Sqladmin {
70
70
  context: APIRequestContext;
71
71
  backupRuns: Resource$Backupruns;
72
+ Backups: Resource$Backups;
72
73
  connect: Resource$Connect;
73
74
  databases: Resource$Databases;
74
75
  flags: Resource$Flags;
@@ -165,6 +166,103 @@ export declare namespace sqladmin_v1 {
165
166
  */
166
167
  name?: string | null;
167
168
  }
169
+ /**
170
+ * A backup resource.
171
+ */
172
+ export interface Schema$Backup {
173
+ /**
174
+ * Output only. This output contains the following values: start_time: All database writes up to this time are available. end_time: Any database writes after this time aren't available.
175
+ */
176
+ backupInterval?: Schema$Interval;
177
+ /**
178
+ * Output only. Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
179
+ */
180
+ backupKind?: string | null;
181
+ /**
182
+ * Output only. The mapping to backup run resource used for IAM validations.
183
+ */
184
+ backupRun?: string | null;
185
+ /**
186
+ * Output only. The database version of the instance of when this backup was made.
187
+ */
188
+ databaseVersion?: string | null;
189
+ /**
190
+ * The description of this backup.
191
+ */
192
+ description?: string | null;
193
+ /**
194
+ * Output only. Information about why the backup operation fails (for example, when the backup state fails).
195
+ */
196
+ error?: Schema$OperationError;
197
+ /**
198
+ * Backup expiration time. A UTC timestamp of when this backup expired.
199
+ */
200
+ expiryTime?: string | null;
201
+ /**
202
+ * The name of the source database instance.
203
+ */
204
+ instance?: string | null;
205
+ /**
206
+ * Optional. Output only. Timestamp in UTC of when the instance associated with this backup is deleted.
207
+ */
208
+ instanceDeletionTime?: string | null;
209
+ /**
210
+ * Optional. Output only. The instance setting of the source instance that's associated with this backup.
211
+ */
212
+ instanceSettings?: Schema$DatabaseInstance;
213
+ /**
214
+ * Output only. This is always `sql#backup`.
215
+ */
216
+ kind?: string | null;
217
+ /**
218
+ * Output only. This output contains the encryption configuration for a backup and the resource name of the KMS key for disk encryption.
219
+ */
220
+ kmsKey?: string | null;
221
+ /**
222
+ * Output only. This output contains the encryption status for a backup and the version of the KMS key that's used to encrypt the Cloud SQL instance.
223
+ */
224
+ kmsKeyVersion?: string | null;
225
+ /**
226
+ * The storage location of the backups. The location can be multi-regional.
227
+ */
228
+ location?: string | null;
229
+ /**
230
+ * Output only. The maximum chargeable bytes for the backup.
231
+ */
232
+ maxChargeableBytes?: string | null;
233
+ /**
234
+ * Output only. The resource name of the backup. Format: projects/{project\}/backups/{backup\}.
235
+ */
236
+ name?: string | null;
237
+ /**
238
+ * Output only. This status indicates whether the backup satisfies PZI. The status is reserved for future use.
239
+ */
240
+ satisfiesPzi?: boolean | null;
241
+ /**
242
+ * Output only. This status indicates whether the backup satisfies PZS. The status is reserved for future use.
243
+ */
244
+ satisfiesPzs?: boolean | null;
245
+ /**
246
+ * Output only. The URI of this resource.
247
+ */
248
+ selfLink?: string | null;
249
+ /**
250
+ * Output only. The status of this backup.
251
+ */
252
+ state?: string | null;
253
+ /**
254
+ * Output only. This output contains a backup time zone. If a Cloud SQL for SQL Server instance has a different time zone from the backup's time zone, then the restore to the instance doesn't happen.
255
+ */
256
+ timeZone?: string | null;
257
+ /**
258
+ * Input only. The time-to-live (TTL) interval for this resource (in days). For example: ttlDays:7, means 7 days from the current time. The expiration time can't exceed 365 days from the time that the backup is created.
259
+ */
260
+ ttlDays?: string | null;
261
+ /**
262
+ * Output only. The type of this backup. The type can be "AUTOMATED", "ON_DEMAND" or “FINAL”.
263
+ */
264
+ type?: string | null;
265
+ }
168
266
  /**
169
267
  * Database instance backup configuration.
170
268
  */
@@ -222,6 +320,10 @@ export declare namespace sqladmin_v1 {
222
320
  * This is always `sql#backupContext`.
223
321
  */
224
322
  kind?: string | null;
323
+ /**
324
+ * The name of the backup. Format: projects/{project\}/backups/{backup\}
325
+ */
326
+ name?: string | null;
225
327
  }
226
328
  /**
227
329
  * Backup Reencryption Config
@@ -257,6 +359,10 @@ export declare namespace sqladmin_v1 {
257
359
  * Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
258
360
  */
259
361
  backupKind?: string | null;
362
+ /**
363
+ * Output only. The instance database version when this backup was made.
364
+ */
365
+ databaseVersion?: string | null;
260
366
  /**
261
367
  * The description of this run, only applicable to on-demand backups.
262
368
  */
@@ -401,6 +507,77 @@ export declare namespace sqladmin_v1 {
401
507
  */
402
508
  preferredZone?: string | null;
403
509
  }
510
+ /**
511
+ * The managed connection pooling configuration.
512
+ */
513
+ export interface Schema$ConnectionPoolConfig {
514
+ /**
515
+ * Client idle timeout.
516
+ */
517
+ clientConnectionIdleTimeout?: string | null;
518
+ /**
519
+ * Whether managed connection pooling is enabled.
520
+ */
521
+ connectionPoolingEnabled?: boolean | null;
522
+ /**
523
+ * Managed connection pool size.
524
+ */
525
+ connPoolSize?: number | null;
526
+ /**
527
+ * Optional. List of connection pool configuration flags
528
+ */
529
+ flags?: Schema$ConnectionPoolFlags[];
530
+ /**
531
+ * Maximum number of client connections in connection pool.
532
+ */
533
+ maxClientConnections?: number | null;
534
+ /**
535
+ * The managed connection pool mode for the instance.
536
+ */
537
+ poolMode?: string | null;
538
+ /**
539
+ * Query wait timeout.
540
+ */
541
+ queryWaitTimeout?: string | null;
542
+ /**
543
+ * Server idle timeout.
544
+ */
545
+ serverConnectionIdleTimeout?: string | null;
546
+ }
547
+ /**
548
+ * Connection pool flags for Cloud SQL instances managed connection pool configuration.
549
+ */
550
+ export interface Schema$ConnectionPoolFlags {
551
+ /**
552
+ * Required. The name of the flag.
553
+ */
554
+ name?: string | null;
555
+ /**
556
+ * Required. The value of the flag. Boolean flags are set to `on` for true and `off` for false. This field must be omitted if the flag doesn't take a value.
557
+ */
558
+ value?: string | null;
559
+ }
560
+ /**
561
+ * Details of a single node of a read pool.
562
+ */
563
+ export interface Schema$ConnectPoolNodeConfig {
564
+ /**
565
+ * Output only. The DNS name of the node.
566
+ */
567
+ dnsName?: string | null;
568
+ /**
569
+ * Output only. The list of DNS names used by this node.
570
+ */
571
+ dnsNames?: Schema$DnsNameMapping[];
572
+ /**
573
+ * Output only. Mappings containing IP addresses that can be used to connect to the node.
574
+ */
575
+ ipAddresses?: Schema$IpMapping[];
576
+ /**
577
+ * Output only. The name of the node. Doesn't include the project ID.
578
+ */
579
+ name?: string | null;
580
+ }
404
581
  /**
405
582
  * Connect settings retrieval response.
406
583
  */
@@ -421,6 +598,10 @@ export declare namespace sqladmin_v1 {
421
598
  * The dns name of the instance.
422
599
  */
423
600
  dnsName?: string | null;
601
+ /**
602
+ * Output only. The list of DNS names used by this instance.
603
+ */
604
+ dnsNames?: Schema$DnsNameMapping[];
424
605
  /**
425
606
  * The assigned IP addresses for the instance.
426
607
  */
@@ -429,6 +610,14 @@ export declare namespace sqladmin_v1 {
429
610
  * This is always `sql#connectSettings`.
430
611
  */
431
612
  kind?: string | null;
613
+ /**
614
+ * The number of nodes in a read pool.
615
+ */
616
+ nodeCount?: number | null;
617
+ /**
618
+ * Output only. Entries containing information about each node of the read pool.
619
+ */
620
+ nodes?: Schema$ConnectPoolNodeConfig[];
432
621
  /**
433
622
  * Whether PSC connectivity is enabled for this instance.
434
623
  */
@@ -541,6 +730,10 @@ export declare namespace sqladmin_v1 {
541
730
  * Output only. The dns name of the instance.
542
731
  */
543
732
  dnsName?: string | null;
733
+ /**
734
+ * Output only. The list of DNS names used by this instance.
735
+ */
736
+ dnsNames?: Schema$DnsNameMapping[];
544
737
  /**
545
738
  * This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead.
546
739
  */
@@ -560,6 +753,10 @@ export declare namespace sqladmin_v1 {
560
753
  * Gemini instance configuration.
561
754
  */
562
755
  geminiConfig?: Schema$GeminiInstanceConfig;
756
+ /**
757
+ * Input only. Determines whether an in-place major version upgrade of replicas happens when an in-place major version upgrade of a primary instance is initiated.
758
+ */
759
+ includeReplicasForMajorVersionUpgrade?: boolean | null;
563
760
  /**
564
761
  * The instance type.
565
762
  */
@@ -592,6 +789,14 @@ export declare namespace sqladmin_v1 {
592
789
  * Name of the Cloud SQL instance. This does not include the project ID.
593
790
  */
594
791
  name?: string | null;
792
+ /**
793
+ * The number of nodes in a read pool.
794
+ */
795
+ nodeCount?: number | null;
796
+ /**
797
+ * Output only. Entries containing information about each node of the read pool.
798
+ */
799
+ nodes?: Schema$PoolNodeConfig[];
595
800
  /**
596
801
  * Configuration specific to on-premises instances.
597
802
  */
@@ -778,7 +983,7 @@ export declare namespace sqladmin_v1 {
778
983
  */
779
984
  clientCertificate?: string | null;
780
985
  /**
781
- * PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate. The format of the replica's private key can be either PKCS #1 or PKCS #8.
986
+ * PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate. The format of the replica's private key can be either PKCS #1 or PKCS #8.
782
987
  */
783
988
  clientKey?: string | null;
784
989
  /**
@@ -837,6 +1042,23 @@ export declare namespace sqladmin_v1 {
837
1042
  */
838
1043
  kmsKeyVersionName?: string | null;
839
1044
  }
1045
+ /**
1046
+ * DNS metadata.
1047
+ */
1048
+ export interface Schema$DnsNameMapping {
1049
+ /**
1050
+ * Output only. The connection type of the DNS name.
1051
+ */
1052
+ connectionType?: string | null;
1053
+ /**
1054
+ * Output only. The scope that the DNS name applies to.
1055
+ */
1056
+ dnsScope?: string | null;
1057
+ /**
1058
+ * The DNS name.
1059
+ */
1060
+ name?: string | null;
1061
+ }
840
1062
  /**
841
1063
  * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \}
842
1064
  */
@@ -869,7 +1091,7 @@ export declare namespace sqladmin_v1 {
869
1091
  selectQuery?: string;
870
1092
  } | null;
871
1093
  /**
872
- * Databases to be exported. `MySQL instances:` If `fileType` is `SQL` and no database is specified, all databases are exported, except for the `mysql` system database. If `fileType` is `CSV`, you can specify one database, either by using this property or by using the `csvExportOptions.selectQuery` property, which takes precedence over this property. `PostgreSQL instances:` You must specify one database to be exported. If `fileType` is `CSV`, this database must match the one specified in the `csvExportOptions.selectQuery` property. `SQL Server instances:` You must specify one database to be exported, and the `fileType` must be `BAK`.
1094
+ * Databases to be exported. `MySQL instances:` If `fileType` is `SQL` and no database is specified, all databases are exported, except for the `mysql` system database. If `fileType` is `CSV`, you can specify one database, either by using this property or by using the `csvExportOptions.selectQuery` property, which takes precedence over this property. `PostgreSQL instances:` If you don't specify a database by name, all user databases in the instance are exported. This excludes system databases and Cloud SQL databases used to manage internal operations. Exporting all user databases is only available for directory-formatted parallel export. If `fileType` is `CSV`, this database must match the one specified in the `csvExportOptions.selectQuery` property. `SQL Server instances:` You must specify one database to be exported, and the `fileType` must be `BAK`.
873
1095
  */
874
1096
  databases?: string[] | null;
875
1097
  /**
@@ -900,6 +1122,15 @@ export declare namespace sqladmin_v1 {
900
1122
  tables?: string[];
901
1123
  threads?: number;
902
1124
  } | null;
1125
+ /**
1126
+ * Optional. Export parameters specific to SQL Server TDE certificates
1127
+ */
1128
+ tdeExportOptions?: {
1129
+ certificatePath?: string;
1130
+ name?: string;
1131
+ privateKeyPassword?: string;
1132
+ privateKeyPath?: string;
1133
+ } | null;
903
1134
  /**
904
1135
  * The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form `gs://bucketName/fileName`. If the file already exists, the request succeeds, but the operation fails. If `fileType` is `SQL` and the filename ends with .gz, the contents are compressed.
905
1136
  */
@@ -943,6 +1174,10 @@ export declare namespace sqladmin_v1 {
943
1174
  * The database version this flag applies to. Can be MySQL instances: `MYSQL_8_0`, `MYSQL_8_0_18`, `MYSQL_8_0_26`, `MYSQL_5_7`, or `MYSQL_5_6`. PostgreSQL instances: `POSTGRES_9_6`, `POSTGRES_10`, `POSTGRES_11` or `POSTGRES_12`. SQL Server instances: `SQLSERVER_2017_STANDARD`, `SQLSERVER_2017_ENTERPRISE`, `SQLSERVER_2017_EXPRESS`, `SQLSERVER_2017_WEB`, `SQLSERVER_2019_STANDARD`, `SQLSERVER_2019_ENTERPRISE`, `SQLSERVER_2019_EXPRESS`, or `SQLSERVER_2019_WEB`. See [the complete list](/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion).
944
1175
  */
945
1176
  appliesTo?: string[] | null;
1177
+ /**
1178
+ * Scope of flag.
1179
+ */
1180
+ flagScope?: string | null;
946
1181
  /**
947
1182
  * Whether or not the flag is considered in beta.
948
1183
  */
@@ -963,6 +1198,14 @@ export declare namespace sqladmin_v1 {
963
1198
  * This is the name of the flag. Flag names always use underscores, not hyphens, for example: `max_allowed_packet`
964
1199
  */
965
1200
  name?: string | null;
1201
+ /**
1202
+ * Recommended int value in integer format for UI display.
1203
+ */
1204
+ recommendedIntValue?: string | null;
1205
+ /**
1206
+ * Recommended string value in string format for UI display.
1207
+ */
1208
+ recommendedStringValue?: string | null;
966
1209
  /**
967
1210
  * Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances.
968
1211
  */
@@ -1055,6 +1298,7 @@ export declare namespace sqladmin_v1 {
1055
1298
  bakType?: string;
1056
1299
  encryptionOptions?: {
1057
1300
  certPath?: string;
1301
+ keepEncrypted?: boolean;
1058
1302
  pvkPassword?: string;
1059
1303
  pvkPath?: string;
1060
1304
  };
@@ -1076,7 +1320,7 @@ export declare namespace sqladmin_v1 {
1076
1320
  table?: string;
1077
1321
  } | null;
1078
1322
  /**
1079
- * The target database for the import. If `fileType` is `SQL`, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. If `fileType` is `CSV`, one database must be specified.
1323
+ * The target database for the import. If `fileType` is `SQL`, this field is required only if the import file does not specify a database, and is overridden by any database specification in the import file. For entire instance parallel import operations, the database is overridden by the database name stored in subdirectory name. If `fileType` is `CSV`, one database must be specified.
1080
1324
  */
1081
1325
  database?: string | null;
1082
1326
  /**
@@ -1102,6 +1346,15 @@ export declare namespace sqladmin_v1 {
1102
1346
  };
1103
1347
  threads?: number;
1104
1348
  } | null;
1349
+ /**
1350
+ * Optional. Import parameters specific to SQL Server TDE certificates
1351
+ */
1352
+ tdeImportOptions?: {
1353
+ certificatePath?: string;
1354
+ name?: string;
1355
+ privateKeyPassword?: string;
1356
+ privateKeyPath?: string;
1357
+ } | null;
1105
1358
  /**
1106
1359
  * Path to the import file in Cloud Storage, in the form `gs://bucketName/fileName`. Compressed gzip files (.gz) are supported when `fileType` is `SQL`. The instance must have write permissions to the bucket and read access to the file.
1107
1360
  */
@@ -1281,10 +1534,18 @@ export declare namespace sqladmin_v1 {
1281
1534
  * Database instance restore backup request.
1282
1535
  */
1283
1536
  export interface Schema$InstancesRestoreBackupRequest {
1537
+ /**
1538
+ * The name of the backup that's used to restore a Cloud SQL instance: Format: projects/{project-id\}/backups/{backup-uid\}. Only one of restore_backup_context, backup, backupdr_backup can be passed to the input.
1539
+ */
1540
+ backup?: string | null;
1284
1541
  /**
1285
1542
  * Parameters required to perform the restore backup operation.
1286
1543
  */
1287
1544
  restoreBackupContext?: Schema$RestoreBackupContext;
1545
+ /**
1546
+ * 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.
1547
+ */
1548
+ restoreInstanceSettings?: Schema$DatabaseInstance;
1288
1549
  }
1289
1550
  /**
1290
1551
  * Rotate server CA request.
@@ -1313,6 +1574,19 @@ export declare namespace sqladmin_v1 {
1313
1574
  */
1314
1575
  truncateLogContext?: Schema$TruncateLogContext;
1315
1576
  }
1577
+ /**
1578
+ * Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.
1579
+ */
1580
+ export interface Schema$Interval {
1581
+ /**
1582
+ * Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
1583
+ */
1584
+ endTime?: string | null;
1585
+ /**
1586
+ * Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
1587
+ */
1588
+ startTime?: string | null;
1589
+ }
1316
1590
  /**
1317
1591
  * IP Management configuration.
1318
1592
  */
@@ -1354,7 +1628,7 @@ export declare namespace sqladmin_v1 {
1354
1628
  */
1355
1629
  serverCaMode?: string | null;
1356
1630
  /**
1357
- * 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/
1631
+ * Optional. The resource name of the server CA pool for an instance with `CUSTOMER_MANAGED_CAS_CA` as the `server_ca_mode`. Format: projects/{PROJECT\}/locations/{REGION\}/caPools/{CA_POOL_ID\}
1358
1632
  */
1359
1633
  serverCaPool?: string | null;
1360
1634
  /**
@@ -1379,6 +1653,23 @@ export declare namespace sqladmin_v1 {
1379
1653
  */
1380
1654
  type?: string | null;
1381
1655
  }
1656
+ /**
1657
+ * The response payload containing a list of the backups.
1658
+ */
1659
+ export interface Schema$ListBackupsResponse {
1660
+ /**
1661
+ * A list of backups.
1662
+ */
1663
+ backups?: Schema$Backup[];
1664
+ /**
1665
+ * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, then there aren't subsequent pages.
1666
+ */
1667
+ nextPageToken?: string | null;
1668
+ /**
1669
+ * If a region isn't unavailable or if an unknown error occurs, then a warning message is returned.
1670
+ */
1671
+ warnings?: Schema$ApiWarning[];
1672
+ }
1382
1673
  /**
1383
1674
  * Preferred location. This specifies where a Cloud SQL instance is located. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified.
1384
1675
  */
@@ -1434,7 +1725,7 @@ export declare namespace sqladmin_v1 {
1434
1725
  */
1435
1726
  clientCertificate?: string | null;
1436
1727
  /**
1437
- * PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
1728
+ * PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate.
1438
1729
  */
1439
1730
  clientKey?: string | null;
1440
1731
  /**
@@ -1492,7 +1783,7 @@ export declare namespace sqladmin_v1 {
1492
1783
  */
1493
1784
  clientCertificate?: string | null;
1494
1785
  /**
1495
- * PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
1786
+ * PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate.
1496
1787
  */
1497
1788
  clientKey?: string | null;
1498
1789
  /**
@@ -1592,6 +1883,9 @@ export declare namespace sqladmin_v1 {
1592
1883
  * Optional. The sub operation based on the operation type.
1593
1884
  */
1594
1885
  subOperationType?: Schema$SqlSubOperationType;
1886
+ /**
1887
+ * Name of the resource on which this operation runs.
1888
+ */
1595
1889
  targetId?: string | null;
1596
1890
  targetLink?: string | null;
1597
1891
  /**
@@ -1738,6 +2032,35 @@ export declare namespace sqladmin_v1 {
1738
2032
  */
1739
2033
  targetSizeGb?: string | null;
1740
2034
  }
2035
+ /**
2036
+ * Details of a single node of a read pool.
2037
+ */
2038
+ export interface Schema$PoolNodeConfig {
2039
+ /**
2040
+ * Output only. The DNS name of the node.
2041
+ */
2042
+ dnsName?: string | null;
2043
+ /**
2044
+ * Output only. The list of DNS names used by this node.
2045
+ */
2046
+ dnsNames?: Schema$DnsNameMapping[];
2047
+ /**
2048
+ * Output only. The serving zone of the node.
2049
+ */
2050
+ gceZone?: string | null;
2051
+ /**
2052
+ * Output only. Mappings containing IP addresses that can be used to connect to the node.
2053
+ */
2054
+ ipAddresses?: Schema$IpMapping[];
2055
+ /**
2056
+ * Output only. The name of the node, to be used for retrieving metrics and logs for the node.
2057
+ */
2058
+ name?: string | null;
2059
+ /**
2060
+ * Output only. The current state of the node.
2061
+ */
2062
+ state?: string | null;
2063
+ }
1741
2064
  /**
1742
2065
  * Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance.
1743
2066
  */
@@ -1916,6 +2239,10 @@ export declare namespace sqladmin_v1 {
1916
2239
  * The name of server Instance collation.
1917
2240
  */
1918
2241
  collation?: string | null;
2242
+ /**
2243
+ * Optional. The managed connection pooling configuration for the instance.
2244
+ */
2245
+ connectionPoolConfig?: Schema$ConnectionPoolConfig;
1919
2246
  /**
1920
2247
  * Specifies if connections must use Cloud SQL connectors. Option values include the following: `NOT_REQUIRED` (Cloud SQL instances can be connected without Cloud SQL Connectors) and `REQUIRED` (Only allow connections that use Cloud SQL Connectors). Note that using REQUIRED disables all existing authorized networks. If this field is not specified when creating a new instance, NOT_REQUIRED is used. If this field is not specified when patching or updating an existing instance, it is left unchanged in the instance.
1921
2248
  */
@@ -1936,6 +2263,14 @@ export declare namespace sqladmin_v1 {
1936
2263
  * Configuration for data cache.
1937
2264
  */
1938
2265
  dataCacheConfig?: Schema$DataCacheConfig;
2266
+ /**
2267
+ * Optional. Provisioned number of I/O operations per second for the data disk. This field is only used for hyperdisk-balanced disk types.
2268
+ */
2269
+ dataDiskProvisionedIops?: string | null;
2270
+ /**
2271
+ * Optional. Provisioned throughput measured in MiB per second for the data disk. This field is only used for hyperdisk-balanced disk types.
2272
+ */
2273
+ dataDiskProvisionedThroughput?: string | null;
1939
2274
  /**
1940
2275
  * The size of data disk, in GB. The data disk size minimum is 10GB.
1941
2276
  */
@@ -2000,6 +2335,10 @@ export declare namespace sqladmin_v1 {
2000
2335
  * The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances.
2001
2336
  */
2002
2337
  replicationType?: string | null;
2338
+ /**
2339
+ * Optional. When this parameter is set to true, Cloud SQL retains backups of the instance even after the instance is deleted. The ON_DEMAND backup will be retained until customer deletes the backup or the project. The AUTOMATED backup will be retained based on the backups retention setting.
2340
+ */
2341
+ retainBackupsOnDelete?: boolean | null;
2003
2342
  /**
2004
2343
  * The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
2005
2344
  */
@@ -2667,6 +3006,134 @@ export declare namespace sqladmin_v1 {
2667
3006
  */
2668
3007
  project?: string;
2669
3008
  }
3009
+ export class Resource$Backups {
3010
+ context: APIRequestContext;
3011
+ constructor(context: APIRequestContext);
3012
+ /**
3013
+ * Creates a backup for a Cloud SQL instance. This API can be used only to create on-demand backups.
3014
+ *
3015
+ * @param params - Parameters for request
3016
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
3017
+ * @param callback - Optional callback that handles the response.
3018
+ * @returns A promise if used with async/await, or void if used with a callback.
3019
+ */
3020
+ CreateBackup(params: Params$Resource$Backups$Createbackup, options: StreamMethodOptions): GaxiosPromise<Readable>;
3021
+ CreateBackup(params?: Params$Resource$Backups$Createbackup, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
3022
+ CreateBackup(params: Params$Resource$Backups$Createbackup, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
3023
+ CreateBackup(params: Params$Resource$Backups$Createbackup, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
3024
+ CreateBackup(params: Params$Resource$Backups$Createbackup, callback: BodyResponseCallback<Schema$Operation>): void;
3025
+ CreateBackup(callback: BodyResponseCallback<Schema$Operation>): void;
3026
+ /**
3027
+ * Deletes the backup.
3028
+ *
3029
+ * @param params - Parameters for request
3030
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
3031
+ * @param callback - Optional callback that handles the response.
3032
+ * @returns A promise if used with async/await, or void if used with a callback.
3033
+ */
3034
+ DeleteBackup(params: Params$Resource$Backups$Deletebackup, options: StreamMethodOptions): GaxiosPromise<Readable>;
3035
+ DeleteBackup(params?: Params$Resource$Backups$Deletebackup, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
3036
+ DeleteBackup(params: Params$Resource$Backups$Deletebackup, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
3037
+ DeleteBackup(params: Params$Resource$Backups$Deletebackup, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
3038
+ DeleteBackup(params: Params$Resource$Backups$Deletebackup, callback: BodyResponseCallback<Schema$Operation>): void;
3039
+ DeleteBackup(callback: BodyResponseCallback<Schema$Operation>): void;
3040
+ /**
3041
+ * Retrieves a resource containing information about a backup.
3042
+ *
3043
+ * @param params - Parameters for request
3044
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
3045
+ * @param callback - Optional callback that handles the response.
3046
+ * @returns A promise if used with async/await, or void if used with a callback.
3047
+ */
3048
+ GetBackup(params: Params$Resource$Backups$Getbackup, options: StreamMethodOptions): GaxiosPromise<Readable>;
3049
+ GetBackup(params?: Params$Resource$Backups$Getbackup, options?: MethodOptions): GaxiosPromise<Schema$Backup>;
3050
+ GetBackup(params: Params$Resource$Backups$Getbackup, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
3051
+ GetBackup(params: Params$Resource$Backups$Getbackup, options: MethodOptions | BodyResponseCallback<Schema$Backup>, callback: BodyResponseCallback<Schema$Backup>): void;
3052
+ GetBackup(params: Params$Resource$Backups$Getbackup, callback: BodyResponseCallback<Schema$Backup>): void;
3053
+ GetBackup(callback: BodyResponseCallback<Schema$Backup>): void;
3054
+ /**
3055
+ * Lists all backups associated with the project.
3056
+ *
3057
+ * @param params - Parameters for request
3058
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
3059
+ * @param callback - Optional callback that handles the response.
3060
+ * @returns A promise if used with async/await, or void if used with a callback.
3061
+ */
3062
+ ListBackups(params: Params$Resource$Backups$Listbackups, options: StreamMethodOptions): GaxiosPromise<Readable>;
3063
+ ListBackups(params?: Params$Resource$Backups$Listbackups, options?: MethodOptions): GaxiosPromise<Schema$ListBackupsResponse>;
3064
+ ListBackups(params: Params$Resource$Backups$Listbackups, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
3065
+ ListBackups(params: Params$Resource$Backups$Listbackups, options: MethodOptions | BodyResponseCallback<Schema$ListBackupsResponse>, callback: BodyResponseCallback<Schema$ListBackupsResponse>): void;
3066
+ ListBackups(params: Params$Resource$Backups$Listbackups, callback: BodyResponseCallback<Schema$ListBackupsResponse>): void;
3067
+ ListBackups(callback: BodyResponseCallback<Schema$ListBackupsResponse>): void;
3068
+ /**
3069
+ * Updates the retention period and description of the backup. You can use this API to update final backups only.
3070
+ *
3071
+ * @param params - Parameters for request
3072
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
3073
+ * @param callback - Optional callback that handles the response.
3074
+ * @returns A promise if used with async/await, or void if used with a callback.
3075
+ */
3076
+ UpdateBackup(params: Params$Resource$Backups$Updatebackup, options: StreamMethodOptions): GaxiosPromise<Readable>;
3077
+ UpdateBackup(params?: Params$Resource$Backups$Updatebackup, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
3078
+ UpdateBackup(params: Params$Resource$Backups$Updatebackup, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
3079
+ UpdateBackup(params: Params$Resource$Backups$Updatebackup, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
3080
+ UpdateBackup(params: Params$Resource$Backups$Updatebackup, callback: BodyResponseCallback<Schema$Operation>): void;
3081
+ UpdateBackup(callback: BodyResponseCallback<Schema$Operation>): void;
3082
+ }
3083
+ export interface Params$Resource$Backups$Createbackup extends StandardParameters {
3084
+ /**
3085
+ * Required. The parent resource where this backup is created. Format: projects/{project\}
3086
+ */
3087
+ parent?: string;
3088
+ /**
3089
+ * Request body metadata
3090
+ */
3091
+ requestBody?: Schema$Backup;
3092
+ }
3093
+ export interface Params$Resource$Backups$Deletebackup extends StandardParameters {
3094
+ /**
3095
+ * Required. The name of the backup to delete. Format: projects/{project\}/backups/{backup\}
3096
+ */
3097
+ name?: string;
3098
+ }
3099
+ export interface Params$Resource$Backups$Getbackup extends StandardParameters {
3100
+ /**
3101
+ * Required. The name of the backup to retrieve. Format: projects/{project\}/backups/{backup\}
3102
+ */
3103
+ name?: string;
3104
+ }
3105
+ export interface Params$Resource$Backups$Listbackups extends StandardParameters {
3106
+ /**
3107
+ * Multiple filter queries are separated by spaces. For example, 'instance:abc AND type:FINAL, 'location:us', 'backupInterval.startTime\>=1950-01-01T01:01:25.771Z'. You can filter by type, instance, backupInterval.startTime (creation time), or location.
3108
+ */
3109
+ filter?: string;
3110
+ /**
3111
+ * The maximum number of backups to return per response. The service might return fewer backups than this value. If a value for this parameter isn't specified, then, at most, 500 backups are returned. The maximum value is 2,000. Any values that you set, which are greater than 2,000, are changed to 2,000.
3112
+ */
3113
+ pageSize?: number;
3114
+ /**
3115
+ * A page token, received from a previous `ListBackups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBackups` must match the call that provided the page token.
3116
+ */
3117
+ pageToken?: string;
3118
+ /**
3119
+ * Required. The parent that owns this collection of backups. Format: projects/{project\}
3120
+ */
3121
+ parent?: string;
3122
+ }
3123
+ export interface Params$Resource$Backups$Updatebackup extends StandardParameters {
3124
+ /**
3125
+ * Output only. The resource name of the backup. Format: projects/{project\}/backups/{backup\}.
3126
+ */
3127
+ name?: string;
3128
+ /**
3129
+ * The list of fields that you can update. You can update only the description and retention period of the final backup.
3130
+ */
3131
+ updateMask?: string;
3132
+ /**
3133
+ * Request body metadata
3134
+ */
3135
+ requestBody?: Schema$Backup;
3136
+ }
2670
3137
  export class Resource$Connect {
2671
3138
  context: APIRequestContext;
2672
3139
  constructor(context: APIRequestContext);
@@ -2926,6 +3393,10 @@ export declare namespace sqladmin_v1 {
2926
3393
  * Database type and version you want to retrieve flags for. By default, this method returns flags for all database types and versions.
2927
3394
  */
2928
3395
  databaseVersion?: string;
3396
+ /**
3397
+ * Optional. Specify the scope of flags to be returned by SqlFlagsListService. Return list of database flags if unspecified.
3398
+ */
3399
+ flagScope?: string;
2929
3400
  }
2930
3401
  export class Resource$Instances {
2931
3402
  context: APIRequestContext;
@@ -3386,6 +3857,22 @@ export declare namespace sqladmin_v1 {
3386
3857
  requestBody?: Schema$InstancesCloneRequest;
3387
3858
  }
3388
3859
  export interface Params$Resource$Instances$Delete extends StandardParameters {
3860
+ /**
3861
+ * Flag to opt-in for final backup. By default, it is turned off.
3862
+ */
3863
+ enableFinalBackup?: boolean;
3864
+ /**
3865
+ * Optional. The description of the final backup.
3866
+ */
3867
+ finalBackupDescription?: string;
3868
+ /**
3869
+ * Optional. Final Backup expiration time. Timestamp in UTC of when this resource is considered expired.
3870
+ */
3871
+ finalBackupExpiryTime?: string;
3872
+ /**
3873
+ * Optional. Retention period of the final backup.
3874
+ */
3875
+ finalBackupTtlDays?: string;
3389
3876
  /**
3390
3877
  * Cloud SQL instance ID. This does not include the project ID.
3391
3878
  */