@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/build/v1beta.d.ts CHANGED
@@ -604,14 +604,6 @@ export declare namespace alloydb_v1beta {
604
604
  * Configuration for Managed Connection Pool (MCP).
605
605
  */
606
606
  export interface Schema$ConnectionPoolConfig {
607
- /**
608
- * 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.
609
- */
610
- defaultPoolSize?: string | null;
611
- /**
612
- * Optional. Deprecated; Prefer 'enabled' as this will be removed soon.
613
- */
614
- enable?: boolean | null;
615
607
  /**
616
608
  * Optional. Whether to enable Managed Connection Pool (MCP).
617
609
  */
@@ -622,42 +614,10 @@ export declare namespace alloydb_v1beta {
622
614
  flags?: {
623
615
  [key: string]: string;
624
616
  } | null;
625
- /**
626
- * 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.
627
- */
628
- ignoreStartupParameters?: string[] | null;
629
- /**
630
- * 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.
631
- */
632
- maxClientConn?: string | null;
633
- /**
634
- * 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.
635
- */
636
- maxPreparedStatements?: string | null;
637
- /**
638
- * 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.
639
- */
640
- minPoolSize?: string | null;
641
617
  /**
642
618
  * Output only. The number of running poolers per instance.
643
619
  */
644
620
  poolerCount?: number | null;
645
- /**
646
- * 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.
647
- */
648
- poolMode?: string | null;
649
- /**
650
- * 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.
651
- */
652
- queryWaitTimeout?: string | null;
653
- /**
654
- * 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.
655
- */
656
- serverIdleTimeout?: string | null;
657
- /**
658
- * 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.
659
- */
660
- statsUsers?: string[] | null;
661
621
  }
662
622
  /**
663
623
  * ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster.
@@ -791,6 +751,19 @@ export declare namespace alloydb_v1beta {
791
751
  */
792
752
  time?: Schema$GoogleTypeTimeOfDay;
793
753
  }
754
+ /**
755
+ * The DNS config for the endpoint, containing the DNS record name, type and targets.
756
+ */
757
+ export interface Schema$DNSConfig {
758
+ /**
759
+ * The fully qualified domain name (FQDN) of the DNS record, e.g., ".location.alloydb-psa.goog".
760
+ */
761
+ dnsName?: string | null;
762
+ /**
763
+ * The type of the DNS record, e.g., "A", "AAAA", "CNAME".
764
+ */
765
+ dnsRecordType?: string | null;
766
+ }
794
767
  /**
795
768
  * 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); \}
796
769
  */
@@ -818,6 +791,69 @@ export declare namespace alloydb_v1beta {
818
791
  */
819
792
  kmsKeyVersions?: string[] | null;
820
793
  }
794
+ /**
795
+ * Endpoint resource.
796
+ */
797
+ export interface Schema$Endpoint {
798
+ /**
799
+ * Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
800
+ */
801
+ annotations?: {
802
+ [key: string]: string;
803
+ } | null;
804
+ /**
805
+ * Output only. Create time stamp
806
+ */
807
+ createTime?: string | null;
808
+ /**
809
+ * Output only. Delete time stamp
810
+ */
811
+ deleteTime?: string | null;
812
+ /**
813
+ * User-settable and human-readable display name for the Endpoint.
814
+ */
815
+ displayName?: string | null;
816
+ /**
817
+ * 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.
818
+ */
819
+ dnsConfig?: Schema$DNSConfig;
820
+ /**
821
+ * 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.
822
+ */
823
+ effectiveTargetInstances?: string[] | null;
824
+ /**
825
+ * The type of the endpoint, either write or read.
826
+ */
827
+ endpointType?: string | null;
828
+ /**
829
+ * For Resource freshness validation (https://google.aip.dev/154)
830
+ */
831
+ etag?: string | null;
832
+ /**
833
+ * 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\}
834
+ */
835
+ name?: string | null;
836
+ /**
837
+ * 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.
838
+ */
839
+ reconciling?: boolean | null;
840
+ /**
841
+ * Output only. The state of the endpoint.
842
+ */
843
+ state?: string | null;
844
+ /**
845
+ * 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.
846
+ */
847
+ targetInstances?: string[] | null;
848
+ /**
849
+ * 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.
850
+ */
851
+ uid?: string | null;
852
+ /**
853
+ * Output only. Update time stamp
854
+ */
855
+ updateTime?: string | null;
856
+ }
821
857
  /**
822
858
  * Export cluster request.
823
859
  */
@@ -1040,6 +1076,10 @@ export declare namespace alloydb_v1beta {
1040
1076
  * Output only. Create time stamp
1041
1077
  */
1042
1078
  createTime?: string | null;
1079
+ /**
1080
+ * 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.
1081
+ */
1082
+ dataApiAccess?: string | null;
1043
1083
  /**
1044
1084
  * 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.
1045
1085
  */
@@ -1162,7 +1202,7 @@ export declare namespace alloydb_v1beta {
1162
1202
  */
1163
1203
  export interface Schema$InstanceNetworkConfig {
1164
1204
  /**
1165
- * 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])?.
1205
+ * 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])?.
1166
1206
  */
1167
1207
  allocatedIpRangeOverride?: string | null;
1168
1208
  /**
@@ -1246,6 +1286,23 @@ export declare namespace alloydb_v1beta {
1246
1286
  */
1247
1287
  unreachable?: string[] | null;
1248
1288
  }
1289
+ /**
1290
+ * Message for response to listing Endpoints
1291
+ */
1292
+ export interface Schema$ListEndpointsResponse {
1293
+ /**
1294
+ * The list of Endpoints
1295
+ */
1296
+ endpoints?: Schema$Endpoint[];
1297
+ /**
1298
+ * A token identifying a page of results the server should return.
1299
+ */
1300
+ nextPageToken?: string | null;
1301
+ /**
1302
+ * Locations that could not be reached.
1303
+ */
1304
+ unreachable?: string[] | null;
1305
+ }
1249
1306
  /**
1250
1307
  * Message for response to listing Instances
1251
1308
  */
@@ -1400,6 +1457,10 @@ export declare namespace alloydb_v1beta {
1400
1457
  * Output only. The private IP address of the VM e.g. "10.57.0.34".
1401
1458
  */
1402
1459
  ip?: string | null;
1460
+ /**
1461
+ * Output only. Indicates whether the node set up to be configured as a hot standby.
1462
+ */
1463
+ isHotStandby?: boolean | null;
1403
1464
  /**
1404
1465
  * 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.
1405
1466
  */
@@ -1441,6 +1502,10 @@ export declare namespace alloydb_v1beta {
1441
1502
  * Track actively running queries on the instance. If not set, this flag is "off" by default.
1442
1503
  */
1443
1504
  trackActiveQueries?: boolean | null;
1505
+ /**
1506
+ * 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.
1507
+ */
1508
+ trackActiveQueryPlan?: boolean | null;
1444
1509
  /**
1445
1510
  * Track client address for an instance. If not set, default value is "off".
1446
1511
  */
@@ -1558,6 +1623,10 @@ export declare namespace alloydb_v1beta {
1558
1623
  * 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.
1559
1624
  */
1560
1625
  etag?: string | null;
1626
+ /**
1627
+ * 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.
1628
+ */
1629
+ failover?: boolean | null;
1561
1630
  /**
1562
1631
  * 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).
1563
1632
  */
@@ -2192,7 +2261,7 @@ export declare namespace alloydb_v1beta {
2192
2261
  uniqueId?: string | null;
2193
2262
  }
2194
2263
  /**
2195
- * Common model for database resource instance metadata. Next ID: 30
2264
+ * Common model for database resource instance metadata. Next ID: 32
2196
2265
  */
2197
2266
  export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata {
2198
2267
  /**
@@ -2263,6 +2332,10 @@ export declare namespace alloydb_v1beta {
2263
2332
  * Optional. Maintenance info for the resource.
2264
2333
  */
2265
2334
  maintenanceInfo?: Schema$StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo;
2335
+ /**
2336
+ * Optional. The modes of the database resource.
2337
+ */
2338
+ modes?: string[] | null;
2266
2339
  /**
2267
2340
  * 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.
2268
2341
  */
@@ -2279,6 +2352,10 @@ export declare namespace alloydb_v1beta {
2279
2352
  * 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.
2280
2353
  */
2281
2354
  resourceContainer?: string | null;
2355
+ /**
2356
+ * Optional. List of resource flags for the database resource.
2357
+ */
2358
+ resourceFlags?: Schema$StorageDatabasecenterPartnerapiV1mainResourceFlags[];
2282
2359
  /**
2283
2360
  * 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
2284
2361
  */
@@ -2344,9 +2421,13 @@ export declare namespace alloydb_v1beta {
2344
2421
  signalType?: string | null;
2345
2422
  }
2346
2423
  /**
2347
- * 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
2424
+ * 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
2348
2425
  */
2349
2426
  export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData {
2427
+ /**
2428
+ * Deprecated: Use signal_metadata_list instead.
2429
+ */
2430
+ backupRun?: Schema$StorageDatabasecenterPartnerapiV1mainBackupRun;
2350
2431
  /**
2351
2432
  * Required. Full Resource name of the source resource.
2352
2433
  */
@@ -2355,14 +2436,22 @@ export declare namespace alloydb_v1beta {
2355
2436
  * Required. Last time signal was refreshed
2356
2437
  */
2357
2438
  lastRefreshTime?: string | null;
2439
+ /**
2440
+ * Required. Resource location.
2441
+ */
2442
+ location?: string | null;
2358
2443
  /**
2359
2444
  * Database resource id.
2360
2445
  */
2361
2446
  resourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId;
2362
2447
  /**
2363
- * Signal data for boolean signals.
2448
+ * Deprecated: Use signal_metadata_list instead.
2364
2449
  */
2365
2450
  signalBoolValue?: boolean | null;
2451
+ /**
2452
+ * This will support array of OneOf signal metadata information for a given signal type.
2453
+ */
2454
+ signalMetadataList?: Schema$StorageDatabasecenterPartnerapiV1mainSignalMetadata[];
2366
2455
  /**
2367
2456
  * Required. Output only. Signal state of the signal
2368
2457
  */
@@ -2482,6 +2571,19 @@ export declare namespace alloydb_v1beta {
2482
2571
  */
2483
2572
  message?: string | null;
2484
2573
  }
2574
+ /**
2575
+ * Message type for storing resource flags.
2576
+ */
2577
+ export interface Schema$StorageDatabasecenterPartnerapiV1mainResourceFlags {
2578
+ /**
2579
+ * Optional. Key of the resource flag.
2580
+ */
2581
+ key?: string | null;
2582
+ /**
2583
+ * Optional. Value of the resource flag.
2584
+ */
2585
+ value?: string | null;
2586
+ }
2485
2587
  /**
2486
2588
  * Deny maintenance period for the database resource. It specifies the time range during which the maintenance cannot start. This is configured by the customer.
2487
2589
  */
@@ -2503,18 +2605,34 @@ export declare namespace alloydb_v1beta {
2503
2605
  * MaintenanceInfo to capture the maintenance details of database resource.
2504
2606
  */
2505
2607
  export interface Schema$StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo {
2608
+ /**
2609
+ * Optional. The date when the current maintenance version was released.
2610
+ */
2611
+ currentVersionReleaseDate?: Schema$GoogleTypeDate;
2506
2612
  /**
2507
2613
  * Optional. List of Deny maintenance period for the database resource.
2508
2614
  */
2509
2615
  denyMaintenanceSchedules?: Schema$StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule[];
2616
+ /**
2617
+ * Optional. Whether the instance is in stopped state. This information is temporarily being captured in maintenanceInfo, till STOPPED state is supported by DB Center.
2618
+ */
2619
+ isInstanceStopped?: boolean | null;
2510
2620
  /**
2511
2621
  * Optional. Maintenance window for the database resource.
2512
2622
  */
2513
2623
  maintenanceSchedule?: Schema$StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule;
2624
+ /**
2625
+ * Output only. Current state of maintenance on the database resource.
2626
+ */
2627
+ maintenanceState?: string | null;
2514
2628
  /**
2515
2629
  * Optional. Current Maintenance version of the database resource. Example: "MYSQL_8_0_41.R20250531.01_15"
2516
2630
  */
2517
2631
  maintenanceVersion?: string | null;
2632
+ /**
2633
+ * Optional. Upcoming maintenance for the database resource. This field is populated once SLM generates and publishes upcoming maintenance window.
2634
+ */
2635
+ upcomingMaintenance?: Schema$StorageDatabasecenterPartnerapiV1mainUpcomingMaintenance;
2518
2636
  }
2519
2637
  /**
2520
2638
  * 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.
@@ -2549,6 +2667,19 @@ export declare namespace alloydb_v1beta {
2549
2667
  */
2550
2668
  timestampBasedRetentionTime?: string | null;
2551
2669
  }
2670
+ /**
2671
+ * 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
2672
+ */
2673
+ export interface Schema$StorageDatabasecenterPartnerapiV1mainSignalMetadata {
2674
+ /**
2675
+ * Signal data for backup runs.
2676
+ */
2677
+ backupRun?: Schema$StorageDatabasecenterPartnerapiV1mainBackupRun;
2678
+ /**
2679
+ * Signal data for boolean signals.
2680
+ */
2681
+ signalBoolValue?: boolean | null;
2682
+ }
2552
2683
  /**
2553
2684
  * 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.
2554
2685
  */
@@ -2560,6 +2691,19 @@ export declare namespace alloydb_v1beta {
2560
2691
  [key: string]: string;
2561
2692
  } | null;
2562
2693
  }
2694
+ /**
2695
+ * Upcoming maintenance for the database resource. This is generated by SLM once the upcoming maintenance schedule is published.
2696
+ */
2697
+ export interface Schema$StorageDatabasecenterPartnerapiV1mainUpcomingMaintenance {
2698
+ /**
2699
+ * Optional. The end time of the upcoming maintenance.
2700
+ */
2701
+ endTime?: string | null;
2702
+ /**
2703
+ * Optional. The start time of the upcoming maintenance.
2704
+ */
2705
+ startTime?: string | null;
2706
+ }
2563
2707
  /**
2564
2708
  * 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.
2565
2709
  */
@@ -2840,6 +2984,7 @@ export declare namespace alloydb_v1beta {
2840
2984
  context: APIRequestContext;
2841
2985
  backups: Resource$Projects$Locations$Backups;
2842
2986
  clusters: Resource$Projects$Locations$Clusters;
2987
+ endpoints: Resource$Projects$Locations$Endpoints;
2843
2988
  operations: Resource$Projects$Locations$Operations;
2844
2989
  supportedDatabaseFlags: Resource$Projects$Locations$Supporteddatabaseflags;
2845
2990
  constructor(context: APIRequestContext);
@@ -2908,7 +3053,7 @@ export declare namespace alloydb_v1beta {
2908
3053
  get(params: Params$Resource$Projects$Locations$Get, callback: BodyResponseCallback<Schema$GoogleCloudLocationLocation>): void;
2909
3054
  get(callback: BodyResponseCallback<Schema$GoogleCloudLocationLocation>): void;
2910
3055
  /**
2911
- * Lists information about the supported locations for this service.
3056
+ * 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.
2912
3057
  * @example
2913
3058
  * ```js
2914
3059
  * // Before running the sample:
@@ -2938,7 +3083,7 @@ export declare namespace alloydb_v1beta {
2938
3083
  *
2939
3084
  * // Do the magic
2940
3085
  * const res = await alloydb.projects.locations.list({
2941
- * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.
3086
+ * // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
2942
3087
  * extraLocationTypes: 'placeholder-value',
2943
3088
  * // 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).
2944
3089
  * filter: 'placeholder-value',
@@ -2985,7 +3130,7 @@ export declare namespace alloydb_v1beta {
2985
3130
  }
2986
3131
  export interface Params$Resource$Projects$Locations$List extends StandardParameters {
2987
3132
  /**
2988
- * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.
3133
+ * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
2989
3134
  */
2990
3135
  extraLocationTypes?: string[];
2991
3136
  /**
@@ -4336,6 +4481,7 @@ export declare namespace alloydb_v1beta {
4336
4481
  * // request body parameters
4337
4482
  * // {
4338
4483
  * // "etag": "my_etag",
4484
+ * // "failover": false,
4339
4485
  * // "requestId": "my_requestId",
4340
4486
  * // "validateOnly": false
4341
4487
  * // }
@@ -4920,6 +5066,7 @@ export declare namespace alloydb_v1beta {
4920
5066
  * // "clientConnectionConfig": {},
4921
5067
  * // "connectionPoolConfig": {},
4922
5068
  * // "createTime": "my_createTime",
5069
+ * // "dataApiAccess": "my_dataApiAccess",
4923
5070
  * // "databaseFlags": {},
4924
5071
  * // "deleteTime": "my_deleteTime",
4925
5072
  * // "displayName": "my_displayName",
@@ -5032,6 +5179,7 @@ export declare namespace alloydb_v1beta {
5032
5179
  * // "clientConnectionConfig": {},
5033
5180
  * // "connectionPoolConfig": {},
5034
5181
  * // "createTime": "my_createTime",
5182
+ * // "dataApiAccess": "my_dataApiAccess",
5035
5183
  * // "databaseFlags": {},
5036
5184
  * // "deleteTime": "my_deleteTime",
5037
5185
  * // "displayName": "my_displayName",
@@ -5282,6 +5430,7 @@ export declare namespace alloydb_v1beta {
5282
5430
  * // "clientConnectionConfig": {},
5283
5431
  * // "connectionPoolConfig": {},
5284
5432
  * // "createTime": "my_createTime",
5433
+ * // "dataApiAccess": "my_dataApiAccess",
5285
5434
  * // "databaseFlags": {},
5286
5435
  * // "deleteTime": "my_deleteTime",
5287
5436
  * // "displayName": "my_displayName",
@@ -5596,6 +5745,7 @@ export declare namespace alloydb_v1beta {
5596
5745
  * // "clientConnectionConfig": {},
5597
5746
  * // "connectionPoolConfig": {},
5598
5747
  * // "createTime": "my_createTime",
5748
+ * // "dataApiAccess": "my_dataApiAccess",
5599
5749
  * // "databaseFlags": {},
5600
5750
  * // "deleteTime": "my_deleteTime",
5601
5751
  * // "displayName": "my_displayName",
@@ -6348,6 +6498,501 @@ export declare namespace alloydb_v1beta {
6348
6498
  */
6349
6499
  requestBody?: Schema$User;
6350
6500
  }
6501
+ export class Resource$Projects$Locations$Endpoints {
6502
+ context: APIRequestContext;
6503
+ constructor(context: APIRequestContext);
6504
+ /**
6505
+ * Creates a new Endpoint in a given project and location.
6506
+ * @example
6507
+ * ```js
6508
+ * // Before running the sample:
6509
+ * // - Enable the API at:
6510
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
6511
+ * // - Login into gcloud by running:
6512
+ * // ```sh
6513
+ * // $ gcloud auth application-default login
6514
+ * // ```
6515
+ * // - Install the npm module by running:
6516
+ * // ```sh
6517
+ * // $ npm install googleapis
6518
+ * // ```
6519
+ *
6520
+ * const {google} = require('googleapis');
6521
+ * const alloydb = google.alloydb('v1beta');
6522
+ *
6523
+ * async function main() {
6524
+ * const auth = new google.auth.GoogleAuth({
6525
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6526
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
6527
+ * });
6528
+ *
6529
+ * // Acquire an auth client, and bind it to all future calls
6530
+ * const authClient = await auth.getClient();
6531
+ * google.options({auth: authClient});
6532
+ *
6533
+ * // Do the magic
6534
+ * const res = await alloydb.projects.locations.endpoints.create({
6535
+ * // Required. ID of the requesting object.
6536
+ * endpointId: 'placeholder-value',
6537
+ * // Required. The location of the new endpoint. For the required format, see the comment on the Endpoint.name field.
6538
+ * parent: 'projects/my-project/locations/my-location',
6539
+ * // 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).
6540
+ * requestId: 'placeholder-value',
6541
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
6542
+ * validateOnly: 'placeholder-value',
6543
+ *
6544
+ * // Request body metadata
6545
+ * requestBody: {
6546
+ * // request body parameters
6547
+ * // {
6548
+ * // "annotations": {},
6549
+ * // "createTime": "my_createTime",
6550
+ * // "deleteTime": "my_deleteTime",
6551
+ * // "displayName": "my_displayName",
6552
+ * // "dnsConfig": {},
6553
+ * // "effectiveTargetInstances": [],
6554
+ * // "endpointType": "my_endpointType",
6555
+ * // "etag": "my_etag",
6556
+ * // "name": "my_name",
6557
+ * // "reconciling": false,
6558
+ * // "state": "my_state",
6559
+ * // "targetInstances": [],
6560
+ * // "uid": "my_uid",
6561
+ * // "updateTime": "my_updateTime"
6562
+ * // }
6563
+ * },
6564
+ * });
6565
+ * console.log(res.data);
6566
+ *
6567
+ * // Example response
6568
+ * // {
6569
+ * // "done": false,
6570
+ * // "error": {},
6571
+ * // "metadata": {},
6572
+ * // "name": "my_name",
6573
+ * // "response": {}
6574
+ * // }
6575
+ * }
6576
+ *
6577
+ * main().catch(e => {
6578
+ * console.error(e);
6579
+ * throw e;
6580
+ * });
6581
+ *
6582
+ * ```
6583
+ *
6584
+ * @param params - Parameters for request
6585
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
6586
+ * @param callback - Optional callback that handles the response.
6587
+ * @returns A promise if used with async/await, or void if used with a callback.
6588
+ */
6589
+ create(params: Params$Resource$Projects$Locations$Endpoints$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
6590
+ create(params?: Params$Resource$Projects$Locations$Endpoints$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
6591
+ create(params: Params$Resource$Projects$Locations$Endpoints$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
6592
+ create(params: Params$Resource$Projects$Locations$Endpoints$Create, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
6593
+ create(params: Params$Resource$Projects$Locations$Endpoints$Create, callback: BodyResponseCallback<Schema$Operation>): void;
6594
+ create(callback: BodyResponseCallback<Schema$Operation>): void;
6595
+ /**
6596
+ * Deletes a single Endpoint.
6597
+ * @example
6598
+ * ```js
6599
+ * // Before running the sample:
6600
+ * // - Enable the API at:
6601
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
6602
+ * // - Login into gcloud by running:
6603
+ * // ```sh
6604
+ * // $ gcloud auth application-default login
6605
+ * // ```
6606
+ * // - Install the npm module by running:
6607
+ * // ```sh
6608
+ * // $ npm install googleapis
6609
+ * // ```
6610
+ *
6611
+ * const {google} = require('googleapis');
6612
+ * const alloydb = google.alloydb('v1beta');
6613
+ *
6614
+ * async function main() {
6615
+ * const auth = new google.auth.GoogleAuth({
6616
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6617
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
6618
+ * });
6619
+ *
6620
+ * // Acquire an auth client, and bind it to all future calls
6621
+ * const authClient = await auth.getClient();
6622
+ * google.options({auth: authClient});
6623
+ *
6624
+ * // Do the magic
6625
+ * const res = await alloydb.projects.locations.endpoints.delete({
6626
+ * // 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.
6627
+ * etag: 'placeholder-value',
6628
+ * // Required. The name of the resource. For the required format, see the comment on the Endpoint.name field.
6629
+ * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint',
6630
+ * // 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).
6631
+ * requestId: 'placeholder-value',
6632
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
6633
+ * validateOnly: 'placeholder-value',
6634
+ * });
6635
+ * console.log(res.data);
6636
+ *
6637
+ * // Example response
6638
+ * // {
6639
+ * // "done": false,
6640
+ * // "error": {},
6641
+ * // "metadata": {},
6642
+ * // "name": "my_name",
6643
+ * // "response": {}
6644
+ * // }
6645
+ * }
6646
+ *
6647
+ * main().catch(e => {
6648
+ * console.error(e);
6649
+ * throw e;
6650
+ * });
6651
+ *
6652
+ * ```
6653
+ *
6654
+ * @param params - Parameters for request
6655
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
6656
+ * @param callback - Optional callback that handles the response.
6657
+ * @returns A promise if used with async/await, or void if used with a callback.
6658
+ */
6659
+ delete(params: Params$Resource$Projects$Locations$Endpoints$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
6660
+ delete(params?: Params$Resource$Projects$Locations$Endpoints$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
6661
+ delete(params: Params$Resource$Projects$Locations$Endpoints$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
6662
+ delete(params: Params$Resource$Projects$Locations$Endpoints$Delete, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
6663
+ delete(params: Params$Resource$Projects$Locations$Endpoints$Delete, callback: BodyResponseCallback<Schema$Operation>): void;
6664
+ delete(callback: BodyResponseCallback<Schema$Operation>): void;
6665
+ /**
6666
+ * Gets details of a single Endpoint.
6667
+ * @example
6668
+ * ```js
6669
+ * // Before running the sample:
6670
+ * // - Enable the API at:
6671
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
6672
+ * // - Login into gcloud by running:
6673
+ * // ```sh
6674
+ * // $ gcloud auth application-default login
6675
+ * // ```
6676
+ * // - Install the npm module by running:
6677
+ * // ```sh
6678
+ * // $ npm install googleapis
6679
+ * // ```
6680
+ *
6681
+ * const {google} = require('googleapis');
6682
+ * const alloydb = google.alloydb('v1beta');
6683
+ *
6684
+ * async function main() {
6685
+ * const auth = new google.auth.GoogleAuth({
6686
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6687
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
6688
+ * });
6689
+ *
6690
+ * // Acquire an auth client, and bind it to all future calls
6691
+ * const authClient = await auth.getClient();
6692
+ * google.options({auth: authClient});
6693
+ *
6694
+ * // Do the magic
6695
+ * const res = await alloydb.projects.locations.endpoints.get({
6696
+ * // Required. The name of the resource. For the required format, see the comment on the Endpoint.name field.
6697
+ * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint',
6698
+ * });
6699
+ * console.log(res.data);
6700
+ *
6701
+ * // Example response
6702
+ * // {
6703
+ * // "annotations": {},
6704
+ * // "createTime": "my_createTime",
6705
+ * // "deleteTime": "my_deleteTime",
6706
+ * // "displayName": "my_displayName",
6707
+ * // "dnsConfig": {},
6708
+ * // "effectiveTargetInstances": [],
6709
+ * // "endpointType": "my_endpointType",
6710
+ * // "etag": "my_etag",
6711
+ * // "name": "my_name",
6712
+ * // "reconciling": false,
6713
+ * // "state": "my_state",
6714
+ * // "targetInstances": [],
6715
+ * // "uid": "my_uid",
6716
+ * // "updateTime": "my_updateTime"
6717
+ * // }
6718
+ * }
6719
+ *
6720
+ * main().catch(e => {
6721
+ * console.error(e);
6722
+ * throw e;
6723
+ * });
6724
+ *
6725
+ * ```
6726
+ *
6727
+ * @param params - Parameters for request
6728
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
6729
+ * @param callback - Optional callback that handles the response.
6730
+ * @returns A promise if used with async/await, or void if used with a callback.
6731
+ */
6732
+ get(params: Params$Resource$Projects$Locations$Endpoints$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
6733
+ get(params?: Params$Resource$Projects$Locations$Endpoints$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Endpoint>>;
6734
+ get(params: Params$Resource$Projects$Locations$Endpoints$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
6735
+ get(params: Params$Resource$Projects$Locations$Endpoints$Get, options: MethodOptions | BodyResponseCallback<Schema$Endpoint>, callback: BodyResponseCallback<Schema$Endpoint>): void;
6736
+ get(params: Params$Resource$Projects$Locations$Endpoints$Get, callback: BodyResponseCallback<Schema$Endpoint>): void;
6737
+ get(callback: BodyResponseCallback<Schema$Endpoint>): void;
6738
+ /**
6739
+ * Lists Endpoints in a given project and location.
6740
+ * @example
6741
+ * ```js
6742
+ * // Before running the sample:
6743
+ * // - Enable the API at:
6744
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
6745
+ * // - Login into gcloud by running:
6746
+ * // ```sh
6747
+ * // $ gcloud auth application-default login
6748
+ * // ```
6749
+ * // - Install the npm module by running:
6750
+ * // ```sh
6751
+ * // $ npm install googleapis
6752
+ * // ```
6753
+ *
6754
+ * const {google} = require('googleapis');
6755
+ * const alloydb = google.alloydb('v1beta');
6756
+ *
6757
+ * async function main() {
6758
+ * const auth = new google.auth.GoogleAuth({
6759
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6760
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
6761
+ * });
6762
+ *
6763
+ * // Acquire an auth client, and bind it to all future calls
6764
+ * const authClient = await auth.getClient();
6765
+ * google.options({auth: authClient});
6766
+ *
6767
+ * // Do the magic
6768
+ * const res = await alloydb.projects.locations.endpoints.list({
6769
+ * // Optional. Filtering results. This field is currently not supported, its value will be ignored if passed.
6770
+ * filter: 'placeholder-value',
6771
+ * // Optional. Hint for how to order the results
6772
+ * orderBy: 'placeholder-value',
6773
+ * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
6774
+ * pageSize: 'placeholder-value',
6775
+ * // 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.
6776
+ * pageToken: 'placeholder-value',
6777
+ * // 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/-
6778
+ * parent: 'projects/my-project/locations/my-location',
6779
+ * });
6780
+ * console.log(res.data);
6781
+ *
6782
+ * // Example response
6783
+ * // {
6784
+ * // "endpoints": [],
6785
+ * // "nextPageToken": "my_nextPageToken",
6786
+ * // "unreachable": []
6787
+ * // }
6788
+ * }
6789
+ *
6790
+ * main().catch(e => {
6791
+ * console.error(e);
6792
+ * throw e;
6793
+ * });
6794
+ *
6795
+ * ```
6796
+ *
6797
+ * @param params - Parameters for request
6798
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
6799
+ * @param callback - Optional callback that handles the response.
6800
+ * @returns A promise if used with async/await, or void if used with a callback.
6801
+ */
6802
+ list(params: Params$Resource$Projects$Locations$Endpoints$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
6803
+ list(params?: Params$Resource$Projects$Locations$Endpoints$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ListEndpointsResponse>>;
6804
+ list(params: Params$Resource$Projects$Locations$Endpoints$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
6805
+ list(params: Params$Resource$Projects$Locations$Endpoints$List, options: MethodOptions | BodyResponseCallback<Schema$ListEndpointsResponse>, callback: BodyResponseCallback<Schema$ListEndpointsResponse>): void;
6806
+ list(params: Params$Resource$Projects$Locations$Endpoints$List, callback: BodyResponseCallback<Schema$ListEndpointsResponse>): void;
6807
+ list(callback: BodyResponseCallback<Schema$ListEndpointsResponse>): void;
6808
+ /**
6809
+ * Updates the parameters of a single Endpoint.
6810
+ * @example
6811
+ * ```js
6812
+ * // Before running the sample:
6813
+ * // - Enable the API at:
6814
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
6815
+ * // - Login into gcloud by running:
6816
+ * // ```sh
6817
+ * // $ gcloud auth application-default login
6818
+ * // ```
6819
+ * // - Install the npm module by running:
6820
+ * // ```sh
6821
+ * // $ npm install googleapis
6822
+ * // ```
6823
+ *
6824
+ * const {google} = require('googleapis');
6825
+ * const alloydb = google.alloydb('v1beta');
6826
+ *
6827
+ * async function main() {
6828
+ * const auth = new google.auth.GoogleAuth({
6829
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6830
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
6831
+ * });
6832
+ *
6833
+ * // Acquire an auth client, and bind it to all future calls
6834
+ * const authClient = await auth.getClient();
6835
+ * google.options({auth: authClient});
6836
+ *
6837
+ * // Do the magic
6838
+ * const res = await alloydb.projects.locations.endpoints.patch({
6839
+ * // 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.
6840
+ * allowMissing: 'placeholder-value',
6841
+ * // 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\}
6842
+ * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint',
6843
+ * // 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).
6844
+ * requestId: 'placeholder-value',
6845
+ * // 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.
6846
+ * updateMask: 'placeholder-value',
6847
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
6848
+ * validateOnly: 'placeholder-value',
6849
+ *
6850
+ * // Request body metadata
6851
+ * requestBody: {
6852
+ * // request body parameters
6853
+ * // {
6854
+ * // "annotations": {},
6855
+ * // "createTime": "my_createTime",
6856
+ * // "deleteTime": "my_deleteTime",
6857
+ * // "displayName": "my_displayName",
6858
+ * // "dnsConfig": {},
6859
+ * // "effectiveTargetInstances": [],
6860
+ * // "endpointType": "my_endpointType",
6861
+ * // "etag": "my_etag",
6862
+ * // "name": "my_name",
6863
+ * // "reconciling": false,
6864
+ * // "state": "my_state",
6865
+ * // "targetInstances": [],
6866
+ * // "uid": "my_uid",
6867
+ * // "updateTime": "my_updateTime"
6868
+ * // }
6869
+ * },
6870
+ * });
6871
+ * console.log(res.data);
6872
+ *
6873
+ * // Example response
6874
+ * // {
6875
+ * // "done": false,
6876
+ * // "error": {},
6877
+ * // "metadata": {},
6878
+ * // "name": "my_name",
6879
+ * // "response": {}
6880
+ * // }
6881
+ * }
6882
+ *
6883
+ * main().catch(e => {
6884
+ * console.error(e);
6885
+ * throw e;
6886
+ * });
6887
+ *
6888
+ * ```
6889
+ *
6890
+ * @param params - Parameters for request
6891
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
6892
+ * @param callback - Optional callback that handles the response.
6893
+ * @returns A promise if used with async/await, or void if used with a callback.
6894
+ */
6895
+ patch(params: Params$Resource$Projects$Locations$Endpoints$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
6896
+ patch(params?: Params$Resource$Projects$Locations$Endpoints$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
6897
+ patch(params: Params$Resource$Projects$Locations$Endpoints$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
6898
+ patch(params: Params$Resource$Projects$Locations$Endpoints$Patch, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
6899
+ patch(params: Params$Resource$Projects$Locations$Endpoints$Patch, callback: BodyResponseCallback<Schema$Operation>): void;
6900
+ patch(callback: BodyResponseCallback<Schema$Operation>): void;
6901
+ }
6902
+ export interface Params$Resource$Projects$Locations$Endpoints$Create extends StandardParameters {
6903
+ /**
6904
+ * Required. ID of the requesting object.
6905
+ */
6906
+ endpointId?: string;
6907
+ /**
6908
+ * Required. The location of the new endpoint. For the required format, see the comment on the Endpoint.name field.
6909
+ */
6910
+ parent?: string;
6911
+ /**
6912
+ * 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).
6913
+ */
6914
+ requestId?: string;
6915
+ /**
6916
+ * Optional. If set, the backend validates the request, but doesn't actually execute it.
6917
+ */
6918
+ validateOnly?: boolean;
6919
+ /**
6920
+ * Request body metadata
6921
+ */
6922
+ requestBody?: Schema$Endpoint;
6923
+ }
6924
+ export interface Params$Resource$Projects$Locations$Endpoints$Delete extends StandardParameters {
6925
+ /**
6926
+ * 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.
6927
+ */
6928
+ etag?: string;
6929
+ /**
6930
+ * Required. The name of the resource. For the required format, see the comment on the Endpoint.name field.
6931
+ */
6932
+ name?: string;
6933
+ /**
6934
+ * 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).
6935
+ */
6936
+ requestId?: string;
6937
+ /**
6938
+ * Optional. If set, the backend validates the request, but doesn't actually execute it.
6939
+ */
6940
+ validateOnly?: boolean;
6941
+ }
6942
+ export interface Params$Resource$Projects$Locations$Endpoints$Get extends StandardParameters {
6943
+ /**
6944
+ * Required. The name of the resource. For the required format, see the comment on the Endpoint.name field.
6945
+ */
6946
+ name?: string;
6947
+ }
6948
+ export interface Params$Resource$Projects$Locations$Endpoints$List extends StandardParameters {
6949
+ /**
6950
+ * Optional. Filtering results. This field is currently not supported, its value will be ignored if passed.
6951
+ */
6952
+ filter?: string;
6953
+ /**
6954
+ * Optional. Hint for how to order the results
6955
+ */
6956
+ orderBy?: string;
6957
+ /**
6958
+ * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
6959
+ */
6960
+ pageSize?: number;
6961
+ /**
6962
+ * 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.
6963
+ */
6964
+ pageToken?: string;
6965
+ /**
6966
+ * 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/-
6967
+ */
6968
+ parent?: string;
6969
+ }
6970
+ export interface Params$Resource$Projects$Locations$Endpoints$Patch extends StandardParameters {
6971
+ /**
6972
+ * 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.
6973
+ */
6974
+ allowMissing?: boolean;
6975
+ /**
6976
+ * 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\}
6977
+ */
6978
+ name?: string;
6979
+ /**
6980
+ * 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).
6981
+ */
6982
+ requestId?: string;
6983
+ /**
6984
+ * 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.
6985
+ */
6986
+ updateMask?: string;
6987
+ /**
6988
+ * Optional. If set, the backend validates the request, but doesn't actually execute it.
6989
+ */
6990
+ validateOnly?: boolean;
6991
+ /**
6992
+ * Request body metadata
6993
+ */
6994
+ requestBody?: Schema$Endpoint;
6995
+ }
6351
6996
  export class Resource$Projects$Locations$Operations {
6352
6997
  context: APIRequestContext;
6353
6998
  constructor(context: APIRequestContext);