@googleapis/sqladmin 24.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
  */
@@ -409,6 +586,10 @@ export declare namespace sqladmin_v1 {
409
586
  * `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.
410
587
  */
411
588
  backendType?: string | null;
589
+ /**
590
+ * Custom subject alternative names for the server certificate.
591
+ */
592
+ customSubjectAlternativeNames?: string[] | null;
412
593
  /**
413
594
  * 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`.
414
595
  */
@@ -417,6 +598,10 @@ export declare namespace sqladmin_v1 {
417
598
  * The dns name of the instance.
418
599
  */
419
600
  dnsName?: string | null;
601
+ /**
602
+ * Output only. The list of DNS names used by this instance.
603
+ */
604
+ dnsNames?: Schema$DnsNameMapping[];
420
605
  /**
421
606
  * The assigned IP addresses for the instance.
422
607
  */
@@ -425,6 +610,14 @@ export declare namespace sqladmin_v1 {
425
610
  * This is always `sql#connectSettings`.
426
611
  */
427
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[];
428
621
  /**
429
622
  * Whether PSC connectivity is enabled for this instance.
430
623
  */
@@ -537,6 +730,10 @@ export declare namespace sqladmin_v1 {
537
730
  * Output only. The dns name of the instance.
538
731
  */
539
732
  dnsName?: string | null;
733
+ /**
734
+ * Output only. The list of DNS names used by this instance.
735
+ */
736
+ dnsNames?: Schema$DnsNameMapping[];
540
737
  /**
541
738
  * This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead.
542
739
  */
@@ -556,6 +753,10 @@ export declare namespace sqladmin_v1 {
556
753
  * Gemini instance configuration.
557
754
  */
558
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;
559
760
  /**
560
761
  * The instance type.
561
762
  */
@@ -588,6 +789,14 @@ export declare namespace sqladmin_v1 {
588
789
  * Name of the Cloud SQL instance. This does not include the project ID.
589
790
  */
590
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[];
591
800
  /**
592
801
  * Configuration specific to on-premises instances.
593
802
  */
@@ -621,7 +830,7 @@ export declare namespace sqladmin_v1 {
621
830
  */
622
831
  replicaNames?: string[] | null;
623
832
  /**
624
- * 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. Only applicable to MySQL.
833
+ * 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.
625
834
  */
626
835
  replicationCluster?: Schema$ReplicationCluster;
627
836
  /**
@@ -673,6 +882,12 @@ export declare namespace sqladmin_v1 {
673
882
  * Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage.
674
883
  */
675
884
  switchTransactionLogsToCloudStorageEnabled?: boolean | null;
885
+ /**
886
+ * 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.
887
+ */
888
+ tags?: {
889
+ [key: string]: string;
890
+ } | null;
676
891
  /**
677
892
  * Output only. All database versions that are available for upgrade.
678
893
  */
@@ -768,7 +983,7 @@ export declare namespace sqladmin_v1 {
768
983
  */
769
984
  clientCertificate?: string | null;
770
985
  /**
771
- * 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.
772
987
  */
773
988
  clientKey?: string | null;
774
989
  /**
@@ -827,6 +1042,23 @@ export declare namespace sqladmin_v1 {
827
1042
  */
828
1043
  kmsKeyVersionName?: string | null;
829
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
+ }
830
1062
  /**
831
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); \}
832
1064
  */
@@ -843,6 +1075,8 @@ export declare namespace sqladmin_v1 {
843
1075
  bakType?: string;
844
1076
  copyOnly?: boolean;
845
1077
  differentialBase?: boolean;
1078
+ exportLogEndTime?: string;
1079
+ exportLogStartTime?: string;
846
1080
  stripeCount?: number;
847
1081
  striped?: boolean;
848
1082
  } | null;
@@ -857,7 +1091,7 @@ export declare namespace sqladmin_v1 {
857
1091
  selectQuery?: string;
858
1092
  } | null;
859
1093
  /**
860
- * 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`.
861
1095
  */
862
1096
  databases?: string[] | null;
863
1097
  /**
@@ -888,11 +1122,29 @@ export declare namespace sqladmin_v1 {
888
1122
  tables?: string[];
889
1123
  threads?: number;
890
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;
891
1134
  /**
892
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.
893
1136
  */
894
1137
  uri?: string | null;
895
1138
  }
1139
+ /**
1140
+ * The selected object that Cloud SQL migrates.
1141
+ */
1142
+ export interface Schema$ExternalSyncSelectedObject {
1143
+ /**
1144
+ * The name of the database that Cloud SQL migrates.
1145
+ */
1146
+ database?: string | null;
1147
+ }
896
1148
  /**
897
1149
  * Database instance failover context.
898
1150
  */
@@ -922,6 +1174,10 @@ export declare namespace sqladmin_v1 {
922
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).
923
1175
  */
924
1176
  appliesTo?: string[] | null;
1177
+ /**
1178
+ * Scope of flag.
1179
+ */
1180
+ flagScope?: string | null;
925
1181
  /**
926
1182
  * Whether or not the flag is considered in beta.
927
1183
  */
@@ -942,6 +1198,14 @@ export declare namespace sqladmin_v1 {
942
1198
  * This is the name of the flag. Flag names always use underscores, not hyphens, for example: `max_allowed_packet`
943
1199
  */
944
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;
945
1209
  /**
946
1210
  * Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances.
947
1211
  */
@@ -1034,6 +1298,7 @@ export declare namespace sqladmin_v1 {
1034
1298
  bakType?: string;
1035
1299
  encryptionOptions?: {
1036
1300
  certPath?: string;
1301
+ keepEncrypted?: boolean;
1037
1302
  pvkPassword?: string;
1038
1303
  pvkPath?: string;
1039
1304
  };
@@ -1055,7 +1320,7 @@ export declare namespace sqladmin_v1 {
1055
1320
  table?: string;
1056
1321
  } | null;
1057
1322
  /**
1058
- * 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.
1059
1324
  */
1060
1325
  database?: string | null;
1061
1326
  /**
@@ -1081,6 +1346,15 @@ export declare namespace sqladmin_v1 {
1081
1346
  };
1082
1347
  threads?: number;
1083
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;
1084
1358
  /**
1085
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.
1086
1360
  */
@@ -1226,6 +1500,27 @@ export declare namespace sqladmin_v1 {
1226
1500
  */
1227
1501
  kind?: string | null;
1228
1502
  }
1503
+ /**
1504
+ * Instances ListServerCertificates response.
1505
+ */
1506
+ export interface Schema$InstancesListServerCertificatesResponse {
1507
+ /**
1508
+ * The `sha1_fingerprint` of the active certificate from `server_certs`.
1509
+ */
1510
+ activeVersion?: string | null;
1511
+ /**
1512
+ * List of server CA certificates for the instance.
1513
+ */
1514
+ caCerts?: Schema$SslCert[];
1515
+ /**
1516
+ * This is always `sql#instancesListServerCertificates`.
1517
+ */
1518
+ kind?: string | null;
1519
+ /**
1520
+ * List of server certificates for the instance, signed by the corresponding CA from the `ca_certs` list.
1521
+ */
1522
+ serverCerts?: Schema$SslCert[];
1523
+ }
1229
1524
  /**
1230
1525
  * Database Instance reencrypt request.
1231
1526
  */
@@ -1239,10 +1534,18 @@ export declare namespace sqladmin_v1 {
1239
1534
  * Database instance restore backup request.
1240
1535
  */
1241
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;
1242
1541
  /**
1243
1542
  * Parameters required to perform the restore backup operation.
1244
1543
  */
1245
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;
1246
1549
  }
1247
1550
  /**
1248
1551
  * Rotate server CA request.
@@ -1253,6 +1556,15 @@ export declare namespace sqladmin_v1 {
1253
1556
  */
1254
1557
  rotateServerCaContext?: Schema$RotateServerCaContext;
1255
1558
  }
1559
+ /**
1560
+ * Rotate server certificate request.
1561
+ */
1562
+ export interface Schema$InstancesRotateServerCertificateRequest {
1563
+ /**
1564
+ * Optional. Contains details about the rotate server certificate operation.
1565
+ */
1566
+ rotateServerCertificateContext?: Schema$RotateServerCertificateContext;
1567
+ }
1256
1568
  /**
1257
1569
  * Instance truncate log request.
1258
1570
  */
@@ -1262,6 +1574,19 @@ export declare namespace sqladmin_v1 {
1262
1574
  */
1263
1575
  truncateLogContext?: Schema$TruncateLogContext;
1264
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
+ }
1265
1590
  /**
1266
1591
  * IP Management configuration.
1267
1592
  */
@@ -1274,6 +1599,10 @@ export declare namespace sqladmin_v1 {
1274
1599
  * 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`).
1275
1600
  */
1276
1601
  authorizedNetworks?: Schema$AclEntry[];
1602
+ /**
1603
+ * Optional. Custom Subject Alternative Name(SAN)s for a Cloud SQL instance.
1604
+ */
1605
+ customSubjectAlternativeNames?: string[] | null;
1277
1606
  /**
1278
1607
  * Controls connectivity to private IP instances from Google services, such as BigQuery.
1279
1608
  */
@@ -1298,6 +1627,10 @@ export declare namespace sqladmin_v1 {
1298
1627
  * Specify what type of CA is used for the server certificate.
1299
1628
  */
1300
1629
  serverCaMode?: string | null;
1630
+ /**
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\}
1632
+ */
1633
+ serverCaPool?: string | null;
1301
1634
  /**
1302
1635
  * 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.
1303
1636
  */
@@ -1320,6 +1653,23 @@ export declare namespace sqladmin_v1 {
1320
1653
  */
1321
1654
  type?: string | null;
1322
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
+ }
1323
1673
  /**
1324
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.
1325
1675
  */
@@ -1375,7 +1725,7 @@ export declare namespace sqladmin_v1 {
1375
1725
  */
1376
1726
  clientCertificate?: string | null;
1377
1727
  /**
1378
- * 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.
1379
1729
  */
1380
1730
  clientKey?: string | null;
1381
1731
  /**
@@ -1433,7 +1783,7 @@ export declare namespace sqladmin_v1 {
1433
1783
  */
1434
1784
  clientCertificate?: string | null;
1435
1785
  /**
1436
- * 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.
1437
1787
  */
1438
1788
  clientKey?: string | null;
1439
1789
  /**
@@ -1452,10 +1802,18 @@ export declare namespace sqladmin_v1 {
1452
1802
  * The password for connecting to on-premises instance.
1453
1803
  */
1454
1804
  password?: string | null;
1805
+ /**
1806
+ * Optional. A list of objects that the user selects for replication from an external source instance.
1807
+ */
1808
+ selectedObjects?: Schema$SelectedObjects[];
1455
1809
  /**
1456
1810
  * The reference to Cloud SQL instance if the source is Cloud SQL.
1457
1811
  */
1458
1812
  sourceInstance?: Schema$InstanceReference;
1813
+ /**
1814
+ * Optional. SSL option for replica connection to the on-premises source.
1815
+ */
1816
+ sslOption?: string | null;
1459
1817
  /**
1460
1818
  * The username for connecting to on-premises instance.
1461
1819
  */
@@ -1522,7 +1880,11 @@ export declare namespace sqladmin_v1 {
1522
1880
  */
1523
1881
  status?: string | null;
1524
1882
  /**
1525
- * Name of the database instance related to this operation.
1883
+ * Optional. The sub operation based on the operation type.
1884
+ */
1885
+ subOperationType?: Schema$SqlSubOperationType;
1886
+ /**
1887
+ * Name of the resource on which this operation runs.
1526
1888
  */
1527
1889
  targetId?: string | null;
1528
1890
  targetLink?: string | null;
@@ -1574,7 +1936,7 @@ export declare namespace sqladmin_v1 {
1574
1936
  */
1575
1937
  apiVersion?: string | null;
1576
1938
  /**
1577
- * 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, corresponding to `Code.CANCELLED`.
1939
+ * 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`.
1578
1940
  */
1579
1941
  cancelRequested?: boolean | null;
1580
1942
  /**
@@ -1670,6 +2032,60 @@ export declare namespace sqladmin_v1 {
1670
2032
  */
1671
2033
  targetSizeGb?: string | null;
1672
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
+ }
2064
+ /**
2065
+ * Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance.
2066
+ */
2067
+ export interface Schema$PscAutoConnectionConfig {
2068
+ /**
2069
+ * 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.
2070
+ */
2071
+ consumerNetwork?: string | null;
2072
+ /**
2073
+ * The connection policy status of the consumer network.
2074
+ */
2075
+ consumerNetworkStatus?: string | null;
2076
+ /**
2077
+ * 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.
2078
+ */
2079
+ consumerProject?: string | null;
2080
+ /**
2081
+ * The IP address of the consumer endpoint.
2082
+ */
2083
+ ipAddress?: string | null;
2084
+ /**
2085
+ * The connection status of the consumer endpoint.
2086
+ */
2087
+ status?: string | null;
2088
+ }
1673
2089
  /**
1674
2090
  * PSC settings for a Cloud SQL instance.
1675
2091
  */
@@ -1678,6 +2094,10 @@ export declare namespace sqladmin_v1 {
1678
2094
  * 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).
1679
2095
  */
1680
2096
  allowedConsumerProjects?: string[] | null;
2097
+ /**
2098
+ * Optional. The list of settings for requested Private Service Connect consumer endpoints that can be used to connect to this Cloud SQL instance.
2099
+ */
2100
+ pscAutoConnections?: Schema$PscAutoConnectionConfig[];
1681
2101
  /**
1682
2102
  * Whether PSC connectivity is enabled for this instance.
1683
2103
  */
@@ -1705,7 +2125,7 @@ export declare namespace sqladmin_v1 {
1705
2125
  mysqlReplicaConfiguration?: Schema$MySqlReplicaConfiguration;
1706
2126
  }
1707
2127
  /**
1708
- * 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. Only applicable to MySQL.
2128
+ * 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.
1709
2129
  */
1710
2130
  export interface Schema$ReplicationCluster {
1711
2131
  /**
@@ -1717,7 +2137,7 @@ export declare namespace sqladmin_v1 {
1717
2137
  */
1718
2138
  failoverDrReplicaName?: string | null;
1719
2139
  /**
1720
- * Output only. If set, it 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, the dns should be pointing to this instance. After Switchover or Replica failover, 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 does not yet have a replica, or had a DR replica that was deleted.
2140
+ * 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.
1721
2141
  */
1722
2142
  psaWriteEndpoint?: string | null;
1723
2143
  }
@@ -1765,6 +2185,28 @@ export declare namespace sqladmin_v1 {
1765
2185
  */
1766
2186
  nextVersion?: string | null;
1767
2187
  }
2188
+ /**
2189
+ * Instance rotate server certificate context.
2190
+ */
2191
+ export interface Schema$RotateServerCertificateContext {
2192
+ /**
2193
+ * Optional. This is always `sql#rotateServerCertificateContext`.
2194
+ */
2195
+ kind?: string | null;
2196
+ /**
2197
+ * The fingerprint of the next version to be rotated to. If left unspecified, will be rotated to the most recently added server certificate version.
2198
+ */
2199
+ nextVersion?: string | null;
2200
+ }
2201
+ /**
2202
+ * A list of objects that the user selects for replication from an external source instance.
2203
+ */
2204
+ export interface Schema$SelectedObjects {
2205
+ /**
2206
+ * Required. The name of the database to migrate.
2207
+ */
2208
+ database?: string | null;
2209
+ }
1768
2210
  /**
1769
2211
  * Database instance settings.
1770
2212
  */
@@ -1797,6 +2239,10 @@ export declare namespace sqladmin_v1 {
1797
2239
  * The name of server Instance collation.
1798
2240
  */
1799
2241
  collation?: string | null;
2242
+ /**
2243
+ * Optional. The managed connection pooling configuration for the instance.
2244
+ */
2245
+ connectionPoolConfig?: Schema$ConnectionPoolConfig;
1800
2246
  /**
1801
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.
1802
2248
  */
@@ -1817,6 +2263,14 @@ export declare namespace sqladmin_v1 {
1817
2263
  * Configuration for data cache.
1818
2264
  */
1819
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;
1820
2274
  /**
1821
2275
  * The size of data disk, in GB. The data disk size minimum is 10GB.
1822
2276
  */
@@ -1873,10 +2327,18 @@ export declare namespace sqladmin_v1 {
1873
2327
  * The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances.
1874
2328
  */
1875
2329
  pricingPlan?: string | null;
2330
+ /**
2331
+ * Optional. Configuration value for recreation of replica after certain replication lag
2332
+ */
2333
+ replicationLagMaxSeconds?: number | null;
1876
2334
  /**
1877
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.
1878
2336
  */
1879
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;
1880
2342
  /**
1881
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.
1882
2344
  */
@@ -2037,6 +2499,10 @@ export declare namespace sqladmin_v1 {
2037
2499
  * Optional. MySQL-specific settings for start external sync.
2038
2500
  */
2039
2501
  mysqlSyncConfig?: Schema$MySqlSyncConfig;
2502
+ /**
2503
+ * Optional. Migrate only the specified objects from the source instance. If this field is empty, then migrate all objects.
2504
+ */
2505
+ selectedObjects?: Schema$ExternalSyncSelectedObject[];
2040
2506
  /**
2041
2507
  * External sync mode
2042
2508
  */
@@ -2149,6 +2615,15 @@ export declare namespace sqladmin_v1 {
2149
2615
  */
2150
2616
  serverRoles?: string[] | null;
2151
2617
  }
2618
+ /**
2619
+ * The sub operation type based on the operation type.
2620
+ */
2621
+ export interface Schema$SqlSubOperationType {
2622
+ /**
2623
+ * The type of maintenance to be performed on the instance.
2624
+ */
2625
+ maintenanceType?: string | null;
2626
+ }
2152
2627
  /**
2153
2628
  * SslCerts Resource
2154
2629
  */
@@ -2531,6 +3006,134 @@ export declare namespace sqladmin_v1 {
2531
3006
  */
2532
3007
  project?: string;
2533
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
+ }
2534
3137
  export class Resource$Connect {
2535
3138
  context: APIRequestContext;
2536
3139
  constructor(context: APIRequestContext);
@@ -2790,6 +3393,10 @@ export declare namespace sqladmin_v1 {
2790
3393
  * Database type and version you want to retrieve flags for. By default, this method returns flags for all database types and versions.
2791
3394
  */
2792
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;
2793
3400
  }
2794
3401
  export class Resource$Instances {
2795
3402
  context: APIRequestContext;
@@ -2809,7 +3416,7 @@ export declare namespace sqladmin_v1 {
2809
3416
  acquireSsrsLease(params: Params$Resource$Instances$Acquiressrslease, callback: BodyResponseCallback<Schema$SqlInstancesAcquireSsrsLeaseResponse>): void;
2810
3417
  acquireSsrsLease(callback: BodyResponseCallback<Schema$SqlInstancesAcquireSsrsLeaseResponse>): void;
2811
3418
  /**
2812
- * 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, please use AddServerCertificate to add a new server certificate.
3419
+ * 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.
2813
3420
  *
2814
3421
  * @param params - Parameters for request
2815
3422
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2822,6 +3429,20 @@ export declare namespace sqladmin_v1 {
2822
3429
  addServerCa(params: Params$Resource$Instances$Addserverca, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
2823
3430
  addServerCa(params: Params$Resource$Instances$Addserverca, callback: BodyResponseCallback<Schema$Operation>): void;
2824
3431
  addServerCa(callback: BodyResponseCallback<Schema$Operation>): void;
3432
+ /**
3433
+ * 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.
3434
+ *
3435
+ * @param params - Parameters for request
3436
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
3437
+ * @param callback - Optional callback that handles the response.
3438
+ * @returns A promise if used with async/await, or void if used with a callback.
3439
+ */
3440
+ addServerCertificate(params: Params$Resource$Instances$Addservercertificate, options: StreamMethodOptions): GaxiosPromise<Readable>;
3441
+ addServerCertificate(params?: Params$Resource$Instances$Addservercertificate, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
3442
+ addServerCertificate(params: Params$Resource$Instances$Addservercertificate, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
3443
+ addServerCertificate(params: Params$Resource$Instances$Addservercertificate, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
3444
+ addServerCertificate(params: Params$Resource$Instances$Addservercertificate, callback: BodyResponseCallback<Schema$Operation>): void;
3445
+ addServerCertificate(callback: BodyResponseCallback<Schema$Operation>): void;
2825
3446
  /**
2826
3447
  * Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart.
2827
3448
  *
@@ -2976,6 +3597,20 @@ export declare namespace sqladmin_v1 {
2976
3597
  listServerCas(params: Params$Resource$Instances$Listservercas, options: MethodOptions | BodyResponseCallback<Schema$InstancesListServerCasResponse>, callback: BodyResponseCallback<Schema$InstancesListServerCasResponse>): void;
2977
3598
  listServerCas(params: Params$Resource$Instances$Listservercas, callback: BodyResponseCallback<Schema$InstancesListServerCasResponse>): void;
2978
3599
  listServerCas(callback: BodyResponseCallback<Schema$InstancesListServerCasResponse>): void;
3600
+ /**
3601
+ * 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.
3602
+ *
3603
+ * @param params - Parameters for request
3604
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
3605
+ * @param callback - Optional callback that handles the response.
3606
+ * @returns A promise if used with async/await, or void if used with a callback.
3607
+ */
3608
+ ListServerCertificates(params: Params$Resource$Instances$Listservercertificates, options: StreamMethodOptions): GaxiosPromise<Readable>;
3609
+ ListServerCertificates(params?: Params$Resource$Instances$Listservercertificates, options?: MethodOptions): GaxiosPromise<Schema$InstancesListServerCertificatesResponse>;
3610
+ ListServerCertificates(params: Params$Resource$Instances$Listservercertificates, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
3611
+ ListServerCertificates(params: Params$Resource$Instances$Listservercertificates, options: MethodOptions | BodyResponseCallback<Schema$InstancesListServerCertificatesResponse>, callback: BodyResponseCallback<Schema$InstancesListServerCertificatesResponse>): void;
3612
+ ListServerCertificates(params: Params$Resource$Instances$Listservercertificates, callback: BodyResponseCallback<Schema$InstancesListServerCertificatesResponse>): void;
3613
+ ListServerCertificates(callback: BodyResponseCallback<Schema$InstancesListServerCertificatesResponse>): void;
2979
3614
  /**
2980
3615
  * Partially updates settings of a Cloud SQL instance by merging the request with the current configuration. This method supports patch semantics.
2981
3616
  *
@@ -3075,7 +3710,7 @@ export declare namespace sqladmin_v1 {
3075
3710
  restoreBackup(params: Params$Resource$Instances$Restorebackup, callback: BodyResponseCallback<Schema$Operation>): void;
3076
3711
  restoreBackup(callback: BodyResponseCallback<Schema$Operation>): void;
3077
3712
  /**
3078
- * 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, please use RotateServerCertificate to rotate the server certificate.
3713
+ * 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.
3079
3714
  *
3080
3715
  * @param params - Parameters for request
3081
3716
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3088,6 +3723,20 @@ export declare namespace sqladmin_v1 {
3088
3723
  rotateServerCa(params: Params$Resource$Instances$Rotateserverca, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
3089
3724
  rotateServerCa(params: Params$Resource$Instances$Rotateserverca, callback: BodyResponseCallback<Schema$Operation>): void;
3090
3725
  rotateServerCa(callback: BodyResponseCallback<Schema$Operation>): void;
3726
+ /**
3727
+ * 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.
3728
+ *
3729
+ * @param params - Parameters for request
3730
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
3731
+ * @param callback - Optional callback that handles the response.
3732
+ * @returns A promise if used with async/await, or void if used with a callback.
3733
+ */
3734
+ RotateServerCertificate(params: Params$Resource$Instances$Rotateservercertificate, options: StreamMethodOptions): GaxiosPromise<Readable>;
3735
+ RotateServerCertificate(params?: Params$Resource$Instances$Rotateservercertificate, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
3736
+ RotateServerCertificate(params: Params$Resource$Instances$Rotateservercertificate, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
3737
+ RotateServerCertificate(params: Params$Resource$Instances$Rotateservercertificate, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
3738
+ RotateServerCertificate(params: Params$Resource$Instances$Rotateservercertificate, callback: BodyResponseCallback<Schema$Operation>): void;
3739
+ RotateServerCertificate(callback: BodyResponseCallback<Schema$Operation>): void;
3091
3740
  /**
3092
3741
  * Starts the replication in the read replica instance.
3093
3742
  *
@@ -3117,7 +3766,7 @@ export declare namespace sqladmin_v1 {
3117
3766
  stopReplica(params: Params$Resource$Instances$Stopreplica, callback: BodyResponseCallback<Schema$Operation>): void;
3118
3767
  stopReplica(callback: BodyResponseCallback<Schema$Operation>): void;
3119
3768
  /**
3120
- * Switches over from the primary instance to the designated DR replica instance.
3769
+ * Switches over from the primary instance to the DR replica instance.
3121
3770
  *
3122
3771
  * @param params - Parameters for request
3123
3772
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3183,6 +3832,16 @@ export declare namespace sqladmin_v1 {
3183
3832
  */
3184
3833
  project?: string;
3185
3834
  }
3835
+ export interface Params$Resource$Instances$Addservercertificate extends StandardParameters {
3836
+ /**
3837
+ * Cloud SQL instance ID. This does not include the project ID.
3838
+ */
3839
+ instance?: string;
3840
+ /**
3841
+ * Project ID of the project that contains the instance.
3842
+ */
3843
+ project?: string;
3844
+ }
3186
3845
  export interface Params$Resource$Instances$Clone extends StandardParameters {
3187
3846
  /**
3188
3847
  * The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID.
@@ -3198,6 +3857,22 @@ export declare namespace sqladmin_v1 {
3198
3857
  requestBody?: Schema$InstancesCloneRequest;
3199
3858
  }
3200
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;
3201
3876
  /**
3202
3877
  * Cloud SQL instance ID. This does not include the project ID.
3203
3878
  */
@@ -3325,6 +4000,16 @@ export declare namespace sqladmin_v1 {
3325
4000
  */
3326
4001
  project?: string;
3327
4002
  }
4003
+ export interface Params$Resource$Instances$Listservercertificates extends StandardParameters {
4004
+ /**
4005
+ * Required. Cloud SQL instance ID. This does not include the project ID.
4006
+ */
4007
+ instance?: string;
4008
+ /**
4009
+ * Required. Project ID of the project that contains the instance.
4010
+ */
4011
+ project?: string;
4012
+ }
3328
4013
  export interface Params$Resource$Instances$Patch extends StandardParameters {
3329
4014
  /**
3330
4015
  * Cloud SQL instance ID. This does not include the project ID.
@@ -3341,7 +4026,7 @@ export declare namespace sqladmin_v1 {
3341
4026
  }
3342
4027
  export interface Params$Resource$Instances$Promotereplica extends StandardParameters {
3343
4028
  /**
3344
- * Set to true to invoke a replica failover to the designated 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. Only applicable to MySQL.
4029
+ * 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.
3345
4030
  */
3346
4031
  failover?: boolean;
3347
4032
  /**
@@ -3425,6 +4110,20 @@ export declare namespace sqladmin_v1 {
3425
4110
  */
3426
4111
  requestBody?: Schema$InstancesRotateServerCaRequest;
3427
4112
  }
4113
+ export interface Params$Resource$Instances$Rotateservercertificate extends StandardParameters {
4114
+ /**
4115
+ * Required. Cloud SQL instance ID. This does not include the project ID.
4116
+ */
4117
+ instance?: string;
4118
+ /**
4119
+ * Required. Project ID of the project that contains the instance.
4120
+ */
4121
+ project?: string;
4122
+ /**
4123
+ * Request body metadata
4124
+ */
4125
+ requestBody?: Schema$InstancesRotateServerCertificateRequest;
4126
+ }
3428
4127
  export interface Params$Resource$Instances$Startreplica extends StandardParameters {
3429
4128
  /**
3430
4129
  * Cloud SQL read replica instance name.
@@ -3447,7 +4146,7 @@ export declare namespace sqladmin_v1 {
3447
4146
  }
3448
4147
  export interface Params$Resource$Instances$Switchover extends StandardParameters {
3449
4148
  /**
3450
- * 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.
4149
+ * 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.
3451
4150
  */
3452
4151
  dbTimeout?: string;
3453
4152
  /**