@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.
@@ -69,6 +69,7 @@ export declare namespace sqladmin_v1beta4 {
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_v1beta4 {
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 resource expired.
199
+ */
200
+ expiryTime?: string | null;
201
+ /**
202
+ * The name of the 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. 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 state 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_v1beta4 {
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_v1beta4 {
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_v1beta4 {
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 instance.
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_v1beta4 {
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` or `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_v1beta4 {
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_v1beta4 {
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_v1beta4 {
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_v1beta4 {
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_v1beta4 {
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_v1beta4 {
621
830
  */
622
831
  replicaNames?: string[] | null;
623
832
  /**
624
- * 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
+ * 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
  /**
@@ -676,6 +885,12 @@ export declare namespace sqladmin_v1beta4 {
676
885
  * Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage.
677
886
  */
678
887
  switchTransactionLogsToCloudStorageEnabled?: boolean | null;
888
+ /**
889
+ * 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.
890
+ */
891
+ tags?: {
892
+ [key: string]: string;
893
+ } | null;
679
894
  /**
680
895
  * Output only. All database versions that are available for upgrade.
681
896
  */
@@ -771,7 +986,7 @@ export declare namespace sqladmin_v1beta4 {
771
986
  */
772
987
  clientCertificate?: string | null;
773
988
  /**
774
- * 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.
989
+ * 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.
775
990
  */
776
991
  clientKey?: string | null;
777
992
  /**
@@ -830,6 +1045,23 @@ export declare namespace sqladmin_v1beta4 {
830
1045
  */
831
1046
  kmsKeyVersionName?: string | null;
832
1047
  }
1048
+ /**
1049
+ * DNS metadata.
1050
+ */
1051
+ export interface Schema$DnsNameMapping {
1052
+ /**
1053
+ * Output only. The connection type of the DNS name.
1054
+ */
1055
+ connectionType?: string | null;
1056
+ /**
1057
+ * Output only. The scope that the DNS name applies to.
1058
+ */
1059
+ dnsScope?: string | null;
1060
+ /**
1061
+ * The DNS name.
1062
+ */
1063
+ name?: string | null;
1064
+ }
833
1065
  /**
834
1066
  * 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); \}
835
1067
  */
@@ -846,6 +1078,8 @@ export declare namespace sqladmin_v1beta4 {
846
1078
  bakType?: string;
847
1079
  copyOnly?: boolean;
848
1080
  differentialBase?: boolean;
1081
+ exportLogEndTime?: string;
1082
+ exportLogStartTime?: string;
849
1083
  stripeCount?: number;
850
1084
  striped?: boolean;
851
1085
  } | null;
@@ -860,7 +1094,7 @@ export declare namespace sqladmin_v1beta4 {
860
1094
  selectQuery?: string;
861
1095
  } | null;
862
1096
  /**
863
- * 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`.
1097
+ * 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`.
864
1098
  */
865
1099
  databases?: string[] | null;
866
1100
  /**
@@ -891,11 +1125,29 @@ export declare namespace sqladmin_v1beta4 {
891
1125
  tables?: string[];
892
1126
  threads?: number;
893
1127
  } | null;
1128
+ /**
1129
+ * Optional. Export parameters specific to SQL Server TDE certificates
1130
+ */
1131
+ tdeExportOptions?: {
1132
+ certificatePath?: string;
1133
+ name?: string;
1134
+ privateKeyPassword?: string;
1135
+ privateKeyPath?: string;
1136
+ } | null;
894
1137
  /**
895
1138
  * 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.
896
1139
  */
897
1140
  uri?: string | null;
898
1141
  }
1142
+ /**
1143
+ * The selected object that Cloud SQL migrates.
1144
+ */
1145
+ export interface Schema$ExternalSyncSelectedObject {
1146
+ /**
1147
+ * The name of the database that Cloud SQL migrates.
1148
+ */
1149
+ database?: string | null;
1150
+ }
899
1151
  /**
900
1152
  * Database instance failover context.
901
1153
  */
@@ -925,6 +1177,10 @@ export declare namespace sqladmin_v1beta4 {
925
1177
  * 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).
926
1178
  */
927
1179
  appliesTo?: string[] | null;
1180
+ /**
1181
+ * Scope of flag.
1182
+ */
1183
+ flagScope?: string | null;
928
1184
  /**
929
1185
  * Whether or not the flag is considered in beta.
930
1186
  */
@@ -945,6 +1201,14 @@ export declare namespace sqladmin_v1beta4 {
945
1201
  * This is the name of the flag. Flag names always use underscores, not hyphens, for example: `max_allowed_packet`
946
1202
  */
947
1203
  name?: string | null;
1204
+ /**
1205
+ * Recommended flag value in integer format for UI display.
1206
+ */
1207
+ recommendedIntValue?: string | null;
1208
+ /**
1209
+ * Recommended flag value in string format for UI display.
1210
+ */
1211
+ recommendedStringValue?: string | null;
948
1212
  /**
949
1213
  * Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances.
950
1214
  */
@@ -1037,6 +1301,7 @@ export declare namespace sqladmin_v1beta4 {
1037
1301
  bakType?: string;
1038
1302
  encryptionOptions?: {
1039
1303
  certPath?: string;
1304
+ keepEncrypted?: boolean;
1040
1305
  pvkPassword?: string;
1041
1306
  pvkPath?: string;
1042
1307
  };
@@ -1058,7 +1323,7 @@ export declare namespace sqladmin_v1beta4 {
1058
1323
  table?: string;
1059
1324
  } | null;
1060
1325
  /**
1061
- * 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.
1326
+ * 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.
1062
1327
  */
1063
1328
  database?: string | null;
1064
1329
  /**
@@ -1084,6 +1349,15 @@ export declare namespace sqladmin_v1beta4 {
1084
1349
  };
1085
1350
  threads?: number;
1086
1351
  } | null;
1352
+ /**
1353
+ * Optional. Import parameters specific to SQL Server .TDE files Import parameters specific to SQL Server TDE certificates
1354
+ */
1355
+ tdeImportOptions?: {
1356
+ certificatePath?: string;
1357
+ name?: string;
1358
+ privateKeyPassword?: string;
1359
+ privateKeyPath?: string;
1360
+ } | null;
1087
1361
  /**
1088
1362
  * 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.
1089
1363
  */
@@ -1229,6 +1503,27 @@ export declare namespace sqladmin_v1beta4 {
1229
1503
  */
1230
1504
  kind?: string | null;
1231
1505
  }
1506
+ /**
1507
+ * Instances ListServerCertificatess response.
1508
+ */
1509
+ export interface Schema$InstancesListServerCertificatesResponse {
1510
+ /**
1511
+ * The `sha1_fingerprint` of the active certificate from `server_certs`.
1512
+ */
1513
+ activeVersion?: string | null;
1514
+ /**
1515
+ * List of server CA certificates for the instance.
1516
+ */
1517
+ caCerts?: Schema$SslCert[];
1518
+ /**
1519
+ * This is always `sql#instancesListServerCertificates`.
1520
+ */
1521
+ kind?: string | null;
1522
+ /**
1523
+ * List of server certificates for the instance, signed by the corresponding CA from the `ca_certs` list.
1524
+ */
1525
+ serverCerts?: Schema$SslCert[];
1526
+ }
1232
1527
  /**
1233
1528
  * Database Instance reencrypt request.
1234
1529
  */
@@ -1242,10 +1537,18 @@ export declare namespace sqladmin_v1beta4 {
1242
1537
  * Database instance restore backup request.
1243
1538
  */
1244
1539
  export interface Schema$InstancesRestoreBackupRequest {
1540
+ /**
1541
+ * 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.
1542
+ */
1543
+ backup?: string | null;
1245
1544
  /**
1246
1545
  * Parameters required to perform the restore backup operation.
1247
1546
  */
1248
1547
  restoreBackupContext?: Schema$RestoreBackupContext;
1548
+ /**
1549
+ * 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.
1550
+ */
1551
+ restoreInstanceSettings?: Schema$DatabaseInstance;
1249
1552
  }
1250
1553
  /**
1251
1554
  * Rotate Server CA request.
@@ -1256,6 +1559,15 @@ export declare namespace sqladmin_v1beta4 {
1256
1559
  */
1257
1560
  rotateServerCaContext?: Schema$RotateServerCaContext;
1258
1561
  }
1562
+ /**
1563
+ * Rotate Server Certificate request.
1564
+ */
1565
+ export interface Schema$InstancesRotateServerCertificateRequest {
1566
+ /**
1567
+ * Optional. Contains details about the rotate server CA operation.
1568
+ */
1569
+ rotateServerCertificateContext?: Schema$RotateServerCertificateContext;
1570
+ }
1259
1571
  /**
1260
1572
  * Instance truncate log request.
1261
1573
  */
@@ -1265,6 +1577,19 @@ export declare namespace sqladmin_v1beta4 {
1265
1577
  */
1266
1578
  truncateLogContext?: Schema$TruncateLogContext;
1267
1579
  }
1580
+ /**
1581
+ * 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.
1582
+ */
1583
+ export interface Schema$Interval {
1584
+ /**
1585
+ * Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
1586
+ */
1587
+ endTime?: string | null;
1588
+ /**
1589
+ * Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
1590
+ */
1591
+ startTime?: string | null;
1592
+ }
1268
1593
  /**
1269
1594
  * IP Management configuration.
1270
1595
  */
@@ -1277,6 +1602,10 @@ export declare namespace sqladmin_v1beta4 {
1277
1602
  * 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`).
1278
1603
  */
1279
1604
  authorizedNetworks?: Schema$AclEntry[];
1605
+ /**
1606
+ * Optional. Custom Subject Alternative Name(SAN)s for a Cloud SQL instance.
1607
+ */
1608
+ customSubjectAlternativeNames?: string[] | null;
1280
1609
  /**
1281
1610
  * Controls connectivity to private IP instances from Google services, such as BigQuery.
1282
1611
  */
@@ -1301,6 +1630,10 @@ export declare namespace sqladmin_v1beta4 {
1301
1630
  * Specify what type of CA is used for the server certificate.
1302
1631
  */
1303
1632
  serverCaMode?: string | null;
1633
+ /**
1634
+ * 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\}
1635
+ */
1636
+ serverCaPool?: string | null;
1304
1637
  /**
1305
1638
  * 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.
1306
1639
  */
@@ -1323,6 +1656,23 @@ export declare namespace sqladmin_v1beta4 {
1323
1656
  */
1324
1657
  type?: string | null;
1325
1658
  }
1659
+ /**
1660
+ * The response payload containing a list of the backups.
1661
+ */
1662
+ export interface Schema$ListBackupsResponse {
1663
+ /**
1664
+ * A list of backups.
1665
+ */
1666
+ backups?: Schema$Backup[];
1667
+ /**
1668
+ * 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.
1669
+ */
1670
+ nextPageToken?: string | null;
1671
+ /**
1672
+ * If a region isn't unavailable or if an unknown error occurs, then a warning message is returned.
1673
+ */
1674
+ warnings?: Schema$ApiWarning[];
1675
+ }
1326
1676
  /**
1327
1677
  * 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.
1328
1678
  */
@@ -1378,7 +1728,7 @@ export declare namespace sqladmin_v1beta4 {
1378
1728
  */
1379
1729
  clientCertificate?: string | null;
1380
1730
  /**
1381
- * PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
1731
+ * PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate.
1382
1732
  */
1383
1733
  clientKey?: string | null;
1384
1734
  /**
@@ -1436,7 +1786,7 @@ export declare namespace sqladmin_v1beta4 {
1436
1786
  */
1437
1787
  clientCertificate?: string | null;
1438
1788
  /**
1439
- * PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
1789
+ * PEM representation of the replica's private key. The corresponding public key is encoded in the client's certificate.
1440
1790
  */
1441
1791
  clientKey?: string | null;
1442
1792
  /**
@@ -1455,10 +1805,18 @@ export declare namespace sqladmin_v1beta4 {
1455
1805
  * The password for connecting to on-premises instance.
1456
1806
  */
1457
1807
  password?: string | null;
1808
+ /**
1809
+ * Optional. A list of objects that the user selects for replication from an external source instance.
1810
+ */
1811
+ selectedObjects?: Schema$SelectedObjects[];
1458
1812
  /**
1459
1813
  * The reference to Cloud SQL instance if the source is Cloud SQL.
1460
1814
  */
1461
1815
  sourceInstance?: Schema$InstanceReference;
1816
+ /**
1817
+ * Optional. SslOption for replica connection to the on-premises source.
1818
+ */
1819
+ sslOption?: string | null;
1462
1820
  /**
1463
1821
  * The username for connecting to on-premises instance.
1464
1822
  */
@@ -1525,7 +1883,11 @@ export declare namespace sqladmin_v1beta4 {
1525
1883
  */
1526
1884
  status?: string | null;
1527
1885
  /**
1528
- * Name of the database instance related to this operation.
1886
+ * Optional. The sub operation based on the operation type.
1887
+ */
1888
+ subOperationType?: Schema$SqlSubOperationType;
1889
+ /**
1890
+ * Name of the resource on which this operation runs.
1529
1891
  */
1530
1892
  targetId?: string | null;
1531
1893
  targetLink?: string | null;
@@ -1577,7 +1939,7 @@ export declare namespace sqladmin_v1beta4 {
1577
1939
  */
1578
1940
  apiVersion?: string | null;
1579
1941
  /**
1580
- * 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`.
1942
+ * 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`.
1581
1943
  */
1582
1944
  cancelRequested?: boolean | null;
1583
1945
  /**
@@ -1673,6 +2035,60 @@ export declare namespace sqladmin_v1beta4 {
1673
2035
  */
1674
2036
  targetSizeGb?: string | null;
1675
2037
  }
2038
+ /**
2039
+ * Details of a single node of a read pool.
2040
+ */
2041
+ export interface Schema$PoolNodeConfig {
2042
+ /**
2043
+ * Output only. The DNS name of the node.
2044
+ */
2045
+ dnsName?: string | null;
2046
+ /**
2047
+ * Output only. The list of DNS names used by this node.
2048
+ */
2049
+ dnsNames?: Schema$DnsNameMapping[];
2050
+ /**
2051
+ * Output only. The serving zone of the node.
2052
+ */
2053
+ gceZone?: string | null;
2054
+ /**
2055
+ * Output only. Mappings containing IP addresses that can be used to connect to the node.
2056
+ */
2057
+ ipAddresses?: Schema$IpMapping[];
2058
+ /**
2059
+ * Output only. The name of the node, to be used for retrieving metrics and logs for the node.
2060
+ */
2061
+ name?: string | null;
2062
+ /**
2063
+ * Output only. The current state of the node.
2064
+ */
2065
+ state?: string | null;
2066
+ }
2067
+ /**
2068
+ * Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance.
2069
+ */
2070
+ export interface Schema$PscAutoConnectionConfig {
2071
+ /**
2072
+ * 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.
2073
+ */
2074
+ consumerNetwork?: string | null;
2075
+ /**
2076
+ * The connection policy status of the consumer network.
2077
+ */
2078
+ consumerNetworkStatus?: string | null;
2079
+ /**
2080
+ * 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.
2081
+ */
2082
+ consumerProject?: string | null;
2083
+ /**
2084
+ * The IP address of the consumer endpoint.
2085
+ */
2086
+ ipAddress?: string | null;
2087
+ /**
2088
+ * The connection status of the consumer endpoint.
2089
+ */
2090
+ status?: string | null;
2091
+ }
1676
2092
  /**
1677
2093
  * PSC settings for a Cloud SQL instance.
1678
2094
  */
@@ -1681,6 +2097,10 @@ export declare namespace sqladmin_v1beta4 {
1681
2097
  * 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).
1682
2098
  */
1683
2099
  allowedConsumerProjects?: string[] | null;
2100
+ /**
2101
+ * Optional. The list of settings for requested Private Service Connect consumer endpoints that can be used to connect to this Cloud SQL instance.
2102
+ */
2103
+ pscAutoConnections?: Schema$PscAutoConnectionConfig[];
1684
2104
  /**
1685
2105
  * Whether PSC connectivity is enabled for this instance.
1686
2106
  */
@@ -1708,7 +2128,7 @@ export declare namespace sqladmin_v1beta4 {
1708
2128
  mysqlReplicaConfiguration?: Schema$MySqlReplicaConfiguration;
1709
2129
  }
1710
2130
  /**
1711
- * 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 has regional failure. Only applicable to MySQL.
2131
+ * 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 has regional failure. Applicable to MySQL and PostgreSQL.
1712
2132
  */
1713
2133
  export interface Schema$ReplicationCluster {
1714
2134
  /**
@@ -1720,7 +2140,7 @@ export declare namespace sqladmin_v1beta4 {
1720
2140
  */
1721
2141
  failoverDrReplicaName?: string | null;
1722
2142
  /**
1723
- * 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.
2143
+ * 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.
1724
2144
  */
1725
2145
  psaWriteEndpoint?: string | null;
1726
2146
  }
@@ -1768,6 +2188,28 @@ export declare namespace sqladmin_v1beta4 {
1768
2188
  */
1769
2189
  nextVersion?: string | null;
1770
2190
  }
2191
+ /**
2192
+ * Instance rotate server certificate context.
2193
+ */
2194
+ export interface Schema$RotateServerCertificateContext {
2195
+ /**
2196
+ * Optional. This is always `sql#rotateServerCertificateContext`.
2197
+ */
2198
+ kind?: string | null;
2199
+ /**
2200
+ * Optional. The fingerprint of the next version to be rotated to. If left unspecified, will be rotated to the most recently added server certificate version.
2201
+ */
2202
+ nextVersion?: string | null;
2203
+ }
2204
+ /**
2205
+ * A list of objects that the user selects for replication from an external source instance.
2206
+ */
2207
+ export interface Schema$SelectedObjects {
2208
+ /**
2209
+ * Required. The name of the database to migrate.
2210
+ */
2211
+ database?: string | null;
2212
+ }
1771
2213
  /**
1772
2214
  * Database instance settings.
1773
2215
  */
@@ -1800,6 +2242,10 @@ export declare namespace sqladmin_v1beta4 {
1800
2242
  * The name of server Instance collation.
1801
2243
  */
1802
2244
  collation?: string | null;
2245
+ /**
2246
+ * Optional. The managed connection pooling configuration for the instance.
2247
+ */
2248
+ connectionPoolConfig?: Schema$ConnectionPoolConfig;
1803
2249
  /**
1804
2250
  * 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.
1805
2251
  */
@@ -1820,6 +2266,14 @@ export declare namespace sqladmin_v1beta4 {
1820
2266
  * Configuration for data cache.
1821
2267
  */
1822
2268
  dataCacheConfig?: Schema$DataCacheConfig;
2269
+ /**
2270
+ * Optional. Provisioned number of I/O operations per second for the data disk. This field is only used for hyperdisk-balanced disk types.
2271
+ */
2272
+ dataDiskProvisionedIops?: string | null;
2273
+ /**
2274
+ * Optional. Provisioned throughput measured in MiB per second for the data disk. This field is only used for hyperdisk-balanced disk types.
2275
+ */
2276
+ dataDiskProvisionedThroughput?: string | null;
1823
2277
  /**
1824
2278
  * The size of data disk, in GB. The data disk size minimum is 10GB.
1825
2279
  */
@@ -1876,10 +2330,18 @@ export declare namespace sqladmin_v1beta4 {
1876
2330
  * The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances.
1877
2331
  */
1878
2332
  pricingPlan?: string | null;
2333
+ /**
2334
+ * Optional. Configuration value for recreation of replica after certain replication lag
2335
+ */
2336
+ replicationLagMaxSeconds?: number | null;
1879
2337
  /**
1880
2338
  * The type of replication this instance uses. This can be either `ASYNCHRONOUS` or `SYNCHRONOUS`. (Deprecated) This property was only applicable to First Generation instances.
1881
2339
  */
1882
2340
  replicationType?: string | null;
2341
+ /**
2342
+ * 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.
2343
+ */
2344
+ retainBackupsOnDelete?: boolean | null;
1883
2345
  /**
1884
2346
  * 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.
1885
2347
  */
@@ -2034,6 +2496,10 @@ export declare namespace sqladmin_v1beta4 {
2034
2496
  * Optional. MySQL-specific settings for start external sync.
2035
2497
  */
2036
2498
  mysqlSyncConfig?: Schema$MySqlSyncConfig;
2499
+ /**
2500
+ * Optional. Migrate only the specified objects from the source instance. If this field is empty, then migrate all objects.
2501
+ */
2502
+ selectedObjects?: Schema$ExternalSyncSelectedObject[];
2037
2503
  /**
2038
2504
  * External sync mode
2039
2505
  */
@@ -2146,6 +2612,15 @@ export declare namespace sqladmin_v1beta4 {
2146
2612
  */
2147
2613
  serverRoles?: string[] | null;
2148
2614
  }
2615
+ /**
2616
+ * The sub operation type based on the operation type.
2617
+ */
2618
+ export interface Schema$SqlSubOperationType {
2619
+ /**
2620
+ * The type of maintenance to be performed on the instance.
2621
+ */
2622
+ maintenanceType?: string | null;
2623
+ }
2149
2624
  /**
2150
2625
  * SslCerts Resource
2151
2626
  */
@@ -2528,6 +3003,134 @@ export declare namespace sqladmin_v1beta4 {
2528
3003
  */
2529
3004
  project?: string;
2530
3005
  }
3006
+ export class Resource$Backups {
3007
+ context: APIRequestContext;
3008
+ constructor(context: APIRequestContext);
3009
+ /**
3010
+ * Creates a backup for a Cloud SQL instance. This API can be used only to create on-demand backups.
3011
+ *
3012
+ * @param params - Parameters for request
3013
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
3014
+ * @param callback - Optional callback that handles the response.
3015
+ * @returns A promise if used with async/await, or void if used with a callback.
3016
+ */
3017
+ createBackup(params: Params$Resource$Backups$Createbackup, options: StreamMethodOptions): GaxiosPromise<Readable>;
3018
+ createBackup(params?: Params$Resource$Backups$Createbackup, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
3019
+ createBackup(params: Params$Resource$Backups$Createbackup, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
3020
+ createBackup(params: Params$Resource$Backups$Createbackup, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
3021
+ createBackup(params: Params$Resource$Backups$Createbackup, callback: BodyResponseCallback<Schema$Operation>): void;
3022
+ createBackup(callback: BodyResponseCallback<Schema$Operation>): void;
3023
+ /**
3024
+ * Deletes the backup.
3025
+ *
3026
+ * @param params - Parameters for request
3027
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
3028
+ * @param callback - Optional callback that handles the response.
3029
+ * @returns A promise if used with async/await, or void if used with a callback.
3030
+ */
3031
+ deleteBackup(params: Params$Resource$Backups$Deletebackup, options: StreamMethodOptions): GaxiosPromise<Readable>;
3032
+ deleteBackup(params?: Params$Resource$Backups$Deletebackup, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
3033
+ deleteBackup(params: Params$Resource$Backups$Deletebackup, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
3034
+ deleteBackup(params: Params$Resource$Backups$Deletebackup, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
3035
+ deleteBackup(params: Params$Resource$Backups$Deletebackup, callback: BodyResponseCallback<Schema$Operation>): void;
3036
+ deleteBackup(callback: BodyResponseCallback<Schema$Operation>): void;
3037
+ /**
3038
+ * Retrieves a resource containing information about a backup.
3039
+ *
3040
+ * @param params - Parameters for request
3041
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
3042
+ * @param callback - Optional callback that handles the response.
3043
+ * @returns A promise if used with async/await, or void if used with a callback.
3044
+ */
3045
+ getBackup(params: Params$Resource$Backups$Getbackup, options: StreamMethodOptions): GaxiosPromise<Readable>;
3046
+ getBackup(params?: Params$Resource$Backups$Getbackup, options?: MethodOptions): GaxiosPromise<Schema$Backup>;
3047
+ getBackup(params: Params$Resource$Backups$Getbackup, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
3048
+ getBackup(params: Params$Resource$Backups$Getbackup, options: MethodOptions | BodyResponseCallback<Schema$Backup>, callback: BodyResponseCallback<Schema$Backup>): void;
3049
+ getBackup(params: Params$Resource$Backups$Getbackup, callback: BodyResponseCallback<Schema$Backup>): void;
3050
+ getBackup(callback: BodyResponseCallback<Schema$Backup>): void;
3051
+ /**
3052
+ * Lists all backups associated with the project.
3053
+ *
3054
+ * @param params - Parameters for request
3055
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
3056
+ * @param callback - Optional callback that handles the response.
3057
+ * @returns A promise if used with async/await, or void if used with a callback.
3058
+ */
3059
+ listBackups(params: Params$Resource$Backups$Listbackups, options: StreamMethodOptions): GaxiosPromise<Readable>;
3060
+ listBackups(params?: Params$Resource$Backups$Listbackups, options?: MethodOptions): GaxiosPromise<Schema$ListBackupsResponse>;
3061
+ listBackups(params: Params$Resource$Backups$Listbackups, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
3062
+ listBackups(params: Params$Resource$Backups$Listbackups, options: MethodOptions | BodyResponseCallback<Schema$ListBackupsResponse>, callback: BodyResponseCallback<Schema$ListBackupsResponse>): void;
3063
+ listBackups(params: Params$Resource$Backups$Listbackups, callback: BodyResponseCallback<Schema$ListBackupsResponse>): void;
3064
+ listBackups(callback: BodyResponseCallback<Schema$ListBackupsResponse>): void;
3065
+ /**
3066
+ * Updates the retention period and the description of the backup. You can use this API to update final backups only.
3067
+ *
3068
+ * @param params - Parameters for request
3069
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
3070
+ * @param callback - Optional callback that handles the response.
3071
+ * @returns A promise if used with async/await, or void if used with a callback.
3072
+ */
3073
+ updateBackup(params: Params$Resource$Backups$Updatebackup, options: StreamMethodOptions): GaxiosPromise<Readable>;
3074
+ updateBackup(params?: Params$Resource$Backups$Updatebackup, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
3075
+ updateBackup(params: Params$Resource$Backups$Updatebackup, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
3076
+ updateBackup(params: Params$Resource$Backups$Updatebackup, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
3077
+ updateBackup(params: Params$Resource$Backups$Updatebackup, callback: BodyResponseCallback<Schema$Operation>): void;
3078
+ updateBackup(callback: BodyResponseCallback<Schema$Operation>): void;
3079
+ }
3080
+ export interface Params$Resource$Backups$Createbackup extends StandardParameters {
3081
+ /**
3082
+ * Required. The parent resource where this backup is created. Format: projects/{project\}
3083
+ */
3084
+ parent?: string;
3085
+ /**
3086
+ * Request body metadata
3087
+ */
3088
+ requestBody?: Schema$Backup;
3089
+ }
3090
+ export interface Params$Resource$Backups$Deletebackup extends StandardParameters {
3091
+ /**
3092
+ * Required. The name of the backup to delete. Format: projects/{project\}/backups/{backup\}
3093
+ */
3094
+ name?: string;
3095
+ }
3096
+ export interface Params$Resource$Backups$Getbackup extends StandardParameters {
3097
+ /**
3098
+ * Required. The name of the backup to retrieve. Format: projects/{project\}/backups/{backup\}
3099
+ */
3100
+ name?: string;
3101
+ }
3102
+ export interface Params$Resource$Backups$Listbackups extends StandardParameters {
3103
+ /**
3104
+ * 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.
3105
+ */
3106
+ filter?: string;
3107
+ /**
3108
+ * 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.
3109
+ */
3110
+ pageSize?: number;
3111
+ /**
3112
+ * 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.
3113
+ */
3114
+ pageToken?: string;
3115
+ /**
3116
+ * Required. The parent that owns this collection of backups. Format: projects/{project\}
3117
+ */
3118
+ parent?: string;
3119
+ }
3120
+ export interface Params$Resource$Backups$Updatebackup extends StandardParameters {
3121
+ /**
3122
+ * Output only. The resource name of the backup. Format: projects/{project\}/backups/{backup\}.
3123
+ */
3124
+ name?: string;
3125
+ /**
3126
+ * The list of fields that you can update. You can update only the description and retention period of the final backup.
3127
+ */
3128
+ updateMask?: string;
3129
+ /**
3130
+ * Request body metadata
3131
+ */
3132
+ requestBody?: Schema$Backup;
3133
+ }
2531
3134
  export class Resource$Connect {
2532
3135
  context: APIRequestContext;
2533
3136
  constructor(context: APIRequestContext);
@@ -2787,6 +3390,10 @@ export declare namespace sqladmin_v1beta4 {
2787
3390
  * Database type and version you want to retrieve flags for. By default, this method returns flags for all database types and versions.
2788
3391
  */
2789
3392
  databaseVersion?: string;
3393
+ /**
3394
+ * Optional. Specify the scope of flags to be returned by SqlFlagsListService. Return list of database flags if unspecified.
3395
+ */
3396
+ flagScope?: string;
2790
3397
  }
2791
3398
  export class Resource$Instances {
2792
3399
  context: APIRequestContext;
@@ -2806,7 +3413,7 @@ export declare namespace sqladmin_v1beta4 {
2806
3413
  acquireSsrsLease(params: Params$Resource$Instances$Acquiressrslease, callback: BodyResponseCallback<Schema$SqlInstancesAcquireSsrsLeaseResponse>): void;
2807
3414
  acquireSsrsLease(callback: BodyResponseCallback<Schema$SqlInstancesAcquireSsrsLeaseResponse>): void;
2808
3415
  /**
2809
- * Add 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.
3416
+ * Add 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.
2810
3417
  *
2811
3418
  * @param params - Parameters for request
2812
3419
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2819,6 +3426,20 @@ export declare namespace sqladmin_v1beta4 {
2819
3426
  addServerCa(params: Params$Resource$Instances$Addserverca, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
2820
3427
  addServerCa(params: Params$Resource$Instances$Addserverca, callback: BodyResponseCallback<Schema$Operation>): void;
2821
3428
  addServerCa(callback: BodyResponseCallback<Schema$Operation>): void;
3429
+ /**
3430
+ * 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.
3431
+ *
3432
+ * @param params - Parameters for request
3433
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
3434
+ * @param callback - Optional callback that handles the response.
3435
+ * @returns A promise if used with async/await, or void if used with a callback.
3436
+ */
3437
+ addServerCertificate(params: Params$Resource$Instances$Addservercertificate, options: StreamMethodOptions): GaxiosPromise<Readable>;
3438
+ addServerCertificate(params?: Params$Resource$Instances$Addservercertificate, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
3439
+ addServerCertificate(params: Params$Resource$Instances$Addservercertificate, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
3440
+ addServerCertificate(params: Params$Resource$Instances$Addservercertificate, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
3441
+ addServerCertificate(params: Params$Resource$Instances$Addservercertificate, callback: BodyResponseCallback<Schema$Operation>): void;
3442
+ addServerCertificate(callback: BodyResponseCallback<Schema$Operation>): void;
2822
3443
  /**
2823
3444
  * Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart.
2824
3445
  *
@@ -2973,6 +3594,20 @@ export declare namespace sqladmin_v1beta4 {
2973
3594
  listServerCas(params: Params$Resource$Instances$Listservercas, options: MethodOptions | BodyResponseCallback<Schema$InstancesListServerCasResponse>, callback: BodyResponseCallback<Schema$InstancesListServerCasResponse>): void;
2974
3595
  listServerCas(params: Params$Resource$Instances$Listservercas, callback: BodyResponseCallback<Schema$InstancesListServerCasResponse>): void;
2975
3596
  listServerCas(callback: BodyResponseCallback<Schema$InstancesListServerCasResponse>): void;
3597
+ /**
3598
+ * 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.
3599
+ *
3600
+ * @param params - Parameters for request
3601
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
3602
+ * @param callback - Optional callback that handles the response.
3603
+ * @returns A promise if used with async/await, or void if used with a callback.
3604
+ */
3605
+ ListServerCertificates(params: Params$Resource$Instances$Listservercertificates, options: StreamMethodOptions): GaxiosPromise<Readable>;
3606
+ ListServerCertificates(params?: Params$Resource$Instances$Listservercertificates, options?: MethodOptions): GaxiosPromise<Schema$InstancesListServerCertificatesResponse>;
3607
+ ListServerCertificates(params: Params$Resource$Instances$Listservercertificates, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
3608
+ ListServerCertificates(params: Params$Resource$Instances$Listservercertificates, options: MethodOptions | BodyResponseCallback<Schema$InstancesListServerCertificatesResponse>, callback: BodyResponseCallback<Schema$InstancesListServerCertificatesResponse>): void;
3609
+ ListServerCertificates(params: Params$Resource$Instances$Listservercertificates, callback: BodyResponseCallback<Schema$InstancesListServerCertificatesResponse>): void;
3610
+ ListServerCertificates(callback: BodyResponseCallback<Schema$InstancesListServerCertificatesResponse>): void;
2976
3611
  /**
2977
3612
  * Partially updates settings of a Cloud SQL instance by merging the request with the current configuration. This method supports patch semantics.
2978
3613
  *
@@ -3072,7 +3707,7 @@ export declare namespace sqladmin_v1beta4 {
3072
3707
  restoreBackup(params: Params$Resource$Instances$Restorebackup, callback: BodyResponseCallback<Schema$Operation>): void;
3073
3708
  restoreBackup(callback: BodyResponseCallback<Schema$Operation>): void;
3074
3709
  /**
3075
- * 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.
3710
+ * 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.
3076
3711
  *
3077
3712
  * @param params - Parameters for request
3078
3713
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3085,6 +3720,20 @@ export declare namespace sqladmin_v1beta4 {
3085
3720
  rotateServerCa(params: Params$Resource$Instances$Rotateserverca, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
3086
3721
  rotateServerCa(params: Params$Resource$Instances$Rotateserverca, callback: BodyResponseCallback<Schema$Operation>): void;
3087
3722
  rotateServerCa(callback: BodyResponseCallback<Schema$Operation>): void;
3723
+ /**
3724
+ * 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.
3725
+ *
3726
+ * @param params - Parameters for request
3727
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
3728
+ * @param callback - Optional callback that handles the response.
3729
+ * @returns A promise if used with async/await, or void if used with a callback.
3730
+ */
3731
+ RotateServerCertificate(params: Params$Resource$Instances$Rotateservercertificate, options: StreamMethodOptions): GaxiosPromise<Readable>;
3732
+ RotateServerCertificate(params?: Params$Resource$Instances$Rotateservercertificate, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
3733
+ RotateServerCertificate(params: Params$Resource$Instances$Rotateservercertificate, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
3734
+ RotateServerCertificate(params: Params$Resource$Instances$Rotateservercertificate, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
3735
+ RotateServerCertificate(params: Params$Resource$Instances$Rotateservercertificate, callback: BodyResponseCallback<Schema$Operation>): void;
3736
+ RotateServerCertificate(callback: BodyResponseCallback<Schema$Operation>): void;
3088
3737
  /**
3089
3738
  * Starts the replication in the read replica instance.
3090
3739
  *
@@ -3114,7 +3763,7 @@ export declare namespace sqladmin_v1beta4 {
3114
3763
  stopReplica(params: Params$Resource$Instances$Stopreplica, callback: BodyResponseCallback<Schema$Operation>): void;
3115
3764
  stopReplica(callback: BodyResponseCallback<Schema$Operation>): void;
3116
3765
  /**
3117
- * Switches over from the primary instance to the designated DR replica instance.
3766
+ * Switches over from the primary instance to the DR replica instance.
3118
3767
  *
3119
3768
  * @param params - Parameters for request
3120
3769
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3180,6 +3829,16 @@ export declare namespace sqladmin_v1beta4 {
3180
3829
  */
3181
3830
  project?: string;
3182
3831
  }
3832
+ export interface Params$Resource$Instances$Addservercertificate extends StandardParameters {
3833
+ /**
3834
+ * Required. Cloud SQL instance ID. This does not include the project ID.
3835
+ */
3836
+ instance?: string;
3837
+ /**
3838
+ * Required. Project ID of the project that contains the instance.
3839
+ */
3840
+ project?: string;
3841
+ }
3183
3842
  export interface Params$Resource$Instances$Clone extends StandardParameters {
3184
3843
  /**
3185
3844
  * The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID.
@@ -3195,6 +3854,22 @@ export declare namespace sqladmin_v1beta4 {
3195
3854
  requestBody?: Schema$InstancesCloneRequest;
3196
3855
  }
3197
3856
  export interface Params$Resource$Instances$Delete extends StandardParameters {
3857
+ /**
3858
+ * Flag to opt-in for final backup. By default, it is turned off.
3859
+ */
3860
+ enableFinalBackup?: boolean;
3861
+ /**
3862
+ * Optional. The description of the final backup.
3863
+ */
3864
+ finalBackupDescription?: string;
3865
+ /**
3866
+ * Optional. Final Backup expiration time. Timestamp in UTC of when this resource is considered expired.
3867
+ */
3868
+ finalBackupExpiryTime?: string;
3869
+ /**
3870
+ * Optional. Retention period of the final backup.
3871
+ */
3872
+ finalBackupTtlDays?: string;
3198
3873
  /**
3199
3874
  * Cloud SQL instance ID. This does not include the project ID.
3200
3875
  */
@@ -3322,6 +3997,16 @@ export declare namespace sqladmin_v1beta4 {
3322
3997
  */
3323
3998
  project?: string;
3324
3999
  }
4000
+ export interface Params$Resource$Instances$Listservercertificates extends StandardParameters {
4001
+ /**
4002
+ * Required. Cloud SQL instance ID. This does not include the project ID.
4003
+ */
4004
+ instance?: string;
4005
+ /**
4006
+ * Required. Project ID of the project that contains the instance.
4007
+ */
4008
+ project?: string;
4009
+ }
3325
4010
  export interface Params$Resource$Instances$Patch extends StandardParameters {
3326
4011
  /**
3327
4012
  * Cloud SQL instance ID. This does not include the project ID.
@@ -3338,7 +4023,7 @@ export declare namespace sqladmin_v1beta4 {
3338
4023
  }
3339
4024
  export interface Params$Resource$Instances$Promotereplica extends StandardParameters {
3340
4025
  /**
3341
- * 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.
4026
+ * 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.
3342
4027
  */
3343
4028
  failover?: boolean;
3344
4029
  /**
@@ -3422,6 +4107,20 @@ export declare namespace sqladmin_v1beta4 {
3422
4107
  */
3423
4108
  requestBody?: Schema$InstancesRotateServerCaRequest;
3424
4109
  }
4110
+ export interface Params$Resource$Instances$Rotateservercertificate extends StandardParameters {
4111
+ /**
4112
+ * Required. Cloud SQL instance ID. This does not include the project ID.
4113
+ */
4114
+ instance?: string;
4115
+ /**
4116
+ * Required. Project ID of the project that contains the instance.
4117
+ */
4118
+ project?: string;
4119
+ /**
4120
+ * Request body metadata
4121
+ */
4122
+ requestBody?: Schema$InstancesRotateServerCertificateRequest;
4123
+ }
3425
4124
  export interface Params$Resource$Instances$Startreplica extends StandardParameters {
3426
4125
  /**
3427
4126
  * Cloud SQL read replica instance name.
@@ -3444,7 +4143,7 @@ export declare namespace sqladmin_v1beta4 {
3444
4143
  }
3445
4144
  export interface Params$Resource$Instances$Switchover extends StandardParameters {
3446
4145
  /**
3447
- * 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.
4146
+ * 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.
3448
4147
  */
3449
4148
  dbTimeout?: string;
3450
4149
  /**