@googleapis/alloydb 11.0.0 → 11.3.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/v1.ts CHANGED
@@ -250,6 +250,10 @@ export namespace alloydb_v1 {
250
250
  * Output only. The current state of the backup.
251
251
  */
252
252
  state?: string | null;
253
+ /**
254
+ * Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: ``` "123/environment": "production", "123/costCenter": "marketing" ```
255
+ */
256
+ tags?: {[key: string]: string} | null;
253
257
  /**
254
258
  * The backup type, which suggests the trigger for the backup.
255
259
  */
@@ -289,7 +293,7 @@ export namespace alloydb_v1 {
289
293
  */
290
294
  requireConnectors?: boolean | null;
291
295
  /**
292
- * Optional. SSL config option for this instance.
296
+ * Optional. SSL configuration option for this instance.
293
297
  */
294
298
  sslConfig?: Schema$SslConfig;
295
299
  }
@@ -423,6 +427,10 @@ export namespace alloydb_v1 {
423
427
  * Optional. Subscription type of the cluster.
424
428
  */
425
429
  subscriptionType?: string | null;
430
+ /**
431
+ * Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: ``` "123/environment": "production", "123/costCenter": "marketing" ```
432
+ */
433
+ tags?: {[key: string]: string} | null;
426
434
  /**
427
435
  * Output only. Metadata for free trial clusters
428
436
  */
@@ -537,6 +545,27 @@ export namespace alloydb_v1 {
537
545
  */
538
546
  pointInTime?: string | null;
539
547
  }
548
+ /**
549
+ * Options for exporting data in CSV format.
550
+ */
551
+ export interface Schema$CsvExportOptions {
552
+ /**
553
+ * Optional. Specifies the character that should appear before a data character that needs to be escaped. The default is the same as quote character. The value of this argument has to be a character in Hex ASCII Code.
554
+ */
555
+ escapeCharacter?: string | null;
556
+ /**
557
+ * Optional. Specifies the character that separates columns within each row (line) of the file. The default is comma. The value of this argument has to be a character in Hex ASCII Code.
558
+ */
559
+ fieldDelimiter?: string | null;
560
+ /**
561
+ * Optional. Specifies the quoting character to be used when a data value is quoted. The default is double-quote. The value of this argument has to be a character in Hex ASCII Code.
562
+ */
563
+ quoteCharacter?: string | null;
564
+ /**
565
+ * Required. The SELECT query used to extract the data.
566
+ */
567
+ selectQuery?: string | null;
568
+ }
540
569
  /**
541
570
  * 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); \}
542
571
  */
@@ -563,19 +592,58 @@ export namespace alloydb_v1 {
563
592
  */
564
593
  kmsKeyVersions?: string[] | null;
565
594
  }
595
+ /**
596
+ * Export cluster request.
597
+ */
598
+ export interface Schema$ExportClusterRequest {
599
+ /**
600
+ * Options for exporting data in CSV format. Required field to be set for CSV file type.
601
+ */
602
+ csvExportOptions?: Schema$CsvExportOptions;
603
+ /**
604
+ * Required. Name of the database where the export command will be executed. Note - Value provided should be the same as expected from `SELECT current_database();` and NOT as a resource reference.
605
+ */
606
+ database?: string | null;
607
+ /**
608
+ * Required. Option to export data to cloud storage.
609
+ */
610
+ gcsDestination?: Schema$GcsDestination;
611
+ /**
612
+ * Options for exporting data in SQL format. Required field to be set for SQL file type.
613
+ */
614
+ sqlExportOptions?: Schema$SqlExportOptions;
615
+ }
616
+ /**
617
+ * Response of export cluster rpc.
618
+ */
619
+ export interface Schema$ExportClusterResponse {
620
+ /**
621
+ * Required. Option to export data to cloud storage.
622
+ */
623
+ gcsDestination?: Schema$GcsDestination;
624
+ }
566
625
  /**
567
626
  * Message for triggering failover on an Instance
568
627
  */
569
628
  export interface Schema$FailoverInstanceRequest {
570
629
  /**
571
- * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
630
+ * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
572
631
  */
573
632
  requestId?: string | null;
574
633
  /**
575
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the failover.
634
+ * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
576
635
  */
577
636
  validateOnly?: boolean | null;
578
637
  }
638
+ /**
639
+ * Destination for Export. Export will be done to cloud storage.
640
+ */
641
+ export interface Schema$GcsDestination {
642
+ /**
643
+ * Required. The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form `gs://bucketName/fileName`.
644
+ */
645
+ uri?: string | null;
646
+ }
579
647
  /**
580
648
  * The response message for Locations.ListLocations.
581
649
  */
@@ -619,19 +687,19 @@ export namespace alloydb_v1 {
619
687
  */
620
688
  export interface Schema$GoogleTypeTimeOfDay {
621
689
  /**
622
- * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
690
+ * Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
623
691
  */
624
692
  hours?: number | null;
625
693
  /**
626
- * Minutes of hour of day. Must be from 0 to 59.
694
+ * Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
627
695
  */
628
696
  minutes?: number | null;
629
697
  /**
630
- * Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
698
+ * Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
631
699
  */
632
700
  nanos?: number | null;
633
701
  /**
634
- * Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
702
+ * Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
635
703
  */
636
704
  seconds?: number | null;
637
705
  }
@@ -644,11 +712,11 @@ export namespace alloydb_v1 {
644
712
  */
645
713
  faultType?: string | null;
646
714
  /**
647
- * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
715
+ * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
648
716
  */
649
717
  requestId?: string | null;
650
718
  /**
651
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the fault injection.
719
+ * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
652
720
  */
653
721
  validateOnly?: boolean | null;
654
722
  }
@@ -673,7 +741,7 @@ export namespace alloydb_v1 {
673
741
  */
674
742
  createTime?: string | null;
675
743
  /**
676
- * Database flags. Set at instance level. * They are copied from primary instance on read instance creation. * Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary. This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value.
744
+ * Database flags. Set at the instance level. They are copied from the primary instance on secondary instance creation. Flags that have restrictions default to the value at primary instance on read instances during creation. Read instances can set new flags or override existing flags that are relevant for reads, for example, for enabling columnar cache on a read instance. Flags set on read instance might or might not be present on the primary instance. This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value.
677
745
  */
678
746
  databaseFlags?: {[key: string]: string} | null;
679
747
  /**
@@ -713,13 +781,17 @@ export namespace alloydb_v1 {
713
781
  */
714
782
  name?: string | null;
715
783
  /**
716
- * Optional. Instance level network configuration.
784
+ * Optional. Instance-level network configuration.
717
785
  */
718
786
  networkConfig?: Schema$InstanceNetworkConfig;
719
787
  /**
720
788
  * Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
721
789
  */
722
790
  nodes?: Schema$Node[];
791
+ /**
792
+ * Output only. All outbound public IP addresses configured for the instance.
793
+ */
794
+ outboundPublicIpAddresses?: string[] | null;
723
795
  /**
724
796
  * Optional. The configuration for Private Service Connect (PSC) for the instance.
725
797
  */
@@ -762,13 +834,17 @@ export namespace alloydb_v1 {
762
834
  writableNode?: Schema$Node;
763
835
  }
764
836
  /**
765
- * Metadata related to instance level network configuration.
837
+ * Metadata related to instance-level network configuration.
766
838
  */
767
839
  export interface Schema$InstanceNetworkConfig {
768
840
  /**
769
841
  * Optional. A list of external network authorized to access this instance.
770
842
  */
771
843
  authorizedExternalNetworks?: Schema$AuthorizedNetwork[];
844
+ /**
845
+ * Optional. Enabling an outbound public IP address to support a database server sending requests out into the internet.
846
+ */
847
+ enableOutboundPublicIp?: boolean | null;
772
848
  /**
773
849
  * Optional. Enabling public ip for the instance.
774
850
  */
@@ -973,19 +1049,19 @@ export namespace alloydb_v1 {
973
1049
  */
974
1050
  export interface Schema$Node {
975
1051
  /**
976
- * The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
1052
+ * Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
977
1053
  */
978
1054
  id?: string | null;
979
1055
  /**
980
- * The private IP address of the VM e.g. "10.57.0.34".
1056
+ * Output only. The private IP address of the VM e.g. "10.57.0.34".
981
1057
  */
982
1058
  ip?: string | null;
983
1059
  /**
984
- * Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
1060
+ * Output only. Determined by state of the compute VM and postgres-service health. Compute VM state can have values listed in https://cloud.google.com/compute/docs/instances/instance-life-cycle and postgres-service health can have values: HEALTHY and UNHEALTHY.
985
1061
  */
986
1062
  state?: string | null;
987
1063
  /**
988
- * The Compute Engine zone of the VM e.g. "us-central1-b".
1064
+ * Output only. The Compute Engine zone of the VM e.g. "us-central1-b".
989
1065
  */
990
1066
  zoneId?: string | null;
991
1067
  }
@@ -1031,7 +1107,7 @@ export namespace alloydb_v1 {
1031
1107
  */
1032
1108
  endTime?: string | null;
1033
1109
  /**
1034
- * Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
1110
+ * Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
1035
1111
  */
1036
1112
  requestedCancellation?: boolean | null;
1037
1113
  /**
@@ -1065,11 +1141,11 @@ export namespace alloydb_v1 {
1065
1141
  */
1066
1142
  etag?: string | null;
1067
1143
  /**
1068
- * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
1144
+ * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
1069
1145
  */
1070
1146
  requestId?: string | null;
1071
1147
  /**
1072
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.
1148
+ * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
1073
1149
  */
1074
1150
  validateOnly?: boolean | null;
1075
1151
  }
@@ -1153,15 +1229,15 @@ export namespace alloydb_v1 {
1153
1229
  }
1154
1230
  export interface Schema$RestartInstanceRequest {
1155
1231
  /**
1156
- * Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Only applicable for read instances.
1232
+ * Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Applicable only to read instances.
1157
1233
  */
1158
1234
  nodeIds?: string[] | null;
1159
1235
  /**
1160
- * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
1236
+ * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
1161
1237
  */
1162
1238
  requestId?: string | null;
1163
1239
  /**
1164
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the restart.
1240
+ * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
1165
1241
  */
1166
1242
  validateOnly?: boolean | null;
1167
1243
  }
@@ -1186,11 +1262,11 @@ export namespace alloydb_v1 {
1186
1262
  */
1187
1263
  continuousBackupSource?: Schema$ContinuousBackupSource;
1188
1264
  /**
1189
- * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
1265
+ * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
1190
1266
  */
1191
1267
  requestId?: string | null;
1192
1268
  /**
1193
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the import request.
1269
+ * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
1194
1270
  */
1195
1271
  validateOnly?: boolean | null;
1196
1272
  }
@@ -1203,6 +1279,27 @@ export namespace alloydb_v1 {
1203
1279
  */
1204
1280
  primaryClusterName?: string | null;
1205
1281
  }
1282
+ /**
1283
+ * Options for exporting data in SQL format.
1284
+ */
1285
+ export interface Schema$SqlExportOptions {
1286
+ /**
1287
+ * Optional. If true, output commands to DROP all the dumped database objects prior to outputting the commands for creating them.
1288
+ */
1289
+ cleanTargetObjects?: boolean | null;
1290
+ /**
1291
+ * Optional. If true, use DROP ... IF EXISTS commands to check for the object's existence before dropping it in clean_target_objects mode.
1292
+ */
1293
+ ifExistTargetObjects?: boolean | null;
1294
+ /**
1295
+ * Optional. If true, only export the schema.
1296
+ */
1297
+ schemaOnly?: boolean | null;
1298
+ /**
1299
+ * Optional. Tables to export from.
1300
+ */
1301
+ tables?: string[] | null;
1302
+ }
1206
1303
  /**
1207
1304
  * SSL configuration.
1208
1305
  */
@@ -1254,6 +1351,10 @@ export namespace alloydb_v1 {
1254
1351
  * Configuration for availability of database instance
1255
1352
  */
1256
1353
  export interface Schema$StorageDatabasecenterPartnerapiV1mainAvailabilityConfiguration {
1354
+ /**
1355
+ * Checks for existence of (multi-cluster) routing configuration that allows automatic failover to a different zone/region in case of an outage. Applicable to Bigtable resources.
1356
+ */
1357
+ automaticFailoverRoutingConfigured?: boolean | null;
1257
1358
  /**
1258
1359
  * Availability type. Potential values: * `ZONAL`: The instance serves data from only one zone. Outages in that zone affect data accessibility. * `REGIONAL`: The instance can serve data from more than one zone in a region (it is highly available).
1259
1360
  */
@@ -1426,7 +1527,7 @@ export namespace alloydb_v1 {
1426
1527
  uniqueId?: string | null;
1427
1528
  }
1428
1529
  /**
1429
- * Common model for database resource instance metadata.
1530
+ * Common model for database resource instance metadata. Next ID: 23
1430
1531
  */
1431
1532
  export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata {
1432
1533
  /**
@@ -1453,6 +1554,10 @@ export namespace alloydb_v1 {
1453
1554
  * Any custom metadata associated with the resource
1454
1555
  */
1455
1556
  customMetadata?: Schema$StorageDatabasecenterPartnerapiV1mainCustomMetadataData;
1557
+ /**
1558
+ * Optional. Edition represents whether the instance is ENTERPRISE or ENTERPRISE_PLUS. This information is core to Cloud SQL only and is used to identify the edition of the instance.
1559
+ */
1560
+ edition?: string | null;
1456
1561
  /**
1457
1562
  * Entitlements associated with the resource
1458
1563
  */
@@ -1481,6 +1586,10 @@ export namespace alloydb_v1 {
1481
1586
  * Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional.
1482
1587
  */
1483
1588
  primaryResourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId;
1589
+ /**
1590
+ * Primary resource location. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional.
1591
+ */
1592
+ primaryResourceLocation?: string | null;
1484
1593
  /**
1485
1594
  * The product this resource represents.
1486
1595
  */
@@ -1493,6 +1602,10 @@ export namespace alloydb_v1 {
1493
1602
  * Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named "ABC" is deleted, the name "ABC" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel
1494
1603
  */
1495
1604
  resourceName?: string | null;
1605
+ /**
1606
+ * Optional. Tags associated with this resources.
1607
+ */
1608
+ tagsSet?: Schema$StorageDatabasecenterPartnerapiV1mainTags;
1496
1609
  /**
1497
1610
  * The time at which the resource was updated and recorded at partner service.
1498
1611
  */
@@ -1576,13 +1689,21 @@ export namespace alloydb_v1 {
1576
1689
  */
1577
1690
  export interface Schema$StorageDatabasecenterPartnerapiV1mainMachineConfiguration {
1578
1691
  /**
1579
- * The number of CPUs. TODO(b/342344482, b/342346271) add proto validations again after bug fix.
1692
+ * The number of CPUs. Deprecated. Use vcpu_count instead. TODO(b/342344482, b/342346271) add proto validations again after bug fix.
1580
1693
  */
1581
1694
  cpuCount?: number | null;
1582
1695
  /**
1583
1696
  * Memory size in bytes. TODO(b/342344482, b/342346271) add proto validations again after bug fix.
1584
1697
  */
1585
1698
  memorySizeInBytes?: string | null;
1699
+ /**
1700
+ * Optional. Number of shards (if applicable).
1701
+ */
1702
+ shardCount?: number | null;
1703
+ /**
1704
+ * Optional. The number of vCPUs. TODO(b/342344482, b/342346271) add proto validations again after bug fix.
1705
+ */
1706
+ vcpuCount?: number | null;
1586
1707
  }
1587
1708
  export interface Schema$StorageDatabasecenterPartnerapiV1mainObservabilityMetricData {
1588
1709
  /**
@@ -1621,12 +1742,29 @@ export namespace alloydb_v1 {
1621
1742
  message?: string | null;
1622
1743
  }
1623
1744
  export interface Schema$StorageDatabasecenterPartnerapiV1mainRetentionSettings {
1745
+ /**
1746
+ * Duration based retention period i.e. 172800 seconds (2 days)
1747
+ */
1748
+ durationBasedRetention?: string | null;
1624
1749
  quantityBasedRetention?: number | null;
1625
1750
  /**
1626
1751
  * The unit that 'retained_backups' represents.
1627
1752
  */
1628
1753
  retentionUnit?: string | null;
1629
1754
  timeBasedRetention?: string | null;
1755
+ /**
1756
+ * Timestamp based retention period i.e. 2024-05-01T00:00:00Z
1757
+ */
1758
+ timestampBasedRetentionTime?: string | null;
1759
+ }
1760
+ /**
1761
+ * Message type for storing tags. Tags provide a way to create annotations for resources, and in some cases conditionally allow or deny policies based on whether a resource has a specific tag.
1762
+ */
1763
+ export interface Schema$StorageDatabasecenterPartnerapiV1mainTags {
1764
+ /**
1765
+ * The Tag key/value mappings.
1766
+ */
1767
+ tags?: {[key: string]: string} | null;
1630
1768
  }
1631
1769
  /**
1632
1770
  * Message type for storing user labels. User labels are used to tag App Engine resources, allowing users to search for resources matching a set of labels and to aggregate usage data by labels.
@@ -1720,11 +1858,11 @@ export namespace alloydb_v1 {
1720
1858
  */
1721
1859
  export interface Schema$SwitchoverClusterRequest {
1722
1860
  /**
1723
- * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
1861
+ * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
1724
1862
  */
1725
1863
  requestId?: string | null;
1726
1864
  /**
1727
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.
1865
+ * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
1728
1866
  */
1729
1867
  validateOnly?: boolean | null;
1730
1868
  }
@@ -1758,6 +1896,27 @@ export namespace alloydb_v1 {
1758
1896
  */
1759
1897
  upgradeTime?: string | null;
1760
1898
  }
1899
+ /**
1900
+ * Upgrades a cluster.
1901
+ */
1902
+ export interface Schema$UpgradeClusterRequest {
1903
+ /**
1904
+ * Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, upgrade will be blocked and an ABORTED error will be returned.
1905
+ */
1906
+ etag?: string | null;
1907
+ /**
1908
+ * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
1909
+ */
1910
+ requestId?: string | null;
1911
+ /**
1912
+ * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
1913
+ */
1914
+ validateOnly?: boolean | null;
1915
+ /**
1916
+ * Required. The version the cluster is going to be upgraded to.
1917
+ */
1918
+ version?: string | null;
1919
+ }
1761
1920
  /**
1762
1921
  * UpgradeClusterResponse contains the response for upgrade cluster operation.
1763
1922
  */
@@ -1783,6 +1942,10 @@ export namespace alloydb_v1 {
1783
1942
  * Optional. List of database roles this user has. The database role strings are subject to the PostgreSQL naming conventions.
1784
1943
  */
1785
1944
  databaseRoles?: string[] | null;
1945
+ /**
1946
+ * Input only. If the user already exists and it has additional roles, keep them granted.
1947
+ */
1948
+ keepExtraRoles?: boolean | null;
1786
1949
  /**
1787
1950
  * Output only. Name of the resource in the form of projects/{project\}/locations/{location\}/cluster/{cluster\}/users/{user\}.
1788
1951
  */
@@ -2518,7 +2681,7 @@ export namespace alloydb_v1 {
2518
2681
  */
2519
2682
  parent?: string;
2520
2683
  /**
2521
- * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
2684
+ * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
2522
2685
  */
2523
2686
  requestId?: string;
2524
2687
  /**
@@ -2542,7 +2705,7 @@ export namespace alloydb_v1 {
2542
2705
  */
2543
2706
  name?: string;
2544
2707
  /**
2545
- * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
2708
+ * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
2546
2709
  */
2547
2710
  requestId?: string;
2548
2711
  /**
@@ -2591,7 +2754,7 @@ export namespace alloydb_v1 {
2591
2754
  */
2592
2755
  name?: string;
2593
2756
  /**
2594
- * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
2757
+ * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
2595
2758
  */
2596
2759
  requestId?: string;
2597
2760
  /**
@@ -2883,6 +3046,91 @@ export namespace alloydb_v1 {
2883
3046
  }
2884
3047
  }
2885
3048
 
3049
+ /**
3050
+ * Exports data from the cluster. Imperative only.
3051
+ *
3052
+ * @param params - Parameters for request
3053
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
3054
+ * @param callback - Optional callback that handles the response.
3055
+ * @returns A promise if used with async/await, or void if used with a callback.
3056
+ */
3057
+ export(
3058
+ params: Params$Resource$Projects$Locations$Clusters$Export,
3059
+ options: StreamMethodOptions
3060
+ ): GaxiosPromise<Readable>;
3061
+ export(
3062
+ params?: Params$Resource$Projects$Locations$Clusters$Export,
3063
+ options?: MethodOptions
3064
+ ): GaxiosPromise<Schema$Operation>;
3065
+ export(
3066
+ params: Params$Resource$Projects$Locations$Clusters$Export,
3067
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
3068
+ callback: BodyResponseCallback<Readable>
3069
+ ): void;
3070
+ export(
3071
+ params: Params$Resource$Projects$Locations$Clusters$Export,
3072
+ options: MethodOptions | BodyResponseCallback<Schema$Operation>,
3073
+ callback: BodyResponseCallback<Schema$Operation>
3074
+ ): void;
3075
+ export(
3076
+ params: Params$Resource$Projects$Locations$Clusters$Export,
3077
+ callback: BodyResponseCallback<Schema$Operation>
3078
+ ): void;
3079
+ export(callback: BodyResponseCallback<Schema$Operation>): void;
3080
+ export(
3081
+ paramsOrCallback?:
3082
+ | Params$Resource$Projects$Locations$Clusters$Export
3083
+ | BodyResponseCallback<Schema$Operation>
3084
+ | BodyResponseCallback<Readable>,
3085
+ optionsOrCallback?:
3086
+ | MethodOptions
3087
+ | StreamMethodOptions
3088
+ | BodyResponseCallback<Schema$Operation>
3089
+ | BodyResponseCallback<Readable>,
3090
+ callback?:
3091
+ | BodyResponseCallback<Schema$Operation>
3092
+ | BodyResponseCallback<Readable>
3093
+ ): void | GaxiosPromise<Schema$Operation> | GaxiosPromise<Readable> {
3094
+ let params = (paramsOrCallback ||
3095
+ {}) as Params$Resource$Projects$Locations$Clusters$Export;
3096
+ let options = (optionsOrCallback || {}) as MethodOptions;
3097
+
3098
+ if (typeof paramsOrCallback === 'function') {
3099
+ callback = paramsOrCallback;
3100
+ params = {} as Params$Resource$Projects$Locations$Clusters$Export;
3101
+ options = {};
3102
+ }
3103
+
3104
+ if (typeof optionsOrCallback === 'function') {
3105
+ callback = optionsOrCallback;
3106
+ options = {};
3107
+ }
3108
+
3109
+ const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/';
3110
+ const parameters = {
3111
+ options: Object.assign(
3112
+ {
3113
+ url: (rootUrl + '/v1/{+name}:export').replace(/([^:]\/)\/+/g, '$1'),
3114
+ method: 'POST',
3115
+ apiVersion: '',
3116
+ },
3117
+ options
3118
+ ),
3119
+ params,
3120
+ requiredParams: ['name'],
3121
+ pathParams: ['name'],
3122
+ context: this.context,
3123
+ };
3124
+ if (callback) {
3125
+ createAPIRequest<Schema$Operation>(
3126
+ parameters,
3127
+ callback as BodyResponseCallback<unknown>
3128
+ );
3129
+ } else {
3130
+ return createAPIRequest<Schema$Operation>(parameters);
3131
+ }
3132
+ }
3133
+
2886
3134
  /**
2887
3135
  * Gets details of a single Cluster.
2888
3136
  *
@@ -3323,7 +3571,7 @@ export namespace alloydb_v1 {
3323
3571
  }
3324
3572
 
3325
3573
  /**
3326
- * Switches the role of PRIMARY and SECONDARY cluster without any data loss. This promotes the SECONDARY cluster to PRIMARY and sets up original PRIMARY cluster to replicate from this newly promoted cluster.
3574
+ * Switches the roles of PRIMARY and SECONDARY clusters without any data loss. This promotes the SECONDARY cluster to PRIMARY and sets up the original PRIMARY cluster to replicate from this newly promoted cluster.
3327
3575
  *
3328
3576
  * @param params - Parameters for request
3329
3577
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3409,6 +3657,94 @@ export namespace alloydb_v1 {
3409
3657
  return createAPIRequest<Schema$Operation>(parameters);
3410
3658
  }
3411
3659
  }
3660
+
3661
+ /**
3662
+ * Upgrades a single Cluster. Imperative only.
3663
+ *
3664
+ * @param params - Parameters for request
3665
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
3666
+ * @param callback - Optional callback that handles the response.
3667
+ * @returns A promise if used with async/await, or void if used with a callback.
3668
+ */
3669
+ upgrade(
3670
+ params: Params$Resource$Projects$Locations$Clusters$Upgrade,
3671
+ options: StreamMethodOptions
3672
+ ): GaxiosPromise<Readable>;
3673
+ upgrade(
3674
+ params?: Params$Resource$Projects$Locations$Clusters$Upgrade,
3675
+ options?: MethodOptions
3676
+ ): GaxiosPromise<Schema$Operation>;
3677
+ upgrade(
3678
+ params: Params$Resource$Projects$Locations$Clusters$Upgrade,
3679
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
3680
+ callback: BodyResponseCallback<Readable>
3681
+ ): void;
3682
+ upgrade(
3683
+ params: Params$Resource$Projects$Locations$Clusters$Upgrade,
3684
+ options: MethodOptions | BodyResponseCallback<Schema$Operation>,
3685
+ callback: BodyResponseCallback<Schema$Operation>
3686
+ ): void;
3687
+ upgrade(
3688
+ params: Params$Resource$Projects$Locations$Clusters$Upgrade,
3689
+ callback: BodyResponseCallback<Schema$Operation>
3690
+ ): void;
3691
+ upgrade(callback: BodyResponseCallback<Schema$Operation>): void;
3692
+ upgrade(
3693
+ paramsOrCallback?:
3694
+ | Params$Resource$Projects$Locations$Clusters$Upgrade
3695
+ | BodyResponseCallback<Schema$Operation>
3696
+ | BodyResponseCallback<Readable>,
3697
+ optionsOrCallback?:
3698
+ | MethodOptions
3699
+ | StreamMethodOptions
3700
+ | BodyResponseCallback<Schema$Operation>
3701
+ | BodyResponseCallback<Readable>,
3702
+ callback?:
3703
+ | BodyResponseCallback<Schema$Operation>
3704
+ | BodyResponseCallback<Readable>
3705
+ ): void | GaxiosPromise<Schema$Operation> | GaxiosPromise<Readable> {
3706
+ let params = (paramsOrCallback ||
3707
+ {}) as Params$Resource$Projects$Locations$Clusters$Upgrade;
3708
+ let options = (optionsOrCallback || {}) as MethodOptions;
3709
+
3710
+ if (typeof paramsOrCallback === 'function') {
3711
+ callback = paramsOrCallback;
3712
+ params = {} as Params$Resource$Projects$Locations$Clusters$Upgrade;
3713
+ options = {};
3714
+ }
3715
+
3716
+ if (typeof optionsOrCallback === 'function') {
3717
+ callback = optionsOrCallback;
3718
+ options = {};
3719
+ }
3720
+
3721
+ const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/';
3722
+ const parameters = {
3723
+ options: Object.assign(
3724
+ {
3725
+ url: (rootUrl + '/v1/{+name}:upgrade').replace(
3726
+ /([^:]\/)\/+/g,
3727
+ '$1'
3728
+ ),
3729
+ method: 'PATCH',
3730
+ apiVersion: '',
3731
+ },
3732
+ options
3733
+ ),
3734
+ params,
3735
+ requiredParams: ['name'],
3736
+ pathParams: ['name'],
3737
+ context: this.context,
3738
+ };
3739
+ if (callback) {
3740
+ createAPIRequest<Schema$Operation>(
3741
+ parameters,
3742
+ callback as BodyResponseCallback<unknown>
3743
+ );
3744
+ } else {
3745
+ return createAPIRequest<Schema$Operation>(parameters);
3746
+ }
3747
+ }
3412
3748
  }
3413
3749
 
3414
3750
  export interface Params$Resource$Projects$Locations$Clusters$Create
@@ -3422,11 +3758,11 @@ export namespace alloydb_v1 {
3422
3758
  */
3423
3759
  parent?: string;
3424
3760
  /**
3425
- * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
3761
+ * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
3426
3762
  */
3427
3763
  requestId?: string;
3428
3764
  /**
3429
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.
3765
+ * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
3430
3766
  */
3431
3767
  validateOnly?: boolean;
3432
3768
 
@@ -3446,11 +3782,11 @@ export namespace alloydb_v1 {
3446
3782
  */
3447
3783
  parent?: string;
3448
3784
  /**
3449
- * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
3785
+ * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
3450
3786
  */
3451
3787
  requestId?: string;
3452
3788
  /**
3453
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.
3789
+ * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
3454
3790
  */
3455
3791
  validateOnly?: boolean;
3456
3792
 
@@ -3474,14 +3810,26 @@ export namespace alloydb_v1 {
3474
3810
  */
3475
3811
  name?: string;
3476
3812
  /**
3477
- * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
3813
+ * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
3478
3814
  */
3479
3815
  requestId?: string;
3480
3816
  /**
3481
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.
3817
+ * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
3482
3818
  */
3483
3819
  validateOnly?: boolean;
3484
3820
  }
3821
+ export interface Params$Resource$Projects$Locations$Clusters$Export
3822
+ extends StandardParameters {
3823
+ /**
3824
+ * Required. The resource name of the cluster.
3825
+ */
3826
+ name?: string;
3827
+
3828
+ /**
3829
+ * Request body metadata
3830
+ */
3831
+ requestBody?: Schema$ExportClusterRequest;
3832
+ }
3485
3833
  export interface Params$Resource$Projects$Locations$Clusters$Get
3486
3834
  extends StandardParameters {
3487
3835
  /**
@@ -3527,7 +3875,7 @@ export namespace alloydb_v1 {
3527
3875
  */
3528
3876
  name?: string;
3529
3877
  /**
3530
- * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
3878
+ * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
3531
3879
  */
3532
3880
  requestId?: string;
3533
3881
  /**
@@ -3535,7 +3883,7 @@ export namespace alloydb_v1 {
3535
3883
  */
3536
3884
  updateMask?: string;
3537
3885
  /**
3538
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request.
3886
+ * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
3539
3887
  */
3540
3888
  validateOnly?: boolean;
3541
3889
 
@@ -3580,6 +3928,18 @@ export namespace alloydb_v1 {
3580
3928
  */
3581
3929
  requestBody?: Schema$SwitchoverClusterRequest;
3582
3930
  }
3931
+ export interface Params$Resource$Projects$Locations$Clusters$Upgrade
3932
+ extends StandardParameters {
3933
+ /**
3934
+ * Required. The resource name of the cluster.
3935
+ */
3936
+ name?: string;
3937
+
3938
+ /**
3939
+ * Request body metadata
3940
+ */
3941
+ requestBody?: Schema$UpgradeClusterRequest;
3942
+ }
3583
3943
 
3584
3944
  export class Resource$Projects$Locations$Clusters$Instances {
3585
3945
  context: APIRequestContext;
@@ -4487,11 +4847,11 @@ export namespace alloydb_v1 {
4487
4847
  */
4488
4848
  parent?: string;
4489
4849
  /**
4490
- * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
4850
+ * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
4491
4851
  */
4492
4852
  requestId?: string;
4493
4853
  /**
4494
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.
4854
+ * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
4495
4855
  */
4496
4856
  validateOnly?: boolean;
4497
4857
 
@@ -4511,11 +4871,11 @@ export namespace alloydb_v1 {
4511
4871
  */
4512
4872
  parent?: string;
4513
4873
  /**
4514
- * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
4874
+ * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
4515
4875
  */
4516
4876
  requestId?: string;
4517
4877
  /**
4518
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.
4878
+ * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
4519
4879
  */
4520
4880
  validateOnly?: boolean;
4521
4881
 
@@ -4535,11 +4895,11 @@ export namespace alloydb_v1 {
4535
4895
  */
4536
4896
  name?: string;
4537
4897
  /**
4538
- * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
4898
+ * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
4539
4899
  */
4540
4900
  requestId?: string;
4541
4901
  /**
4542
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.
4902
+ * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
4543
4903
  */
4544
4904
  validateOnly?: boolean;
4545
4905
  }
@@ -4573,7 +4933,7 @@ export namespace alloydb_v1 {
4573
4933
  */
4574
4934
  parent?: string;
4575
4935
  /**
4576
- * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
4936
+ * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
4577
4937
  */
4578
4938
  requestId?: string;
4579
4939
  }
@@ -4623,7 +4983,7 @@ export namespace alloydb_v1 {
4623
4983
  */
4624
4984
  name?: string;
4625
4985
  /**
4626
- * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
4986
+ * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
4627
4987
  */
4628
4988
  requestId?: string;
4629
4989
  /**
@@ -4631,7 +4991,7 @@ export namespace alloydb_v1 {
4631
4991
  */
4632
4992
  updateMask?: string;
4633
4993
  /**
4634
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request.
4994
+ * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
4635
4995
  */
4636
4996
  validateOnly?: boolean;
4637
4997
 
@@ -5101,7 +5461,7 @@ export namespace alloydb_v1 {
5101
5461
  */
5102
5462
  parent?: string;
5103
5463
  /**
5104
- * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
5464
+ * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
5105
5465
  */
5106
5466
  requestId?: string;
5107
5467
  /**
@@ -5125,7 +5485,7 @@ export namespace alloydb_v1 {
5125
5485
  */
5126
5486
  name?: string;
5127
5487
  /**
5128
- * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
5488
+ * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
5129
5489
  */
5130
5490
  requestId?: string;
5131
5491
  /**
@@ -5174,7 +5534,7 @@ export namespace alloydb_v1 {
5174
5534
  */
5175
5535
  name?: string;
5176
5536
  /**
5177
- * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
5537
+ * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
5178
5538
  */
5179
5539
  requestId?: string;
5180
5540
  /**
@@ -5199,7 +5559,7 @@ export namespace alloydb_v1 {
5199
5559
  }
5200
5560
 
5201
5561
  /**
5202
- * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
5562
+ * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
5203
5563
  *
5204
5564
  * @param params - Parameters for request
5205
5565
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.