@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/build/v1.d.ts CHANGED
@@ -93,7 +93,7 @@ export declare namespace alloydb_v1 {
93
93
  */
94
94
  enabled?: boolean | null;
95
95
  /**
96
- * 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.
96
+ * 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.
97
97
  */
98
98
  encryptionConfig?: Schema$EncryptionConfig;
99
99
  /**
@@ -137,6 +137,10 @@ export declare namespace alloydb_v1 {
137
137
  * Output only. The system-generated UID of the cluster which was used to create this resource.
138
138
  */
139
139
  clusterUid?: string | null;
140
+ /**
141
+ * Output only. Timestamp when the resource finished being created.
142
+ */
143
+ createCompletionTime?: string | null;
140
144
  /**
141
145
  * Output only. Create time stamp
142
146
  */
@@ -203,6 +207,12 @@ export declare namespace alloydb_v1 {
203
207
  * Output only. The current state of the backup.
204
208
  */
205
209
  state?: string | null;
210
+ /**
211
+ * Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: ``` "123/environment": "production", "123/costCenter": "marketing" ```
212
+ */
213
+ tags?: {
214
+ [key: string]: string;
215
+ } | null;
206
216
  /**
207
217
  * The backup type, which suggests the trigger for the backup.
208
218
  */
@@ -212,7 +222,7 @@ export declare namespace alloydb_v1 {
212
222
  */
213
223
  uid?: string | null;
214
224
  /**
215
- * Output only. Update time stamp
225
+ * 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.
216
226
  */
217
227
  updateTime?: string | null;
218
228
  }
@@ -243,7 +253,7 @@ export declare namespace alloydb_v1 {
243
253
  */
244
254
  requireConnectors?: boolean | null;
245
255
  /**
246
- * Optional. SSL config option for this instance.
256
+ * Optional. SSL configuration option for this instance.
247
257
  */
248
258
  sslConfig?: Schema$SslConfig;
249
259
  }
@@ -260,6 +270,23 @@ export declare namespace alloydb_v1 {
260
270
  */
261
271
  exclusiveAction?: string | null;
262
272
  }
273
+ /**
274
+ * The source CloudSQL backup resource.
275
+ */
276
+ export interface Schema$CloudSQLBackupRunSource {
277
+ /**
278
+ * Required. The CloudSQL backup run ID.
279
+ */
280
+ backupRunId?: string | null;
281
+ /**
282
+ * Required. The CloudSQL instance ID.
283
+ */
284
+ instanceId?: string | null;
285
+ /**
286
+ * The project ID of the source CloudSQL instance. This should be the same as the AlloyDB cluster's project.
287
+ */
288
+ project?: string | null;
289
+ }
263
290
  /**
264
291
  * 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.
265
292
  */
@@ -278,6 +305,10 @@ export declare namespace alloydb_v1 {
278
305
  * Output only. Cluster created from backup.
279
306
  */
280
307
  backupSource?: Schema$BackupSource;
308
+ /**
309
+ * Output only. Cluster created from CloudSQL snapshot.
310
+ */
311
+ cloudsqlBackupRunSource?: Schema$CloudSQLBackupRunSource;
281
312
  /**
282
313
  * 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`
283
314
  */
@@ -381,6 +412,12 @@ export declare namespace alloydb_v1 {
381
412
  * Optional. Subscription type of the cluster.
382
413
  */
383
414
  subscriptionType?: string | null;
415
+ /**
416
+ * Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: ``` "123/environment": "production", "123/costCenter": "marketing" ```
417
+ */
418
+ tags?: {
419
+ [key: string]: string;
420
+ } | null;
384
421
  /**
385
422
  * Output only. Metadata for free trial clusters
386
423
  */
@@ -453,7 +490,7 @@ export declare namespace alloydb_v1 {
453
490
  */
454
491
  enabled?: boolean | null;
455
492
  /**
456
- * 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.
493
+ * 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.
457
494
  */
458
495
  encryptionConfig?: Schema$EncryptionConfig;
459
496
  /**
@@ -495,6 +532,69 @@ export declare namespace alloydb_v1 {
495
532
  */
496
533
  pointInTime?: string | null;
497
534
  }
535
+ /**
536
+ * Options for exporting data in CSV format.
537
+ */
538
+ export interface Schema$CsvExportOptions {
539
+ /**
540
+ * 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.
541
+ */
542
+ escapeCharacter?: string | null;
543
+ /**
544
+ * 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.
545
+ */
546
+ fieldDelimiter?: string | null;
547
+ /**
548
+ * 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.
549
+ */
550
+ quoteCharacter?: string | null;
551
+ /**
552
+ * Required. The SELECT query used to extract the data.
553
+ */
554
+ selectQuery?: string | null;
555
+ }
556
+ /**
557
+ * Options for importing data in CSV format.
558
+ */
559
+ export interface Schema$CsvImportOptions {
560
+ /**
561
+ * Optional. The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
562
+ */
563
+ columns?: string[] | null;
564
+ /**
565
+ * 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.
566
+ */
567
+ escapeCharacter?: string | null;
568
+ /**
569
+ * 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.
570
+ */
571
+ fieldDelimiter?: string | null;
572
+ /**
573
+ * 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.
574
+ */
575
+ quoteCharacter?: string | null;
576
+ /**
577
+ * Required. The database table to import CSV file into.
578
+ */
579
+ table?: string | null;
580
+ }
581
+ /**
582
+ * 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.
583
+ */
584
+ export interface Schema$DenyMaintenancePeriod {
585
+ /**
586
+ * 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
587
+ */
588
+ endDate?: Schema$GoogleTypeDate;
589
+ /**
590
+ * 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
591
+ */
592
+ startDate?: Schema$GoogleTypeDate;
593
+ /**
594
+ * 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
595
+ */
596
+ time?: Schema$GoogleTypeTimeOfDay;
597
+ }
498
598
  /**
499
599
  * 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); \}
500
600
  */
@@ -522,19 +622,58 @@ export declare namespace alloydb_v1 {
522
622
  */
523
623
  kmsKeyVersions?: string[] | null;
524
624
  }
625
+ /**
626
+ * Export cluster request.
627
+ */
628
+ export interface Schema$ExportClusterRequest {
629
+ /**
630
+ * Options for exporting data in CSV format. Required field to be set for CSV file type.
631
+ */
632
+ csvExportOptions?: Schema$CsvExportOptions;
633
+ /**
634
+ * 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.
635
+ */
636
+ database?: string | null;
637
+ /**
638
+ * Required. Option to export data to cloud storage.
639
+ */
640
+ gcsDestination?: Schema$GcsDestination;
641
+ /**
642
+ * Options for exporting data in SQL format. Required field to be set for SQL file type.
643
+ */
644
+ sqlExportOptions?: Schema$SqlExportOptions;
645
+ }
646
+ /**
647
+ * Response of export cluster rpc.
648
+ */
649
+ export interface Schema$ExportClusterResponse {
650
+ /**
651
+ * Required. Option to export data to cloud storage.
652
+ */
653
+ gcsDestination?: Schema$GcsDestination;
654
+ }
525
655
  /**
526
656
  * Message for triggering failover on an Instance
527
657
  */
528
658
  export interface Schema$FailoverInstanceRequest {
529
659
  /**
530
- * 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).
660
+ * 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).
531
661
  */
532
662
  requestId?: string | null;
533
663
  /**
534
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the failover.
664
+ * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
535
665
  */
536
666
  validateOnly?: boolean | null;
537
667
  }
668
+ /**
669
+ * Destination for Export. Export will be done to cloud storage.
670
+ */
671
+ export interface Schema$GcsDestination {
672
+ /**
673
+ * 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`.
674
+ */
675
+ uri?: string | null;
676
+ }
538
677
  /**
539
678
  * The response message for Locations.ListLocations.
540
679
  */
@@ -577,27 +716,78 @@ export declare namespace alloydb_v1 {
577
716
  */
578
717
  name?: string | null;
579
718
  }
719
+ /**
720
+ * 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
721
+ */
722
+ export interface Schema$GoogleTypeDate {
723
+ /**
724
+ * 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.
725
+ */
726
+ day?: number | null;
727
+ /**
728
+ * Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
729
+ */
730
+ month?: number | null;
731
+ /**
732
+ * Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
733
+ */
734
+ year?: number | null;
735
+ }
580
736
  /**
581
737
  * 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`.
582
738
  */
583
739
  export interface Schema$GoogleTypeTimeOfDay {
584
740
  /**
585
- * 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.
741
+ * 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.
586
742
  */
587
743
  hours?: number | null;
588
744
  /**
589
- * Minutes of hour of day. Must be from 0 to 59.
745
+ * Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
590
746
  */
591
747
  minutes?: number | null;
592
748
  /**
593
- * Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
749
+ * Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
594
750
  */
595
751
  nanos?: number | null;
596
752
  /**
597
- * 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.
753
+ * 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.
598
754
  */
599
755
  seconds?: number | null;
600
756
  }
757
+ /**
758
+ * Import cluster request.
759
+ */
760
+ export interface Schema$ImportClusterRequest {
761
+ /**
762
+ * Options for importing data in CSV format.
763
+ */
764
+ csvImportOptions?: Schema$CsvImportOptions;
765
+ /**
766
+ * 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.
767
+ */
768
+ database?: string | null;
769
+ /**
770
+ * 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`.
771
+ */
772
+ gcsUri?: string | null;
773
+ /**
774
+ * Options for importing data in SQL format.
775
+ */
776
+ sqlImportOptions?: Schema$SqlImportOptions;
777
+ /**
778
+ * 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.
779
+ */
780
+ user?: string | null;
781
+ }
782
+ /**
783
+ * Response of import rpc.
784
+ */
785
+ export interface Schema$ImportClusterResponse {
786
+ /**
787
+ * Required. Size of the object downloaded from Google Cloud Storage in bytes.
788
+ */
789
+ bytesDownloaded?: string | null;
790
+ }
601
791
  /**
602
792
  * Message for triggering fault injection on an instance
603
793
  */
@@ -607,11 +797,11 @@ export declare namespace alloydb_v1 {
607
797
  */
608
798
  faultType?: string | null;
609
799
  /**
610
- * 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).
800
+ * 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).
611
801
  */
612
802
  requestId?: string | null;
613
803
  /**
614
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the fault injection.
804
+ * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
615
805
  */
616
806
  validateOnly?: boolean | null;
617
807
  }
@@ -638,7 +828,7 @@ export declare namespace alloydb_v1 {
638
828
  */
639
829
  createTime?: string | null;
640
830
  /**
641
- * 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.
831
+ * 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.
642
832
  */
643
833
  databaseFlags?: {
644
834
  [key: string]: string;
@@ -682,13 +872,21 @@ export declare namespace alloydb_v1 {
682
872
  */
683
873
  name?: string | null;
684
874
  /**
685
- * Optional. Instance level network configuration.
875
+ * Optional. Instance-level network configuration.
686
876
  */
687
877
  networkConfig?: Schema$InstanceNetworkConfig;
688
878
  /**
689
879
  * Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
690
880
  */
691
881
  nodes?: Schema$Node[];
882
+ /**
883
+ * Configuration for observability.
884
+ */
885
+ observabilityConfig?: Schema$ObservabilityInstanceConfig;
886
+ /**
887
+ * Output only. All outbound public IP addresses configured for the instance.
888
+ */
889
+ outboundPublicIpAddresses?: string[] | null;
692
890
  /**
693
891
  * Optional. The configuration for Private Service Connect (PSC) for the instance.
694
892
  */
@@ -731,17 +929,25 @@ export declare namespace alloydb_v1 {
731
929
  writableNode?: Schema$Node;
732
930
  }
733
931
  /**
734
- * Metadata related to instance level network configuration.
932
+ * Metadata related to instance-level network configuration.
735
933
  */
736
934
  export interface Schema$InstanceNetworkConfig {
737
935
  /**
738
936
  * Optional. A list of external network authorized to access this instance.
739
937
  */
740
938
  authorizedExternalNetworks?: Schema$AuthorizedNetwork[];
939
+ /**
940
+ * Optional. Enabling an outbound public IP address to support a database server sending requests out into the internet.
941
+ */
942
+ enableOutboundPublicIp?: boolean | null;
741
943
  /**
742
944
  * Optional. Enabling public ip for the instance.
743
945
  */
744
946
  enablePublicIp?: boolean | null;
947
+ /**
948
+ * 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\}`.
949
+ */
950
+ network?: string | null;
745
951
  }
746
952
  /**
747
953
  * Details regarding the upgrade of instaces associated with a cluster.
@@ -875,6 +1081,10 @@ export declare namespace alloydb_v1 {
875
1081
  * The number of CPU's in the VM instance.
876
1082
  */
877
1083
  cpuCount?: number | null;
1084
+ /**
1085
+ * 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.
1086
+ */
1087
+ machineType?: string | null;
878
1088
  }
879
1089
  /**
880
1090
  * 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.
@@ -889,6 +1099,10 @@ export declare namespace alloydb_v1 {
889
1099
  * MaintenanceUpdatePolicy defines the policy for system updates.
890
1100
  */
891
1101
  export interface Schema$MaintenanceUpdatePolicy {
1102
+ /**
1103
+ * Periods to deny maintenance. Currently limited to 1.
1104
+ */
1105
+ denyMaintenancePeriods?: Schema$DenyMaintenancePeriod[];
892
1106
  /**
893
1107
  * Preferred windows to perform maintenance. Currently limited to 1.
894
1108
  */
@@ -938,26 +1152,63 @@ export declare namespace alloydb_v1 {
938
1152
  network?: string | null;
939
1153
  }
940
1154
  /**
941
- * 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.
1155
+ * 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.
942
1156
  */
943
1157
  export interface Schema$Node {
944
1158
  /**
945
- * The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
1159
+ * Output only. The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
946
1160
  */
947
1161
  id?: string | null;
948
1162
  /**
949
- * The private IP address of the VM e.g. "10.57.0.34".
1163
+ * Output only. The private IP address of the VM e.g. "10.57.0.34".
950
1164
  */
951
1165
  ip?: string | null;
952
1166
  /**
953
- * 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.
1167
+ * 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.
954
1168
  */
955
1169
  state?: string | null;
956
1170
  /**
957
- * The Compute Engine zone of the VM e.g. "us-central1-b".
1171
+ * Output only. The Compute Engine zone of the VM e.g. "us-central1-b".
958
1172
  */
959
1173
  zoneId?: string | null;
960
1174
  }
1175
+ /**
1176
+ * Observability Instance specific configuration.
1177
+ */
1178
+ export interface Schema$ObservabilityInstanceConfig {
1179
+ /**
1180
+ * Observability feature status for an instance. This flag is turned "off" by default.
1181
+ */
1182
+ enabled?: boolean | null;
1183
+ /**
1184
+ * Query string length. The default value is 10k.
1185
+ */
1186
+ maxQueryStringLength?: number | null;
1187
+ /**
1188
+ * Preserve comments in query string for an instance. This flag is turned "off" by default.
1189
+ */
1190
+ preserveComments?: boolean | null;
1191
+ /**
1192
+ * 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.
1193
+ */
1194
+ queryPlansPerMinute?: number | null;
1195
+ /**
1196
+ * Record application tags for an instance. This flag is turned "off" by default.
1197
+ */
1198
+ recordApplicationTags?: boolean | null;
1199
+ /**
1200
+ * Track actively running queries on the instance. If not set, this flag is "off" by default.
1201
+ */
1202
+ trackActiveQueries?: boolean | null;
1203
+ /**
1204
+ * 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.
1205
+ */
1206
+ trackWaitEvents?: boolean | null;
1207
+ /**
1208
+ * 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.
1209
+ */
1210
+ trackWaitEventTypes?: boolean | null;
1211
+ }
961
1212
  /**
962
1213
  * This resource represents a long-running operation that is the result of a network API call.
963
1214
  */
@@ -1004,7 +1255,7 @@ export declare namespace alloydb_v1 {
1004
1255
  */
1005
1256
  endTime?: string | null;
1006
1257
  /**
1007
- * 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`.
1258
+ * 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`.
1008
1259
  */
1009
1260
  requestedCancellation?: boolean | null;
1010
1261
  /**
@@ -1015,6 +1266,10 @@ export declare namespace alloydb_v1 {
1015
1266
  * Output only. Server-defined resource path for the target of the operation.
1016
1267
  */
1017
1268
  target?: string | null;
1269
+ /**
1270
+ * Output only. UpgradeClusterStatus related metadata.
1271
+ */
1272
+ upgradeClusterStatus?: Schema$UpgradeClusterStatus;
1018
1273
  /**
1019
1274
  * Output only. Name of the verb executed by the operation.
1020
1275
  */
@@ -1038,14 +1293,39 @@ export declare namespace alloydb_v1 {
1038
1293
  */
1039
1294
  etag?: string | null;
1040
1295
  /**
1041
- * 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).
1296
+ * 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).
1042
1297
  */
1043
1298
  requestId?: string | null;
1044
1299
  /**
1045
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.
1300
+ * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
1046
1301
  */
1047
1302
  validateOnly?: boolean | null;
1048
1303
  }
1304
+ /**
1305
+ * Configuration for setting up PSC service automation. Consumer projects in the configs will be allowlisted automatically for the instance.
1306
+ */
1307
+ export interface Schema$PscAutoConnectionConfig {
1308
+ /**
1309
+ * 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.
1310
+ */
1311
+ consumerNetwork?: string | null;
1312
+ /**
1313
+ * 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.
1314
+ */
1315
+ consumerNetworkStatus?: string | null;
1316
+ /**
1317
+ * The consumer project to which the PSC service automation endpoint will be created.
1318
+ */
1319
+ consumerProject?: string | null;
1320
+ /**
1321
+ * Output only. The IP address of the PSC service automation endpoint.
1322
+ */
1323
+ ipAddress?: string | null;
1324
+ /**
1325
+ * 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.
1326
+ */
1327
+ status?: string | null;
1328
+ }
1049
1329
  /**
1050
1330
  * PscConfig contains PSC related configuration at a cluster level.
1051
1331
  */
@@ -1054,6 +1334,10 @@ export declare namespace alloydb_v1 {
1054
1334
  * Optional. Create an instance that allows connections from Private Service Connect endpoints to the instance.
1055
1335
  */
1056
1336
  pscEnabled?: boolean | null;
1337
+ /**
1338
+ * Output only. The project number that needs to be allowlisted on the network attachment to enable outbound connectivity.
1339
+ */
1340
+ serviceOwnedProjectNumber?: string | null;
1057
1341
  }
1058
1342
  /**
1059
1343
  * PscInstanceConfig contains PSC related configuration at an instance level.
@@ -1063,15 +1347,32 @@ export declare namespace alloydb_v1 {
1063
1347
  * Optional. List of consumer projects that are allowed to create PSC endpoints to service-attachments to this instance.
1064
1348
  */
1065
1349
  allowedConsumerProjects?: string[] | null;
1350
+ /**
1351
+ * Optional. Configurations for setting up PSC service automation.
1352
+ */
1353
+ pscAutoConnections?: Schema$PscAutoConnectionConfig[];
1066
1354
  /**
1067
1355
  * Output only. The DNS name of the instance for PSC connectivity. Name convention: ...alloydb-psc.goog
1068
1356
  */
1069
1357
  pscDnsName?: string | null;
1358
+ /**
1359
+ * 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.
1360
+ */
1361
+ pscInterfaceConfigs?: Schema$PscInterfaceConfig[];
1070
1362
  /**
1071
1363
  * 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/`
1072
1364
  */
1073
1365
  serviceAttachmentLink?: string | null;
1074
1366
  }
1367
+ /**
1368
+ * Configuration for setting up a PSC interface to enable outbound connectivity.
1369
+ */
1370
+ export interface Schema$PscInterfaceConfig {
1371
+ /**
1372
+ * 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.
1373
+ */
1374
+ networkAttachmentResource?: string | null;
1375
+ }
1075
1376
  /**
1076
1377
  * 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)
1077
1378
  */
@@ -1124,22 +1425,31 @@ export declare namespace alloydb_v1 {
1124
1425
  */
1125
1426
  nodeCount?: number | null;
1126
1427
  }
1428
+ /**
1429
+ * Read pool instances upgrade specific status.
1430
+ */
1431
+ export interface Schema$ReadPoolInstancesUpgradeStageStatus {
1432
+ /**
1433
+ * Read pool instances upgrade statistics.
1434
+ */
1435
+ upgradeStats?: Schema$Stats;
1436
+ }
1127
1437
  export interface Schema$RestartInstanceRequest {
1128
1438
  /**
1129
- * Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Only applicable for read instances.
1439
+ * Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Applicable only to read instances.
1130
1440
  */
1131
1441
  nodeIds?: string[] | null;
1132
1442
  /**
1133
- * 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).
1443
+ * 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).
1134
1444
  */
1135
1445
  requestId?: string | null;
1136
1446
  /**
1137
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the restart.
1447
+ * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
1138
1448
  */
1139
1449
  validateOnly?: boolean | null;
1140
1450
  }
1141
1451
  /**
1142
- * Message for restoring a Cluster from a backup or another cluster at a given point in time.
1452
+ * Message for restoring a Cluster from a backup or another cluster at a given point in time. NEXT_ID: 11
1143
1453
  */
1144
1454
  export interface Schema$RestoreClusterRequest {
1145
1455
  /**
@@ -1159,14 +1469,31 @@ export declare namespace alloydb_v1 {
1159
1469
  */
1160
1470
  continuousBackupSource?: Schema$ContinuousBackupSource;
1161
1471
  /**
1162
- * 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).
1472
+ * 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).
1163
1473
  */
1164
1474
  requestId?: string | null;
1165
1475
  /**
1166
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the import request.
1476
+ * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
1167
1477
  */
1168
1478
  validateOnly?: boolean | null;
1169
1479
  }
1480
+ /**
1481
+ * Message for registering Restoring from CloudSQL resource.
1482
+ */
1483
+ export interface Schema$RestoreFromCloudSQLRequest {
1484
+ /**
1485
+ * Cluster created from CloudSQL backup run.
1486
+ */
1487
+ cloudsqlBackupRunSource?: Schema$CloudSQLBackupRunSource;
1488
+ /**
1489
+ * Required. The resource being created
1490
+ */
1491
+ cluster?: Schema$Cluster;
1492
+ /**
1493
+ * Required. ID of the requesting object.
1494
+ */
1495
+ clusterId?: string | null;
1496
+ }
1170
1497
  /**
1171
1498
  * Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY.
1172
1499
  */
@@ -1176,6 +1503,32 @@ export declare namespace alloydb_v1 {
1176
1503
  */
1177
1504
  primaryClusterName?: string | null;
1178
1505
  }
1506
+ /**
1507
+ * Options for exporting data in SQL format.
1508
+ */
1509
+ export interface Schema$SqlExportOptions {
1510
+ /**
1511
+ * Optional. If true, output commands to DROP all the dumped database objects prior to outputting the commands for creating them.
1512
+ */
1513
+ cleanTargetObjects?: boolean | null;
1514
+ /**
1515
+ * Optional. If true, use DROP ... IF EXISTS commands to check for the object's existence before dropping it in clean_target_objects mode.
1516
+ */
1517
+ ifExistTargetObjects?: boolean | null;
1518
+ /**
1519
+ * Optional. If true, only export the schema.
1520
+ */
1521
+ schemaOnly?: boolean | null;
1522
+ /**
1523
+ * Optional. Tables to export from.
1524
+ */
1525
+ tables?: string[] | null;
1526
+ }
1527
+ /**
1528
+ * Options for importing data in SQL format.
1529
+ */
1530
+ export interface Schema$SqlImportOptions {
1531
+ }
1179
1532
  /**
1180
1533
  * SSL configuration.
1181
1534
  */
@@ -1206,6 +1559,44 @@ export declare namespace alloydb_v1 {
1206
1559
  */
1207
1560
  status?: string | null;
1208
1561
  }
1562
+ /**
1563
+ * Status of an upgrade stage.
1564
+ */
1565
+ export interface Schema$StageStatus {
1566
+ /**
1567
+ * Read pool instances upgrade metadata.
1568
+ */
1569
+ readPoolInstancesUpgrade?: Schema$ReadPoolInstancesUpgradeStageStatus;
1570
+ /**
1571
+ * Upgrade stage.
1572
+ */
1573
+ stage?: string | null;
1574
+ /**
1575
+ * State of this stage.
1576
+ */
1577
+ state?: string | null;
1578
+ }
1579
+ /**
1580
+ * Upgrade stats for read pool instances.
1581
+ */
1582
+ export interface Schema$Stats {
1583
+ /**
1584
+ * Number of read pool instances which failed to upgrade.
1585
+ */
1586
+ failed?: number | null;
1587
+ /**
1588
+ * Number of read pool instances for which upgrade has not started.
1589
+ */
1590
+ notStarted?: number | null;
1591
+ /**
1592
+ * Number of read pool instances undergoing upgrade.
1593
+ */
1594
+ ongoing?: number | null;
1595
+ /**
1596
+ * Number of read pool instances successfully upgraded.
1597
+ */
1598
+ success?: number | null;
1599
+ }
1209
1600
  /**
1210
1601
  * 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).
1211
1602
  */
@@ -1407,7 +1798,7 @@ export declare namespace alloydb_v1 {
1407
1798
  uniqueId?: string | null;
1408
1799
  }
1409
1800
  /**
1410
- * Common model for database resource instance metadata.
1801
+ * Common model for database resource instance metadata. Next ID: 25
1411
1802
  */
1412
1803
  export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata {
1413
1804
  /**
@@ -1434,6 +1825,10 @@ export declare namespace alloydb_v1 {
1434
1825
  * Any custom metadata associated with the resource
1435
1826
  */
1436
1827
  customMetadata?: Schema$StorageDatabasecenterPartnerapiV1mainCustomMetadataData;
1828
+ /**
1829
+ * 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.
1830
+ */
1831
+ edition?: string | null;
1437
1832
  /**
1438
1833
  * Entitlements associated with the resource
1439
1834
  */
@@ -1442,6 +1837,10 @@ export declare namespace alloydb_v1 {
1442
1837
  * 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.
1443
1838
  */
1444
1839
  expectedState?: string | null;
1840
+ /**
1841
+ * GCBDR configuration for the resource.
1842
+ */
1843
+ gcbdrConfiguration?: Schema$StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration;
1445
1844
  /**
1446
1845
  * Required. Unique identifier for a Database resource
1447
1846
  */
@@ -1462,6 +1861,10 @@ export declare namespace alloydb_v1 {
1462
1861
  * 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.
1463
1862
  */
1464
1863
  primaryResourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId;
1864
+ /**
1865
+ * Primary resource location. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional.
1866
+ */
1867
+ primaryResourceLocation?: string | null;
1465
1868
  /**
1466
1869
  * The product this resource represents.
1467
1870
  */
@@ -1474,6 +1877,14 @@ export declare namespace alloydb_v1 {
1474
1877
  * 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
1475
1878
  */
1476
1879
  resourceName?: string | null;
1880
+ /**
1881
+ * Optional. Suspension reason for the resource.
1882
+ */
1883
+ suspensionReason?: string | null;
1884
+ /**
1885
+ * Optional. Tags associated with this resources.
1886
+ */
1887
+ tagsSet?: Schema$StorageDatabasecenterPartnerapiV1mainTags;
1477
1888
  /**
1478
1889
  * The time at which the resource was updated and recorded at partner service.
1479
1890
  */
@@ -1535,6 +1946,15 @@ export declare namespace alloydb_v1 {
1535
1946
  */
1536
1947
  type?: string | null;
1537
1948
  }
1949
+ /**
1950
+ * GCBDR Configuration for the resource.
1951
+ */
1952
+ export interface Schema$StorageDatabasecenterPartnerapiV1mainGCBDRConfiguration {
1953
+ /**
1954
+ * Whether the resource is managed by GCBDR.
1955
+ */
1956
+ gcbdrManaged?: boolean | null;
1957
+ }
1538
1958
  /**
1539
1959
  * 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.
1540
1960
  */
@@ -1547,6 +1967,10 @@ export declare namespace alloydb_v1 {
1547
1967
  * Information about the last backup attempt for this database
1548
1968
  */
1549
1969
  backupRun?: Schema$StorageDatabasecenterPartnerapiV1mainBackupRun;
1970
+ /**
1971
+ * Whether deletion protection is enabled for this internal resource.
1972
+ */
1973
+ isDeletionProtectionEnabled?: boolean | null;
1550
1974
  product?: Schema$StorageDatabasecenterProtoCommonProduct;
1551
1975
  resourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId;
1552
1976
  /**
@@ -1559,13 +1983,21 @@ export declare namespace alloydb_v1 {
1559
1983
  */
1560
1984
  export interface Schema$StorageDatabasecenterPartnerapiV1mainMachineConfiguration {
1561
1985
  /**
1562
- * The number of CPUs. TODO(b/342344482, b/342346271) add proto validations again after bug fix.
1986
+ * The number of CPUs. Deprecated. Use vcpu_count instead. TODO(b/342344482) add proto validations again after bug fix.
1563
1987
  */
1564
1988
  cpuCount?: number | null;
1565
1989
  /**
1566
- * Memory size in bytes. TODO(b/342344482, b/342346271) add proto validations again after bug fix.
1990
+ * Memory size in bytes. TODO(b/342344482) add proto validations again after bug fix.
1567
1991
  */
1568
1992
  memorySizeInBytes?: string | null;
1993
+ /**
1994
+ * Optional. Number of shards (if applicable).
1995
+ */
1996
+ shardCount?: number | null;
1997
+ /**
1998
+ * Optional. The number of vCPUs. TODO(b/342344482) add proto validations again after bug fix.
1999
+ */
2000
+ vcpuCount?: number | null;
1569
2001
  }
1570
2002
  export interface Schema$StorageDatabasecenterPartnerapiV1mainObservabilityMetricData {
1571
2003
  /**
@@ -1604,12 +2036,31 @@ export declare namespace alloydb_v1 {
1604
2036
  message?: string | null;
1605
2037
  }
1606
2038
  export interface Schema$StorageDatabasecenterPartnerapiV1mainRetentionSettings {
2039
+ /**
2040
+ * Duration based retention period i.e. 172800 seconds (2 days)
2041
+ */
2042
+ durationBasedRetention?: string | null;
1607
2043
  quantityBasedRetention?: number | null;
1608
2044
  /**
1609
2045
  * The unit that 'retained_backups' represents.
1610
2046
  */
1611
2047
  retentionUnit?: string | null;
1612
2048
  timeBasedRetention?: string | null;
2049
+ /**
2050
+ * Timestamp based retention period i.e. 2024-05-01T00:00:00Z
2051
+ */
2052
+ timestampBasedRetentionTime?: string | null;
2053
+ }
2054
+ /**
2055
+ * 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.
2056
+ */
2057
+ export interface Schema$StorageDatabasecenterPartnerapiV1mainTags {
2058
+ /**
2059
+ * The Tag key/value mappings.
2060
+ */
2061
+ tags?: {
2062
+ [key: string]: string;
2063
+ } | null;
1613
2064
  }
1614
2065
  /**
1615
2066
  * 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.
@@ -1686,10 +2137,22 @@ export declare namespace alloydb_v1 {
1686
2137
  * 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.
1687
2138
  */
1688
2139
  name?: string | null;
2140
+ /**
2141
+ * The recommended value for an INTEGER flag.
2142
+ */
2143
+ recommendedIntegerValue?: string | null;
2144
+ /**
2145
+ * The recommended value for a STRING flag.
2146
+ */
2147
+ recommendedStringValue?: string | null;
1689
2148
  /**
1690
2149
  * 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).
1691
2150
  */
1692
2151
  requiresDbRestart?: boolean | null;
2152
+ /**
2153
+ * The scope of the flag.
2154
+ */
2155
+ scope?: string | null;
1693
2156
  /**
1694
2157
  * Restriction on STRING type value.
1695
2158
  */
@@ -1705,11 +2168,11 @@ export declare namespace alloydb_v1 {
1705
2168
  */
1706
2169
  export interface Schema$SwitchoverClusterRequest {
1707
2170
  /**
1708
- * 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).
2171
+ * 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).
1709
2172
  */
1710
2173
  requestId?: string | null;
1711
2174
  /**
1712
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.
2175
+ * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
1713
2176
  */
1714
2177
  validateOnly?: boolean | null;
1715
2178
  }
@@ -1743,6 +2206,27 @@ export declare namespace alloydb_v1 {
1743
2206
  */
1744
2207
  upgradeTime?: string | null;
1745
2208
  }
2209
+ /**
2210
+ * Upgrades a cluster.
2211
+ */
2212
+ export interface Schema$UpgradeClusterRequest {
2213
+ /**
2214
+ * 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.
2215
+ */
2216
+ etag?: string | null;
2217
+ /**
2218
+ * 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).
2219
+ */
2220
+ requestId?: string | null;
2221
+ /**
2222
+ * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
2223
+ */
2224
+ validateOnly?: boolean | null;
2225
+ /**
2226
+ * Required. The version the cluster is going to be upgraded to.
2227
+ */
2228
+ version?: string | null;
2229
+ }
1746
2230
  /**
1747
2231
  * UpgradeClusterResponse contains the response for upgrade cluster operation.
1748
2232
  */
@@ -1760,6 +2244,31 @@ export declare namespace alloydb_v1 {
1760
2244
  */
1761
2245
  status?: string | null;
1762
2246
  }
2247
+ /**
2248
+ * Message for current status of the Major Version Upgrade operation.
2249
+ */
2250
+ export interface Schema$UpgradeClusterStatus {
2251
+ /**
2252
+ * Whether the operation is cancellable.
2253
+ */
2254
+ cancellable?: boolean | null;
2255
+ /**
2256
+ * Source database major version.
2257
+ */
2258
+ sourceVersion?: string | null;
2259
+ /**
2260
+ * Status of all upgrade stages.
2261
+ */
2262
+ stages?: Schema$StageStatus[];
2263
+ /**
2264
+ * Cluster Major Version Upgrade state.
2265
+ */
2266
+ state?: string | null;
2267
+ /**
2268
+ * Target database major version.
2269
+ */
2270
+ targetVersion?: string | null;
2271
+ }
1763
2272
  /**
1764
2273
  * Message describing User object.
1765
2274
  */
@@ -1859,6 +2368,10 @@ export declare namespace alloydb_v1 {
1859
2368
  name?: string;
1860
2369
  }
1861
2370
  export interface Params$Resource$Projects$Locations$List extends StandardParameters {
2371
+ /**
2372
+ * Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.
2373
+ */
2374
+ extraLocationTypes?: string[];
1862
2375
  /**
1863
2376
  * 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).
1864
2377
  */
@@ -1960,7 +2473,7 @@ export declare namespace alloydb_v1 {
1960
2473
  */
1961
2474
  parent?: string;
1962
2475
  /**
1963
- * 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).
2476
+ * 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).
1964
2477
  */
1965
2478
  requestId?: string;
1966
2479
  /**
@@ -1982,7 +2495,7 @@ export declare namespace alloydb_v1 {
1982
2495
  */
1983
2496
  name?: string;
1984
2497
  /**
1985
- * 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).
2498
+ * 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).
1986
2499
  */
1987
2500
  requestId?: string;
1988
2501
  /**
@@ -2028,7 +2541,7 @@ export declare namespace alloydb_v1 {
2028
2541
  */
2029
2542
  name?: string;
2030
2543
  /**
2031
- * 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).
2544
+ * 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).
2032
2545
  */
2033
2546
  requestId?: string;
2034
2547
  /**
@@ -2091,6 +2604,20 @@ export declare namespace alloydb_v1 {
2091
2604
  delete(params: Params$Resource$Projects$Locations$Clusters$Delete, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
2092
2605
  delete(params: Params$Resource$Projects$Locations$Clusters$Delete, callback: BodyResponseCallback<Schema$Operation>): void;
2093
2606
  delete(callback: BodyResponseCallback<Schema$Operation>): void;
2607
+ /**
2608
+ * Exports data from the cluster. Imperative only.
2609
+ *
2610
+ * @param params - Parameters for request
2611
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
2612
+ * @param callback - Optional callback that handles the response.
2613
+ * @returns A promise if used with async/await, or void if used with a callback.
2614
+ */
2615
+ export(params: Params$Resource$Projects$Locations$Clusters$Export, options: StreamMethodOptions): GaxiosPromise<Readable>;
2616
+ export(params?: Params$Resource$Projects$Locations$Clusters$Export, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
2617
+ export(params: Params$Resource$Projects$Locations$Clusters$Export, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
2618
+ export(params: Params$Resource$Projects$Locations$Clusters$Export, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
2619
+ export(params: Params$Resource$Projects$Locations$Clusters$Export, callback: BodyResponseCallback<Schema$Operation>): void;
2620
+ export(callback: BodyResponseCallback<Schema$Operation>): void;
2094
2621
  /**
2095
2622
  * Gets details of a single Cluster.
2096
2623
  *
@@ -2105,6 +2632,20 @@ export declare namespace alloydb_v1 {
2105
2632
  get(params: Params$Resource$Projects$Locations$Clusters$Get, options: MethodOptions | BodyResponseCallback<Schema$Cluster>, callback: BodyResponseCallback<Schema$Cluster>): void;
2106
2633
  get(params: Params$Resource$Projects$Locations$Clusters$Get, callback: BodyResponseCallback<Schema$Cluster>): void;
2107
2634
  get(callback: BodyResponseCallback<Schema$Cluster>): void;
2635
+ /**
2636
+ * Imports data to the cluster. Imperative only.
2637
+ *
2638
+ * @param params - Parameters for request
2639
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
2640
+ * @param callback - Optional callback that handles the response.
2641
+ * @returns A promise if used with async/await, or void if used with a callback.
2642
+ */
2643
+ import(params: Params$Resource$Projects$Locations$Clusters$Import, options: StreamMethodOptions): GaxiosPromise<Readable>;
2644
+ import(params?: Params$Resource$Projects$Locations$Clusters$Import, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
2645
+ import(params: Params$Resource$Projects$Locations$Clusters$Import, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
2646
+ import(params: Params$Resource$Projects$Locations$Clusters$Import, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
2647
+ import(params: Params$Resource$Projects$Locations$Clusters$Import, callback: BodyResponseCallback<Schema$Operation>): void;
2648
+ import(callback: BodyResponseCallback<Schema$Operation>): void;
2108
2649
  /**
2109
2650
  * Lists Clusters in a given project and location.
2110
2651
  *
@@ -2162,7 +2703,21 @@ export declare namespace alloydb_v1 {
2162
2703
  restore(params: Params$Resource$Projects$Locations$Clusters$Restore, callback: BodyResponseCallback<Schema$Operation>): void;
2163
2704
  restore(callback: BodyResponseCallback<Schema$Operation>): void;
2164
2705
  /**
2165
- * 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.
2706
+ * Restores an AlloyDB cluster from a CloudSQL resource.
2707
+ *
2708
+ * @param params - Parameters for request
2709
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
2710
+ * @param callback - Optional callback that handles the response.
2711
+ * @returns A promise if used with async/await, or void if used with a callback.
2712
+ */
2713
+ restoreFromCloudSQL(params: Params$Resource$Projects$Locations$Clusters$Restorefromcloudsql, options: StreamMethodOptions): GaxiosPromise<Readable>;
2714
+ restoreFromCloudSQL(params?: Params$Resource$Projects$Locations$Clusters$Restorefromcloudsql, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
2715
+ restoreFromCloudSQL(params: Params$Resource$Projects$Locations$Clusters$Restorefromcloudsql, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
2716
+ restoreFromCloudSQL(params: Params$Resource$Projects$Locations$Clusters$Restorefromcloudsql, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
2717
+ restoreFromCloudSQL(params: Params$Resource$Projects$Locations$Clusters$Restorefromcloudsql, callback: BodyResponseCallback<Schema$Operation>): void;
2718
+ restoreFromCloudSQL(callback: BodyResponseCallback<Schema$Operation>): void;
2719
+ /**
2720
+ * 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.
2166
2721
  *
2167
2722
  * @param params - Parameters for request
2168
2723
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2175,6 +2730,20 @@ export declare namespace alloydb_v1 {
2175
2730
  switchover(params: Params$Resource$Projects$Locations$Clusters$Switchover, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
2176
2731
  switchover(params: Params$Resource$Projects$Locations$Clusters$Switchover, callback: BodyResponseCallback<Schema$Operation>): void;
2177
2732
  switchover(callback: BodyResponseCallback<Schema$Operation>): void;
2733
+ /**
2734
+ * Upgrades a single Cluster. Imperative only.
2735
+ *
2736
+ * @param params - Parameters for request
2737
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
2738
+ * @param callback - Optional callback that handles the response.
2739
+ * @returns A promise if used with async/await, or void if used with a callback.
2740
+ */
2741
+ upgrade(params: Params$Resource$Projects$Locations$Clusters$Upgrade, options: StreamMethodOptions): GaxiosPromise<Readable>;
2742
+ upgrade(params?: Params$Resource$Projects$Locations$Clusters$Upgrade, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
2743
+ upgrade(params: Params$Resource$Projects$Locations$Clusters$Upgrade, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
2744
+ upgrade(params: Params$Resource$Projects$Locations$Clusters$Upgrade, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
2745
+ upgrade(params: Params$Resource$Projects$Locations$Clusters$Upgrade, callback: BodyResponseCallback<Schema$Operation>): void;
2746
+ upgrade(callback: BodyResponseCallback<Schema$Operation>): void;
2178
2747
  }
2179
2748
  export interface Params$Resource$Projects$Locations$Clusters$Create extends StandardParameters {
2180
2749
  /**
@@ -2186,11 +2755,11 @@ export declare namespace alloydb_v1 {
2186
2755
  */
2187
2756
  parent?: string;
2188
2757
  /**
2189
- * 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).
2758
+ * 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).
2190
2759
  */
2191
2760
  requestId?: string;
2192
2761
  /**
2193
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.
2762
+ * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
2194
2763
  */
2195
2764
  validateOnly?: boolean;
2196
2765
  /**
@@ -2208,11 +2777,11 @@ export declare namespace alloydb_v1 {
2208
2777
  */
2209
2778
  parent?: string;
2210
2779
  /**
2211
- * 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).
2780
+ * 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).
2212
2781
  */
2213
2782
  requestId?: string;
2214
2783
  /**
2215
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.
2784
+ * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
2216
2785
  */
2217
2786
  validateOnly?: boolean;
2218
2787
  /**
@@ -2234,14 +2803,24 @@ export declare namespace alloydb_v1 {
2234
2803
  */
2235
2804
  name?: string;
2236
2805
  /**
2237
- * 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).
2806
+ * 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).
2238
2807
  */
2239
2808
  requestId?: string;
2240
2809
  /**
2241
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.
2810
+ * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
2242
2811
  */
2243
2812
  validateOnly?: boolean;
2244
2813
  }
2814
+ export interface Params$Resource$Projects$Locations$Clusters$Export extends StandardParameters {
2815
+ /**
2816
+ * Required. The resource name of the cluster.
2817
+ */
2818
+ name?: string;
2819
+ /**
2820
+ * Request body metadata
2821
+ */
2822
+ requestBody?: Schema$ExportClusterRequest;
2823
+ }
2245
2824
  export interface Params$Resource$Projects$Locations$Clusters$Get extends StandardParameters {
2246
2825
  /**
2247
2826
  * Required. The name of the resource. For the required format, see the comment on the Cluster.name field.
@@ -2252,6 +2831,16 @@ export declare namespace alloydb_v1 {
2252
2831
  */
2253
2832
  view?: string;
2254
2833
  }
2834
+ export interface Params$Resource$Projects$Locations$Clusters$Import extends StandardParameters {
2835
+ /**
2836
+ * Required. The resource name of the cluster.
2837
+ */
2838
+ name?: string;
2839
+ /**
2840
+ * Request body metadata
2841
+ */
2842
+ requestBody?: Schema$ImportClusterRequest;
2843
+ }
2255
2844
  export interface Params$Resource$Projects$Locations$Clusters$List extends StandardParameters {
2256
2845
  /**
2257
2846
  * Optional. Filtering results
@@ -2284,7 +2873,7 @@ export declare namespace alloydb_v1 {
2284
2873
  */
2285
2874
  name?: string;
2286
2875
  /**
2287
- * 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).
2876
+ * 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).
2288
2877
  */
2289
2878
  requestId?: string;
2290
2879
  /**
@@ -2292,7 +2881,7 @@ export declare namespace alloydb_v1 {
2292
2881
  */
2293
2882
  updateMask?: string;
2294
2883
  /**
2295
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request.
2884
+ * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
2296
2885
  */
2297
2886
  validateOnly?: boolean;
2298
2887
  /**
@@ -2320,6 +2909,16 @@ export declare namespace alloydb_v1 {
2320
2909
  */
2321
2910
  requestBody?: Schema$RestoreClusterRequest;
2322
2911
  }
2912
+ export interface Params$Resource$Projects$Locations$Clusters$Restorefromcloudsql extends StandardParameters {
2913
+ /**
2914
+ * Required. The location of the new cluster. For the required format, see the comment on Cluster.name field.
2915
+ */
2916
+ parent?: string;
2917
+ /**
2918
+ * Request body metadata
2919
+ */
2920
+ requestBody?: Schema$RestoreFromCloudSQLRequest;
2921
+ }
2323
2922
  export interface Params$Resource$Projects$Locations$Clusters$Switchover extends StandardParameters {
2324
2923
  /**
2325
2924
  * Required. The name of the resource. For the required format, see the comment on the Cluster.name field
@@ -2330,6 +2929,16 @@ export declare namespace alloydb_v1 {
2330
2929
  */
2331
2930
  requestBody?: Schema$SwitchoverClusterRequest;
2332
2931
  }
2932
+ export interface Params$Resource$Projects$Locations$Clusters$Upgrade extends StandardParameters {
2933
+ /**
2934
+ * Required. The resource name of the cluster.
2935
+ */
2936
+ name?: string;
2937
+ /**
2938
+ * Request body metadata
2939
+ */
2940
+ requestBody?: Schema$UpgradeClusterRequest;
2941
+ }
2333
2942
  export class Resource$Projects$Locations$Clusters$Instances {
2334
2943
  context: APIRequestContext;
2335
2944
  constructor(context: APIRequestContext);
@@ -2484,11 +3093,11 @@ export declare namespace alloydb_v1 {
2484
3093
  */
2485
3094
  parent?: string;
2486
3095
  /**
2487
- * 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).
3096
+ * 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).
2488
3097
  */
2489
3098
  requestId?: string;
2490
3099
  /**
2491
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.
3100
+ * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
2492
3101
  */
2493
3102
  validateOnly?: boolean;
2494
3103
  /**
@@ -2506,11 +3115,11 @@ export declare namespace alloydb_v1 {
2506
3115
  */
2507
3116
  parent?: string;
2508
3117
  /**
2509
- * 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).
3118
+ * 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).
2510
3119
  */
2511
3120
  requestId?: string;
2512
3121
  /**
2513
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.
3122
+ * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
2514
3123
  */
2515
3124
  validateOnly?: boolean;
2516
3125
  /**
@@ -2528,11 +3137,11 @@ export declare namespace alloydb_v1 {
2528
3137
  */
2529
3138
  name?: string;
2530
3139
  /**
2531
- * 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).
3140
+ * 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).
2532
3141
  */
2533
3142
  requestId?: string;
2534
3143
  /**
2535
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.
3144
+ * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
2536
3145
  */
2537
3146
  validateOnly?: boolean;
2538
3147
  }
@@ -2562,7 +3171,7 @@ export declare namespace alloydb_v1 {
2562
3171
  */
2563
3172
  parent?: string;
2564
3173
  /**
2565
- * 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).
3174
+ * 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).
2566
3175
  */
2567
3176
  requestId?: string;
2568
3177
  }
@@ -2608,7 +3217,7 @@ export declare namespace alloydb_v1 {
2608
3217
  */
2609
3218
  name?: string;
2610
3219
  /**
2611
- * 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).
3220
+ * 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).
2612
3221
  */
2613
3222
  requestId?: string;
2614
3223
  /**
@@ -2616,7 +3225,7 @@ export declare namespace alloydb_v1 {
2616
3225
  */
2617
3226
  updateMask?: string;
2618
3227
  /**
2619
- * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request.
3228
+ * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
2620
3229
  */
2621
3230
  validateOnly?: boolean;
2622
3231
  /**
@@ -2714,7 +3323,7 @@ export declare namespace alloydb_v1 {
2714
3323
  */
2715
3324
  parent?: string;
2716
3325
  /**
2717
- * 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).
3326
+ * 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).
2718
3327
  */
2719
3328
  requestId?: string;
2720
3329
  /**
@@ -2736,7 +3345,7 @@ export declare namespace alloydb_v1 {
2736
3345
  */
2737
3346
  name?: string;
2738
3347
  /**
2739
- * 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).
3348
+ * 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).
2740
3349
  */
2741
3350
  requestId?: string;
2742
3351
  /**
@@ -2782,7 +3391,7 @@ export declare namespace alloydb_v1 {
2782
3391
  */
2783
3392
  name?: string;
2784
3393
  /**
2785
- * 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).
3394
+ * 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).
2786
3395
  */
2787
3396
  requestId?: string;
2788
3397
  /**
@@ -2802,7 +3411,7 @@ export declare namespace alloydb_v1 {
2802
3411
  context: APIRequestContext;
2803
3412
  constructor(context: APIRequestContext);
2804
3413
  /**
2805
- * 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`.
3414
+ * 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`.
2806
3415
  *
2807
3416
  * @param params - Parameters for request
2808
3417
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2929,6 +3538,10 @@ export declare namespace alloydb_v1 {
2929
3538
  * 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.
2930
3539
  */
2931
3540
  parent?: string;
3541
+ /**
3542
+ * Optional. The scope for which supported flags are requested. If not specified, default is DATABASE.
3543
+ */
3544
+ scope?: string;
2932
3545
  }
2933
3546
  export {};
2934
3547
  }