@googleapis/alloydb 11.1.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
  */
@@ -1430,7 +1527,7 @@ export namespace alloydb_v1 {
1430
1527
  uniqueId?: string | null;
1431
1528
  }
1432
1529
  /**
1433
- * Common model for database resource instance metadata.
1530
+ * Common model for database resource instance metadata. Next ID: 23
1434
1531
  */
1435
1532
  export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata {
1436
1533
  /**
@@ -1457,6 +1554,10 @@ export namespace alloydb_v1 {
1457
1554
  * Any custom metadata associated with the resource
1458
1555
  */
1459
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;
1460
1561
  /**
1461
1562
  * Entitlements associated with the resource
1462
1563
  */
@@ -1485,6 +1586,10 @@ export namespace alloydb_v1 {
1485
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.
1486
1587
  */
1487
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;
1488
1593
  /**
1489
1594
  * The product this resource represents.
1490
1595
  */
@@ -1497,6 +1602,10 @@ export namespace alloydb_v1 {
1497
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
1498
1603
  */
1499
1604
  resourceName?: string | null;
1605
+ /**
1606
+ * Optional. Tags associated with this resources.
1607
+ */
1608
+ tagsSet?: Schema$StorageDatabasecenterPartnerapiV1mainTags;
1500
1609
  /**
1501
1610
  * The time at which the resource was updated and recorded at partner service.
1502
1611
  */
@@ -1580,13 +1689,21 @@ export namespace alloydb_v1 {
1580
1689
  */
1581
1690
  export interface Schema$StorageDatabasecenterPartnerapiV1mainMachineConfiguration {
1582
1691
  /**
1583
- * 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.
1584
1693
  */
1585
1694
  cpuCount?: number | null;
1586
1695
  /**
1587
1696
  * Memory size in bytes. TODO(b/342344482, b/342346271) add proto validations again after bug fix.
1588
1697
  */
1589
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;
1590
1707
  }
1591
1708
  export interface Schema$StorageDatabasecenterPartnerapiV1mainObservabilityMetricData {
1592
1709
  /**
@@ -1625,12 +1742,29 @@ export namespace alloydb_v1 {
1625
1742
  message?: string | null;
1626
1743
  }
1627
1744
  export interface Schema$StorageDatabasecenterPartnerapiV1mainRetentionSettings {
1745
+ /**
1746
+ * Duration based retention period i.e. 172800 seconds (2 days)
1747
+ */
1748
+ durationBasedRetention?: string | null;
1628
1749
  quantityBasedRetention?: number | null;
1629
1750
  /**
1630
1751
  * The unit that 'retained_backups' represents.
1631
1752
  */
1632
1753
  retentionUnit?: string | null;
1633
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;
1634
1768
  }
1635
1769
  /**
1636
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.
@@ -1724,11 +1858,11 @@ export namespace alloydb_v1 {
1724
1858
  */
1725
1859
  export interface Schema$SwitchoverClusterRequest {
1726
1860
  /**
1727
- * 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).
1728
1862
  */
1729
1863
  requestId?: string | null;
1730
1864
  /**
1731
- * 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.
1732
1866
  */
1733
1867
  validateOnly?: boolean | null;
1734
1868
  }
@@ -1762,6 +1896,27 @@ export namespace alloydb_v1 {
1762
1896
  */
1763
1897
  upgradeTime?: string | null;
1764
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
+ }
1765
1920
  /**
1766
1921
  * UpgradeClusterResponse contains the response for upgrade cluster operation.
1767
1922
  */
@@ -2526,7 +2681,7 @@ export namespace alloydb_v1 {
2526
2681
  */
2527
2682
  parent?: string;
2528
2683
  /**
2529
- * 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).
2530
2685
  */
2531
2686
  requestId?: string;
2532
2687
  /**
@@ -2550,7 +2705,7 @@ export namespace alloydb_v1 {
2550
2705
  */
2551
2706
  name?: string;
2552
2707
  /**
2553
- * 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).
2554
2709
  */
2555
2710
  requestId?: string;
2556
2711
  /**
@@ -2599,7 +2754,7 @@ export namespace alloydb_v1 {
2599
2754
  */
2600
2755
  name?: string;
2601
2756
  /**
2602
- * 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).
2603
2758
  */
2604
2759
  requestId?: string;
2605
2760
  /**
@@ -2891,6 +3046,91 @@ export namespace alloydb_v1 {
2891
3046
  }
2892
3047
  }
2893
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
+
2894
3134
  /**
2895
3135
  * Gets details of a single Cluster.
2896
3136
  *
@@ -3331,7 +3571,7 @@ export namespace alloydb_v1 {
3331
3571
  }
3332
3572
 
3333
3573
  /**
3334
- * 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.
3335
3575
  *
3336
3576
  * @param params - Parameters for request
3337
3577
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3417,6 +3657,94 @@ export namespace alloydb_v1 {
3417
3657
  return createAPIRequest<Schema$Operation>(parameters);
3418
3658
  }
3419
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
+ }
3420
3748
  }
3421
3749
 
3422
3750
  export interface Params$Resource$Projects$Locations$Clusters$Create
@@ -3430,11 +3758,11 @@ export namespace alloydb_v1 {
3430
3758
  */
3431
3759
  parent?: string;
3432
3760
  /**
3433
- * 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).
3434
3762
  */
3435
3763
  requestId?: string;
3436
3764
  /**
3437
- * 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.
3438
3766
  */
3439
3767
  validateOnly?: boolean;
3440
3768
 
@@ -3454,11 +3782,11 @@ export namespace alloydb_v1 {
3454
3782
  */
3455
3783
  parent?: string;
3456
3784
  /**
3457
- * 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).
3458
3786
  */
3459
3787
  requestId?: string;
3460
3788
  /**
3461
- * 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.
3462
3790
  */
3463
3791
  validateOnly?: boolean;
3464
3792
 
@@ -3482,14 +3810,26 @@ export namespace alloydb_v1 {
3482
3810
  */
3483
3811
  name?: string;
3484
3812
  /**
3485
- * 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).
3486
3814
  */
3487
3815
  requestId?: string;
3488
3816
  /**
3489
- * 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.
3490
3818
  */
3491
3819
  validateOnly?: boolean;
3492
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
+ }
3493
3833
  export interface Params$Resource$Projects$Locations$Clusters$Get
3494
3834
  extends StandardParameters {
3495
3835
  /**
@@ -3535,7 +3875,7 @@ export namespace alloydb_v1 {
3535
3875
  */
3536
3876
  name?: string;
3537
3877
  /**
3538
- * 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).
3539
3879
  */
3540
3880
  requestId?: string;
3541
3881
  /**
@@ -3543,7 +3883,7 @@ export namespace alloydb_v1 {
3543
3883
  */
3544
3884
  updateMask?: string;
3545
3885
  /**
3546
- * 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.
3547
3887
  */
3548
3888
  validateOnly?: boolean;
3549
3889
 
@@ -3588,6 +3928,18 @@ export namespace alloydb_v1 {
3588
3928
  */
3589
3929
  requestBody?: Schema$SwitchoverClusterRequest;
3590
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
+ }
3591
3943
 
3592
3944
  export class Resource$Projects$Locations$Clusters$Instances {
3593
3945
  context: APIRequestContext;
@@ -4495,11 +4847,11 @@ export namespace alloydb_v1 {
4495
4847
  */
4496
4848
  parent?: string;
4497
4849
  /**
4498
- * 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).
4499
4851
  */
4500
4852
  requestId?: string;
4501
4853
  /**
4502
- * 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.
4503
4855
  */
4504
4856
  validateOnly?: boolean;
4505
4857
 
@@ -4519,11 +4871,11 @@ export namespace alloydb_v1 {
4519
4871
  */
4520
4872
  parent?: string;
4521
4873
  /**
4522
- * 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).
4523
4875
  */
4524
4876
  requestId?: string;
4525
4877
  /**
4526
- * 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.
4527
4879
  */
4528
4880
  validateOnly?: boolean;
4529
4881
 
@@ -4543,11 +4895,11 @@ export namespace alloydb_v1 {
4543
4895
  */
4544
4896
  name?: string;
4545
4897
  /**
4546
- * 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).
4547
4899
  */
4548
4900
  requestId?: string;
4549
4901
  /**
4550
- * 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.
4551
4903
  */
4552
4904
  validateOnly?: boolean;
4553
4905
  }
@@ -4581,7 +4933,7 @@ export namespace alloydb_v1 {
4581
4933
  */
4582
4934
  parent?: string;
4583
4935
  /**
4584
- * 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).
4585
4937
  */
4586
4938
  requestId?: string;
4587
4939
  }
@@ -4631,7 +4983,7 @@ export namespace alloydb_v1 {
4631
4983
  */
4632
4984
  name?: string;
4633
4985
  /**
4634
- * 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).
4635
4987
  */
4636
4988
  requestId?: string;
4637
4989
  /**
@@ -4639,7 +4991,7 @@ export namespace alloydb_v1 {
4639
4991
  */
4640
4992
  updateMask?: string;
4641
4993
  /**
4642
- * 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.
4643
4995
  */
4644
4996
  validateOnly?: boolean;
4645
4997
 
@@ -5109,7 +5461,7 @@ export namespace alloydb_v1 {
5109
5461
  */
5110
5462
  parent?: string;
5111
5463
  /**
5112
- * 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).
5113
5465
  */
5114
5466
  requestId?: string;
5115
5467
  /**
@@ -5133,7 +5485,7 @@ export namespace alloydb_v1 {
5133
5485
  */
5134
5486
  name?: string;
5135
5487
  /**
5136
- * 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).
5137
5489
  */
5138
5490
  requestId?: string;
5139
5491
  /**
@@ -5182,7 +5534,7 @@ export namespace alloydb_v1 {
5182
5534
  */
5183
5535
  name?: string;
5184
5536
  /**
5185
- * 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).
5186
5538
  */
5187
5539
  requestId?: string;
5188
5540
  /**
@@ -5207,7 +5559,7 @@ export namespace alloydb_v1 {
5207
5559
  }
5208
5560
 
5209
5561
  /**
5210
- * 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`.
5211
5563
  *
5212
5564
  * @param params - Parameters for request
5213
5565
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.