@googleapis/alloydb 7.0.0 → 10.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/v1alpha.ts CHANGED
@@ -310,6 +310,23 @@ export namespace alloydb_v1alpha {
310
310
  */
311
311
  exclusiveAction?: string | null;
312
312
  }
313
+ /**
314
+ * The source CloudSQL backup resource.
315
+ */
316
+ export interface Schema$CloudSQLBackupRunSource {
317
+ /**
318
+ * Required. The CloudSQL backup run ID.
319
+ */
320
+ backupRunId?: string | null;
321
+ /**
322
+ * Required. The CloudSQL instance ID.
323
+ */
324
+ instanceId?: string | null;
325
+ /**
326
+ * The project ID of the source CloudSQL instance. This should be the same as the AlloyDB cluster's project.
327
+ */
328
+ project?: string | null;
329
+ }
313
330
  /**
314
331
  * 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.
315
332
  */
@@ -326,6 +343,10 @@ export namespace alloydb_v1alpha {
326
343
  * Output only. Cluster created from backup.
327
344
  */
328
345
  backupSource?: Schema$BackupSource;
346
+ /**
347
+ * Output only. Cluster created from CloudSQL snapshot.
348
+ */
349
+ cloudsqlBackupRunSource?: Schema$CloudSQLBackupRunSource;
329
350
  /**
330
351
  * 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`
331
352
  */
@@ -431,6 +452,14 @@ export namespace alloydb_v1alpha {
431
452
  * Output only. The current serving state of the cluster.
432
453
  */
433
454
  state?: string | null;
455
+ /**
456
+ * Optional. Subscription type of the cluster.
457
+ */
458
+ subscriptionType?: string | null;
459
+ /**
460
+ * Output only. Metadata for free trial clusters
461
+ */
462
+ trialMetadata?: Schema$TrialMetadata;
434
463
  /**
435
464
  * Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
436
465
  */
@@ -440,6 +469,35 @@ export namespace alloydb_v1alpha {
440
469
  */
441
470
  updateTime?: string | null;
442
471
  }
472
+ /**
473
+ * Upgrade details of a cluster. This cluster can be primary or secondary.
474
+ */
475
+ export interface Schema$ClusterUpgradeDetails {
476
+ /**
477
+ * Cluster type which can either be primary or secondary.
478
+ */
479
+ clusterType?: string | null;
480
+ /**
481
+ * Database version of the cluster after the upgrade operation. This will be the target version if the upgrade was successful otherwise it remains the same as that before the upgrade operation.
482
+ */
483
+ databaseVersion?: string | null;
484
+ /**
485
+ * Upgrade details of the instances directly associated with this cluster.
486
+ */
487
+ instanceUpgradeDetails?: Schema$InstanceUpgradeDetails[];
488
+ /**
489
+ * Normalized name of the cluster
490
+ */
491
+ name?: string | null;
492
+ /**
493
+ * Array containing stage info associated with this cluster.
494
+ */
495
+ stageInfo?: Schema$StageInfo[];
496
+ /**
497
+ * Upgrade status of the cluster.
498
+ */
499
+ upgradeStatus?: string | null;
500
+ }
443
501
  /**
444
502
  * ConnectionInfo singleton resource. https://google.aip.dev/156
445
503
  */
@@ -729,6 +787,10 @@ export namespace alloydb_v1alpha {
729
787
  * Configuration for observability.
730
788
  */
731
789
  observabilityConfig?: Schema$ObservabilityInstanceConfig;
790
+ /**
791
+ * Output only. All outbound public IP addresses configured for the instance.
792
+ */
793
+ outboundPublicIpAddresses?: string[] | null;
732
794
  /**
733
795
  * Optional. The configuration for Private Service Connect (PSC) for the instance.
734
796
  */
@@ -786,11 +848,32 @@ export namespace alloydb_v1alpha {
786
848
  * Optional. A list of external network authorized to access this instance.
787
849
  */
788
850
  authorizedExternalNetworks?: Schema$AuthorizedNetwork[];
851
+ /**
852
+ * Optional. Enabling an outbound public IP address to support a database server sending requests out into the internet.
853
+ */
854
+ enableOutboundPublicIp?: boolean | null;
789
855
  /**
790
856
  * Optional. Enabling public ip for the instance.
791
857
  */
792
858
  enablePublicIp?: boolean | null;
793
859
  }
860
+ /**
861
+ * Details regarding the upgrade of instaces associated with a cluster.
862
+ */
863
+ export interface Schema$InstanceUpgradeDetails {
864
+ /**
865
+ * Instance type.
866
+ */
867
+ instanceType?: string | null;
868
+ /**
869
+ * Normalized name of the instance.
870
+ */
871
+ name?: string | null;
872
+ /**
873
+ * Upgrade status of the instance.
874
+ */
875
+ upgradeStatus?: string | null;
876
+ }
794
877
  /**
795
878
  * Restrictions on INTEGER type values.
796
879
  */
@@ -994,7 +1077,7 @@ export namespace alloydb_v1alpha {
994
1077
  */
995
1078
  export interface Schema$ObservabilityInstanceConfig {
996
1079
  /**
997
- * Observability feature status for an instance. This is a read-only flag and modifiable only by producer API. This flag is turned "off" by default.
1080
+ * Observability feature status for an instance. This flag is turned "off" by default.
998
1081
  */
999
1082
  enabled?: boolean | null;
1000
1083
  /**
@@ -1006,7 +1089,7 @@ export namespace alloydb_v1alpha {
1006
1089
  */
1007
1090
  preserveComments?: boolean | null;
1008
1091
  /**
1009
- * Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 to 20 is considered valid.
1092
+ * 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.
1010
1093
  */
1011
1094
  queryPlansPerMinute?: number | null;
1012
1095
  /**
@@ -1017,6 +1100,10 @@ export namespace alloydb_v1alpha {
1017
1100
  * Track actively running queries on the instance. If not set, this flag is "off" by default.
1018
1101
  */
1019
1102
  trackActiveQueries?: boolean | null;
1103
+ /**
1104
+ * Track client address for an instance. If not set, default value is "off".
1105
+ */
1106
+ trackClientAddress?: boolean | null;
1020
1107
  /**
1021
1108
  * 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.
1022
1109
  */
@@ -1189,6 +1276,10 @@ export namespace alloydb_v1alpha {
1189
1276
  nodeCount?: number | null;
1190
1277
  }
1191
1278
  export interface Schema$RestartInstanceRequest {
1279
+ /**
1280
+ * Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Only applicable for read instances.
1281
+ */
1282
+ nodeIds?: string[] | null;
1192
1283
  /**
1193
1284
  * 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).
1194
1285
  */
@@ -1249,6 +1340,23 @@ export namespace alloydb_v1alpha {
1249
1340
  */
1250
1341
  sslMode?: string | null;
1251
1342
  }
1343
+ /**
1344
+ * Stage information for different stages in the upgrade process.
1345
+ */
1346
+ export interface Schema$StageInfo {
1347
+ /**
1348
+ * logs_url is the URL for the logs associated with a stage if that stage has logs. Right now, only three stages have logs: ALLOYDB_PRECHECK, PG_UPGRADE_CHECK, PRIMARY_INSTANCE_UPGRADE.
1349
+ */
1350
+ logsUrl?: string | null;
1351
+ /**
1352
+ * The stage.
1353
+ */
1354
+ stage?: string | null;
1355
+ /**
1356
+ * Status of the stage.
1357
+ */
1358
+ status?: string | null;
1359
+ }
1252
1360
  /**
1253
1361
  * 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).
1254
1362
  */
@@ -1333,29 +1441,13 @@ export namespace alloydb_v1alpha {
1333
1441
  version?: string | null;
1334
1442
  }
1335
1443
  /**
1336
- * Any custom metadata associated with the resource. i.e. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data
1444
+ * Any custom metadata associated with the resource. e.g. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data
1337
1445
  */
1338
1446
  export interface Schema$StorageDatabasecenterPartnerapiV1mainCustomMetadataData {
1339
- databaseMetadata?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseMetadata[];
1340
- }
1341
- /**
1342
- * Metadata for individual databases created in an instance. i.e. spanner instance can have multiple databases with unique configuration settings.
1343
- */
1344
- export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseMetadata {
1345
1447
  /**
1346
- * Backup configuration for this database
1347
- */
1348
- backupConfiguration?: Schema$StorageDatabasecenterPartnerapiV1mainBackupConfiguration;
1349
- /**
1350
- * Information about the last backup attempt for this database
1448
+ * Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration.
1351
1449
  */
1352
- backupRun?: Schema$StorageDatabasecenterPartnerapiV1mainBackupRun;
1353
- product?: Schema$StorageDatabasecenterProtoCommonProduct;
1354
- resourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId;
1355
- /**
1356
- * Required. Database name. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel
1357
- */
1358
- resourceName?: string | null;
1450
+ internalResourceMetadata?: Schema$StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata[];
1359
1451
  }
1360
1452
  /**
1361
1453
  * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform.
@@ -1369,9 +1461,7 @@ export namespace alloydb_v1alpha {
1369
1461
  * Required. Type feed to be ingested into condor
1370
1462
  */
1371
1463
  feedType?: string | null;
1372
- /**
1373
- * More feed data would be added in subsequent CLs
1374
- */
1464
+ observabilityMetricData?: Schema$StorageDatabasecenterPartnerapiV1mainObservabilityMetricData;
1375
1465
  recommendationSignalData?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData;
1376
1466
  resourceHealthSignalData?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData;
1377
1467
  /**
@@ -1428,6 +1518,10 @@ export namespace alloydb_v1alpha {
1428
1518
  * Required. Unique identifier for the signal. This is an unique id which would be mainatined by partner to identify a signal.
1429
1519
  */
1430
1520
  signalId?: string | null;
1521
+ /**
1522
+ * The severity of the signal, such as if it's a HIGH or LOW severity.
1523
+ */
1524
+ signalSeverity?: string | null;
1431
1525
  /**
1432
1526
  * Required. Type of signal, for example, `AVAILABLE_IN_MULTIPLE_ZONES`, `LOGGING_MOST_ERRORS`, etc.
1433
1527
  */
@@ -1447,7 +1541,7 @@ export namespace alloydb_v1alpha {
1447
1541
  */
1448
1542
  providerDescription?: string | null;
1449
1543
  /**
1450
- * Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel
1544
+ * Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance, spanner.googleapis.com/Database, firestore.googleapis.com/Database, sqladmin.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel
1451
1545
  */
1452
1546
  resourceType?: string | null;
1453
1547
  /**
@@ -1503,6 +1597,10 @@ export namespace alloydb_v1alpha {
1503
1597
  * The resource location. REQUIRED
1504
1598
  */
1505
1599
  location?: string | null;
1600
+ /**
1601
+ * Machine configuration for this resource.
1602
+ */
1603
+ machineConfiguration?: Schema$StorageDatabasecenterPartnerapiV1mainMachineConfiguration;
1506
1604
  /**
1507
1605
  * 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.
1508
1606
  */
@@ -1523,10 +1621,6 @@ export namespace alloydb_v1alpha {
1523
1621
  * The time at which the resource was updated and recorded at partner service.
1524
1622
  */
1525
1623
  updationTime?: string | null;
1526
- /**
1527
- * User-provided labels, represented as a dictionary where each label is a single key value pair.
1528
- */
1529
- userLabels?: {[key: string]: string} | null;
1530
1624
  /**
1531
1625
  * User-provided labels associated with the resource
1532
1626
  */
@@ -1582,6 +1676,60 @@ export namespace alloydb_v1alpha {
1582
1676
  */
1583
1677
  type?: string | null;
1584
1678
  }
1679
+ /**
1680
+ * 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.
1681
+ */
1682
+ export interface Schema$StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata {
1683
+ /**
1684
+ * Backup configuration for this database
1685
+ */
1686
+ backupConfiguration?: Schema$StorageDatabasecenterPartnerapiV1mainBackupConfiguration;
1687
+ /**
1688
+ * Information about the last backup attempt for this database
1689
+ */
1690
+ backupRun?: Schema$StorageDatabasecenterPartnerapiV1mainBackupRun;
1691
+ product?: Schema$StorageDatabasecenterProtoCommonProduct;
1692
+ resourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId;
1693
+ /**
1694
+ * Required. internal resource name for spanner this will be database name e.g."spanner.googleapis.com/projects/123/abc/instances/inst1/databases/db1"
1695
+ */
1696
+ resourceName?: string | null;
1697
+ }
1698
+ /**
1699
+ * MachineConfiguration describes the configuration of a machine specific to Database Resource.
1700
+ */
1701
+ export interface Schema$StorageDatabasecenterPartnerapiV1mainMachineConfiguration {
1702
+ /**
1703
+ * The number of CPUs. TODO(b/342344482, b/342346271) add proto validations again after bug fix.
1704
+ */
1705
+ cpuCount?: number | null;
1706
+ /**
1707
+ * Memory size in bytes. TODO(b/342344482, b/342346271) add proto validations again after bug fix.
1708
+ */
1709
+ memorySizeInBytes?: string | null;
1710
+ }
1711
+ export interface Schema$StorageDatabasecenterPartnerapiV1mainObservabilityMetricData {
1712
+ /**
1713
+ * Required. Type of aggregation performed on the metric.
1714
+ */
1715
+ aggregationType?: string | null;
1716
+ /**
1717
+ * Required. Type of metric like CPU, Memory, etc.
1718
+ */
1719
+ metricType?: string | null;
1720
+ /**
1721
+ * Required. The time the metric value was observed.
1722
+ */
1723
+ observationTime?: string | null;
1724
+ /**
1725
+ * Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel
1726
+ */
1727
+ resourceName?: string | null;
1728
+ /**
1729
+ * Required. Value of the metric type.
1730
+ */
1731
+ value?: Schema$StorageDatabasecenterProtoCommonTypedValue;
1732
+ }
1585
1733
  /**
1586
1734
  * An error that occurred during a backup creation operation.
1587
1735
  */
@@ -1627,6 +1775,27 @@ export namespace alloydb_v1alpha {
1627
1775
  */
1628
1776
  version?: string | null;
1629
1777
  }
1778
+ /**
1779
+ * TypedValue represents the value of a metric type. It can either be a double, an int64, a string or a bool.
1780
+ */
1781
+ export interface Schema$StorageDatabasecenterProtoCommonTypedValue {
1782
+ /**
1783
+ * For boolean value
1784
+ */
1785
+ boolValue?: boolean | null;
1786
+ /**
1787
+ * For double value
1788
+ */
1789
+ doubleValue?: number | null;
1790
+ /**
1791
+ * For integer value
1792
+ */
1793
+ int64Value?: string | null;
1794
+ /**
1795
+ * For string value
1796
+ */
1797
+ stringValue?: string | null;
1798
+ }
1630
1799
  /**
1631
1800
  * Restrictions on STRING type values
1632
1801
  */
@@ -1670,6 +1839,19 @@ export namespace alloydb_v1alpha {
1670
1839
  supportedDbVersions?: string[] | null;
1671
1840
  valueType?: string | null;
1672
1841
  }
1842
+ /**
1843
+ * Message for switching over to a cluster
1844
+ */
1845
+ export interface Schema$SwitchoverClusterRequest {
1846
+ /**
1847
+ * 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).
1848
+ */
1849
+ requestId?: string | null;
1850
+ /**
1851
+ * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.
1852
+ */
1853
+ validateOnly?: boolean | null;
1854
+ }
1673
1855
  /**
1674
1856
  * A time based retention policy specifies that all backups within a certain time period should be retained.
1675
1857
  */
@@ -1679,6 +1861,27 @@ export namespace alloydb_v1alpha {
1679
1861
  */
1680
1862
  retentionPeriod?: string | null;
1681
1863
  }
1864
+ /**
1865
+ * Contains information and all metadata related to TRIAL clusters.
1866
+ */
1867
+ export interface Schema$TrialMetadata {
1868
+ /**
1869
+ * End time of the trial cluster.
1870
+ */
1871
+ endTime?: string | null;
1872
+ /**
1873
+ * grace end time of the cluster.
1874
+ */
1875
+ graceEndTime?: string | null;
1876
+ /**
1877
+ * start time of the trial cluster.
1878
+ */
1879
+ startTime?: string | null;
1880
+ /**
1881
+ * Upgrade time of trial cluster to Standard cluster.
1882
+ */
1883
+ upgradeTime?: string | null;
1884
+ }
1682
1885
  /**
1683
1886
  * Policy to be used while updating the instance.
1684
1887
  */
@@ -1688,6 +1891,44 @@ export namespace alloydb_v1alpha {
1688
1891
  */
1689
1892
  mode?: string | null;
1690
1893
  }
1894
+ /**
1895
+ * Upgrades a cluster.
1896
+ */
1897
+ export interface Schema$UpgradeClusterRequest {
1898
+ /**
1899
+ * 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.
1900
+ */
1901
+ etag?: string | null;
1902
+ /**
1903
+ * 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).
1904
+ */
1905
+ requestId?: string | null;
1906
+ /**
1907
+ * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but does not actually execute the upgrade.
1908
+ */
1909
+ validateOnly?: boolean | null;
1910
+ /**
1911
+ * Required. The version the cluster is going to be upgraded to.
1912
+ */
1913
+ version?: string | null;
1914
+ }
1915
+ /**
1916
+ * UpgradeClusterResponse contains the response for upgrade cluster operation.
1917
+ */
1918
+ export interface Schema$UpgradeClusterResponse {
1919
+ /**
1920
+ * Array of upgrade details for the current cluster and all the secondary clusters associated with this cluster.
1921
+ */
1922
+ clusterUpgradeDetails?: Schema$ClusterUpgradeDetails[];
1923
+ /**
1924
+ * A user friendly message summarising the upgrade operation details and the next steps for the user if there is any.
1925
+ */
1926
+ message?: string | null;
1927
+ /**
1928
+ * Status of upgrade operation.
1929
+ */
1930
+ status?: string | null;
1931
+ }
1691
1932
  /**
1692
1933
  * Message describing User object.
1693
1934
  */
@@ -3233,6 +3474,182 @@ export namespace alloydb_v1alpha {
3233
3474
  return createAPIRequest<Schema$Operation>(parameters);
3234
3475
  }
3235
3476
  }
3477
+
3478
+ /**
3479
+ * 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.
3480
+ *
3481
+ * @param params - Parameters for request
3482
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
3483
+ * @param callback - Optional callback that handles the response.
3484
+ * @returns A promise if used with async/await, or void if used with a callback.
3485
+ */
3486
+ switchover(
3487
+ params: Params$Resource$Projects$Locations$Clusters$Switchover,
3488
+ options: StreamMethodOptions
3489
+ ): GaxiosPromise<Readable>;
3490
+ switchover(
3491
+ params?: Params$Resource$Projects$Locations$Clusters$Switchover,
3492
+ options?: MethodOptions
3493
+ ): GaxiosPromise<Schema$Operation>;
3494
+ switchover(
3495
+ params: Params$Resource$Projects$Locations$Clusters$Switchover,
3496
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
3497
+ callback: BodyResponseCallback<Readable>
3498
+ ): void;
3499
+ switchover(
3500
+ params: Params$Resource$Projects$Locations$Clusters$Switchover,
3501
+ options: MethodOptions | BodyResponseCallback<Schema$Operation>,
3502
+ callback: BodyResponseCallback<Schema$Operation>
3503
+ ): void;
3504
+ switchover(
3505
+ params: Params$Resource$Projects$Locations$Clusters$Switchover,
3506
+ callback: BodyResponseCallback<Schema$Operation>
3507
+ ): void;
3508
+ switchover(callback: BodyResponseCallback<Schema$Operation>): void;
3509
+ switchover(
3510
+ paramsOrCallback?:
3511
+ | Params$Resource$Projects$Locations$Clusters$Switchover
3512
+ | BodyResponseCallback<Schema$Operation>
3513
+ | BodyResponseCallback<Readable>,
3514
+ optionsOrCallback?:
3515
+ | MethodOptions
3516
+ | StreamMethodOptions
3517
+ | BodyResponseCallback<Schema$Operation>
3518
+ | BodyResponseCallback<Readable>,
3519
+ callback?:
3520
+ | BodyResponseCallback<Schema$Operation>
3521
+ | BodyResponseCallback<Readable>
3522
+ ): void | GaxiosPromise<Schema$Operation> | GaxiosPromise<Readable> {
3523
+ let params = (paramsOrCallback ||
3524
+ {}) as Params$Resource$Projects$Locations$Clusters$Switchover;
3525
+ let options = (optionsOrCallback || {}) as MethodOptions;
3526
+
3527
+ if (typeof paramsOrCallback === 'function') {
3528
+ callback = paramsOrCallback;
3529
+ params = {} as Params$Resource$Projects$Locations$Clusters$Switchover;
3530
+ options = {};
3531
+ }
3532
+
3533
+ if (typeof optionsOrCallback === 'function') {
3534
+ callback = optionsOrCallback;
3535
+ options = {};
3536
+ }
3537
+
3538
+ const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/';
3539
+ const parameters = {
3540
+ options: Object.assign(
3541
+ {
3542
+ url: (rootUrl + '/v1alpha/{+name}:switchover').replace(
3543
+ /([^:]\/)\/+/g,
3544
+ '$1'
3545
+ ),
3546
+ method: 'POST',
3547
+ apiVersion: '',
3548
+ },
3549
+ options
3550
+ ),
3551
+ params,
3552
+ requiredParams: ['name'],
3553
+ pathParams: ['name'],
3554
+ context: this.context,
3555
+ };
3556
+ if (callback) {
3557
+ createAPIRequest<Schema$Operation>(
3558
+ parameters,
3559
+ callback as BodyResponseCallback<unknown>
3560
+ );
3561
+ } else {
3562
+ return createAPIRequest<Schema$Operation>(parameters);
3563
+ }
3564
+ }
3565
+
3566
+ /**
3567
+ * Upgrades a single Cluster. Imperative only.
3568
+ *
3569
+ * @param params - Parameters for request
3570
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
3571
+ * @param callback - Optional callback that handles the response.
3572
+ * @returns A promise if used with async/await, or void if used with a callback.
3573
+ */
3574
+ upgrade(
3575
+ params: Params$Resource$Projects$Locations$Clusters$Upgrade,
3576
+ options: StreamMethodOptions
3577
+ ): GaxiosPromise<Readable>;
3578
+ upgrade(
3579
+ params?: Params$Resource$Projects$Locations$Clusters$Upgrade,
3580
+ options?: MethodOptions
3581
+ ): GaxiosPromise<Schema$Operation>;
3582
+ upgrade(
3583
+ params: Params$Resource$Projects$Locations$Clusters$Upgrade,
3584
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
3585
+ callback: BodyResponseCallback<Readable>
3586
+ ): void;
3587
+ upgrade(
3588
+ params: Params$Resource$Projects$Locations$Clusters$Upgrade,
3589
+ options: MethodOptions | BodyResponseCallback<Schema$Operation>,
3590
+ callback: BodyResponseCallback<Schema$Operation>
3591
+ ): void;
3592
+ upgrade(
3593
+ params: Params$Resource$Projects$Locations$Clusters$Upgrade,
3594
+ callback: BodyResponseCallback<Schema$Operation>
3595
+ ): void;
3596
+ upgrade(callback: BodyResponseCallback<Schema$Operation>): void;
3597
+ upgrade(
3598
+ paramsOrCallback?:
3599
+ | Params$Resource$Projects$Locations$Clusters$Upgrade
3600
+ | BodyResponseCallback<Schema$Operation>
3601
+ | BodyResponseCallback<Readable>,
3602
+ optionsOrCallback?:
3603
+ | MethodOptions
3604
+ | StreamMethodOptions
3605
+ | BodyResponseCallback<Schema$Operation>
3606
+ | BodyResponseCallback<Readable>,
3607
+ callback?:
3608
+ | BodyResponseCallback<Schema$Operation>
3609
+ | BodyResponseCallback<Readable>
3610
+ ): void | GaxiosPromise<Schema$Operation> | GaxiosPromise<Readable> {
3611
+ let params = (paramsOrCallback ||
3612
+ {}) as Params$Resource$Projects$Locations$Clusters$Upgrade;
3613
+ let options = (optionsOrCallback || {}) as MethodOptions;
3614
+
3615
+ if (typeof paramsOrCallback === 'function') {
3616
+ callback = paramsOrCallback;
3617
+ params = {} as Params$Resource$Projects$Locations$Clusters$Upgrade;
3618
+ options = {};
3619
+ }
3620
+
3621
+ if (typeof optionsOrCallback === 'function') {
3622
+ callback = optionsOrCallback;
3623
+ options = {};
3624
+ }
3625
+
3626
+ const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/';
3627
+ const parameters = {
3628
+ options: Object.assign(
3629
+ {
3630
+ url: (rootUrl + '/v1alpha/{+name}:upgrade').replace(
3631
+ /([^:]\/)\/+/g,
3632
+ '$1'
3633
+ ),
3634
+ method: 'PATCH',
3635
+ apiVersion: '',
3636
+ },
3637
+ options
3638
+ ),
3639
+ params,
3640
+ requiredParams: ['name'],
3641
+ pathParams: ['name'],
3642
+ context: this.context,
3643
+ };
3644
+ if (callback) {
3645
+ createAPIRequest<Schema$Operation>(
3646
+ parameters,
3647
+ callback as BodyResponseCallback<unknown>
3648
+ );
3649
+ } else {
3650
+ return createAPIRequest<Schema$Operation>(parameters);
3651
+ }
3652
+ }
3236
3653
  }
3237
3654
 
3238
3655
  export interface Params$Resource$Projects$Locations$Clusters$Create
@@ -3392,6 +3809,30 @@ export namespace alloydb_v1alpha {
3392
3809
  */
3393
3810
  requestBody?: Schema$RestoreClusterRequest;
3394
3811
  }
3812
+ export interface Params$Resource$Projects$Locations$Clusters$Switchover
3813
+ extends StandardParameters {
3814
+ /**
3815
+ * Required. The name of the resource. For the required format, see the comment on the Cluster.name field
3816
+ */
3817
+ name?: string;
3818
+
3819
+ /**
3820
+ * Request body metadata
3821
+ */
3822
+ requestBody?: Schema$SwitchoverClusterRequest;
3823
+ }
3824
+ export interface Params$Resource$Projects$Locations$Clusters$Upgrade
3825
+ extends StandardParameters {
3826
+ /**
3827
+ * Required. The resource name of the cluster.
3828
+ */
3829
+ name?: string;
3830
+
3831
+ /**
3832
+ * Request body metadata
3833
+ */
3834
+ requestBody?: Schema$UpgradeClusterRequest;
3835
+ }
3395
3836
 
3396
3837
  export class Resource$Projects$Locations$Clusters$Instances {
3397
3838
  context: APIRequestContext;