@googleapis/alloydb 19.0.0 → 20.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
@@ -656,14 +656,6 @@ export namespace alloydb_v1alpha {
656
656
  * Configuration for Managed Connection Pool (MCP).
657
657
  */
658
658
  export interface Schema$ConnectionPoolConfig {
659
- /**
660
- * Optional. Deprecated. Use 'flags' instead. The default pool size. Defaults to 20. Note: This field should not be added to client libraries if not present already.
661
- */
662
- defaultPoolSize?: string | null;
663
- /**
664
- * Optional. Deprecated; Prefer 'enabled' as this will be removed soon.
665
- */
666
- enable?: boolean | null;
667
659
  /**
668
660
  * Optional. Whether to enable Managed Connection Pool (MCP).
669
661
  */
@@ -672,42 +664,10 @@ export namespace alloydb_v1alpha {
672
664
  * Optional. Connection Pool flags, as a list of "key": "value" pairs.
673
665
  */
674
666
  flags?: {[key: string]: string} | null;
675
- /**
676
- * Optional. Deprecated. Use 'flags' instead. The list of startup parameters to ignore. Defaults to ["extra_float_digits"] Note: This field should not be added to client libraries if not present already.
677
- */
678
- ignoreStartupParameters?: string[] | null;
679
- /**
680
- * Optional. Deprecated. Use 'flags' instead. The maximum number of client connections allowed. Note: This field should not be added to client libraries if not present already.
681
- */
682
- maxClientConn?: string | null;
683
- /**
684
- * Optional. Deprecated. Use 'flags' instead. The maximum number of prepared statements allowed. MCP makes sure that any statement prepared by a client, up to this limit, is available on the backing server connection in transaction and statement pooling mode. Even if the statement was originally prepared on another server connection. Defaults to 0. Note: This field should not be added to client libraries if not present already.
685
- */
686
- maxPreparedStatements?: string | null;
687
- /**
688
- * Optional. Deprecated. Use 'flags' instead. The minimum pool size. Defaults to 0. Note: This field should not be added to client libraries if not present already.
689
- */
690
- minPoolSize?: string | null;
691
667
  /**
692
668
  * Output only. The number of running poolers per instance.
693
669
  */
694
670
  poolerCount?: number | null;
695
- /**
696
- * Optional. Deprecated. Use 'flags' instead. The pool mode. Defaults to `POOL_MODE_TRANSACTION`. Note: This field should not be added to client libraries if not present already.
697
- */
698
- poolMode?: string | null;
699
- /**
700
- * Optional. Deprecated. Use 'flags' instead. The maximum number of seconds queries are allowed to spend waiting for execution. If the query is not assigned to a server during that time, the client is disconnected. 0 disables. Note: This field should not be added to client libraries if not present already.
701
- */
702
- queryWaitTimeout?: string | null;
703
- /**
704
- * Optional. Deprecated. Use 'flags' instead. The maximum number of seconds a server is allowed to be idle before it is disconnected. 0 disables. Note: This field should not be added to client libraries if not present already.
705
- */
706
- serverIdleTimeout?: string | null;
707
- /**
708
- * Optional. Deprecated. Use 'flags' instead. The list of users that are allowed to connect to the MCP stats console. The users must exist in the database. Note: This field should not be added to client libraries if not present already.
709
- */
710
- statsUsers?: string[] | null;
711
671
  }
712
672
  /**
713
673
  * ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster.
@@ -841,6 +801,19 @@ export namespace alloydb_v1alpha {
841
801
  */
842
802
  time?: Schema$GoogleTypeTimeOfDay;
843
803
  }
804
+ /**
805
+ * The DNS config for the endpoint, containing the DNS record name, type and targets.
806
+ */
807
+ export interface Schema$DNSConfig {
808
+ /**
809
+ * The fully qualified domain name (FQDN) of the DNS record, e.g., ".location.alloydb-psa.goog".
810
+ */
811
+ dnsName?: string | null;
812
+ /**
813
+ * The type of the DNS record, e.g., "A", "AAAA", "CNAME".
814
+ */
815
+ dnsRecordType?: string | null;
816
+ }
844
817
  /**
845
818
  * 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); \}
846
819
  */
@@ -867,6 +840,67 @@ export namespace alloydb_v1alpha {
867
840
  */
868
841
  kmsKeyVersions?: string[] | null;
869
842
  }
843
+ /**
844
+ * Endpoint resource.
845
+ */
846
+ export interface Schema$Endpoint {
847
+ /**
848
+ * Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
849
+ */
850
+ annotations?: {[key: string]: string} | null;
851
+ /**
852
+ * Output only. Create time stamp
853
+ */
854
+ createTime?: string | null;
855
+ /**
856
+ * Output only. Delete time stamp
857
+ */
858
+ deleteTime?: string | null;
859
+ /**
860
+ * User-settable and human-readable display name for the Endpoint.
861
+ */
862
+ displayName?: string | null;
863
+ /**
864
+ * Output only. The DNS config for the endpoint. Each endpoint is associated with a specific DNS name and the DNS type. The DNS targets are the IP addresses of the target instances. The dns_type is the type of the DNS record, eg. Type "A" or Type "CNAME". This field is not configurable by the user, and it is updated when user specifies the target instances.
865
+ */
866
+ dnsConfig?: Schema$DNSConfig;
867
+ /**
868
+ * Output only. The effective target instances that the endpoint is associated with. This is a list of target instance names, e.g. projects/{project_number\}/locations/{location\}/clusters/{cluster_id\}/instances/{instance_id\} For write endpoint, there is only one effective target instance which has to be a primary instance. Effective target instances are only different from target instances after a switchover or cross-region failover operation. Otherwise, effective_target_instances are the same as target_instances. Note that after a cross-region failover operation, the effective_target_instances can be stale until the operation to update the endpoint is complete.
869
+ */
870
+ effectiveTargetInstances?: string[] | null;
871
+ /**
872
+ * The type of the endpoint, either write or read.
873
+ */
874
+ endpointType?: string | null;
875
+ /**
876
+ * For Resource freshness validation (https://google.aip.dev/154)
877
+ */
878
+ etag?: string | null;
879
+ /**
880
+ * Output only. Identifier. The name of the endpoint resource with the format: * projects/{project\}/locations/{region\}/endpoints/{endpoint_id\} where the endpoint ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the endpoint resource name is the name of the parent resource: * projects/{project\}/locations/{region\}
881
+ */
882
+ name?: string | null;
883
+ /**
884
+ * Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Endpoint does not match the user's intended state, and the service is actively updating the Endpoint to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.
885
+ */
886
+ reconciling?: boolean | null;
887
+ /**
888
+ * Output only. The state of the endpoint.
889
+ */
890
+ state?: string | null;
891
+ /**
892
+ * The names of the target instances for the endpoint, should be of format projects/{project\}/locations/{region\}/clusters/{cluster\}/instances/{instance\}. For write endpoint, there is only one target instance which has to be a primary instance. For read endpoint, there can be multiple target instances which can be read or secondary instances. After a cross-region failover or switchover operation, the endpoint will be associated with a different target instance. This change will be reflected in the effective_target_instances field.
893
+ */
894
+ targetInstances?: string[] | null;
895
+ /**
896
+ * 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.
897
+ */
898
+ uid?: string | null;
899
+ /**
900
+ * Output only. Update time stamp
901
+ */
902
+ updateTime?: string | null;
903
+ }
870
904
  /**
871
905
  * Export cluster request.
872
906
  */
@@ -1083,6 +1117,10 @@ export namespace alloydb_v1alpha {
1083
1117
  * Output only. Create time stamp
1084
1118
  */
1085
1119
  createTime?: string | null;
1120
+ /**
1121
+ * Optional. Controls whether the Data API is enabled for this instance. When enabled, this allows authorized users to connect to the instance from the public internet using the `executeSql` API, even for private IP instances. If this is not specified, the data API is enabled by default for Google internal services like AlloyDB Studio. Disable it explicitly to disallow Google internal services as well.
1122
+ */
1123
+ dataApiAccess?: string | null;
1086
1124
  /**
1087
1125
  * 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.
1088
1126
  */
@@ -1205,7 +1243,7 @@ export namespace alloydb_v1alpha {
1205
1243
  */
1206
1244
  export interface Schema$InstanceNetworkConfig {
1207
1245
  /**
1208
- * Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.
1246
+ * Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](https://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.
1209
1247
  */
1210
1248
  allocatedIpRangeOverride?: string | null;
1211
1249
  /**
@@ -1289,6 +1327,23 @@ export namespace alloydb_v1alpha {
1289
1327
  */
1290
1328
  unreachable?: string[] | null;
1291
1329
  }
1330
+ /**
1331
+ * Message for response to listing Endpoints
1332
+ */
1333
+ export interface Schema$ListEndpointsResponse {
1334
+ /**
1335
+ * The list of Endpoints
1336
+ */
1337
+ endpoints?: Schema$Endpoint[];
1338
+ /**
1339
+ * A token identifying a page of results the server should return.
1340
+ */
1341
+ nextPageToken?: string | null;
1342
+ /**
1343
+ * Locations that could not be reached.
1344
+ */
1345
+ unreachable?: string[] | null;
1346
+ }
1292
1347
  /**
1293
1348
  * Message for response to listing Instances
1294
1349
  */
@@ -1443,6 +1498,10 @@ export namespace alloydb_v1alpha {
1443
1498
  * Output only. The private IP address of the VM e.g. "10.57.0.34".
1444
1499
  */
1445
1500
  ip?: string | null;
1501
+ /**
1502
+ * Output only. Indicates whether the node set up to be configured as a hot standby.
1503
+ */
1504
+ isHotStandby?: boolean | null;
1446
1505
  /**
1447
1506
  * 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.
1448
1507
  */
@@ -1484,6 +1543,10 @@ export namespace alloydb_v1alpha {
1484
1543
  * Track actively running queries on the instance. If not set, this flag is "off" by default.
1485
1544
  */
1486
1545
  trackActiveQueries?: boolean | null;
1546
+ /**
1547
+ * Indicates whether to track active query plans for an instance. If not set, the default value is "off". Can only be enabled if track_active_queries is enabled.
1548
+ */
1549
+ trackActiveQueryPlan?: boolean | null;
1487
1550
  /**
1488
1551
  * Track client address for an instance. If not set, default value is "off".
1489
1552
  */
@@ -1597,6 +1660,10 @@ export namespace alloydb_v1alpha {
1597
1660
  * Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, deletion will be blocked and an ABORTED error will be returned.
1598
1661
  */
1599
1662
  etag?: string | null;
1663
+ /**
1664
+ * Optional. If set, the promote operation will attempt to recreate the original primary cluster as a secondary cluster when it comes back online. Otherwise, the promoted cluster will be a standalone cluster. Currently only supported when there is a single secondary cluster.
1665
+ */
1666
+ failover?: boolean | null;
1600
1667
  /**
1601
1668
  * 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).
1602
1669
  */
@@ -2226,7 +2293,7 @@ export namespace alloydb_v1alpha {
2226
2293
  uniqueId?: string | null;
2227
2294
  }
2228
2295
  /**
2229
- * Common model for database resource instance metadata. Next ID: 30
2296
+ * Common model for database resource instance metadata. Next ID: 32
2230
2297
  */
2231
2298
  export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata {
2232
2299
  /**
@@ -2297,6 +2364,10 @@ export namespace alloydb_v1alpha {
2297
2364
  * Optional. Maintenance info for the resource.
2298
2365
  */
2299
2366
  maintenanceInfo?: Schema$StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo;
2367
+ /**
2368
+ * Optional. The modes of the database resource.
2369
+ */
2370
+ modes?: string[] | null;
2300
2371
  /**
2301
2372
  * 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.
2302
2373
  */
@@ -2313,6 +2384,10 @@ export namespace alloydb_v1alpha {
2313
2384
  * Closest parent Cloud Resource Manager container of this resource. It must be resource name of a Cloud Resource Manager project with the format of "/", such as "projects/123". For GCP provided resources, number should be project number.
2314
2385
  */
2315
2386
  resourceContainer?: string | null;
2387
+ /**
2388
+ * Optional. List of resource flags for the database resource.
2389
+ */
2390
+ resourceFlags?: Schema$StorageDatabasecenterPartnerapiV1mainResourceFlags[];
2316
2391
  /**
2317
2392
  * 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
2318
2393
  */
@@ -2376,9 +2451,13 @@ export namespace alloydb_v1alpha {
2376
2451
  signalType?: string | null;
2377
2452
  }
2378
2453
  /**
2379
- * Database resource signal data. This is used to send signals to Condor which are based on the DB/Instance/Fleet level configurations. These will be used to send signals for all inventory types. Next ID: 7
2454
+ * Database resource signal data. This is used to send signals to Condor which are based on the DB/Instance/Fleet level configurations. These will be used to send signals for all inventory types. Next ID: 10
2380
2455
  */
2381
2456
  export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData {
2457
+ /**
2458
+ * Deprecated: Use signal_metadata_list instead.
2459
+ */
2460
+ backupRun?: Schema$StorageDatabasecenterPartnerapiV1mainBackupRun;
2382
2461
  /**
2383
2462
  * Required. Full Resource name of the source resource.
2384
2463
  */
@@ -2387,14 +2466,22 @@ export namespace alloydb_v1alpha {
2387
2466
  * Required. Last time signal was refreshed
2388
2467
  */
2389
2468
  lastRefreshTime?: string | null;
2469
+ /**
2470
+ * Required. Resource location.
2471
+ */
2472
+ location?: string | null;
2390
2473
  /**
2391
2474
  * Database resource id.
2392
2475
  */
2393
2476
  resourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId;
2394
2477
  /**
2395
- * Signal data for boolean signals.
2478
+ * Deprecated: Use signal_metadata_list instead.
2396
2479
  */
2397
2480
  signalBoolValue?: boolean | null;
2481
+ /**
2482
+ * This will support array of OneOf signal metadata information for a given signal type.
2483
+ */
2484
+ signalMetadataList?: Schema$StorageDatabasecenterPartnerapiV1mainSignalMetadata[];
2398
2485
  /**
2399
2486
  * Required. Output only. Signal state of the signal
2400
2487
  */
@@ -2514,6 +2601,19 @@ export namespace alloydb_v1alpha {
2514
2601
  */
2515
2602
  message?: string | null;
2516
2603
  }
2604
+ /**
2605
+ * Message type for storing resource flags.
2606
+ */
2607
+ export interface Schema$StorageDatabasecenterPartnerapiV1mainResourceFlags {
2608
+ /**
2609
+ * Optional. Key of the resource flag.
2610
+ */
2611
+ key?: string | null;
2612
+ /**
2613
+ * Optional. Value of the resource flag.
2614
+ */
2615
+ value?: string | null;
2616
+ }
2517
2617
  /**
2518
2618
  * Deny maintenance period for the database resource. It specifies the time range during which the maintenance cannot start. This is configured by the customer.
2519
2619
  */
@@ -2535,18 +2635,34 @@ export namespace alloydb_v1alpha {
2535
2635
  * MaintenanceInfo to capture the maintenance details of database resource.
2536
2636
  */
2537
2637
  export interface Schema$StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo {
2638
+ /**
2639
+ * Optional. The date when the current maintenance version was released.
2640
+ */
2641
+ currentVersionReleaseDate?: Schema$GoogleTypeDate;
2538
2642
  /**
2539
2643
  * Optional. List of Deny maintenance period for the database resource.
2540
2644
  */
2541
2645
  denyMaintenanceSchedules?: Schema$StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule[];
2646
+ /**
2647
+ * Optional. Whether the instance is in stopped state. This information is temporarily being captured in maintenanceInfo, till STOPPED state is supported by DB Center.
2648
+ */
2649
+ isInstanceStopped?: boolean | null;
2542
2650
  /**
2543
2651
  * Optional. Maintenance window for the database resource.
2544
2652
  */
2545
2653
  maintenanceSchedule?: Schema$StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule;
2654
+ /**
2655
+ * Output only. Current state of maintenance on the database resource.
2656
+ */
2657
+ maintenanceState?: string | null;
2546
2658
  /**
2547
2659
  * Optional. Current Maintenance version of the database resource. Example: "MYSQL_8_0_41.R20250531.01_15"
2548
2660
  */
2549
2661
  maintenanceVersion?: string | null;
2662
+ /**
2663
+ * Optional. Upcoming maintenance for the database resource. This field is populated once SLM generates and publishes upcoming maintenance window.
2664
+ */
2665
+ upcomingMaintenance?: Schema$StorageDatabasecenterPartnerapiV1mainUpcomingMaintenance;
2550
2666
  }
2551
2667
  /**
2552
2668
  * Maintenance window for the database resource. It specifies preferred time and day of the week and phase in some cases, when the maintenance can start. This is configured by the customer.
@@ -2581,6 +2697,19 @@ export namespace alloydb_v1alpha {
2581
2697
  */
2582
2698
  timestampBasedRetentionTime?: string | null;
2583
2699
  }
2700
+ /**
2701
+ * SignalMetadata contains one of the signal metadata proto messages associated with a SignalType. This proto will be mapped to SignalMetadata message in storage.proto. Next ID: 3
2702
+ */
2703
+ export interface Schema$StorageDatabasecenterPartnerapiV1mainSignalMetadata {
2704
+ /**
2705
+ * Signal data for backup runs.
2706
+ */
2707
+ backupRun?: Schema$StorageDatabasecenterPartnerapiV1mainBackupRun;
2708
+ /**
2709
+ * Signal data for boolean signals.
2710
+ */
2711
+ signalBoolValue?: boolean | null;
2712
+ }
2584
2713
  /**
2585
2714
  * 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.
2586
2715
  */
@@ -2590,6 +2719,19 @@ export namespace alloydb_v1alpha {
2590
2719
  */
2591
2720
  tags?: {[key: string]: string} | null;
2592
2721
  }
2722
+ /**
2723
+ * Upcoming maintenance for the database resource. This is generated by SLM once the upcoming maintenance schedule is published.
2724
+ */
2725
+ export interface Schema$StorageDatabasecenterPartnerapiV1mainUpcomingMaintenance {
2726
+ /**
2727
+ * Optional. The end time of the upcoming maintenance.
2728
+ */
2729
+ endTime?: string | null;
2730
+ /**
2731
+ * Optional. The start time of the upcoming maintenance.
2732
+ */
2733
+ startTime?: string | null;
2734
+ }
2593
2735
  /**
2594
2736
  * 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.
2595
2737
  */
@@ -2873,12 +3015,14 @@ export namespace alloydb_v1alpha {
2873
3015
  context: APIRequestContext;
2874
3016
  backups: Resource$Projects$Locations$Backups;
2875
3017
  clusters: Resource$Projects$Locations$Clusters;
3018
+ endpoints: Resource$Projects$Locations$Endpoints;
2876
3019
  operations: Resource$Projects$Locations$Operations;
2877
3020
  supportedDatabaseFlags: Resource$Projects$Locations$Supporteddatabaseflags;
2878
3021
  constructor(context: APIRequestContext) {
2879
3022
  this.context = context;
2880
3023
  this.backups = new Resource$Projects$Locations$Backups(this.context);
2881
3024
  this.clusters = new Resource$Projects$Locations$Clusters(this.context);
3025
+ this.endpoints = new Resource$Projects$Locations$Endpoints(this.context);
2882
3026
  this.operations = new Resource$Projects$Locations$Operations(
2883
3027
  this.context
2884
3028
  );
@@ -3029,7 +3173,7 @@ export namespace alloydb_v1alpha {
3029
3173
  }
3030
3174
 
3031
3175
  /**
3032
- * Lists information about the supported locations for this service.
3176
+ * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
3033
3177
  * @example
3034
3178
  * ```js
3035
3179
  * // Before running the sample:
@@ -3059,7 +3203,7 @@ export namespace alloydb_v1alpha {
3059
3203
  *
3060
3204
  * // Do the magic
3061
3205
  * const res = await alloydb.projects.locations.list({
3062
- * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.
3206
+ * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
3063
3207
  * extraLocationTypes: 'placeholder-value',
3064
3208
  * // 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).
3065
3209
  * filter: 'placeholder-value',
@@ -3193,7 +3337,7 @@ export namespace alloydb_v1alpha {
3193
3337
  }
3194
3338
  export interface Params$Resource$Projects$Locations$List extends StandardParameters {
3195
3339
  /**
3196
- * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.
3340
+ * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
3197
3341
  */
3198
3342
  extraLocationTypes?: string[];
3199
3343
  /**
@@ -5550,6 +5694,7 @@ export namespace alloydb_v1alpha {
5550
5694
  * // request body parameters
5551
5695
  * // {
5552
5696
  * // "etag": "my_etag",
5697
+ * // "failover": false,
5553
5698
  * // "requestId": "my_requestId",
5554
5699
  * // "validateOnly": false
5555
5700
  * // }
@@ -6533,6 +6678,7 @@ export namespace alloydb_v1alpha {
6533
6678
  * // "clientConnectionConfig": {},
6534
6679
  * // "connectionPoolConfig": {},
6535
6680
  * // "createTime": "my_createTime",
6681
+ * // "dataApiAccess": "my_dataApiAccess",
6536
6682
  * // "databaseFlags": {},
6537
6683
  * // "deleteTime": "my_deleteTime",
6538
6684
  * // "displayName": "my_displayName",
@@ -6724,6 +6870,7 @@ export namespace alloydb_v1alpha {
6724
6870
  * // "clientConnectionConfig": {},
6725
6871
  * // "connectionPoolConfig": {},
6726
6872
  * // "createTime": "my_createTime",
6873
+ * // "dataApiAccess": "my_dataApiAccess",
6727
6874
  * // "databaseFlags": {},
6728
6875
  * // "deleteTime": "my_deleteTime",
6729
6876
  * // "displayName": "my_displayName",
@@ -7205,6 +7352,7 @@ export namespace alloydb_v1alpha {
7205
7352
  * // "clientConnectionConfig": {},
7206
7353
  * // "connectionPoolConfig": {},
7207
7354
  * // "createTime": "my_createTime",
7355
+ * // "dataApiAccess": "my_dataApiAccess",
7208
7356
  * // "databaseFlags": {},
7209
7357
  * // "deleteTime": "my_deleteTime",
7210
7358
  * // "displayName": "my_displayName",
@@ -7833,6 +7981,7 @@ export namespace alloydb_v1alpha {
7833
7981
  * // "clientConnectionConfig": {},
7834
7982
  * // "connectionPoolConfig": {},
7835
7983
  * // "createTime": "my_createTime",
7984
+ * // "dataApiAccess": "my_dataApiAccess",
7836
7985
  * // "databaseFlags": {},
7837
7986
  * // "deleteTime": "my_deleteTime",
7838
7987
  * // "displayName": "my_displayName",
@@ -9128,6 +9277,885 @@ export namespace alloydb_v1alpha {
9128
9277
  requestBody?: Schema$User;
9129
9278
  }
9130
9279
 
9280
+ export class Resource$Projects$Locations$Endpoints {
9281
+ context: APIRequestContext;
9282
+ constructor(context: APIRequestContext) {
9283
+ this.context = context;
9284
+ }
9285
+
9286
+ /**
9287
+ * Creates a new Endpoint in a given project and location.
9288
+ * @example
9289
+ * ```js
9290
+ * // Before running the sample:
9291
+ * // - Enable the API at:
9292
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
9293
+ * // - Login into gcloud by running:
9294
+ * // ```sh
9295
+ * // $ gcloud auth application-default login
9296
+ * // ```
9297
+ * // - Install the npm module by running:
9298
+ * // ```sh
9299
+ * // $ npm install googleapis
9300
+ * // ```
9301
+ *
9302
+ * const {google} = require('googleapis');
9303
+ * const alloydb = google.alloydb('v1alpha');
9304
+ *
9305
+ * async function main() {
9306
+ * const auth = new google.auth.GoogleAuth({
9307
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
9308
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
9309
+ * });
9310
+ *
9311
+ * // Acquire an auth client, and bind it to all future calls
9312
+ * const authClient = await auth.getClient();
9313
+ * google.options({auth: authClient});
9314
+ *
9315
+ * // Do the magic
9316
+ * const res = await alloydb.projects.locations.endpoints.create({
9317
+ * // Required. ID of the requesting object.
9318
+ * endpointId: 'placeholder-value',
9319
+ * // Required. The location of the new endpoint. For the required format, see the comment on the Endpoint.name field.
9320
+ * parent: 'projects/my-project/locations/my-location',
9321
+ * // 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).
9322
+ * requestId: 'placeholder-value',
9323
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
9324
+ * validateOnly: 'placeholder-value',
9325
+ *
9326
+ * // Request body metadata
9327
+ * requestBody: {
9328
+ * // request body parameters
9329
+ * // {
9330
+ * // "annotations": {},
9331
+ * // "createTime": "my_createTime",
9332
+ * // "deleteTime": "my_deleteTime",
9333
+ * // "displayName": "my_displayName",
9334
+ * // "dnsConfig": {},
9335
+ * // "effectiveTargetInstances": [],
9336
+ * // "endpointType": "my_endpointType",
9337
+ * // "etag": "my_etag",
9338
+ * // "name": "my_name",
9339
+ * // "reconciling": false,
9340
+ * // "state": "my_state",
9341
+ * // "targetInstances": [],
9342
+ * // "uid": "my_uid",
9343
+ * // "updateTime": "my_updateTime"
9344
+ * // }
9345
+ * },
9346
+ * });
9347
+ * console.log(res.data);
9348
+ *
9349
+ * // Example response
9350
+ * // {
9351
+ * // "done": false,
9352
+ * // "error": {},
9353
+ * // "metadata": {},
9354
+ * // "name": "my_name",
9355
+ * // "response": {}
9356
+ * // }
9357
+ * }
9358
+ *
9359
+ * main().catch(e => {
9360
+ * console.error(e);
9361
+ * throw e;
9362
+ * });
9363
+ *
9364
+ * ```
9365
+ *
9366
+ * @param params - Parameters for request
9367
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
9368
+ * @param callback - Optional callback that handles the response.
9369
+ * @returns A promise if used with async/await, or void if used with a callback.
9370
+ */
9371
+ create(
9372
+ params: Params$Resource$Projects$Locations$Endpoints$Create,
9373
+ options: StreamMethodOptions
9374
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
9375
+ create(
9376
+ params?: Params$Resource$Projects$Locations$Endpoints$Create,
9377
+ options?: MethodOptions
9378
+ ): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
9379
+ create(
9380
+ params: Params$Resource$Projects$Locations$Endpoints$Create,
9381
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
9382
+ callback: BodyResponseCallback<Readable>
9383
+ ): void;
9384
+ create(
9385
+ params: Params$Resource$Projects$Locations$Endpoints$Create,
9386
+ options: MethodOptions | BodyResponseCallback<Schema$Operation>,
9387
+ callback: BodyResponseCallback<Schema$Operation>
9388
+ ): void;
9389
+ create(
9390
+ params: Params$Resource$Projects$Locations$Endpoints$Create,
9391
+ callback: BodyResponseCallback<Schema$Operation>
9392
+ ): void;
9393
+ create(callback: BodyResponseCallback<Schema$Operation>): void;
9394
+ create(
9395
+ paramsOrCallback?:
9396
+ | Params$Resource$Projects$Locations$Endpoints$Create
9397
+ | BodyResponseCallback<Schema$Operation>
9398
+ | BodyResponseCallback<Readable>,
9399
+ optionsOrCallback?:
9400
+ | MethodOptions
9401
+ | StreamMethodOptions
9402
+ | BodyResponseCallback<Schema$Operation>
9403
+ | BodyResponseCallback<Readable>,
9404
+ callback?:
9405
+ | BodyResponseCallback<Schema$Operation>
9406
+ | BodyResponseCallback<Readable>
9407
+ ):
9408
+ | void
9409
+ | Promise<GaxiosResponseWithHTTP2<Schema$Operation>>
9410
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
9411
+ let params = (paramsOrCallback ||
9412
+ {}) as Params$Resource$Projects$Locations$Endpoints$Create;
9413
+ let options = (optionsOrCallback || {}) as MethodOptions;
9414
+
9415
+ if (typeof paramsOrCallback === 'function') {
9416
+ callback = paramsOrCallback;
9417
+ params = {} as Params$Resource$Projects$Locations$Endpoints$Create;
9418
+ options = {};
9419
+ }
9420
+
9421
+ if (typeof optionsOrCallback === 'function') {
9422
+ callback = optionsOrCallback;
9423
+ options = {};
9424
+ }
9425
+
9426
+ const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/';
9427
+ const parameters = {
9428
+ options: Object.assign(
9429
+ {
9430
+ url: (rootUrl + '/v1alpha/{+parent}/endpoints').replace(
9431
+ /([^:]\/)\/+/g,
9432
+ '$1'
9433
+ ),
9434
+ method: 'POST',
9435
+ apiVersion: '',
9436
+ },
9437
+ options
9438
+ ),
9439
+ params,
9440
+ requiredParams: ['parent'],
9441
+ pathParams: ['parent'],
9442
+ context: this.context,
9443
+ };
9444
+ if (callback) {
9445
+ createAPIRequest<Schema$Operation>(
9446
+ parameters,
9447
+ callback as BodyResponseCallback<unknown>
9448
+ );
9449
+ } else {
9450
+ return createAPIRequest<Schema$Operation>(parameters);
9451
+ }
9452
+ }
9453
+
9454
+ /**
9455
+ * Deletes a single Endpoint.
9456
+ * @example
9457
+ * ```js
9458
+ * // Before running the sample:
9459
+ * // - Enable the API at:
9460
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
9461
+ * // - Login into gcloud by running:
9462
+ * // ```sh
9463
+ * // $ gcloud auth application-default login
9464
+ * // ```
9465
+ * // - Install the npm module by running:
9466
+ * // ```sh
9467
+ * // $ npm install googleapis
9468
+ * // ```
9469
+ *
9470
+ * const {google} = require('googleapis');
9471
+ * const alloydb = google.alloydb('v1alpha');
9472
+ *
9473
+ * async function main() {
9474
+ * const auth = new google.auth.GoogleAuth({
9475
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
9476
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
9477
+ * });
9478
+ *
9479
+ * // Acquire an auth client, and bind it to all future calls
9480
+ * const authClient = await auth.getClient();
9481
+ * google.options({auth: authClient});
9482
+ *
9483
+ * // Do the magic
9484
+ * const res = await alloydb.projects.locations.endpoints.delete({
9485
+ * // Optional. The current etag of the Endpoint. If an etag is provided and does not match the current etag of the Endpoint, deletion will be blocked and an ABORTED error will be returned.
9486
+ * etag: 'placeholder-value',
9487
+ * // Required. The name of the resource. For the required format, see the comment on the Endpoint.name field.
9488
+ * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint',
9489
+ * // 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 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 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).
9490
+ * requestId: 'placeholder-value',
9491
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
9492
+ * validateOnly: 'placeholder-value',
9493
+ * });
9494
+ * console.log(res.data);
9495
+ *
9496
+ * // Example response
9497
+ * // {
9498
+ * // "done": false,
9499
+ * // "error": {},
9500
+ * // "metadata": {},
9501
+ * // "name": "my_name",
9502
+ * // "response": {}
9503
+ * // }
9504
+ * }
9505
+ *
9506
+ * main().catch(e => {
9507
+ * console.error(e);
9508
+ * throw e;
9509
+ * });
9510
+ *
9511
+ * ```
9512
+ *
9513
+ * @param params - Parameters for request
9514
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
9515
+ * @param callback - Optional callback that handles the response.
9516
+ * @returns A promise if used with async/await, or void if used with a callback.
9517
+ */
9518
+ delete(
9519
+ params: Params$Resource$Projects$Locations$Endpoints$Delete,
9520
+ options: StreamMethodOptions
9521
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
9522
+ delete(
9523
+ params?: Params$Resource$Projects$Locations$Endpoints$Delete,
9524
+ options?: MethodOptions
9525
+ ): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
9526
+ delete(
9527
+ params: Params$Resource$Projects$Locations$Endpoints$Delete,
9528
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
9529
+ callback: BodyResponseCallback<Readable>
9530
+ ): void;
9531
+ delete(
9532
+ params: Params$Resource$Projects$Locations$Endpoints$Delete,
9533
+ options: MethodOptions | BodyResponseCallback<Schema$Operation>,
9534
+ callback: BodyResponseCallback<Schema$Operation>
9535
+ ): void;
9536
+ delete(
9537
+ params: Params$Resource$Projects$Locations$Endpoints$Delete,
9538
+ callback: BodyResponseCallback<Schema$Operation>
9539
+ ): void;
9540
+ delete(callback: BodyResponseCallback<Schema$Operation>): void;
9541
+ delete(
9542
+ paramsOrCallback?:
9543
+ | Params$Resource$Projects$Locations$Endpoints$Delete
9544
+ | BodyResponseCallback<Schema$Operation>
9545
+ | BodyResponseCallback<Readable>,
9546
+ optionsOrCallback?:
9547
+ | MethodOptions
9548
+ | StreamMethodOptions
9549
+ | BodyResponseCallback<Schema$Operation>
9550
+ | BodyResponseCallback<Readable>,
9551
+ callback?:
9552
+ | BodyResponseCallback<Schema$Operation>
9553
+ | BodyResponseCallback<Readable>
9554
+ ):
9555
+ | void
9556
+ | Promise<GaxiosResponseWithHTTP2<Schema$Operation>>
9557
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
9558
+ let params = (paramsOrCallback ||
9559
+ {}) as Params$Resource$Projects$Locations$Endpoints$Delete;
9560
+ let options = (optionsOrCallback || {}) as MethodOptions;
9561
+
9562
+ if (typeof paramsOrCallback === 'function') {
9563
+ callback = paramsOrCallback;
9564
+ params = {} as Params$Resource$Projects$Locations$Endpoints$Delete;
9565
+ options = {};
9566
+ }
9567
+
9568
+ if (typeof optionsOrCallback === 'function') {
9569
+ callback = optionsOrCallback;
9570
+ options = {};
9571
+ }
9572
+
9573
+ const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/';
9574
+ const parameters = {
9575
+ options: Object.assign(
9576
+ {
9577
+ url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
9578
+ method: 'DELETE',
9579
+ apiVersion: '',
9580
+ },
9581
+ options
9582
+ ),
9583
+ params,
9584
+ requiredParams: ['name'],
9585
+ pathParams: ['name'],
9586
+ context: this.context,
9587
+ };
9588
+ if (callback) {
9589
+ createAPIRequest<Schema$Operation>(
9590
+ parameters,
9591
+ callback as BodyResponseCallback<unknown>
9592
+ );
9593
+ } else {
9594
+ return createAPIRequest<Schema$Operation>(parameters);
9595
+ }
9596
+ }
9597
+
9598
+ /**
9599
+ * Gets details of a single Endpoint.
9600
+ * @example
9601
+ * ```js
9602
+ * // Before running the sample:
9603
+ * // - Enable the API at:
9604
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
9605
+ * // - Login into gcloud by running:
9606
+ * // ```sh
9607
+ * // $ gcloud auth application-default login
9608
+ * // ```
9609
+ * // - Install the npm module by running:
9610
+ * // ```sh
9611
+ * // $ npm install googleapis
9612
+ * // ```
9613
+ *
9614
+ * const {google} = require('googleapis');
9615
+ * const alloydb = google.alloydb('v1alpha');
9616
+ *
9617
+ * async function main() {
9618
+ * const auth = new google.auth.GoogleAuth({
9619
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
9620
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
9621
+ * });
9622
+ *
9623
+ * // Acquire an auth client, and bind it to all future calls
9624
+ * const authClient = await auth.getClient();
9625
+ * google.options({auth: authClient});
9626
+ *
9627
+ * // Do the magic
9628
+ * const res = await alloydb.projects.locations.endpoints.get({
9629
+ * // Required. The name of the resource. For the required format, see the comment on the Endpoint.name field.
9630
+ * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint',
9631
+ * });
9632
+ * console.log(res.data);
9633
+ *
9634
+ * // Example response
9635
+ * // {
9636
+ * // "annotations": {},
9637
+ * // "createTime": "my_createTime",
9638
+ * // "deleteTime": "my_deleteTime",
9639
+ * // "displayName": "my_displayName",
9640
+ * // "dnsConfig": {},
9641
+ * // "effectiveTargetInstances": [],
9642
+ * // "endpointType": "my_endpointType",
9643
+ * // "etag": "my_etag",
9644
+ * // "name": "my_name",
9645
+ * // "reconciling": false,
9646
+ * // "state": "my_state",
9647
+ * // "targetInstances": [],
9648
+ * // "uid": "my_uid",
9649
+ * // "updateTime": "my_updateTime"
9650
+ * // }
9651
+ * }
9652
+ *
9653
+ * main().catch(e => {
9654
+ * console.error(e);
9655
+ * throw e;
9656
+ * });
9657
+ *
9658
+ * ```
9659
+ *
9660
+ * @param params - Parameters for request
9661
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
9662
+ * @param callback - Optional callback that handles the response.
9663
+ * @returns A promise if used with async/await, or void if used with a callback.
9664
+ */
9665
+ get(
9666
+ params: Params$Resource$Projects$Locations$Endpoints$Get,
9667
+ options: StreamMethodOptions
9668
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
9669
+ get(
9670
+ params?: Params$Resource$Projects$Locations$Endpoints$Get,
9671
+ options?: MethodOptions
9672
+ ): Promise<GaxiosResponseWithHTTP2<Schema$Endpoint>>;
9673
+ get(
9674
+ params: Params$Resource$Projects$Locations$Endpoints$Get,
9675
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
9676
+ callback: BodyResponseCallback<Readable>
9677
+ ): void;
9678
+ get(
9679
+ params: Params$Resource$Projects$Locations$Endpoints$Get,
9680
+ options: MethodOptions | BodyResponseCallback<Schema$Endpoint>,
9681
+ callback: BodyResponseCallback<Schema$Endpoint>
9682
+ ): void;
9683
+ get(
9684
+ params: Params$Resource$Projects$Locations$Endpoints$Get,
9685
+ callback: BodyResponseCallback<Schema$Endpoint>
9686
+ ): void;
9687
+ get(callback: BodyResponseCallback<Schema$Endpoint>): void;
9688
+ get(
9689
+ paramsOrCallback?:
9690
+ | Params$Resource$Projects$Locations$Endpoints$Get
9691
+ | BodyResponseCallback<Schema$Endpoint>
9692
+ | BodyResponseCallback<Readable>,
9693
+ optionsOrCallback?:
9694
+ | MethodOptions
9695
+ | StreamMethodOptions
9696
+ | BodyResponseCallback<Schema$Endpoint>
9697
+ | BodyResponseCallback<Readable>,
9698
+ callback?:
9699
+ | BodyResponseCallback<Schema$Endpoint>
9700
+ | BodyResponseCallback<Readable>
9701
+ ):
9702
+ | void
9703
+ | Promise<GaxiosResponseWithHTTP2<Schema$Endpoint>>
9704
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
9705
+ let params = (paramsOrCallback ||
9706
+ {}) as Params$Resource$Projects$Locations$Endpoints$Get;
9707
+ let options = (optionsOrCallback || {}) as MethodOptions;
9708
+
9709
+ if (typeof paramsOrCallback === 'function') {
9710
+ callback = paramsOrCallback;
9711
+ params = {} as Params$Resource$Projects$Locations$Endpoints$Get;
9712
+ options = {};
9713
+ }
9714
+
9715
+ if (typeof optionsOrCallback === 'function') {
9716
+ callback = optionsOrCallback;
9717
+ options = {};
9718
+ }
9719
+
9720
+ const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/';
9721
+ const parameters = {
9722
+ options: Object.assign(
9723
+ {
9724
+ url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
9725
+ method: 'GET',
9726
+ apiVersion: '',
9727
+ },
9728
+ options
9729
+ ),
9730
+ params,
9731
+ requiredParams: ['name'],
9732
+ pathParams: ['name'],
9733
+ context: this.context,
9734
+ };
9735
+ if (callback) {
9736
+ createAPIRequest<Schema$Endpoint>(
9737
+ parameters,
9738
+ callback as BodyResponseCallback<unknown>
9739
+ );
9740
+ } else {
9741
+ return createAPIRequest<Schema$Endpoint>(parameters);
9742
+ }
9743
+ }
9744
+
9745
+ /**
9746
+ * Lists Endpoints in a given project and location.
9747
+ * @example
9748
+ * ```js
9749
+ * // Before running the sample:
9750
+ * // - Enable the API at:
9751
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
9752
+ * // - Login into gcloud by running:
9753
+ * // ```sh
9754
+ * // $ gcloud auth application-default login
9755
+ * // ```
9756
+ * // - Install the npm module by running:
9757
+ * // ```sh
9758
+ * // $ npm install googleapis
9759
+ * // ```
9760
+ *
9761
+ * const {google} = require('googleapis');
9762
+ * const alloydb = google.alloydb('v1alpha');
9763
+ *
9764
+ * async function main() {
9765
+ * const auth = new google.auth.GoogleAuth({
9766
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
9767
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
9768
+ * });
9769
+ *
9770
+ * // Acquire an auth client, and bind it to all future calls
9771
+ * const authClient = await auth.getClient();
9772
+ * google.options({auth: authClient});
9773
+ *
9774
+ * // Do the magic
9775
+ * const res = await alloydb.projects.locations.endpoints.list({
9776
+ * // Optional. Filtering results. This field is currently not supported, its value will be ignored if passed.
9777
+ * filter: 'placeholder-value',
9778
+ * // Optional. Hint for how to order the results
9779
+ * orderBy: 'placeholder-value',
9780
+ * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
9781
+ * pageSize: 'placeholder-value',
9782
+ * // Optional. A page token, received from a previous `ListEndpoints` call. This should be provided to retrieve the subsequent page. This field is currently not supported, its value will be ignored if passed.
9783
+ * pageToken: 'placeholder-value',
9784
+ * // Required. The name of the parent resource. For the required format, see the comment on the Endpoint.name field. Additionally, you can perform an aggregated list operation by specifying a value with the following format: * projects/{project\}/locations/-
9785
+ * parent: 'projects/my-project/locations/my-location',
9786
+ * });
9787
+ * console.log(res.data);
9788
+ *
9789
+ * // Example response
9790
+ * // {
9791
+ * // "endpoints": [],
9792
+ * // "nextPageToken": "my_nextPageToken",
9793
+ * // "unreachable": []
9794
+ * // }
9795
+ * }
9796
+ *
9797
+ * main().catch(e => {
9798
+ * console.error(e);
9799
+ * throw e;
9800
+ * });
9801
+ *
9802
+ * ```
9803
+ *
9804
+ * @param params - Parameters for request
9805
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
9806
+ * @param callback - Optional callback that handles the response.
9807
+ * @returns A promise if used with async/await, or void if used with a callback.
9808
+ */
9809
+ list(
9810
+ params: Params$Resource$Projects$Locations$Endpoints$List,
9811
+ options: StreamMethodOptions
9812
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
9813
+ list(
9814
+ params?: Params$Resource$Projects$Locations$Endpoints$List,
9815
+ options?: MethodOptions
9816
+ ): Promise<GaxiosResponseWithHTTP2<Schema$ListEndpointsResponse>>;
9817
+ list(
9818
+ params: Params$Resource$Projects$Locations$Endpoints$List,
9819
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
9820
+ callback: BodyResponseCallback<Readable>
9821
+ ): void;
9822
+ list(
9823
+ params: Params$Resource$Projects$Locations$Endpoints$List,
9824
+ options:
9825
+ | MethodOptions
9826
+ | BodyResponseCallback<Schema$ListEndpointsResponse>,
9827
+ callback: BodyResponseCallback<Schema$ListEndpointsResponse>
9828
+ ): void;
9829
+ list(
9830
+ params: Params$Resource$Projects$Locations$Endpoints$List,
9831
+ callback: BodyResponseCallback<Schema$ListEndpointsResponse>
9832
+ ): void;
9833
+ list(callback: BodyResponseCallback<Schema$ListEndpointsResponse>): void;
9834
+ list(
9835
+ paramsOrCallback?:
9836
+ | Params$Resource$Projects$Locations$Endpoints$List
9837
+ | BodyResponseCallback<Schema$ListEndpointsResponse>
9838
+ | BodyResponseCallback<Readable>,
9839
+ optionsOrCallback?:
9840
+ | MethodOptions
9841
+ | StreamMethodOptions
9842
+ | BodyResponseCallback<Schema$ListEndpointsResponse>
9843
+ | BodyResponseCallback<Readable>,
9844
+ callback?:
9845
+ | BodyResponseCallback<Schema$ListEndpointsResponse>
9846
+ | BodyResponseCallback<Readable>
9847
+ ):
9848
+ | void
9849
+ | Promise<GaxiosResponseWithHTTP2<Schema$ListEndpointsResponse>>
9850
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
9851
+ let params = (paramsOrCallback ||
9852
+ {}) as Params$Resource$Projects$Locations$Endpoints$List;
9853
+ let options = (optionsOrCallback || {}) as MethodOptions;
9854
+
9855
+ if (typeof paramsOrCallback === 'function') {
9856
+ callback = paramsOrCallback;
9857
+ params = {} as Params$Resource$Projects$Locations$Endpoints$List;
9858
+ options = {};
9859
+ }
9860
+
9861
+ if (typeof optionsOrCallback === 'function') {
9862
+ callback = optionsOrCallback;
9863
+ options = {};
9864
+ }
9865
+
9866
+ const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/';
9867
+ const parameters = {
9868
+ options: Object.assign(
9869
+ {
9870
+ url: (rootUrl + '/v1alpha/{+parent}/endpoints').replace(
9871
+ /([^:]\/)\/+/g,
9872
+ '$1'
9873
+ ),
9874
+ method: 'GET',
9875
+ apiVersion: '',
9876
+ },
9877
+ options
9878
+ ),
9879
+ params,
9880
+ requiredParams: ['parent'],
9881
+ pathParams: ['parent'],
9882
+ context: this.context,
9883
+ };
9884
+ if (callback) {
9885
+ createAPIRequest<Schema$ListEndpointsResponse>(
9886
+ parameters,
9887
+ callback as BodyResponseCallback<unknown>
9888
+ );
9889
+ } else {
9890
+ return createAPIRequest<Schema$ListEndpointsResponse>(parameters);
9891
+ }
9892
+ }
9893
+
9894
+ /**
9895
+ * Updates the parameters of a single Endpoint.
9896
+ * @example
9897
+ * ```js
9898
+ * // Before running the sample:
9899
+ * // - Enable the API at:
9900
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
9901
+ * // - Login into gcloud by running:
9902
+ * // ```sh
9903
+ * // $ gcloud auth application-default login
9904
+ * // ```
9905
+ * // - Install the npm module by running:
9906
+ * // ```sh
9907
+ * // $ npm install googleapis
9908
+ * // ```
9909
+ *
9910
+ * const {google} = require('googleapis');
9911
+ * const alloydb = google.alloydb('v1alpha');
9912
+ *
9913
+ * async function main() {
9914
+ * const auth = new google.auth.GoogleAuth({
9915
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
9916
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
9917
+ * });
9918
+ *
9919
+ * // Acquire an auth client, and bind it to all future calls
9920
+ * const authClient = await auth.getClient();
9921
+ * google.options({auth: authClient});
9922
+ *
9923
+ * // Do the magic
9924
+ * const res = await alloydb.projects.locations.endpoints.patch({
9925
+ * // Optional. If set to true, update succeeds even if endpoint is not found. In that case, a new endpoint is created and `update_mask` is ignored.
9926
+ * allowMissing: 'placeholder-value',
9927
+ * // Output only. Identifier. The name of the endpoint resource with the format: * projects/{project\}/locations/{region\}/endpoints/{endpoint_id\} where the endpoint ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the endpoint resource name is the name of the parent resource: * projects/{project\}/locations/{region\}
9928
+ * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint',
9929
+ * // 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).
9930
+ * requestId: 'placeholder-value',
9931
+ * // Optional. Field mask is used to specify the fields to be overwritten in the Endpoint resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
9932
+ * updateMask: 'placeholder-value',
9933
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
9934
+ * validateOnly: 'placeholder-value',
9935
+ *
9936
+ * // Request body metadata
9937
+ * requestBody: {
9938
+ * // request body parameters
9939
+ * // {
9940
+ * // "annotations": {},
9941
+ * // "createTime": "my_createTime",
9942
+ * // "deleteTime": "my_deleteTime",
9943
+ * // "displayName": "my_displayName",
9944
+ * // "dnsConfig": {},
9945
+ * // "effectiveTargetInstances": [],
9946
+ * // "endpointType": "my_endpointType",
9947
+ * // "etag": "my_etag",
9948
+ * // "name": "my_name",
9949
+ * // "reconciling": false,
9950
+ * // "state": "my_state",
9951
+ * // "targetInstances": [],
9952
+ * // "uid": "my_uid",
9953
+ * // "updateTime": "my_updateTime"
9954
+ * // }
9955
+ * },
9956
+ * });
9957
+ * console.log(res.data);
9958
+ *
9959
+ * // Example response
9960
+ * // {
9961
+ * // "done": false,
9962
+ * // "error": {},
9963
+ * // "metadata": {},
9964
+ * // "name": "my_name",
9965
+ * // "response": {}
9966
+ * // }
9967
+ * }
9968
+ *
9969
+ * main().catch(e => {
9970
+ * console.error(e);
9971
+ * throw e;
9972
+ * });
9973
+ *
9974
+ * ```
9975
+ *
9976
+ * @param params - Parameters for request
9977
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
9978
+ * @param callback - Optional callback that handles the response.
9979
+ * @returns A promise if used with async/await, or void if used with a callback.
9980
+ */
9981
+ patch(
9982
+ params: Params$Resource$Projects$Locations$Endpoints$Patch,
9983
+ options: StreamMethodOptions
9984
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
9985
+ patch(
9986
+ params?: Params$Resource$Projects$Locations$Endpoints$Patch,
9987
+ options?: MethodOptions
9988
+ ): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
9989
+ patch(
9990
+ params: Params$Resource$Projects$Locations$Endpoints$Patch,
9991
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
9992
+ callback: BodyResponseCallback<Readable>
9993
+ ): void;
9994
+ patch(
9995
+ params: Params$Resource$Projects$Locations$Endpoints$Patch,
9996
+ options: MethodOptions | BodyResponseCallback<Schema$Operation>,
9997
+ callback: BodyResponseCallback<Schema$Operation>
9998
+ ): void;
9999
+ patch(
10000
+ params: Params$Resource$Projects$Locations$Endpoints$Patch,
10001
+ callback: BodyResponseCallback<Schema$Operation>
10002
+ ): void;
10003
+ patch(callback: BodyResponseCallback<Schema$Operation>): void;
10004
+ patch(
10005
+ paramsOrCallback?:
10006
+ | Params$Resource$Projects$Locations$Endpoints$Patch
10007
+ | BodyResponseCallback<Schema$Operation>
10008
+ | BodyResponseCallback<Readable>,
10009
+ optionsOrCallback?:
10010
+ | MethodOptions
10011
+ | StreamMethodOptions
10012
+ | BodyResponseCallback<Schema$Operation>
10013
+ | BodyResponseCallback<Readable>,
10014
+ callback?:
10015
+ | BodyResponseCallback<Schema$Operation>
10016
+ | BodyResponseCallback<Readable>
10017
+ ):
10018
+ | void
10019
+ | Promise<GaxiosResponseWithHTTP2<Schema$Operation>>
10020
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
10021
+ let params = (paramsOrCallback ||
10022
+ {}) as Params$Resource$Projects$Locations$Endpoints$Patch;
10023
+ let options = (optionsOrCallback || {}) as MethodOptions;
10024
+
10025
+ if (typeof paramsOrCallback === 'function') {
10026
+ callback = paramsOrCallback;
10027
+ params = {} as Params$Resource$Projects$Locations$Endpoints$Patch;
10028
+ options = {};
10029
+ }
10030
+
10031
+ if (typeof optionsOrCallback === 'function') {
10032
+ callback = optionsOrCallback;
10033
+ options = {};
10034
+ }
10035
+
10036
+ const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/';
10037
+ const parameters = {
10038
+ options: Object.assign(
10039
+ {
10040
+ url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
10041
+ method: 'PATCH',
10042
+ apiVersion: '',
10043
+ },
10044
+ options
10045
+ ),
10046
+ params,
10047
+ requiredParams: ['name'],
10048
+ pathParams: ['name'],
10049
+ context: this.context,
10050
+ };
10051
+ if (callback) {
10052
+ createAPIRequest<Schema$Operation>(
10053
+ parameters,
10054
+ callback as BodyResponseCallback<unknown>
10055
+ );
10056
+ } else {
10057
+ return createAPIRequest<Schema$Operation>(parameters);
10058
+ }
10059
+ }
10060
+ }
10061
+
10062
+ export interface Params$Resource$Projects$Locations$Endpoints$Create extends StandardParameters {
10063
+ /**
10064
+ * Required. ID of the requesting object.
10065
+ */
10066
+ endpointId?: string;
10067
+ /**
10068
+ * Required. The location of the new endpoint. For the required format, see the comment on the Endpoint.name field.
10069
+ */
10070
+ parent?: string;
10071
+ /**
10072
+ * 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).
10073
+ */
10074
+ requestId?: string;
10075
+ /**
10076
+ * Optional. If set, the backend validates the request, but doesn't actually execute it.
10077
+ */
10078
+ validateOnly?: boolean;
10079
+
10080
+ /**
10081
+ * Request body metadata
10082
+ */
10083
+ requestBody?: Schema$Endpoint;
10084
+ }
10085
+ export interface Params$Resource$Projects$Locations$Endpoints$Delete extends StandardParameters {
10086
+ /**
10087
+ * Optional. The current etag of the Endpoint. If an etag is provided and does not match the current etag of the Endpoint, deletion will be blocked and an ABORTED error will be returned.
10088
+ */
10089
+ etag?: string;
10090
+ /**
10091
+ * Required. The name of the resource. For the required format, see the comment on the Endpoint.name field.
10092
+ */
10093
+ name?: string;
10094
+ /**
10095
+ * 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 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 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).
10096
+ */
10097
+ requestId?: string;
10098
+ /**
10099
+ * Optional. If set, the backend validates the request, but doesn't actually execute it.
10100
+ */
10101
+ validateOnly?: boolean;
10102
+ }
10103
+ export interface Params$Resource$Projects$Locations$Endpoints$Get extends StandardParameters {
10104
+ /**
10105
+ * Required. The name of the resource. For the required format, see the comment on the Endpoint.name field.
10106
+ */
10107
+ name?: string;
10108
+ }
10109
+ export interface Params$Resource$Projects$Locations$Endpoints$List extends StandardParameters {
10110
+ /**
10111
+ * Optional. Filtering results. This field is currently not supported, its value will be ignored if passed.
10112
+ */
10113
+ filter?: string;
10114
+ /**
10115
+ * Optional. Hint for how to order the results
10116
+ */
10117
+ orderBy?: string;
10118
+ /**
10119
+ * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
10120
+ */
10121
+ pageSize?: number;
10122
+ /**
10123
+ * Optional. A page token, received from a previous `ListEndpoints` call. This should be provided to retrieve the subsequent page. This field is currently not supported, its value will be ignored if passed.
10124
+ */
10125
+ pageToken?: string;
10126
+ /**
10127
+ * Required. The name of the parent resource. For the required format, see the comment on the Endpoint.name field. Additionally, you can perform an aggregated list operation by specifying a value with the following format: * projects/{project\}/locations/-
10128
+ */
10129
+ parent?: string;
10130
+ }
10131
+ export interface Params$Resource$Projects$Locations$Endpoints$Patch extends StandardParameters {
10132
+ /**
10133
+ * Optional. If set to true, update succeeds even if endpoint is not found. In that case, a new endpoint is created and `update_mask` is ignored.
10134
+ */
10135
+ allowMissing?: boolean;
10136
+ /**
10137
+ * Output only. Identifier. The name of the endpoint resource with the format: * projects/{project\}/locations/{region\}/endpoints/{endpoint_id\} where the endpoint ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the endpoint resource name is the name of the parent resource: * projects/{project\}/locations/{region\}
10138
+ */
10139
+ name?: string;
10140
+ /**
10141
+ * 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).
10142
+ */
10143
+ requestId?: string;
10144
+ /**
10145
+ * Optional. Field mask is used to specify the fields to be overwritten in the Endpoint resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
10146
+ */
10147
+ updateMask?: string;
10148
+ /**
10149
+ * Optional. If set, the backend validates the request, but doesn't actually execute it.
10150
+ */
10151
+ validateOnly?: boolean;
10152
+
10153
+ /**
10154
+ * Request body metadata
10155
+ */
10156
+ requestBody?: Schema$Endpoint;
10157
+ }
10158
+
9131
10159
  export class Resource$Projects$Locations$Operations {
9132
10160
  context: APIRequestContext;
9133
10161
  constructor(context: APIRequestContext) {