@googleapis/alloydb 11.1.0 → 12.1.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
@@ -146,7 +146,7 @@ export namespace alloydb_v1 {
146
146
  */
147
147
  enabled?: boolean | null;
148
148
  /**
149
- * Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
149
+ * Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will use the cluster's encryption config.
150
150
  */
151
151
  encryptionConfig?: Schema$EncryptionConfig;
152
152
  /**
@@ -186,6 +186,10 @@ export namespace alloydb_v1 {
186
186
  * Output only. The system-generated UID of the cluster which was used to create this resource.
187
187
  */
188
188
  clusterUid?: string | null;
189
+ /**
190
+ * Output only. Timestamp when the resource finished being created.
191
+ */
192
+ createCompletionTime?: string | null;
189
193
  /**
190
194
  * Output only. Create time stamp
191
195
  */
@@ -250,6 +254,10 @@ export namespace alloydb_v1 {
250
254
  * Output only. The current state of the backup.
251
255
  */
252
256
  state?: string | null;
257
+ /**
258
+ * Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: ``` "123/environment": "production", "123/costCenter": "marketing" ```
259
+ */
260
+ tags?: {[key: string]: string} | null;
253
261
  /**
254
262
  * The backup type, which suggests the trigger for the backup.
255
263
  */
@@ -259,7 +267,7 @@ export namespace alloydb_v1 {
259
267
  */
260
268
  uid?: string | null;
261
269
  /**
262
- * Output only. Update time stamp
270
+ * Output only. Update time stamp Users should not infer any meaning from this field. Its value is generally unrelated to the timing of the backup creation operation.
263
271
  */
264
272
  updateTime?: string | null;
265
273
  }
@@ -289,7 +297,7 @@ export namespace alloydb_v1 {
289
297
  */
290
298
  requireConnectors?: boolean | null;
291
299
  /**
292
- * Optional. SSL config option for this instance.
300
+ * Optional. SSL configuration option for this instance.
293
301
  */
294
302
  sslConfig?: Schema$SslConfig;
295
303
  }
@@ -306,6 +314,23 @@ export namespace alloydb_v1 {
306
314
  */
307
315
  exclusiveAction?: string | null;
308
316
  }
317
+ /**
318
+ * The source CloudSQL backup resource.
319
+ */
320
+ export interface Schema$CloudSQLBackupRunSource {
321
+ /**
322
+ * Required. The CloudSQL backup run ID.
323
+ */
324
+ backupRunId?: string | null;
325
+ /**
326
+ * Required. The CloudSQL instance ID.
327
+ */
328
+ instanceId?: string | null;
329
+ /**
330
+ * The project ID of the source CloudSQL instance. This should be the same as the AlloyDB cluster's project.
331
+ */
332
+ project?: string | null;
333
+ }
309
334
  /**
310
335
  * A cluster is a collection of regional AlloyDB resources. It can include a primary instance and one or more read pool instances. All cluster resources share a storage layer, which scales as needed.
311
336
  */
@@ -322,6 +347,10 @@ export namespace alloydb_v1 {
322
347
  * Output only. Cluster created from backup.
323
348
  */
324
349
  backupSource?: Schema$BackupSource;
350
+ /**
351
+ * Output only. Cluster created from CloudSQL snapshot.
352
+ */
353
+ cloudsqlBackupRunSource?: Schema$CloudSQLBackupRunSource;
325
354
  /**
326
355
  * Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster`
327
356
  */
@@ -423,6 +452,10 @@ export namespace alloydb_v1 {
423
452
  * Optional. Subscription type of the cluster.
424
453
  */
425
454
  subscriptionType?: string | null;
455
+ /**
456
+ * Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: ``` "123/environment": "production", "123/costCenter": "marketing" ```
457
+ */
458
+ tags?: {[key: string]: string} | null;
426
459
  /**
427
460
  * Output only. Metadata for free trial clusters
428
461
  */
@@ -495,7 +528,7 @@ export namespace alloydb_v1 {
495
528
  */
496
529
  enabled?: boolean | null;
497
530
  /**
498
- * The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.
531
+ * The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will use the cluster's encryption config.
499
532
  */
500
533
  encryptionConfig?: Schema$EncryptionConfig;
501
534
  /**
@@ -537,6 +570,69 @@ export namespace alloydb_v1 {
537
570
  */
538
571
  pointInTime?: string | null;
539
572
  }
573
+ /**
574
+ * Options for exporting data in CSV format.
575
+ */
576
+ export interface Schema$CsvExportOptions {
577
+ /**
578
+ * 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.
579
+ */
580
+ escapeCharacter?: string | null;
581
+ /**
582
+ * 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.
583
+ */
584
+ fieldDelimiter?: string | null;
585
+ /**
586
+ * 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.
587
+ */
588
+ quoteCharacter?: string | null;
589
+ /**
590
+ * Required. The SELECT query used to extract the data.
591
+ */
592
+ selectQuery?: string | null;
593
+ }
594
+ /**
595
+ * Options for importing data in CSV format.
596
+ */
597
+ export interface Schema$CsvImportOptions {
598
+ /**
599
+ * Optional. The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
600
+ */
601
+ columns?: string[] | null;
602
+ /**
603
+ * Optional. Specifies the character that should appear before a data character that needs to be escaped. The default is same as quote character. The value of this argument has to be a character in Hex ASCII Code.
604
+ */
605
+ escapeCharacter?: string | null;
606
+ /**
607
+ * 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.
608
+ */
609
+ fieldDelimiter?: string | null;
610
+ /**
611
+ * 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.
612
+ */
613
+ quoteCharacter?: string | null;
614
+ /**
615
+ * Required. The database table to import CSV file into.
616
+ */
617
+ table?: string | null;
618
+ }
619
+ /**
620
+ * DenyMaintenancePeriod definition. Excepting emergencies, maintenance will not be scheduled to start within this deny period. The start_date must be less than the end_date.
621
+ */
622
+ export interface Schema$DenyMaintenancePeriod {
623
+ /**
624
+ * Deny period end date. This can be: * A full date, with non-zero year, month and day values OR * A month and day value, with a zero year for recurring
625
+ */
626
+ endDate?: Schema$GoogleTypeDate;
627
+ /**
628
+ * Deny period start date. This can be: * A full date, with non-zero year, month and day values OR * A month and day value, with a zero year for recurring
629
+ */
630
+ startDate?: Schema$GoogleTypeDate;
631
+ /**
632
+ * Time in UTC when the deny period starts on start_date and ends on end_date. This can be: * Full time OR * All zeros for 00:00:00 UTC
633
+ */
634
+ time?: Schema$GoogleTypeTimeOfDay;
635
+ }
540
636
  /**
541
637
  * 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
638
  */
@@ -563,19 +659,58 @@ export namespace alloydb_v1 {
563
659
  */
564
660
  kmsKeyVersions?: string[] | null;
565
661
  }
662
+ /**
663
+ * Export cluster request.
664
+ */
665
+ export interface Schema$ExportClusterRequest {
666
+ /**
667
+ * Options for exporting data in CSV format. Required field to be set for CSV file type.
668
+ */
669
+ csvExportOptions?: Schema$CsvExportOptions;
670
+ /**
671
+ * 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.
672
+ */
673
+ database?: string | null;
674
+ /**
675
+ * Required. Option to export data to cloud storage.
676
+ */
677
+ gcsDestination?: Schema$GcsDestination;
678
+ /**
679
+ * Options for exporting data in SQL format. Required field to be set for SQL file type.
680
+ */
681
+ sqlExportOptions?: Schema$SqlExportOptions;
682
+ }
683
+ /**
684
+ * Response of export cluster rpc.
685
+ */
686
+ export interface Schema$ExportClusterResponse {
687
+ /**
688
+ * Required. Option to export data to cloud storage.
689
+ */
690
+ gcsDestination?: Schema$GcsDestination;
691
+ }
566
692
  /**
567
693
  * Message for triggering failover on an Instance
568
694
  */
569
695
  export interface Schema$FailoverInstanceRequest {
570
696
  /**
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).
697
+ * 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
698
  */
573
699
  requestId?: string | null;
574
700
  /**
575
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the failover.
701
+ * 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
702
  */
577
703
  validateOnly?: boolean | null;
578
704
  }
705
+ /**
706
+ * Destination for Export. Export will be done to cloud storage.
707
+ */
708
+ export interface Schema$GcsDestination {
709
+ /**
710
+ * 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`.
711
+ */
712
+ uri?: string | null;
713
+ }
579
714
  /**
580
715
  * The response message for Locations.ListLocations.
581
716
  */
@@ -614,27 +749,78 @@ export namespace alloydb_v1 {
614
749
  */
615
750
  name?: string | null;
616
751
  }
752
+ /**
753
+ * Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp
754
+ */
755
+ export interface Schema$GoogleTypeDate {
756
+ /**
757
+ * Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
758
+ */
759
+ day?: number | null;
760
+ /**
761
+ * Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
762
+ */
763
+ month?: number | null;
764
+ /**
765
+ * Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
766
+ */
767
+ year?: number | null;
768
+ }
617
769
  /**
618
770
  * Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.
619
771
  */
620
772
  export interface Schema$GoogleTypeTimeOfDay {
621
773
  /**
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.
774
+ * 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
775
  */
624
776
  hours?: number | null;
625
777
  /**
626
- * Minutes of hour of day. Must be from 0 to 59.
778
+ * Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
627
779
  */
628
780
  minutes?: number | null;
629
781
  /**
630
- * Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
782
+ * Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
631
783
  */
632
784
  nanos?: number | null;
633
785
  /**
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.
786
+ * 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
787
  */
636
788
  seconds?: number | null;
637
789
  }
790
+ /**
791
+ * Import cluster request.
792
+ */
793
+ export interface Schema$ImportClusterRequest {
794
+ /**
795
+ * Options for importing data in CSV format.
796
+ */
797
+ csvImportOptions?: Schema$CsvImportOptions;
798
+ /**
799
+ * Optional. Name of the database to which the import will be done. For import from SQL file, this is required only if the file does not specify a database. Note - Value provided should be the same as expected from `SELECT current_database();` and NOT as a resource reference.
800
+ */
801
+ database?: string | null;
802
+ /**
803
+ * Required. The path to the file in Google Cloud Storage where the source file for import will be stored. The URI is in the form `gs://bucketName/fileName`.
804
+ */
805
+ gcsUri?: string | null;
806
+ /**
807
+ * Options for importing data in SQL format.
808
+ */
809
+ sqlImportOptions?: Schema$SqlImportOptions;
810
+ /**
811
+ * Optional. Database user to be used for importing the data. Note - Value provided should be the same as expected from `SELECT current_user;` and NOT as a resource reference.
812
+ */
813
+ user?: string | null;
814
+ }
815
+ /**
816
+ * Response of import rpc.
817
+ */
818
+ export interface Schema$ImportClusterResponse {
819
+ /**
820
+ * Required. Size of the object downloaded from Google Cloud Storage in bytes.
821
+ */
822
+ bytesDownloaded?: string | null;
823
+ }
638
824
  /**
639
825
  * Message for triggering fault injection on an instance
640
826
  */
@@ -644,11 +830,11 @@ export namespace alloydb_v1 {
644
830
  */
645
831
  faultType?: string | null;
646
832
  /**
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).
833
+ * 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
834
  */
649
835
  requestId?: string | null;
650
836
  /**
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.
837
+ * 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
838
  */
653
839
  validateOnly?: boolean | null;
654
840
  }
@@ -673,7 +859,7 @@ export namespace alloydb_v1 {
673
859
  */
674
860
  createTime?: string | null;
675
861
  /**
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.
862
+ * 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
863
  */
678
864
  databaseFlags?: {[key: string]: string} | null;
679
865
  /**
@@ -713,13 +899,21 @@ export namespace alloydb_v1 {
713
899
  */
714
900
  name?: string | null;
715
901
  /**
716
- * Optional. Instance level network configuration.
902
+ * Optional. Instance-level network configuration.
717
903
  */
718
904
  networkConfig?: Schema$InstanceNetworkConfig;
719
905
  /**
720
906
  * Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
721
907
  */
722
908
  nodes?: Schema$Node[];
909
+ /**
910
+ * Configuration for observability.
911
+ */
912
+ observabilityConfig?: Schema$ObservabilityInstanceConfig;
913
+ /**
914
+ * Output only. All outbound public IP addresses configured for the instance.
915
+ */
916
+ outboundPublicIpAddresses?: string[] | null;
723
917
  /**
724
918
  * Optional. The configuration for Private Service Connect (PSC) for the instance.
725
919
  */
@@ -762,17 +956,25 @@ export namespace alloydb_v1 {
762
956
  writableNode?: Schema$Node;
763
957
  }
764
958
  /**
765
- * Metadata related to instance level network configuration.
959
+ * Metadata related to instance-level network configuration.
766
960
  */
767
961
  export interface Schema$InstanceNetworkConfig {
768
962
  /**
769
963
  * Optional. A list of external network authorized to access this instance.
770
964
  */
771
965
  authorizedExternalNetworks?: Schema$AuthorizedNetwork[];
966
+ /**
967
+ * Optional. Enabling an outbound public IP address to support a database server sending requests out into the internet.
968
+ */
969
+ enableOutboundPublicIp?: boolean | null;
772
970
  /**
773
971
  * Optional. Enabling public ip for the instance.
774
972
  */
775
973
  enablePublicIp?: boolean | null;
974
+ /**
975
+ * Output only. The resource link for the VPC network in which instance resources are created and from which they are accessible via Private IP. This will be the same value as the parent cluster's network. It is specified in the form: // `projects/{project_number\}/global/networks/{network_id\}`.
976
+ */
977
+ network?: string | null;
776
978
  }
777
979
  /**
778
980
  * Details regarding the upgrade of instaces associated with a cluster.
@@ -906,6 +1108,10 @@ export namespace alloydb_v1 {
906
1108
  * The number of CPU's in the VM instance.
907
1109
  */
908
1110
  cpuCount?: number | null;
1111
+ /**
1112
+ * Machine type of the VM instance. E.g. "n2-highmem-4", "n2-highmem-8", "c4a-highmem-4-lssd". cpu_count must match the number of vCPUs in the machine type.
1113
+ */
1114
+ machineType?: string | null;
909
1115
  }
910
1116
  /**
911
1117
  * MaintenanceSchedule stores the maintenance schedule generated from the MaintenanceUpdatePolicy, once a maintenance rollout is triggered, if MaintenanceWindow is set, and if there is no conflicting DenyPeriod. The schedule is cleared once the update takes place. This field cannot be manually changed; modify the MaintenanceUpdatePolicy instead.
@@ -920,6 +1126,10 @@ export namespace alloydb_v1 {
920
1126
  * MaintenanceUpdatePolicy defines the policy for system updates.
921
1127
  */
922
1128
  export interface Schema$MaintenanceUpdatePolicy {
1129
+ /**
1130
+ * Periods to deny maintenance. Currently limited to 1.
1131
+ */
1132
+ denyMaintenancePeriods?: Schema$DenyMaintenancePeriod[];
923
1133
  /**
924
1134
  * Preferred windows to perform maintenance. Currently limited to 1.
925
1135
  */
@@ -969,26 +1179,63 @@ export namespace alloydb_v1 {
969
1179
  network?: string | null;
970
1180
  }
971
1181
  /**
972
- * Details of a single node in the instance. Nodes in an AlloyDB instance are ephemereal, they can change during update, failover, autohealing and resize operations.
1182
+ * Details of a single node in the instance. Nodes in an AlloyDB instance are ephemeral, they can change during update, failover, autohealing and resize operations.
973
1183
  */
974
1184
  export interface Schema$Node {
975
1185
  /**
976
- * The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
1186
+ * Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
977
1187
  */
978
1188
  id?: string | null;
979
1189
  /**
980
- * The private IP address of the VM e.g. "10.57.0.34".
1190
+ * Output only. The private IP address of the VM e.g. "10.57.0.34".
981
1191
  */
982
1192
  ip?: string | null;
983
1193
  /**
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.
1194
+ * 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
1195
  */
986
1196
  state?: string | null;
987
1197
  /**
988
- * The Compute Engine zone of the VM e.g. "us-central1-b".
1198
+ * Output only. The Compute Engine zone of the VM e.g. "us-central1-b".
989
1199
  */
990
1200
  zoneId?: string | null;
991
1201
  }
1202
+ /**
1203
+ * Observability Instance specific configuration.
1204
+ */
1205
+ export interface Schema$ObservabilityInstanceConfig {
1206
+ /**
1207
+ * Observability feature status for an instance. This flag is turned "off" by default.
1208
+ */
1209
+ enabled?: boolean | null;
1210
+ /**
1211
+ * Query string length. The default value is 10k.
1212
+ */
1213
+ maxQueryStringLength?: number | null;
1214
+ /**
1215
+ * Preserve comments in query string for an instance. This flag is turned "off" by default.
1216
+ */
1217
+ preserveComments?: boolean | null;
1218
+ /**
1219
+ * Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid.
1220
+ */
1221
+ queryPlansPerMinute?: number | null;
1222
+ /**
1223
+ * Record application tags for an instance. This flag is turned "off" by default.
1224
+ */
1225
+ recordApplicationTags?: boolean | null;
1226
+ /**
1227
+ * Track actively running queries on the instance. If not set, this flag is "off" by default.
1228
+ */
1229
+ trackActiveQueries?: boolean | null;
1230
+ /**
1231
+ * Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on.
1232
+ */
1233
+ trackWaitEvents?: boolean | null;
1234
+ /**
1235
+ * Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API.
1236
+ */
1237
+ trackWaitEventTypes?: boolean | null;
1238
+ }
992
1239
  /**
993
1240
  * This resource represents a long-running operation that is the result of a network API call.
994
1241
  */
@@ -1031,7 +1278,7 @@ export namespace alloydb_v1 {
1031
1278
  */
1032
1279
  endTime?: string | null;
1033
1280
  /**
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`.
1281
+ * 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
1282
  */
1036
1283
  requestedCancellation?: boolean | null;
1037
1284
  /**
@@ -1042,6 +1289,10 @@ export namespace alloydb_v1 {
1042
1289
  * Output only. Server-defined resource path for the target of the operation.
1043
1290
  */
1044
1291
  target?: string | null;
1292
+ /**
1293
+ * Output only. UpgradeClusterStatus related metadata.
1294
+ */
1295
+ upgradeClusterStatus?: Schema$UpgradeClusterStatus;
1045
1296
  /**
1046
1297
  * Output only. Name of the verb executed by the operation.
1047
1298
  */
@@ -1065,14 +1316,39 @@ export namespace alloydb_v1 {
1065
1316
  */
1066
1317
  etag?: string | null;
1067
1318
  /**
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).
1319
+ * 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
1320
  */
1070
1321
  requestId?: string | null;
1071
1322
  /**
1072
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.
1323
+ * 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
1324
  */
1074
1325
  validateOnly?: boolean | null;
1075
1326
  }
1327
+ /**
1328
+ * Configuration for setting up PSC service automation. Consumer projects in the configs will be allowlisted automatically for the instance.
1329
+ */
1330
+ export interface Schema$PscAutoConnectionConfig {
1331
+ /**
1332
+ * The consumer network for the PSC service automation, example: "projects/vpc-host-project/global/networks/default". The consumer network might be hosted a different project than the consumer project.
1333
+ */
1334
+ consumerNetwork?: string | null;
1335
+ /**
1336
+ * Output only. The status of the service connection policy. Possible values: "STATE_UNSPECIFIED" - Default state, when Connection Map is created initially. "VALID" - Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit. "CONNECTION_POLICY_MISSING" - No Service Connection Policy found for this network and Service Class "POLICY_LIMIT_REACHED" - Service Connection Policy limit reached for this network and Service Class "CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED" - The consumer instance project is not in AllowedGoogleProducersResourceHierarchyLevels of the matching ServiceConnectionPolicy.
1337
+ */
1338
+ consumerNetworkStatus?: string | null;
1339
+ /**
1340
+ * The consumer project to which the PSC service automation endpoint will be created.
1341
+ */
1342
+ consumerProject?: string | null;
1343
+ /**
1344
+ * Output only. The IP address of the PSC service automation endpoint.
1345
+ */
1346
+ ipAddress?: string | null;
1347
+ /**
1348
+ * Output only. The status of the PSC service automation connection. Possible values: "STATE_UNSPECIFIED" - An invalid state as the default case. "ACTIVE" - The connection has been created successfully. "FAILED" - The connection is not functional since some resources on the connection fail to be created. "CREATING" - The connection is being created. "DELETING" - The connection is being deleted. "CREATE_REPAIRING" - The connection is being repaired to complete creation. "DELETE_REPAIRING" - The connection is being repaired to complete deletion.
1349
+ */
1350
+ status?: string | null;
1351
+ }
1076
1352
  /**
1077
1353
  * PscConfig contains PSC related configuration at a cluster level.
1078
1354
  */
@@ -1081,6 +1357,10 @@ export namespace alloydb_v1 {
1081
1357
  * Optional. Create an instance that allows connections from Private Service Connect endpoints to the instance.
1082
1358
  */
1083
1359
  pscEnabled?: boolean | null;
1360
+ /**
1361
+ * Output only. The project number that needs to be allowlisted on the network attachment to enable outbound connectivity.
1362
+ */
1363
+ serviceOwnedProjectNumber?: string | null;
1084
1364
  }
1085
1365
  /**
1086
1366
  * PscInstanceConfig contains PSC related configuration at an instance level.
@@ -1090,15 +1370,32 @@ export namespace alloydb_v1 {
1090
1370
  * Optional. List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance.
1091
1371
  */
1092
1372
  allowedConsumerProjects?: string[] | null;
1373
+ /**
1374
+ * Optional. Configurations for setting up PSC service automation.
1375
+ */
1376
+ pscAutoConnections?: Schema$PscAutoConnectionConfig[];
1093
1377
  /**
1094
1378
  * Output only. The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog
1095
1379
  */
1096
1380
  pscDnsName?: string | null;
1381
+ /**
1382
+ * Optional. Configurations for setting up PSC interfaces attached to the instance which are used for outbound connectivity. Only primary instances can have PSC interface attached. Currently we only support 0 or 1 PSC interface.
1383
+ */
1384
+ pscInterfaceConfigs?: Schema$PscInterfaceConfig[];
1097
1385
  /**
1098
1386
  * Output only. The service attachment created when Private Service Connect (PSC) is enabled for the instance. The name of the resource will be in the format of `projects//regions//serviceAttachments/`
1099
1387
  */
1100
1388
  serviceAttachmentLink?: string | null;
1101
1389
  }
1390
+ /**
1391
+ * Configuration for setting up a PSC interface to enable outbound connectivity.
1392
+ */
1393
+ export interface Schema$PscInterfaceConfig {
1394
+ /**
1395
+ * The network attachment resource created in the consumer network to which the PSC interface will be linked. This is of the format: "projects/${CONSUMER_PROJECT\}/regions/${REGION\}/networkAttachments/${NETWORK_ATTACHMENT_NAME\}". The network attachment must be in the same region as the instance.
1396
+ */
1397
+ networkAttachmentResource?: string | null;
1398
+ }
1102
1399
  /**
1103
1400
  * A backup's position in a quantity-based retention queue, of backups with the same source cluster and type, with length, retention, specified by the backup's retention policy. Once the position is greater than the retention, the backup is eligible to be garbage collected. Example: 5 backups from the same source cluster and type with a quantity-based retention of 3 and denoted by backup_id (position, retention). Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3). Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)
1104
1401
  */
@@ -1151,22 +1448,31 @@ export namespace alloydb_v1 {
1151
1448
  */
1152
1449
  nodeCount?: number | null;
1153
1450
  }
1451
+ /**
1452
+ * Read pool instances upgrade specific status.
1453
+ */
1454
+ export interface Schema$ReadPoolInstancesUpgradeStageStatus {
1455
+ /**
1456
+ * Read pool instances upgrade statistics.
1457
+ */
1458
+ upgradeStats?: Schema$Stats;
1459
+ }
1154
1460
  export interface Schema$RestartInstanceRequest {
1155
1461
  /**
1156
- * Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Only applicable for read instances.
1462
+ * Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Applicable only to read instances.
1157
1463
  */
1158
1464
  nodeIds?: string[] | null;
1159
1465
  /**
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).
1466
+ * 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
1467
  */
1162
1468
  requestId?: string | null;
1163
1469
  /**
1164
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the restart.
1470
+ * 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
1471
  */
1166
1472
  validateOnly?: boolean | null;
1167
1473
  }
1168
1474
  /**
1169
- * Message for restoring a Cluster from a backup or another cluster at a given point in time.
1475
+ * Message for restoring a Cluster from a backup or another cluster at a given point in time. NEXT_ID: 11
1170
1476
  */
1171
1477
  export interface Schema$RestoreClusterRequest {
1172
1478
  /**
@@ -1186,14 +1492,31 @@ export namespace alloydb_v1 {
1186
1492
  */
1187
1493
  continuousBackupSource?: Schema$ContinuousBackupSource;
1188
1494
  /**
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).
1495
+ * 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
1496
  */
1191
1497
  requestId?: string | null;
1192
1498
  /**
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.
1499
+ * 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
1500
  */
1195
1501
  validateOnly?: boolean | null;
1196
1502
  }
1503
+ /**
1504
+ * Message for registering Restoring from CloudSQL resource.
1505
+ */
1506
+ export interface Schema$RestoreFromCloudSQLRequest {
1507
+ /**
1508
+ * Cluster created from CloudSQL backup run.
1509
+ */
1510
+ cloudsqlBackupRunSource?: Schema$CloudSQLBackupRunSource;
1511
+ /**
1512
+ * Required. The resource being created
1513
+ */
1514
+ cluster?: Schema$Cluster;
1515
+ /**
1516
+ * Required. ID of the requesting object.
1517
+ */
1518
+ clusterId?: string | null;
1519
+ }
1197
1520
  /**
1198
1521
  * Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY.
1199
1522
  */
@@ -1203,6 +1526,31 @@ export namespace alloydb_v1 {
1203
1526
  */
1204
1527
  primaryClusterName?: string | null;
1205
1528
  }
1529
+ /**
1530
+ * Options for exporting data in SQL format.
1531
+ */
1532
+ export interface Schema$SqlExportOptions {
1533
+ /**
1534
+ * Optional. If true, output commands to DROP all the dumped database objects prior to outputting the commands for creating them.
1535
+ */
1536
+ cleanTargetObjects?: boolean | null;
1537
+ /**
1538
+ * Optional. If true, use DROP ... IF EXISTS commands to check for the object's existence before dropping it in clean_target_objects mode.
1539
+ */
1540
+ ifExistTargetObjects?: boolean | null;
1541
+ /**
1542
+ * Optional. If true, only export the schema.
1543
+ */
1544
+ schemaOnly?: boolean | null;
1545
+ /**
1546
+ * Optional. Tables to export from.
1547
+ */
1548
+ tables?: string[] | null;
1549
+ }
1550
+ /**
1551
+ * Options for importing data in SQL format.
1552
+ */
1553
+ export interface Schema$SqlImportOptions {}
1206
1554
  /**
1207
1555
  * SSL configuration.
1208
1556
  */
@@ -1233,6 +1581,44 @@ export namespace alloydb_v1 {
1233
1581
  */
1234
1582
  status?: string | null;
1235
1583
  }
1584
+ /**
1585
+ * Status of an upgrade stage.
1586
+ */
1587
+ export interface Schema$StageStatus {
1588
+ /**
1589
+ * Read pool instances upgrade metadata.
1590
+ */
1591
+ readPoolInstancesUpgrade?: Schema$ReadPoolInstancesUpgradeStageStatus;
1592
+ /**
1593
+ * Upgrade stage.
1594
+ */
1595
+ stage?: string | null;
1596
+ /**
1597
+ * State of this stage.
1598
+ */
1599
+ state?: string | null;
1600
+ }
1601
+ /**
1602
+ * Upgrade stats for read pool instances.
1603
+ */
1604
+ export interface Schema$Stats {
1605
+ /**
1606
+ * Number of read pool instances which failed to upgrade.
1607
+ */
1608
+ failed?: number | null;
1609
+ /**
1610
+ * Number of read pool instances for which upgrade has not started.
1611
+ */
1612
+ notStarted?: number | null;
1613
+ /**
1614
+ * Number of read pool instances undergoing upgrade.
1615
+ */
1616
+ ongoing?: number | null;
1617
+ /**
1618
+ * Number of read pool instances successfully upgraded.
1619
+ */
1620
+ success?: number | null;
1621
+ }
1236
1622
  /**
1237
1623
  * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
1238
1624
  */
@@ -1430,7 +1816,7 @@ export namespace alloydb_v1 {
1430
1816
  uniqueId?: string | null;
1431
1817
  }
1432
1818
  /**
1433
- * Common model for database resource instance metadata.
1819
+ * Common model for database resource instance metadata. Next ID: 25
1434
1820
  */
1435
1821
  export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata {
1436
1822
  /**
@@ -1457,6 +1843,10 @@ export namespace alloydb_v1 {
1457
1843
  * Any custom metadata associated with the resource
1458
1844
  */
1459
1845
  customMetadata?: Schema$StorageDatabasecenterPartnerapiV1mainCustomMetadataData;
1846
+ /**
1847
+ * 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.
1848
+ */
1849
+ edition?: string | null;
1460
1850
  /**
1461
1851
  * Entitlements associated with the resource
1462
1852
  */
@@ -1465,6 +1855,10 @@ export namespace alloydb_v1 {
1465
1855
  * The state that the instance is expected to be in. For example, an instance state can transition to UNHEALTHY due to wrong patch update, while the expected state will remain at the HEALTHY.
1466
1856
  */
1467
1857
  expectedState?: string | null;
1858
+ /**
1859
+ * GCBDR configuration for the resource.
1860
+ */
1861
+ gcbdrConfiguration?: Schema$StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration;
1468
1862
  /**
1469
1863
  * Required. Unique identifier for a Database resource
1470
1864
  */
@@ -1485,6 +1879,10 @@ export namespace alloydb_v1 {
1485
1879
  * 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
1880
  */
1487
1881
  primaryResourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId;
1882
+ /**
1883
+ * Primary resource location. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional.
1884
+ */
1885
+ primaryResourceLocation?: string | null;
1488
1886
  /**
1489
1887
  * The product this resource represents.
1490
1888
  */
@@ -1497,6 +1895,14 @@ export namespace alloydb_v1 {
1497
1895
  * 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
1896
  */
1499
1897
  resourceName?: string | null;
1898
+ /**
1899
+ * Optional. Suspension reason for the resource.
1900
+ */
1901
+ suspensionReason?: string | null;
1902
+ /**
1903
+ * Optional. Tags associated with this resources.
1904
+ */
1905
+ tagsSet?: Schema$StorageDatabasecenterPartnerapiV1mainTags;
1500
1906
  /**
1501
1907
  * The time at which the resource was updated and recorded at partner service.
1502
1908
  */
@@ -1556,6 +1962,15 @@ export namespace alloydb_v1 {
1556
1962
  */
1557
1963
  type?: string | null;
1558
1964
  }
1965
+ /**
1966
+ * GCBDR Configuration for the resource.
1967
+ */
1968
+ export interface Schema$StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration {
1969
+ /**
1970
+ * Whether the resource is managed by GCBDR.
1971
+ */
1972
+ gcbdrManaged?: boolean | null;
1973
+ }
1559
1974
  /**
1560
1975
  * Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration settings. Similarly bigtable can have multiple clusters within same bigtable instance.
1561
1976
  */
@@ -1568,6 +1983,10 @@ export namespace alloydb_v1 {
1568
1983
  * Information about the last backup attempt for this database
1569
1984
  */
1570
1985
  backupRun?: Schema$StorageDatabasecenterPartnerapiV1mainBackupRun;
1986
+ /**
1987
+ * Whether deletion protection is enabled for this internal resource.
1988
+ */
1989
+ isDeletionProtectionEnabled?: boolean | null;
1571
1990
  product?: Schema$StorageDatabasecenterProtoCommonProduct;
1572
1991
  resourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId;
1573
1992
  /**
@@ -1580,13 +1999,21 @@ export namespace alloydb_v1 {
1580
1999
  */
1581
2000
  export interface Schema$StorageDatabasecenterPartnerapiV1mainMachineConfiguration {
1582
2001
  /**
1583
- * The number of CPUs. TODO(b/342344482, b/342346271) add proto validations again after bug fix.
2002
+ * The number of CPUs. Deprecated. Use vcpu_count instead. TODO(b/342344482) add proto validations again after bug fix.
1584
2003
  */
1585
2004
  cpuCount?: number | null;
1586
2005
  /**
1587
- * Memory size in bytes. TODO(b/342344482, b/342346271) add proto validations again after bug fix.
2006
+ * Memory size in bytes. TODO(b/342344482) add proto validations again after bug fix.
1588
2007
  */
1589
2008
  memorySizeInBytes?: string | null;
2009
+ /**
2010
+ * Optional. Number of shards (if applicable).
2011
+ */
2012
+ shardCount?: number | null;
2013
+ /**
2014
+ * Optional. The number of vCPUs. TODO(b/342344482) add proto validations again after bug fix.
2015
+ */
2016
+ vcpuCount?: number | null;
1590
2017
  }
1591
2018
  export interface Schema$StorageDatabasecenterPartnerapiV1mainObservabilityMetricData {
1592
2019
  /**
@@ -1625,12 +2052,29 @@ export namespace alloydb_v1 {
1625
2052
  message?: string | null;
1626
2053
  }
1627
2054
  export interface Schema$StorageDatabasecenterPartnerapiV1mainRetentionSettings {
2055
+ /**
2056
+ * Duration based retention period i.e. 172800 seconds (2 days)
2057
+ */
2058
+ durationBasedRetention?: string | null;
1628
2059
  quantityBasedRetention?: number | null;
1629
2060
  /**
1630
2061
  * The unit that 'retained_backups' represents.
1631
2062
  */
1632
2063
  retentionUnit?: string | null;
1633
2064
  timeBasedRetention?: string | null;
2065
+ /**
2066
+ * Timestamp based retention period i.e. 2024-05-01T00:00:00Z
2067
+ */
2068
+ timestampBasedRetentionTime?: string | null;
2069
+ }
2070
+ /**
2071
+ * 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.
2072
+ */
2073
+ export interface Schema$StorageDatabasecenterPartnerapiV1mainTags {
2074
+ /**
2075
+ * The Tag key/value mappings.
2076
+ */
2077
+ tags?: {[key: string]: string} | null;
1634
2078
  }
1635
2079
  /**
1636
2080
  * 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.
@@ -1705,10 +2149,22 @@ export namespace alloydb_v1 {
1705
2149
  * The name of the flag resource, following Google Cloud conventions, e.g.: * projects/{project\}/locations/{location\}/flags/{flag\} This field currently has no semantic meaning.
1706
2150
  */
1707
2151
  name?: string | null;
2152
+ /**
2153
+ * The recommended value for an INTEGER flag.
2154
+ */
2155
+ recommendedIntegerValue?: string | null;
2156
+ /**
2157
+ * The recommended value for a STRING flag.
2158
+ */
2159
+ recommendedStringValue?: string | null;
1708
2160
  /**
1709
2161
  * Whether setting or updating this flag on an Instance requires a database restart. If a flag that requires database restart is set, the backend will automatically restart the database (making sure to satisfy any availability SLO's).
1710
2162
  */
1711
2163
  requiresDbRestart?: boolean | null;
2164
+ /**
2165
+ * The scope of the flag.
2166
+ */
2167
+ scope?: string | null;
1712
2168
  /**
1713
2169
  * Restriction on STRING type value.
1714
2170
  */
@@ -1724,11 +2180,11 @@ export namespace alloydb_v1 {
1724
2180
  */
1725
2181
  export interface Schema$SwitchoverClusterRequest {
1726
2182
  /**
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).
2183
+ * 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
2184
  */
1729
2185
  requestId?: string | null;
1730
2186
  /**
1731
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.
2187
+ * 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
2188
  */
1733
2189
  validateOnly?: boolean | null;
1734
2190
  }
@@ -1762,6 +2218,27 @@ export namespace alloydb_v1 {
1762
2218
  */
1763
2219
  upgradeTime?: string | null;
1764
2220
  }
2221
+ /**
2222
+ * Upgrades a cluster.
2223
+ */
2224
+ export interface Schema$UpgradeClusterRequest {
2225
+ /**
2226
+ * 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.
2227
+ */
2228
+ etag?: string | null;
2229
+ /**
2230
+ * 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).
2231
+ */
2232
+ requestId?: string | null;
2233
+ /**
2234
+ * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
2235
+ */
2236
+ validateOnly?: boolean | null;
2237
+ /**
2238
+ * Required. The version the cluster is going to be upgraded to.
2239
+ */
2240
+ version?: string | null;
2241
+ }
1765
2242
  /**
1766
2243
  * UpgradeClusterResponse contains the response for upgrade cluster operation.
1767
2244
  */
@@ -1779,6 +2256,31 @@ export namespace alloydb_v1 {
1779
2256
  */
1780
2257
  status?: string | null;
1781
2258
  }
2259
+ /**
2260
+ * Message for current status of the Major Version Upgrade operation.
2261
+ */
2262
+ export interface Schema$UpgradeClusterStatus {
2263
+ /**
2264
+ * Whether the operation is cancellable.
2265
+ */
2266
+ cancellable?: boolean | null;
2267
+ /**
2268
+ * Source database major version.
2269
+ */
2270
+ sourceVersion?: string | null;
2271
+ /**
2272
+ * Status of all upgrade stages.
2273
+ */
2274
+ stages?: Schema$StageStatus[];
2275
+ /**
2276
+ * Cluster Major Version Upgrade state.
2277
+ */
2278
+ state?: string | null;
2279
+ /**
2280
+ * Target database major version.
2281
+ */
2282
+ targetVersion?: string | null;
2283
+ }
1782
2284
  /**
1783
2285
  * Message describing User object.
1784
2286
  */
@@ -2056,6 +2558,10 @@ export namespace alloydb_v1 {
2056
2558
  }
2057
2559
  export interface Params$Resource$Projects$Locations$List
2058
2560
  extends StandardParameters {
2561
+ /**
2562
+ * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.
2563
+ */
2564
+ extraLocationTypes?: string[];
2059
2565
  /**
2060
2566
  * A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
2061
2567
  */
@@ -2526,7 +3032,7 @@ export namespace alloydb_v1 {
2526
3032
  */
2527
3033
  parent?: string;
2528
3034
  /**
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).
3035
+ * 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
3036
  */
2531
3037
  requestId?: string;
2532
3038
  /**
@@ -2550,7 +3056,7 @@ export namespace alloydb_v1 {
2550
3056
  */
2551
3057
  name?: string;
2552
3058
  /**
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).
3059
+ * 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
3060
  */
2555
3061
  requestId?: string;
2556
3062
  /**
@@ -2599,7 +3105,7 @@ export namespace alloydb_v1 {
2599
3105
  */
2600
3106
  name?: string;
2601
3107
  /**
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).
3108
+ * 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
3109
  */
2604
3110
  requestId?: string;
2605
3111
  /**
@@ -2832,14 +3338,99 @@ export namespace alloydb_v1 {
2832
3338
  options: MethodOptions | BodyResponseCallback<Schema$Operation>,
2833
3339
  callback: BodyResponseCallback<Schema$Operation>
2834
3340
  ): void;
2835
- delete(
2836
- params: Params$Resource$Projects$Locations$Clusters$Delete,
3341
+ delete(
3342
+ params: Params$Resource$Projects$Locations$Clusters$Delete,
3343
+ callback: BodyResponseCallback<Schema$Operation>
3344
+ ): void;
3345
+ delete(callback: BodyResponseCallback<Schema$Operation>): void;
3346
+ delete(
3347
+ paramsOrCallback?:
3348
+ | Params$Resource$Projects$Locations$Clusters$Delete
3349
+ | BodyResponseCallback<Schema$Operation>
3350
+ | BodyResponseCallback<Readable>,
3351
+ optionsOrCallback?:
3352
+ | MethodOptions
3353
+ | StreamMethodOptions
3354
+ | BodyResponseCallback<Schema$Operation>
3355
+ | BodyResponseCallback<Readable>,
3356
+ callback?:
3357
+ | BodyResponseCallback<Schema$Operation>
3358
+ | BodyResponseCallback<Readable>
3359
+ ): void | GaxiosPromise<Schema$Operation> | GaxiosPromise<Readable> {
3360
+ let params = (paramsOrCallback ||
3361
+ {}) as Params$Resource$Projects$Locations$Clusters$Delete;
3362
+ let options = (optionsOrCallback || {}) as MethodOptions;
3363
+
3364
+ if (typeof paramsOrCallback === 'function') {
3365
+ callback = paramsOrCallback;
3366
+ params = {} as Params$Resource$Projects$Locations$Clusters$Delete;
3367
+ options = {};
3368
+ }
3369
+
3370
+ if (typeof optionsOrCallback === 'function') {
3371
+ callback = optionsOrCallback;
3372
+ options = {};
3373
+ }
3374
+
3375
+ const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/';
3376
+ const parameters = {
3377
+ options: Object.assign(
3378
+ {
3379
+ url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
3380
+ method: 'DELETE',
3381
+ apiVersion: '',
3382
+ },
3383
+ options
3384
+ ),
3385
+ params,
3386
+ requiredParams: ['name'],
3387
+ pathParams: ['name'],
3388
+ context: this.context,
3389
+ };
3390
+ if (callback) {
3391
+ createAPIRequest<Schema$Operation>(
3392
+ parameters,
3393
+ callback as BodyResponseCallback<unknown>
3394
+ );
3395
+ } else {
3396
+ return createAPIRequest<Schema$Operation>(parameters);
3397
+ }
3398
+ }
3399
+
3400
+ /**
3401
+ * Exports data from the cluster. Imperative only.
3402
+ *
3403
+ * @param params - Parameters for request
3404
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
3405
+ * @param callback - Optional callback that handles the response.
3406
+ * @returns A promise if used with async/await, or void if used with a callback.
3407
+ */
3408
+ export(
3409
+ params: Params$Resource$Projects$Locations$Clusters$Export,
3410
+ options: StreamMethodOptions
3411
+ ): GaxiosPromise<Readable>;
3412
+ export(
3413
+ params?: Params$Resource$Projects$Locations$Clusters$Export,
3414
+ options?: MethodOptions
3415
+ ): GaxiosPromise<Schema$Operation>;
3416
+ export(
3417
+ params: Params$Resource$Projects$Locations$Clusters$Export,
3418
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
3419
+ callback: BodyResponseCallback<Readable>
3420
+ ): void;
3421
+ export(
3422
+ params: Params$Resource$Projects$Locations$Clusters$Export,
3423
+ options: MethodOptions | BodyResponseCallback<Schema$Operation>,
3424
+ callback: BodyResponseCallback<Schema$Operation>
3425
+ ): void;
3426
+ export(
3427
+ params: Params$Resource$Projects$Locations$Clusters$Export,
2837
3428
  callback: BodyResponseCallback<Schema$Operation>
2838
3429
  ): void;
2839
- delete(callback: BodyResponseCallback<Schema$Operation>): void;
2840
- delete(
3430
+ export(callback: BodyResponseCallback<Schema$Operation>): void;
3431
+ export(
2841
3432
  paramsOrCallback?:
2842
- | Params$Resource$Projects$Locations$Clusters$Delete
3433
+ | Params$Resource$Projects$Locations$Clusters$Export
2843
3434
  | BodyResponseCallback<Schema$Operation>
2844
3435
  | BodyResponseCallback<Readable>,
2845
3436
  optionsOrCallback?:
@@ -2852,12 +3443,12 @@ export namespace alloydb_v1 {
2852
3443
  | BodyResponseCallback<Readable>
2853
3444
  ): void | GaxiosPromise<Schema$Operation> | GaxiosPromise<Readable> {
2854
3445
  let params = (paramsOrCallback ||
2855
- {}) as Params$Resource$Projects$Locations$Clusters$Delete;
3446
+ {}) as Params$Resource$Projects$Locations$Clusters$Export;
2856
3447
  let options = (optionsOrCallback || {}) as MethodOptions;
2857
3448
 
2858
3449
  if (typeof paramsOrCallback === 'function') {
2859
3450
  callback = paramsOrCallback;
2860
- params = {} as Params$Resource$Projects$Locations$Clusters$Delete;
3451
+ params = {} as Params$Resource$Projects$Locations$Clusters$Export;
2861
3452
  options = {};
2862
3453
  }
2863
3454
 
@@ -2870,8 +3461,8 @@ export namespace alloydb_v1 {
2870
3461
  const parameters = {
2871
3462
  options: Object.assign(
2872
3463
  {
2873
- url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
2874
- method: 'DELETE',
3464
+ url: (rootUrl + '/v1/{+name}:export').replace(/([^:]\/)\/+/g, '$1'),
3465
+ method: 'POST',
2875
3466
  apiVersion: '',
2876
3467
  },
2877
3468
  options
@@ -2976,6 +3567,91 @@ export namespace alloydb_v1 {
2976
3567
  }
2977
3568
  }
2978
3569
 
3570
+ /**
3571
+ * Imports data to the cluster. Imperative only.
3572
+ *
3573
+ * @param params - Parameters for request
3574
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
3575
+ * @param callback - Optional callback that handles the response.
3576
+ * @returns A promise if used with async/await, or void if used with a callback.
3577
+ */
3578
+ import(
3579
+ params: Params$Resource$Projects$Locations$Clusters$Import,
3580
+ options: StreamMethodOptions
3581
+ ): GaxiosPromise<Readable>;
3582
+ import(
3583
+ params?: Params$Resource$Projects$Locations$Clusters$Import,
3584
+ options?: MethodOptions
3585
+ ): GaxiosPromise<Schema$Operation>;
3586
+ import(
3587
+ params: Params$Resource$Projects$Locations$Clusters$Import,
3588
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
3589
+ callback: BodyResponseCallback<Readable>
3590
+ ): void;
3591
+ import(
3592
+ params: Params$Resource$Projects$Locations$Clusters$Import,
3593
+ options: MethodOptions | BodyResponseCallback<Schema$Operation>,
3594
+ callback: BodyResponseCallback<Schema$Operation>
3595
+ ): void;
3596
+ import(
3597
+ params: Params$Resource$Projects$Locations$Clusters$Import,
3598
+ callback: BodyResponseCallback<Schema$Operation>
3599
+ ): void;
3600
+ import(callback: BodyResponseCallback<Schema$Operation>): void;
3601
+ import(
3602
+ paramsOrCallback?:
3603
+ | Params$Resource$Projects$Locations$Clusters$Import
3604
+ | BodyResponseCallback<Schema$Operation>
3605
+ | BodyResponseCallback<Readable>,
3606
+ optionsOrCallback?:
3607
+ | MethodOptions
3608
+ | StreamMethodOptions
3609
+ | BodyResponseCallback<Schema$Operation>
3610
+ | BodyResponseCallback<Readable>,
3611
+ callback?:
3612
+ | BodyResponseCallback<Schema$Operation>
3613
+ | BodyResponseCallback<Readable>
3614
+ ): void | GaxiosPromise<Schema$Operation> | GaxiosPromise<Readable> {
3615
+ let params = (paramsOrCallback ||
3616
+ {}) as Params$Resource$Projects$Locations$Clusters$Import;
3617
+ let options = (optionsOrCallback || {}) as MethodOptions;
3618
+
3619
+ if (typeof paramsOrCallback === 'function') {
3620
+ callback = paramsOrCallback;
3621
+ params = {} as Params$Resource$Projects$Locations$Clusters$Import;
3622
+ options = {};
3623
+ }
3624
+
3625
+ if (typeof optionsOrCallback === 'function') {
3626
+ callback = optionsOrCallback;
3627
+ options = {};
3628
+ }
3629
+
3630
+ const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/';
3631
+ const parameters = {
3632
+ options: Object.assign(
3633
+ {
3634
+ url: (rootUrl + '/v1/{+name}:import').replace(/([^:]\/)\/+/g, '$1'),
3635
+ method: 'POST',
3636
+ apiVersion: '',
3637
+ },
3638
+ options
3639
+ ),
3640
+ params,
3641
+ requiredParams: ['name'],
3642
+ pathParams: ['name'],
3643
+ context: this.context,
3644
+ };
3645
+ if (callback) {
3646
+ createAPIRequest<Schema$Operation>(
3647
+ parameters,
3648
+ callback as BodyResponseCallback<unknown>
3649
+ );
3650
+ } else {
3651
+ return createAPIRequest<Schema$Operation>(parameters);
3652
+ }
3653
+ }
3654
+
2979
3655
  /**
2980
3656
  * Lists Clusters in a given project and location.
2981
3657
  *
@@ -3331,7 +4007,95 @@ export namespace alloydb_v1 {
3331
4007
  }
3332
4008
 
3333
4009
  /**
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.
4010
+ * Restores an AlloyDB cluster from a CloudSQL resource.
4011
+ *
4012
+ * @param params - Parameters for request
4013
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
4014
+ * @param callback - Optional callback that handles the response.
4015
+ * @returns A promise if used with async/await, or void if used with a callback.
4016
+ */
4017
+ restoreFromCloudSQL(
4018
+ params: Params$Resource$Projects$Locations$Clusters$Restorefromcloudsql,
4019
+ options: StreamMethodOptions
4020
+ ): GaxiosPromise<Readable>;
4021
+ restoreFromCloudSQL(
4022
+ params?: Params$Resource$Projects$Locations$Clusters$Restorefromcloudsql,
4023
+ options?: MethodOptions
4024
+ ): GaxiosPromise<Schema$Operation>;
4025
+ restoreFromCloudSQL(
4026
+ params: Params$Resource$Projects$Locations$Clusters$Restorefromcloudsql,
4027
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
4028
+ callback: BodyResponseCallback<Readable>
4029
+ ): void;
4030
+ restoreFromCloudSQL(
4031
+ params: Params$Resource$Projects$Locations$Clusters$Restorefromcloudsql,
4032
+ options: MethodOptions | BodyResponseCallback<Schema$Operation>,
4033
+ callback: BodyResponseCallback<Schema$Operation>
4034
+ ): void;
4035
+ restoreFromCloudSQL(
4036
+ params: Params$Resource$Projects$Locations$Clusters$Restorefromcloudsql,
4037
+ callback: BodyResponseCallback<Schema$Operation>
4038
+ ): void;
4039
+ restoreFromCloudSQL(callback: BodyResponseCallback<Schema$Operation>): void;
4040
+ restoreFromCloudSQL(
4041
+ paramsOrCallback?:
4042
+ | Params$Resource$Projects$Locations$Clusters$Restorefromcloudsql
4043
+ | BodyResponseCallback<Schema$Operation>
4044
+ | BodyResponseCallback<Readable>,
4045
+ optionsOrCallback?:
4046
+ | MethodOptions
4047
+ | StreamMethodOptions
4048
+ | BodyResponseCallback<Schema$Operation>
4049
+ | BodyResponseCallback<Readable>,
4050
+ callback?:
4051
+ | BodyResponseCallback<Schema$Operation>
4052
+ | BodyResponseCallback<Readable>
4053
+ ): void | GaxiosPromise<Schema$Operation> | GaxiosPromise<Readable> {
4054
+ let params = (paramsOrCallback ||
4055
+ {}) as Params$Resource$Projects$Locations$Clusters$Restorefromcloudsql;
4056
+ let options = (optionsOrCallback || {}) as MethodOptions;
4057
+
4058
+ if (typeof paramsOrCallback === 'function') {
4059
+ callback = paramsOrCallback;
4060
+ params =
4061
+ {} as Params$Resource$Projects$Locations$Clusters$Restorefromcloudsql;
4062
+ options = {};
4063
+ }
4064
+
4065
+ if (typeof optionsOrCallback === 'function') {
4066
+ callback = optionsOrCallback;
4067
+ options = {};
4068
+ }
4069
+
4070
+ const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/';
4071
+ const parameters = {
4072
+ options: Object.assign(
4073
+ {
4074
+ url: (
4075
+ rootUrl + '/v1/{+parent}/clusters:restoreFromCloudSQL'
4076
+ ).replace(/([^:]\/)\/+/g, '$1'),
4077
+ method: 'POST',
4078
+ apiVersion: '',
4079
+ },
4080
+ options
4081
+ ),
4082
+ params,
4083
+ requiredParams: ['parent'],
4084
+ pathParams: ['parent'],
4085
+ context: this.context,
4086
+ };
4087
+ if (callback) {
4088
+ createAPIRequest<Schema$Operation>(
4089
+ parameters,
4090
+ callback as BodyResponseCallback<unknown>
4091
+ );
4092
+ } else {
4093
+ return createAPIRequest<Schema$Operation>(parameters);
4094
+ }
4095
+ }
4096
+
4097
+ /**
4098
+ * 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
4099
  *
3336
4100
  * @param params - Parameters for request
3337
4101
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3417,6 +4181,94 @@ export namespace alloydb_v1 {
3417
4181
  return createAPIRequest<Schema$Operation>(parameters);
3418
4182
  }
3419
4183
  }
4184
+
4185
+ /**
4186
+ * Upgrades a single Cluster. Imperative only.
4187
+ *
4188
+ * @param params - Parameters for request
4189
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
4190
+ * @param callback - Optional callback that handles the response.
4191
+ * @returns A promise if used with async/await, or void if used with a callback.
4192
+ */
4193
+ upgrade(
4194
+ params: Params$Resource$Projects$Locations$Clusters$Upgrade,
4195
+ options: StreamMethodOptions
4196
+ ): GaxiosPromise<Readable>;
4197
+ upgrade(
4198
+ params?: Params$Resource$Projects$Locations$Clusters$Upgrade,
4199
+ options?: MethodOptions
4200
+ ): GaxiosPromise<Schema$Operation>;
4201
+ upgrade(
4202
+ params: Params$Resource$Projects$Locations$Clusters$Upgrade,
4203
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
4204
+ callback: BodyResponseCallback<Readable>
4205
+ ): void;
4206
+ upgrade(
4207
+ params: Params$Resource$Projects$Locations$Clusters$Upgrade,
4208
+ options: MethodOptions | BodyResponseCallback<Schema$Operation>,
4209
+ callback: BodyResponseCallback<Schema$Operation>
4210
+ ): void;
4211
+ upgrade(
4212
+ params: Params$Resource$Projects$Locations$Clusters$Upgrade,
4213
+ callback: BodyResponseCallback<Schema$Operation>
4214
+ ): void;
4215
+ upgrade(callback: BodyResponseCallback<Schema$Operation>): void;
4216
+ upgrade(
4217
+ paramsOrCallback?:
4218
+ | Params$Resource$Projects$Locations$Clusters$Upgrade
4219
+ | BodyResponseCallback<Schema$Operation>
4220
+ | BodyResponseCallback<Readable>,
4221
+ optionsOrCallback?:
4222
+ | MethodOptions
4223
+ | StreamMethodOptions
4224
+ | BodyResponseCallback<Schema$Operation>
4225
+ | BodyResponseCallback<Readable>,
4226
+ callback?:
4227
+ | BodyResponseCallback<Schema$Operation>
4228
+ | BodyResponseCallback<Readable>
4229
+ ): void | GaxiosPromise<Schema$Operation> | GaxiosPromise<Readable> {
4230
+ let params = (paramsOrCallback ||
4231
+ {}) as Params$Resource$Projects$Locations$Clusters$Upgrade;
4232
+ let options = (optionsOrCallback || {}) as MethodOptions;
4233
+
4234
+ if (typeof paramsOrCallback === 'function') {
4235
+ callback = paramsOrCallback;
4236
+ params = {} as Params$Resource$Projects$Locations$Clusters$Upgrade;
4237
+ options = {};
4238
+ }
4239
+
4240
+ if (typeof optionsOrCallback === 'function') {
4241
+ callback = optionsOrCallback;
4242
+ options = {};
4243
+ }
4244
+
4245
+ const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/';
4246
+ const parameters = {
4247
+ options: Object.assign(
4248
+ {
4249
+ url: (rootUrl + '/v1/{+name}:upgrade').replace(
4250
+ /([^:]\/)\/+/g,
4251
+ '$1'
4252
+ ),
4253
+ method: 'PATCH',
4254
+ apiVersion: '',
4255
+ },
4256
+ options
4257
+ ),
4258
+ params,
4259
+ requiredParams: ['name'],
4260
+ pathParams: ['name'],
4261
+ context: this.context,
4262
+ };
4263
+ if (callback) {
4264
+ createAPIRequest<Schema$Operation>(
4265
+ parameters,
4266
+ callback as BodyResponseCallback<unknown>
4267
+ );
4268
+ } else {
4269
+ return createAPIRequest<Schema$Operation>(parameters);
4270
+ }
4271
+ }
3420
4272
  }
3421
4273
 
3422
4274
  export interface Params$Resource$Projects$Locations$Clusters$Create
@@ -3430,11 +4282,11 @@ export namespace alloydb_v1 {
3430
4282
  */
3431
4283
  parent?: string;
3432
4284
  /**
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).
4285
+ * 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
4286
  */
3435
4287
  requestId?: string;
3436
4288
  /**
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.
4289
+ * 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
4290
  */
3439
4291
  validateOnly?: boolean;
3440
4292
 
@@ -3454,11 +4306,11 @@ export namespace alloydb_v1 {
3454
4306
  */
3455
4307
  parent?: string;
3456
4308
  /**
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).
4309
+ * 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
4310
  */
3459
4311
  requestId?: string;
3460
4312
  /**
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.
4313
+ * 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
4314
  */
3463
4315
  validateOnly?: boolean;
3464
4316
 
@@ -3482,14 +4334,26 @@ export namespace alloydb_v1 {
3482
4334
  */
3483
4335
  name?: string;
3484
4336
  /**
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).
4337
+ * 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
4338
  */
3487
4339
  requestId?: string;
3488
4340
  /**
3489
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.
4341
+ * 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
4342
  */
3491
4343
  validateOnly?: boolean;
3492
4344
  }
4345
+ export interface Params$Resource$Projects$Locations$Clusters$Export
4346
+ extends StandardParameters {
4347
+ /**
4348
+ * Required. The resource name of the cluster.
4349
+ */
4350
+ name?: string;
4351
+
4352
+ /**
4353
+ * Request body metadata
4354
+ */
4355
+ requestBody?: Schema$ExportClusterRequest;
4356
+ }
3493
4357
  export interface Params$Resource$Projects$Locations$Clusters$Get
3494
4358
  extends StandardParameters {
3495
4359
  /**
@@ -3501,6 +4365,18 @@ export namespace alloydb_v1 {
3501
4365
  */
3502
4366
  view?: string;
3503
4367
  }
4368
+ export interface Params$Resource$Projects$Locations$Clusters$Import
4369
+ extends StandardParameters {
4370
+ /**
4371
+ * Required. The resource name of the cluster.
4372
+ */
4373
+ name?: string;
4374
+
4375
+ /**
4376
+ * Request body metadata
4377
+ */
4378
+ requestBody?: Schema$ImportClusterRequest;
4379
+ }
3504
4380
  export interface Params$Resource$Projects$Locations$Clusters$List
3505
4381
  extends StandardParameters {
3506
4382
  /**
@@ -3535,7 +4411,7 @@ export namespace alloydb_v1 {
3535
4411
  */
3536
4412
  name?: string;
3537
4413
  /**
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).
4414
+ * 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
4415
  */
3540
4416
  requestId?: string;
3541
4417
  /**
@@ -3543,7 +4419,7 @@ export namespace alloydb_v1 {
3543
4419
  */
3544
4420
  updateMask?: string;
3545
4421
  /**
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.
4422
+ * 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
4423
  */
3548
4424
  validateOnly?: boolean;
3549
4425
 
@@ -3576,6 +4452,18 @@ export namespace alloydb_v1 {
3576
4452
  */
3577
4453
  requestBody?: Schema$RestoreClusterRequest;
3578
4454
  }
4455
+ export interface Params$Resource$Projects$Locations$Clusters$Restorefromcloudsql
4456
+ extends StandardParameters {
4457
+ /**
4458
+ * Required. The location of the new cluster. For the required format, see the comment on Cluster.name field.
4459
+ */
4460
+ parent?: string;
4461
+
4462
+ /**
4463
+ * Request body metadata
4464
+ */
4465
+ requestBody?: Schema$RestoreFromCloudSQLRequest;
4466
+ }
3579
4467
  export interface Params$Resource$Projects$Locations$Clusters$Switchover
3580
4468
  extends StandardParameters {
3581
4469
  /**
@@ -3588,6 +4476,18 @@ export namespace alloydb_v1 {
3588
4476
  */
3589
4477
  requestBody?: Schema$SwitchoverClusterRequest;
3590
4478
  }
4479
+ export interface Params$Resource$Projects$Locations$Clusters$Upgrade
4480
+ extends StandardParameters {
4481
+ /**
4482
+ * Required. The resource name of the cluster.
4483
+ */
4484
+ name?: string;
4485
+
4486
+ /**
4487
+ * Request body metadata
4488
+ */
4489
+ requestBody?: Schema$UpgradeClusterRequest;
4490
+ }
3591
4491
 
3592
4492
  export class Resource$Projects$Locations$Clusters$Instances {
3593
4493
  context: APIRequestContext;
@@ -4495,11 +5395,11 @@ export namespace alloydb_v1 {
4495
5395
  */
4496
5396
  parent?: string;
4497
5397
  /**
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).
5398
+ * 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
5399
  */
4500
5400
  requestId?: string;
4501
5401
  /**
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.
5402
+ * 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
5403
  */
4504
5404
  validateOnly?: boolean;
4505
5405
 
@@ -4519,11 +5419,11 @@ export namespace alloydb_v1 {
4519
5419
  */
4520
5420
  parent?: string;
4521
5421
  /**
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).
5422
+ * 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
5423
  */
4524
5424
  requestId?: string;
4525
5425
  /**
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.
5426
+ * 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
5427
  */
4528
5428
  validateOnly?: boolean;
4529
5429
 
@@ -4543,11 +5443,11 @@ export namespace alloydb_v1 {
4543
5443
  */
4544
5444
  name?: string;
4545
5445
  /**
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).
5446
+ * 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
5447
  */
4548
5448
  requestId?: string;
4549
5449
  /**
4550
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.
5450
+ * 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
5451
  */
4552
5452
  validateOnly?: boolean;
4553
5453
  }
@@ -4581,7 +5481,7 @@ export namespace alloydb_v1 {
4581
5481
  */
4582
5482
  parent?: string;
4583
5483
  /**
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).
5484
+ * 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
5485
  */
4586
5486
  requestId?: string;
4587
5487
  }
@@ -4631,7 +5531,7 @@ export namespace alloydb_v1 {
4631
5531
  */
4632
5532
  name?: string;
4633
5533
  /**
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).
5534
+ * 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
5535
  */
4636
5536
  requestId?: string;
4637
5537
  /**
@@ -4639,7 +5539,7 @@ export namespace alloydb_v1 {
4639
5539
  */
4640
5540
  updateMask?: string;
4641
5541
  /**
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.
5542
+ * 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
5543
  */
4644
5544
  validateOnly?: boolean;
4645
5545
 
@@ -5109,7 +6009,7 @@ export namespace alloydb_v1 {
5109
6009
  */
5110
6010
  parent?: string;
5111
6011
  /**
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).
6012
+ * 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
6013
  */
5114
6014
  requestId?: string;
5115
6015
  /**
@@ -5133,7 +6033,7 @@ export namespace alloydb_v1 {
5133
6033
  */
5134
6034
  name?: string;
5135
6035
  /**
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).
6036
+ * 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
6037
  */
5138
6038
  requestId?: string;
5139
6039
  /**
@@ -5182,7 +6082,7 @@ export namespace alloydb_v1 {
5182
6082
  */
5183
6083
  name?: string;
5184
6084
  /**
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).
6085
+ * 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
6086
  */
5187
6087
  requestId?: string;
5188
6088
  /**
@@ -5207,7 +6107,7 @@ export namespace alloydb_v1 {
5207
6107
  }
5208
6108
 
5209
6109
  /**
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`.
6110
+ * 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
6111
  *
5212
6112
  * @param params - Parameters for request
5213
6113
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5720,5 +6620,9 @@ export namespace alloydb_v1 {
5720
6620
  * Required. The name of the parent resource. The required format is: * projects/{project\}/locations/{location\} Regardless of the parent specified here, as long it is contains a valid project and location, the service will return a static list of supported flags resources. Note that we do not yet support region-specific flags.
5721
6621
  */
5722
6622
  parent?: string;
6623
+ /**
6624
+ * Optional. The scope for which supported flags are requested. If not specified, default is DATABASE.
6625
+ */
6626
+ scope?: string;
5723
6627
  }
5724
6628
  }