@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/v1beta.ts CHANGED
@@ -419,6 +419,14 @@ export namespace alloydb_v1beta {
419
419
  * Output only. The current serving state of the cluster.
420
420
  */
421
421
  state?: string | null;
422
+ /**
423
+ * Optional. Subscription type of the cluster.
424
+ */
425
+ subscriptionType?: string | null;
426
+ /**
427
+ * Output only. Metadata for free trial clusters
428
+ */
429
+ trialMetadata?: Schema$TrialMetadata;
422
430
  /**
423
431
  * 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.
424
432
  */
@@ -717,6 +725,10 @@ export namespace alloydb_v1beta {
717
725
  * Configuration for observability.
718
726
  */
719
727
  observabilityConfig?: Schema$ObservabilityInstanceConfig;
728
+ /**
729
+ * Output only. All outbound public IP addresses configured for the instance.
730
+ */
731
+ outboundPublicIpAddresses?: string[] | null;
720
732
  /**
721
733
  * Optional. The configuration for Private Service Connect (PSC) for the instance.
722
734
  */
@@ -770,6 +782,10 @@ export namespace alloydb_v1beta {
770
782
  * Optional. A list of external network authorized to access this instance.
771
783
  */
772
784
  authorizedExternalNetworks?: Schema$AuthorizedNetwork[];
785
+ /**
786
+ * Optional. Enabling an outbound public IP address to support a database server sending requests out into the internet.
787
+ */
788
+ enableOutboundPublicIp?: boolean | null;
773
789
  /**
774
790
  * Optional. Enabling public ip for the instance.
775
791
  */
@@ -978,7 +994,7 @@ export namespace alloydb_v1beta {
978
994
  */
979
995
  export interface Schema$ObservabilityInstanceConfig {
980
996
  /**
981
- * 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.
997
+ * Observability feature status for an instance. This flag is turned "off" by default.
982
998
  */
983
999
  enabled?: boolean | null;
984
1000
  /**
@@ -990,7 +1006,7 @@ export namespace alloydb_v1beta {
990
1006
  */
991
1007
  preserveComments?: boolean | null;
992
1008
  /**
993
- * 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.
1009
+ * 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.
994
1010
  */
995
1011
  queryPlansPerMinute?: number | null;
996
1012
  /**
@@ -1356,6 +1372,7 @@ export namespace alloydb_v1beta {
1356
1372
  /**
1357
1373
  * More feed data would be added in subsequent CLs
1358
1374
  */
1375
+ observabilityMetricData?: Schema$StorageDatabasecenterPartnerapiV1mainObservabilityMetricData;
1359
1376
  recommendationSignalData?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData;
1360
1377
  resourceHealthSignalData?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData;
1361
1378
  /**
@@ -1487,6 +1504,10 @@ export namespace alloydb_v1beta {
1487
1504
  * The resource location. REQUIRED
1488
1505
  */
1489
1506
  location?: string | null;
1507
+ /**
1508
+ * Machine configuration for this resource.
1509
+ */
1510
+ machineConfiguration?: Schema$StorageDatabasecenterPartnerapiV1mainMachineConfiguration;
1490
1511
  /**
1491
1512
  * 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.
1492
1513
  */
@@ -1507,10 +1528,6 @@ export namespace alloydb_v1beta {
1507
1528
  * The time at which the resource was updated and recorded at partner service.
1508
1529
  */
1509
1530
  updationTime?: string | null;
1510
- /**
1511
- * User-provided labels, represented as a dictionary where each label is a single key value pair.
1512
- */
1513
- userLabels?: {[key: string]: string} | null;
1514
1531
  /**
1515
1532
  * User-provided labels associated with the resource
1516
1533
  */
@@ -1566,6 +1583,41 @@ export namespace alloydb_v1beta {
1566
1583
  */
1567
1584
  type?: string | null;
1568
1585
  }
1586
+ /**
1587
+ * MachineConfiguration describes the configuration of a machine specific to Database Resource.
1588
+ */
1589
+ export interface Schema$StorageDatabasecenterPartnerapiV1mainMachineConfiguration {
1590
+ /**
1591
+ * The number of CPUs. TODO(b/342344482, b/342346271) add proto validations again after bug fix.
1592
+ */
1593
+ cpuCount?: number | null;
1594
+ /**
1595
+ * Memory size in bytes. TODO(b/342344482, b/342346271) add proto validations again after bug fix.
1596
+ */
1597
+ memorySizeInBytes?: string | null;
1598
+ }
1599
+ export interface Schema$StorageDatabasecenterPartnerapiV1mainObservabilityMetricData {
1600
+ /**
1601
+ * Required. Type of aggregation performed on the metric.
1602
+ */
1603
+ aggregationType?: string | null;
1604
+ /**
1605
+ * Required. Type of metric like CPU, Memory, etc.
1606
+ */
1607
+ metricType?: string | null;
1608
+ /**
1609
+ * Required. The time the metric value was observed.
1610
+ */
1611
+ observationTime?: string | null;
1612
+ /**
1613
+ * Required. Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel
1614
+ */
1615
+ resourceName?: string | null;
1616
+ /**
1617
+ * Required. Value of the metric type.
1618
+ */
1619
+ value?: Schema$StorageDatabasecenterProtoCommonTypedValue;
1620
+ }
1569
1621
  /**
1570
1622
  * An error that occurred during a backup creation operation.
1571
1623
  */
@@ -1611,6 +1663,27 @@ export namespace alloydb_v1beta {
1611
1663
  */
1612
1664
  version?: string | null;
1613
1665
  }
1666
+ /**
1667
+ * TypedValue represents the value of a metric type. It can either be a double, an int64, a string or a bool.
1668
+ */
1669
+ export interface Schema$StorageDatabasecenterProtoCommonTypedValue {
1670
+ /**
1671
+ * For boolean value
1672
+ */
1673
+ boolValue?: boolean | null;
1674
+ /**
1675
+ * For double value
1676
+ */
1677
+ doubleValue?: number | null;
1678
+ /**
1679
+ * For integer value
1680
+ */
1681
+ int64Value?: string | null;
1682
+ /**
1683
+ * For string value
1684
+ */
1685
+ stringValue?: string | null;
1686
+ }
1614
1687
  /**
1615
1688
  * Restrictions on STRING type values
1616
1689
  */
@@ -1654,6 +1727,19 @@ export namespace alloydb_v1beta {
1654
1727
  supportedDbVersions?: string[] | null;
1655
1728
  valueType?: string | null;
1656
1729
  }
1730
+ /**
1731
+ * Message for switching over to a cluster
1732
+ */
1733
+ export interface Schema$SwitchoverClusterRequest {
1734
+ /**
1735
+ * 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).
1736
+ */
1737
+ requestId?: string | null;
1738
+ /**
1739
+ * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.
1740
+ */
1741
+ validateOnly?: boolean | null;
1742
+ }
1657
1743
  /**
1658
1744
  * A time based retention policy specifies that all backups within a certain time period should be retained.
1659
1745
  */
@@ -1663,6 +1749,23 @@ export namespace alloydb_v1beta {
1663
1749
  */
1664
1750
  retentionPeriod?: string | null;
1665
1751
  }
1752
+ /**
1753
+ * Contains information and all metadata related to TRIAL clusters.
1754
+ */
1755
+ export interface Schema$TrialMetadata {
1756
+ /**
1757
+ * End time of the trial cluster.
1758
+ */
1759
+ endTime?: string | null;
1760
+ /**
1761
+ * start time of the trial cluster.
1762
+ */
1763
+ startTime?: string | null;
1764
+ /**
1765
+ * Upgrade time of trial cluster to Standard cluster.
1766
+ */
1767
+ upgradeTime?: string | null;
1768
+ }
1666
1769
  /**
1667
1770
  * Policy to be used while updating the instance.
1668
1771
  */
@@ -3217,6 +3320,94 @@ export namespace alloydb_v1beta {
3217
3320
  return createAPIRequest<Schema$Operation>(parameters);
3218
3321
  }
3219
3322
  }
3323
+
3324
+ /**
3325
+ * 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.
3326
+ *
3327
+ * @param params - Parameters for request
3328
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
3329
+ * @param callback - Optional callback that handles the response.
3330
+ * @returns A promise if used with async/await, or void if used with a callback.
3331
+ */
3332
+ switchover(
3333
+ params: Params$Resource$Projects$Locations$Clusters$Switchover,
3334
+ options: StreamMethodOptions
3335
+ ): GaxiosPromise<Readable>;
3336
+ switchover(
3337
+ params?: Params$Resource$Projects$Locations$Clusters$Switchover,
3338
+ options?: MethodOptions
3339
+ ): GaxiosPromise<Schema$Operation>;
3340
+ switchover(
3341
+ params: Params$Resource$Projects$Locations$Clusters$Switchover,
3342
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
3343
+ callback: BodyResponseCallback<Readable>
3344
+ ): void;
3345
+ switchover(
3346
+ params: Params$Resource$Projects$Locations$Clusters$Switchover,
3347
+ options: MethodOptions | BodyResponseCallback<Schema$Operation>,
3348
+ callback: BodyResponseCallback<Schema$Operation>
3349
+ ): void;
3350
+ switchover(
3351
+ params: Params$Resource$Projects$Locations$Clusters$Switchover,
3352
+ callback: BodyResponseCallback<Schema$Operation>
3353
+ ): void;
3354
+ switchover(callback: BodyResponseCallback<Schema$Operation>): void;
3355
+ switchover(
3356
+ paramsOrCallback?:
3357
+ | Params$Resource$Projects$Locations$Clusters$Switchover
3358
+ | BodyResponseCallback<Schema$Operation>
3359
+ | BodyResponseCallback<Readable>,
3360
+ optionsOrCallback?:
3361
+ | MethodOptions
3362
+ | StreamMethodOptions
3363
+ | BodyResponseCallback<Schema$Operation>
3364
+ | BodyResponseCallback<Readable>,
3365
+ callback?:
3366
+ | BodyResponseCallback<Schema$Operation>
3367
+ | BodyResponseCallback<Readable>
3368
+ ): void | GaxiosPromise<Schema$Operation> | GaxiosPromise<Readable> {
3369
+ let params = (paramsOrCallback ||
3370
+ {}) as Params$Resource$Projects$Locations$Clusters$Switchover;
3371
+ let options = (optionsOrCallback || {}) as MethodOptions;
3372
+
3373
+ if (typeof paramsOrCallback === 'function') {
3374
+ callback = paramsOrCallback;
3375
+ params = {} as Params$Resource$Projects$Locations$Clusters$Switchover;
3376
+ options = {};
3377
+ }
3378
+
3379
+ if (typeof optionsOrCallback === 'function') {
3380
+ callback = optionsOrCallback;
3381
+ options = {};
3382
+ }
3383
+
3384
+ const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/';
3385
+ const parameters = {
3386
+ options: Object.assign(
3387
+ {
3388
+ url: (rootUrl + '/v1beta/{+name}:switchover').replace(
3389
+ /([^:]\/)\/+/g,
3390
+ '$1'
3391
+ ),
3392
+ method: 'POST',
3393
+ apiVersion: '',
3394
+ },
3395
+ options
3396
+ ),
3397
+ params,
3398
+ requiredParams: ['name'],
3399
+ pathParams: ['name'],
3400
+ context: this.context,
3401
+ };
3402
+ if (callback) {
3403
+ createAPIRequest<Schema$Operation>(
3404
+ parameters,
3405
+ callback as BodyResponseCallback<unknown>
3406
+ );
3407
+ } else {
3408
+ return createAPIRequest<Schema$Operation>(parameters);
3409
+ }
3410
+ }
3220
3411
  }
3221
3412
 
3222
3413
  export interface Params$Resource$Projects$Locations$Clusters$Create
@@ -3376,6 +3567,18 @@ export namespace alloydb_v1beta {
3376
3567
  */
3377
3568
  requestBody?: Schema$RestoreClusterRequest;
3378
3569
  }
3570
+ export interface Params$Resource$Projects$Locations$Clusters$Switchover
3571
+ extends StandardParameters {
3572
+ /**
3573
+ * Required. The name of the resource. For the required format, see the comment on the Cluster.name field
3574
+ */
3575
+ name?: string;
3576
+
3577
+ /**
3578
+ * Request body metadata
3579
+ */
3580
+ requestBody?: Schema$SwitchoverClusterRequest;
3581
+ }
3379
3582
 
3380
3583
  export class Resource$Projects$Locations$Clusters$Instances {
3381
3584
  context: APIRequestContext;