@googleapis/alloydb 5.0.0 → 6.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/v1.ts CHANGED
@@ -124,6 +124,15 @@ export namespace alloydb_v1 {
124
124
  }
125
125
  }
126
126
 
127
+ /**
128
+ * AuthorizedNetwork contains metadata for an authorized network.
129
+ */
130
+ export interface Schema$AuthorizedNetwork {
131
+ /**
132
+ * CIDR range for one authorzied network of the instance.
133
+ */
134
+ cidrRange?: string | null;
135
+ }
127
136
  /**
128
137
  * Message describing the user-specified automated backup policy. All fields in the automated backup policy are optional. Defaults for each field are provided if they are not set.
129
138
  */
@@ -370,7 +379,7 @@ export namespace alloydb_v1 {
370
379
  */
371
380
  name?: string | null;
372
381
  /**
373
- * Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project\}/global/networks/{network_id\}". This is required to create a cluster. Deprecated, use network_config.network instead.
382
+ * Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project\}/global/networks/{network_id\}`. This is required to create a cluster. Deprecated, use network_config.network instead.
374
383
  */
375
384
  network?: string | null;
376
385
  networkConfig?: Schema$NetworkConfig;
@@ -423,6 +432,10 @@ export namespace alloydb_v1 {
423
432
  * The name of the ConnectionInfo singleton resource, e.g.: projects/{project\}/locations/{location\}/clusters/x/instances/x/connectionInfo This field currently has no semantic meaning.
424
433
  */
425
434
  name?: string | null;
435
+ /**
436
+ * Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.
437
+ */
438
+ publicIpAddress?: string | null;
426
439
  }
427
440
  /**
428
441
  * ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster.
@@ -514,40 +527,6 @@ export namespace alloydb_v1 {
514
527
  */
515
528
  validateOnly?: boolean | null;
516
529
  }
517
- /**
518
- * Message for requests to generate a client certificate signed by the Cluster CA.
519
- */
520
- export interface Schema$GenerateClientCertificateRequest {
521
- /**
522
- * Optional. An optional hint to the endpoint to generate the client certificate with the requested duration. The duration can be from 1 hour to 24 hours. The endpoint may or may not honor the hint. If the hint is left unspecified or is not honored, then the endpoint will pick an appropriate default duration.
523
- */
524
- certDuration?: string | null;
525
- /**
526
- * Optional. The public key from the client.
527
- */
528
- publicKey?: string | null;
529
- /**
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).
531
- */
532
- requestId?: string | null;
533
- /**
534
- * Optional. An optional hint to the endpoint to generate a client ceritificate that can be used by AlloyDB connectors to exchange additional metadata with the server after TLS handshake.
535
- */
536
- useMetadataExchange?: boolean | null;
537
- }
538
- /**
539
- * Message returned by a GenerateClientCertificate operation.
540
- */
541
- export interface Schema$GenerateClientCertificateResponse {
542
- /**
543
- * Optional. The pem-encoded cluster ca X.509 certificate.
544
- */
545
- caCert?: string | null;
546
- /**
547
- * Output only. The pem-encoded chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246.
548
- */
549
- pemCertificateChain?: string[] | null;
550
- }
551
530
  /**
552
531
  * The response message for Locations.ListLocations.
553
532
  */
@@ -684,10 +663,18 @@ export namespace alloydb_v1 {
684
663
  * Output only. The name of the instance resource with the format: * projects/{project\}/locations/{region\}/clusters/{cluster_id\}/instances/{instance_id\} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61\}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project\}/locations/{region\}/clusters/{cluster_id\}
685
664
  */
686
665
  name?: string | null;
666
+ /**
667
+ * Optional. Instance level network configuration.
668
+ */
669
+ networkConfig?: Schema$InstanceNetworkConfig;
687
670
  /**
688
671
  * Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.
689
672
  */
690
673
  nodes?: Schema$Node[];
674
+ /**
675
+ * Output only. The public IP addresses for the Instance. This is available ONLY when enable_public_ip is set. This is the connection endpoint for an end-user application.
676
+ */
677
+ publicIpAddress?: string | null;
691
678
  /**
692
679
  * Configuration for query insights.
693
680
  */
@@ -721,6 +708,19 @@ export namespace alloydb_v1 {
721
708
  */
722
709
  writableNode?: Schema$Node;
723
710
  }
711
+ /**
712
+ * Metadata related to instance level network configuration.
713
+ */
714
+ export interface Schema$InstanceNetworkConfig {
715
+ /**
716
+ * Optional. A list of external network authorized to access this instance.
717
+ */
718
+ authorizedExternalNetworks?: Schema$AuthorizedNetwork[];
719
+ /**
720
+ * Optional. Enabling public ip for the instance.
721
+ */
722
+ enablePublicIp?: boolean | null;
723
+ }
724
724
  /**
725
725
  * Restrictions on INTEGER type values.
726
726
  */
@@ -863,7 +863,7 @@ export namespace alloydb_v1 {
863
863
  */
864
864
  allocatedIpRange?: string | null;
865
865
  /**
866
- * Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project_number\}/global/networks/{network_id\}". This is required to create a cluster.
866
+ * Optional. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: `projects/{project_number\}/global/networks/{network_id\}`. This is required to create a cluster.
867
867
  */
868
868
  network?: string | null;
869
869
  }
@@ -1336,7 +1336,7 @@ export namespace alloydb_v1 {
1336
1336
  */
1337
1337
  location?: string | null;
1338
1338
  /**
1339
- * 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
1339
+ * 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.
1340
1340
  */
1341
1341
  primaryResourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId;
1342
1342
  /**
@@ -1359,13 +1359,17 @@ export namespace alloydb_v1 {
1359
1359
  * User-provided labels, represented as a dictionary where each label is a single key value pair.
1360
1360
  */
1361
1361
  userLabels?: {[key: string]: string} | null;
1362
+ /**
1363
+ * User-provided labels associated with the resource
1364
+ */
1365
+ userLabelSet?: Schema$StorageDatabasecenterPartnerapiV1mainUserLabels;
1362
1366
  }
1363
1367
  /**
1364
1368
  * Common model for database resource recommendation signal data.
1365
1369
  */
1366
1370
  export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData {
1367
1371
  /**
1368
- * Required. Any other additional metadata specific to recommendation
1372
+ * Optional. Any other additional metadata specific to recommendation
1369
1373
  */
1370
1374
  additionalMetadata?: {[key: string]: any} | null;
1371
1375
  /**
@@ -1418,6 +1422,7 @@ export namespace alloydb_v1 {
1418
1422
  * Identifies the specific error that occurred. REQUIRED
1419
1423
  */
1420
1424
  code?: string | null;
1425
+ errorType?: string | null;
1421
1426
  /**
1422
1427
  * Additional information about the error encountered. REQUIRED
1423
1428
  */
@@ -1431,6 +1436,12 @@ export namespace alloydb_v1 {
1431
1436
  retentionUnit?: string | null;
1432
1437
  timeBasedRetention?: string | null;
1433
1438
  }
1439
+ /**
1440
+ * 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.
1441
+ */
1442
+ export interface Schema$StorageDatabasecenterPartnerapiV1mainUserLabels {
1443
+ labels?: {[key: string]: string} | null;
1444
+ }
1434
1445
  /**
1435
1446
  * Product specification for Condor resources.
1436
1447
  */
@@ -2598,103 +2609,6 @@ export namespace alloydb_v1 {
2598
2609
  }
2599
2610
  }
2600
2611
 
2601
- /**
2602
- * Generate a client certificate signed by a Cluster CA. The sole purpose of this endpoint is to support AlloyDB connectors and the Auth Proxy client. The endpoint's behavior is subject to change without notice, so do not rely on its behavior remaining constant. Future changes will not break AlloyDB connectors or the Auth Proxy client.
2603
- *
2604
- * @param params - Parameters for request
2605
- * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
2606
- * @param callback - Optional callback that handles the response.
2607
- * @returns A promise if used with async/await, or void if used with a callback.
2608
- */
2609
- generateClientCertificate(
2610
- params: Params$Resource$Projects$Locations$Clusters$Generateclientcertificate,
2611
- options: StreamMethodOptions
2612
- ): GaxiosPromise<Readable>;
2613
- generateClientCertificate(
2614
- params?: Params$Resource$Projects$Locations$Clusters$Generateclientcertificate,
2615
- options?: MethodOptions
2616
- ): GaxiosPromise<Schema$GenerateClientCertificateResponse>;
2617
- generateClientCertificate(
2618
- params: Params$Resource$Projects$Locations$Clusters$Generateclientcertificate,
2619
- options: StreamMethodOptions | BodyResponseCallback<Readable>,
2620
- callback: BodyResponseCallback<Readable>
2621
- ): void;
2622
- generateClientCertificate(
2623
- params: Params$Resource$Projects$Locations$Clusters$Generateclientcertificate,
2624
- options:
2625
- | MethodOptions
2626
- | BodyResponseCallback<Schema$GenerateClientCertificateResponse>,
2627
- callback: BodyResponseCallback<Schema$GenerateClientCertificateResponse>
2628
- ): void;
2629
- generateClientCertificate(
2630
- params: Params$Resource$Projects$Locations$Clusters$Generateclientcertificate,
2631
- callback: BodyResponseCallback<Schema$GenerateClientCertificateResponse>
2632
- ): void;
2633
- generateClientCertificate(
2634
- callback: BodyResponseCallback<Schema$GenerateClientCertificateResponse>
2635
- ): void;
2636
- generateClientCertificate(
2637
- paramsOrCallback?:
2638
- | Params$Resource$Projects$Locations$Clusters$Generateclientcertificate
2639
- | BodyResponseCallback<Schema$GenerateClientCertificateResponse>
2640
- | BodyResponseCallback<Readable>,
2641
- optionsOrCallback?:
2642
- | MethodOptions
2643
- | StreamMethodOptions
2644
- | BodyResponseCallback<Schema$GenerateClientCertificateResponse>
2645
- | BodyResponseCallback<Readable>,
2646
- callback?:
2647
- | BodyResponseCallback<Schema$GenerateClientCertificateResponse>
2648
- | BodyResponseCallback<Readable>
2649
- ):
2650
- | void
2651
- | GaxiosPromise<Schema$GenerateClientCertificateResponse>
2652
- | GaxiosPromise<Readable> {
2653
- let params = (paramsOrCallback ||
2654
- {}) as Params$Resource$Projects$Locations$Clusters$Generateclientcertificate;
2655
- let options = (optionsOrCallback || {}) as MethodOptions;
2656
-
2657
- if (typeof paramsOrCallback === 'function') {
2658
- callback = paramsOrCallback;
2659
- params =
2660
- {} as Params$Resource$Projects$Locations$Clusters$Generateclientcertificate;
2661
- options = {};
2662
- }
2663
-
2664
- if (typeof optionsOrCallback === 'function') {
2665
- callback = optionsOrCallback;
2666
- options = {};
2667
- }
2668
-
2669
- const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/';
2670
- const parameters = {
2671
- options: Object.assign(
2672
- {
2673
- url: (rootUrl + '/v1/{+parent}:generateClientCertificate').replace(
2674
- /([^:]\/)\/+/g,
2675
- '$1'
2676
- ),
2677
- method: 'POST',
2678
- },
2679
- options
2680
- ),
2681
- params,
2682
- requiredParams: ['parent'],
2683
- pathParams: ['parent'],
2684
- context: this.context,
2685
- };
2686
- if (callback) {
2687
- createAPIRequest<Schema$GenerateClientCertificateResponse>(
2688
- parameters,
2689
- callback as BodyResponseCallback<unknown>
2690
- );
2691
- } else {
2692
- return createAPIRequest<Schema$GenerateClientCertificateResponse>(
2693
- parameters
2694
- );
2695
- }
2696
- }
2697
-
2698
2612
  /**
2699
2613
  * Gets details of a single Cluster.
2700
2614
  *
@@ -3201,18 +3115,6 @@ export namespace alloydb_v1 {
3201
3115
  */
3202
3116
  validateOnly?: boolean;
3203
3117
  }
3204
- export interface Params$Resource$Projects$Locations$Clusters$Generateclientcertificate
3205
- extends StandardParameters {
3206
- /**
3207
- * Required. The name of the parent resource. The required format is: * projects/{project\}/locations/{location\}/clusters/{cluster\}
3208
- */
3209
- parent?: string;
3210
-
3211
- /**
3212
- * Request body metadata
3213
- */
3214
- requestBody?: Schema$GenerateClientCertificateRequest;
3215
- }
3216
3118
  export interface Params$Resource$Projects$Locations$Clusters$Get
3217
3119
  extends StandardParameters {
3218
3120
  /**