@googleapis/alloydb 19.1.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/CHANGELOG.md +18 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v1.d.ts +65 -7
- package/build/v1.js.map +1 -1
- package/build/v1alpha.d.ts +663 -47
- package/build/v1alpha.js +169 -0
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +663 -47
- package/build/v1beta.js +169 -0
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1.ts +65 -7
- package/v1alpha.ts +1046 -47
- package/v1beta.ts +1046 -47
package/build/v1alpha.d.ts
CHANGED
|
@@ -617,14 +617,6 @@ export declare namespace alloydb_v1alpha {
|
|
|
617
617
|
* Configuration for Managed Connection Pool (MCP).
|
|
618
618
|
*/
|
|
619
619
|
export interface Schema$ConnectionPoolConfig {
|
|
620
|
-
/**
|
|
621
|
-
* 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.
|
|
622
|
-
*/
|
|
623
|
-
defaultPoolSize?: string | null;
|
|
624
|
-
/**
|
|
625
|
-
* Optional. Deprecated; Prefer 'enabled' as this will be removed soon.
|
|
626
|
-
*/
|
|
627
|
-
enable?: boolean | null;
|
|
628
620
|
/**
|
|
629
621
|
* Optional. Whether to enable Managed Connection Pool (MCP).
|
|
630
622
|
*/
|
|
@@ -635,42 +627,10 @@ export declare namespace alloydb_v1alpha {
|
|
|
635
627
|
flags?: {
|
|
636
628
|
[key: string]: string;
|
|
637
629
|
} | null;
|
|
638
|
-
/**
|
|
639
|
-
* 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.
|
|
640
|
-
*/
|
|
641
|
-
ignoreStartupParameters?: string[] | null;
|
|
642
|
-
/**
|
|
643
|
-
* 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.
|
|
644
|
-
*/
|
|
645
|
-
maxClientConn?: string | null;
|
|
646
|
-
/**
|
|
647
|
-
* 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.
|
|
648
|
-
*/
|
|
649
|
-
maxPreparedStatements?: string | null;
|
|
650
|
-
/**
|
|
651
|
-
* 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.
|
|
652
|
-
*/
|
|
653
|
-
minPoolSize?: string | null;
|
|
654
630
|
/**
|
|
655
631
|
* Output only. The number of running poolers per instance.
|
|
656
632
|
*/
|
|
657
633
|
poolerCount?: number | null;
|
|
658
|
-
/**
|
|
659
|
-
* 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.
|
|
660
|
-
*/
|
|
661
|
-
poolMode?: string | null;
|
|
662
|
-
/**
|
|
663
|
-
* 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.
|
|
664
|
-
*/
|
|
665
|
-
queryWaitTimeout?: string | null;
|
|
666
|
-
/**
|
|
667
|
-
* 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.
|
|
668
|
-
*/
|
|
669
|
-
serverIdleTimeout?: string | null;
|
|
670
|
-
/**
|
|
671
|
-
* 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.
|
|
672
|
-
*/
|
|
673
|
-
statsUsers?: string[] | null;
|
|
674
634
|
}
|
|
675
635
|
/**
|
|
676
636
|
* ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster.
|
|
@@ -804,6 +764,19 @@ export declare namespace alloydb_v1alpha {
|
|
|
804
764
|
*/
|
|
805
765
|
time?: Schema$GoogleTypeTimeOfDay;
|
|
806
766
|
}
|
|
767
|
+
/**
|
|
768
|
+
* The DNS config for the endpoint, containing the DNS record name, type and targets.
|
|
769
|
+
*/
|
|
770
|
+
export interface Schema$DNSConfig {
|
|
771
|
+
/**
|
|
772
|
+
* The fully qualified domain name (FQDN) of the DNS record, e.g., ".location.alloydb-psa.goog".
|
|
773
|
+
*/
|
|
774
|
+
dnsName?: string | null;
|
|
775
|
+
/**
|
|
776
|
+
* The type of the DNS record, e.g., "A", "AAAA", "CNAME".
|
|
777
|
+
*/
|
|
778
|
+
dnsRecordType?: string | null;
|
|
779
|
+
}
|
|
807
780
|
/**
|
|
808
781
|
* 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); \}
|
|
809
782
|
*/
|
|
@@ -831,6 +804,69 @@ export declare namespace alloydb_v1alpha {
|
|
|
831
804
|
*/
|
|
832
805
|
kmsKeyVersions?: string[] | null;
|
|
833
806
|
}
|
|
807
|
+
/**
|
|
808
|
+
* Endpoint resource.
|
|
809
|
+
*/
|
|
810
|
+
export interface Schema$Endpoint {
|
|
811
|
+
/**
|
|
812
|
+
* Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
|
|
813
|
+
*/
|
|
814
|
+
annotations?: {
|
|
815
|
+
[key: string]: string;
|
|
816
|
+
} | null;
|
|
817
|
+
/**
|
|
818
|
+
* Output only. Create time stamp
|
|
819
|
+
*/
|
|
820
|
+
createTime?: string | null;
|
|
821
|
+
/**
|
|
822
|
+
* Output only. Delete time stamp
|
|
823
|
+
*/
|
|
824
|
+
deleteTime?: string | null;
|
|
825
|
+
/**
|
|
826
|
+
* User-settable and human-readable display name for the Endpoint.
|
|
827
|
+
*/
|
|
828
|
+
displayName?: string | null;
|
|
829
|
+
/**
|
|
830
|
+
* 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.
|
|
831
|
+
*/
|
|
832
|
+
dnsConfig?: Schema$DNSConfig;
|
|
833
|
+
/**
|
|
834
|
+
* 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.
|
|
835
|
+
*/
|
|
836
|
+
effectiveTargetInstances?: string[] | null;
|
|
837
|
+
/**
|
|
838
|
+
* The type of the endpoint, either write or read.
|
|
839
|
+
*/
|
|
840
|
+
endpointType?: string | null;
|
|
841
|
+
/**
|
|
842
|
+
* For Resource freshness validation (https://google.aip.dev/154)
|
|
843
|
+
*/
|
|
844
|
+
etag?: string | null;
|
|
845
|
+
/**
|
|
846
|
+
* 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\}
|
|
847
|
+
*/
|
|
848
|
+
name?: string | null;
|
|
849
|
+
/**
|
|
850
|
+
* 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.
|
|
851
|
+
*/
|
|
852
|
+
reconciling?: boolean | null;
|
|
853
|
+
/**
|
|
854
|
+
* Output only. The state of the endpoint.
|
|
855
|
+
*/
|
|
856
|
+
state?: string | null;
|
|
857
|
+
/**
|
|
858
|
+
* 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.
|
|
859
|
+
*/
|
|
860
|
+
targetInstances?: string[] | null;
|
|
861
|
+
/**
|
|
862
|
+
* 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.
|
|
863
|
+
*/
|
|
864
|
+
uid?: string | null;
|
|
865
|
+
/**
|
|
866
|
+
* Output only. Update time stamp
|
|
867
|
+
*/
|
|
868
|
+
updateTime?: string | null;
|
|
869
|
+
}
|
|
834
870
|
/**
|
|
835
871
|
* Export cluster request.
|
|
836
872
|
*/
|
|
@@ -1183,7 +1219,7 @@ export declare namespace alloydb_v1alpha {
|
|
|
1183
1219
|
*/
|
|
1184
1220
|
export interface Schema$InstanceNetworkConfig {
|
|
1185
1221
|
/**
|
|
1186
|
-
* 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](
|
|
1222
|
+
* 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])?.
|
|
1187
1223
|
*/
|
|
1188
1224
|
allocatedIpRangeOverride?: string | null;
|
|
1189
1225
|
/**
|
|
@@ -1267,6 +1303,23 @@ export declare namespace alloydb_v1alpha {
|
|
|
1267
1303
|
*/
|
|
1268
1304
|
unreachable?: string[] | null;
|
|
1269
1305
|
}
|
|
1306
|
+
/**
|
|
1307
|
+
* Message for response to listing Endpoints
|
|
1308
|
+
*/
|
|
1309
|
+
export interface Schema$ListEndpointsResponse {
|
|
1310
|
+
/**
|
|
1311
|
+
* The list of Endpoints
|
|
1312
|
+
*/
|
|
1313
|
+
endpoints?: Schema$Endpoint[];
|
|
1314
|
+
/**
|
|
1315
|
+
* A token identifying a page of results the server should return.
|
|
1316
|
+
*/
|
|
1317
|
+
nextPageToken?: string | null;
|
|
1318
|
+
/**
|
|
1319
|
+
* Locations that could not be reached.
|
|
1320
|
+
*/
|
|
1321
|
+
unreachable?: string[] | null;
|
|
1322
|
+
}
|
|
1270
1323
|
/**
|
|
1271
1324
|
* Message for response to listing Instances
|
|
1272
1325
|
*/
|
|
@@ -1421,6 +1474,10 @@ export declare namespace alloydb_v1alpha {
|
|
|
1421
1474
|
* Output only. The private IP address of the VM e.g. "10.57.0.34".
|
|
1422
1475
|
*/
|
|
1423
1476
|
ip?: string | null;
|
|
1477
|
+
/**
|
|
1478
|
+
* Output only. Indicates whether the node set up to be configured as a hot standby.
|
|
1479
|
+
*/
|
|
1480
|
+
isHotStandby?: boolean | null;
|
|
1424
1481
|
/**
|
|
1425
1482
|
* 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.
|
|
1426
1483
|
*/
|
|
@@ -1462,6 +1519,10 @@ export declare namespace alloydb_v1alpha {
|
|
|
1462
1519
|
* Track actively running queries on the instance. If not set, this flag is "off" by default.
|
|
1463
1520
|
*/
|
|
1464
1521
|
trackActiveQueries?: boolean | null;
|
|
1522
|
+
/**
|
|
1523
|
+
* 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.
|
|
1524
|
+
*/
|
|
1525
|
+
trackActiveQueryPlan?: boolean | null;
|
|
1465
1526
|
/**
|
|
1466
1527
|
* Track client address for an instance. If not set, default value is "off".
|
|
1467
1528
|
*/
|
|
@@ -1579,6 +1640,10 @@ export declare namespace alloydb_v1alpha {
|
|
|
1579
1640
|
* 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.
|
|
1580
1641
|
*/
|
|
1581
1642
|
etag?: string | null;
|
|
1643
|
+
/**
|
|
1644
|
+
* 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.
|
|
1645
|
+
*/
|
|
1646
|
+
failover?: boolean | null;
|
|
1582
1647
|
/**
|
|
1583
1648
|
* 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).
|
|
1584
1649
|
*/
|
|
@@ -2213,7 +2278,7 @@ export declare namespace alloydb_v1alpha {
|
|
|
2213
2278
|
uniqueId?: string | null;
|
|
2214
2279
|
}
|
|
2215
2280
|
/**
|
|
2216
|
-
* Common model for database resource instance metadata. Next ID:
|
|
2281
|
+
* Common model for database resource instance metadata. Next ID: 32
|
|
2217
2282
|
*/
|
|
2218
2283
|
export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata {
|
|
2219
2284
|
/**
|
|
@@ -2284,6 +2349,10 @@ export declare namespace alloydb_v1alpha {
|
|
|
2284
2349
|
* Optional. Maintenance info for the resource.
|
|
2285
2350
|
*/
|
|
2286
2351
|
maintenanceInfo?: Schema$StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo;
|
|
2352
|
+
/**
|
|
2353
|
+
* Optional. The modes of the database resource.
|
|
2354
|
+
*/
|
|
2355
|
+
modes?: string[] | null;
|
|
2287
2356
|
/**
|
|
2288
2357
|
* 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.
|
|
2289
2358
|
*/
|
|
@@ -2300,6 +2369,10 @@ export declare namespace alloydb_v1alpha {
|
|
|
2300
2369
|
* 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.
|
|
2301
2370
|
*/
|
|
2302
2371
|
resourceContainer?: string | null;
|
|
2372
|
+
/**
|
|
2373
|
+
* Optional. List of resource flags for the database resource.
|
|
2374
|
+
*/
|
|
2375
|
+
resourceFlags?: Schema$StorageDatabasecenterPartnerapiV1mainResourceFlags[];
|
|
2303
2376
|
/**
|
|
2304
2377
|
* 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
|
|
2305
2378
|
*/
|
|
@@ -2365,9 +2438,13 @@ export declare namespace alloydb_v1alpha {
|
|
|
2365
2438
|
signalType?: string | null;
|
|
2366
2439
|
}
|
|
2367
2440
|
/**
|
|
2368
|
-
* 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:
|
|
2441
|
+
* 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
|
|
2369
2442
|
*/
|
|
2370
2443
|
export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData {
|
|
2444
|
+
/**
|
|
2445
|
+
* Deprecated: Use signal_metadata_list instead.
|
|
2446
|
+
*/
|
|
2447
|
+
backupRun?: Schema$StorageDatabasecenterPartnerapiV1mainBackupRun;
|
|
2371
2448
|
/**
|
|
2372
2449
|
* Required. Full Resource name of the source resource.
|
|
2373
2450
|
*/
|
|
@@ -2376,14 +2453,22 @@ export declare namespace alloydb_v1alpha {
|
|
|
2376
2453
|
* Required. Last time signal was refreshed
|
|
2377
2454
|
*/
|
|
2378
2455
|
lastRefreshTime?: string | null;
|
|
2456
|
+
/**
|
|
2457
|
+
* Required. Resource location.
|
|
2458
|
+
*/
|
|
2459
|
+
location?: string | null;
|
|
2379
2460
|
/**
|
|
2380
2461
|
* Database resource id.
|
|
2381
2462
|
*/
|
|
2382
2463
|
resourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId;
|
|
2383
2464
|
/**
|
|
2384
|
-
*
|
|
2465
|
+
* Deprecated: Use signal_metadata_list instead.
|
|
2385
2466
|
*/
|
|
2386
2467
|
signalBoolValue?: boolean | null;
|
|
2468
|
+
/**
|
|
2469
|
+
* This will support array of OneOf signal metadata information for a given signal type.
|
|
2470
|
+
*/
|
|
2471
|
+
signalMetadataList?: Schema$StorageDatabasecenterPartnerapiV1mainSignalMetadata[];
|
|
2387
2472
|
/**
|
|
2388
2473
|
* Required. Output only. Signal state of the signal
|
|
2389
2474
|
*/
|
|
@@ -2503,6 +2588,19 @@ export declare namespace alloydb_v1alpha {
|
|
|
2503
2588
|
*/
|
|
2504
2589
|
message?: string | null;
|
|
2505
2590
|
}
|
|
2591
|
+
/**
|
|
2592
|
+
* Message type for storing resource flags.
|
|
2593
|
+
*/
|
|
2594
|
+
export interface Schema$StorageDatabasecenterPartnerapiV1mainResourceFlags {
|
|
2595
|
+
/**
|
|
2596
|
+
* Optional. Key of the resource flag.
|
|
2597
|
+
*/
|
|
2598
|
+
key?: string | null;
|
|
2599
|
+
/**
|
|
2600
|
+
* Optional. Value of the resource flag.
|
|
2601
|
+
*/
|
|
2602
|
+
value?: string | null;
|
|
2603
|
+
}
|
|
2506
2604
|
/**
|
|
2507
2605
|
* Deny maintenance period for the database resource. It specifies the time range during which the maintenance cannot start. This is configured by the customer.
|
|
2508
2606
|
*/
|
|
@@ -2524,10 +2622,18 @@ export declare namespace alloydb_v1alpha {
|
|
|
2524
2622
|
* MaintenanceInfo to capture the maintenance details of database resource.
|
|
2525
2623
|
*/
|
|
2526
2624
|
export interface Schema$StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo {
|
|
2625
|
+
/**
|
|
2626
|
+
* Optional. The date when the current maintenance version was released.
|
|
2627
|
+
*/
|
|
2628
|
+
currentVersionReleaseDate?: Schema$GoogleTypeDate;
|
|
2527
2629
|
/**
|
|
2528
2630
|
* Optional. List of Deny maintenance period for the database resource.
|
|
2529
2631
|
*/
|
|
2530
2632
|
denyMaintenanceSchedules?: Schema$StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule[];
|
|
2633
|
+
/**
|
|
2634
|
+
* Optional. Whether the instance is in stopped state. This information is temporarily being captured in maintenanceInfo, till STOPPED state is supported by DB Center.
|
|
2635
|
+
*/
|
|
2636
|
+
isInstanceStopped?: boolean | null;
|
|
2531
2637
|
/**
|
|
2532
2638
|
* Optional. Maintenance window for the database resource.
|
|
2533
2639
|
*/
|
|
@@ -2578,6 +2684,19 @@ export declare namespace alloydb_v1alpha {
|
|
|
2578
2684
|
*/
|
|
2579
2685
|
timestampBasedRetentionTime?: string | null;
|
|
2580
2686
|
}
|
|
2687
|
+
/**
|
|
2688
|
+
* 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
|
|
2689
|
+
*/
|
|
2690
|
+
export interface Schema$StorageDatabasecenterPartnerapiV1mainSignalMetadata {
|
|
2691
|
+
/**
|
|
2692
|
+
* Signal data for backup runs.
|
|
2693
|
+
*/
|
|
2694
|
+
backupRun?: Schema$StorageDatabasecenterPartnerapiV1mainBackupRun;
|
|
2695
|
+
/**
|
|
2696
|
+
* Signal data for boolean signals.
|
|
2697
|
+
*/
|
|
2698
|
+
signalBoolValue?: boolean | null;
|
|
2699
|
+
}
|
|
2581
2700
|
/**
|
|
2582
2701
|
* 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.
|
|
2583
2702
|
*/
|
|
@@ -2882,6 +3001,7 @@ export declare namespace alloydb_v1alpha {
|
|
|
2882
3001
|
context: APIRequestContext;
|
|
2883
3002
|
backups: Resource$Projects$Locations$Backups;
|
|
2884
3003
|
clusters: Resource$Projects$Locations$Clusters;
|
|
3004
|
+
endpoints: Resource$Projects$Locations$Endpoints;
|
|
2885
3005
|
operations: Resource$Projects$Locations$Operations;
|
|
2886
3006
|
supportedDatabaseFlags: Resource$Projects$Locations$Supporteddatabaseflags;
|
|
2887
3007
|
constructor(context: APIRequestContext);
|
|
@@ -2950,7 +3070,7 @@ export declare namespace alloydb_v1alpha {
|
|
|
2950
3070
|
get(params: Params$Resource$Projects$Locations$Get, callback: BodyResponseCallback<Schema$GoogleCloudLocationLocation>): void;
|
|
2951
3071
|
get(callback: BodyResponseCallback<Schema$GoogleCloudLocationLocation>): void;
|
|
2952
3072
|
/**
|
|
2953
|
-
* Lists information about the supported locations for this service.
|
|
3073
|
+
* 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.
|
|
2954
3074
|
* @example
|
|
2955
3075
|
* ```js
|
|
2956
3076
|
* // Before running the sample:
|
|
@@ -2980,7 +3100,7 @@ export declare namespace alloydb_v1alpha {
|
|
|
2980
3100
|
*
|
|
2981
3101
|
* // Do the magic
|
|
2982
3102
|
* const res = await alloydb.projects.locations.list({
|
|
2983
|
-
* // Optional. Do not use this field
|
|
3103
|
+
* // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
|
|
2984
3104
|
* extraLocationTypes: 'placeholder-value',
|
|
2985
3105
|
* // 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).
|
|
2986
3106
|
* filter: 'placeholder-value',
|
|
@@ -3027,7 +3147,7 @@ export declare namespace alloydb_v1alpha {
|
|
|
3027
3147
|
}
|
|
3028
3148
|
export interface Params$Resource$Projects$Locations$List extends StandardParameters {
|
|
3029
3149
|
/**
|
|
3030
|
-
* Optional. Do not use this field
|
|
3150
|
+
* Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
|
|
3031
3151
|
*/
|
|
3032
3152
|
extraLocationTypes?: string[];
|
|
3033
3153
|
/**
|
|
@@ -4385,6 +4505,7 @@ export declare namespace alloydb_v1alpha {
|
|
|
4385
4505
|
* // request body parameters
|
|
4386
4506
|
* // {
|
|
4387
4507
|
* // "etag": "my_etag",
|
|
4508
|
+
* // "failover": false,
|
|
4388
4509
|
* // "requestId": "my_requestId",
|
|
4389
4510
|
* // "validateOnly": false
|
|
4390
4511
|
* // }
|
|
@@ -6405,6 +6526,501 @@ export declare namespace alloydb_v1alpha {
|
|
|
6405
6526
|
*/
|
|
6406
6527
|
requestBody?: Schema$User;
|
|
6407
6528
|
}
|
|
6529
|
+
export class Resource$Projects$Locations$Endpoints {
|
|
6530
|
+
context: APIRequestContext;
|
|
6531
|
+
constructor(context: APIRequestContext);
|
|
6532
|
+
/**
|
|
6533
|
+
* Creates a new Endpoint in a given project and location.
|
|
6534
|
+
* @example
|
|
6535
|
+
* ```js
|
|
6536
|
+
* // Before running the sample:
|
|
6537
|
+
* // - Enable the API at:
|
|
6538
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
6539
|
+
* // - Login into gcloud by running:
|
|
6540
|
+
* // ```sh
|
|
6541
|
+
* // $ gcloud auth application-default login
|
|
6542
|
+
* // ```
|
|
6543
|
+
* // - Install the npm module by running:
|
|
6544
|
+
* // ```sh
|
|
6545
|
+
* // $ npm install googleapis
|
|
6546
|
+
* // ```
|
|
6547
|
+
*
|
|
6548
|
+
* const {google} = require('googleapis');
|
|
6549
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
6550
|
+
*
|
|
6551
|
+
* async function main() {
|
|
6552
|
+
* const auth = new google.auth.GoogleAuth({
|
|
6553
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
6554
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
6555
|
+
* });
|
|
6556
|
+
*
|
|
6557
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
6558
|
+
* const authClient = await auth.getClient();
|
|
6559
|
+
* google.options({auth: authClient});
|
|
6560
|
+
*
|
|
6561
|
+
* // Do the magic
|
|
6562
|
+
* const res = await alloydb.projects.locations.endpoints.create({
|
|
6563
|
+
* // Required. ID of the requesting object.
|
|
6564
|
+
* endpointId: 'placeholder-value',
|
|
6565
|
+
* // Required. The location of the new endpoint. For the required format, see the comment on the Endpoint.name field.
|
|
6566
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
6567
|
+
* // 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).
|
|
6568
|
+
* requestId: 'placeholder-value',
|
|
6569
|
+
* // Optional. If set, the backend validates the request, but doesn't actually execute it.
|
|
6570
|
+
* validateOnly: 'placeholder-value',
|
|
6571
|
+
*
|
|
6572
|
+
* // Request body metadata
|
|
6573
|
+
* requestBody: {
|
|
6574
|
+
* // request body parameters
|
|
6575
|
+
* // {
|
|
6576
|
+
* // "annotations": {},
|
|
6577
|
+
* // "createTime": "my_createTime",
|
|
6578
|
+
* // "deleteTime": "my_deleteTime",
|
|
6579
|
+
* // "displayName": "my_displayName",
|
|
6580
|
+
* // "dnsConfig": {},
|
|
6581
|
+
* // "effectiveTargetInstances": [],
|
|
6582
|
+
* // "endpointType": "my_endpointType",
|
|
6583
|
+
* // "etag": "my_etag",
|
|
6584
|
+
* // "name": "my_name",
|
|
6585
|
+
* // "reconciling": false,
|
|
6586
|
+
* // "state": "my_state",
|
|
6587
|
+
* // "targetInstances": [],
|
|
6588
|
+
* // "uid": "my_uid",
|
|
6589
|
+
* // "updateTime": "my_updateTime"
|
|
6590
|
+
* // }
|
|
6591
|
+
* },
|
|
6592
|
+
* });
|
|
6593
|
+
* console.log(res.data);
|
|
6594
|
+
*
|
|
6595
|
+
* // Example response
|
|
6596
|
+
* // {
|
|
6597
|
+
* // "done": false,
|
|
6598
|
+
* // "error": {},
|
|
6599
|
+
* // "metadata": {},
|
|
6600
|
+
* // "name": "my_name",
|
|
6601
|
+
* // "response": {}
|
|
6602
|
+
* // }
|
|
6603
|
+
* }
|
|
6604
|
+
*
|
|
6605
|
+
* main().catch(e => {
|
|
6606
|
+
* console.error(e);
|
|
6607
|
+
* throw e;
|
|
6608
|
+
* });
|
|
6609
|
+
*
|
|
6610
|
+
* ```
|
|
6611
|
+
*
|
|
6612
|
+
* @param params - Parameters for request
|
|
6613
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6614
|
+
* @param callback - Optional callback that handles the response.
|
|
6615
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6616
|
+
*/
|
|
6617
|
+
create(params: Params$Resource$Projects$Locations$Endpoints$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
6618
|
+
create(params?: Params$Resource$Projects$Locations$Endpoints$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
6619
|
+
create(params: Params$Resource$Projects$Locations$Endpoints$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6620
|
+
create(params: Params$Resource$Projects$Locations$Endpoints$Create, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
6621
|
+
create(params: Params$Resource$Projects$Locations$Endpoints$Create, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
6622
|
+
create(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
6623
|
+
/**
|
|
6624
|
+
* Deletes a single Endpoint.
|
|
6625
|
+
* @example
|
|
6626
|
+
* ```js
|
|
6627
|
+
* // Before running the sample:
|
|
6628
|
+
* // - Enable the API at:
|
|
6629
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
6630
|
+
* // - Login into gcloud by running:
|
|
6631
|
+
* // ```sh
|
|
6632
|
+
* // $ gcloud auth application-default login
|
|
6633
|
+
* // ```
|
|
6634
|
+
* // - Install the npm module by running:
|
|
6635
|
+
* // ```sh
|
|
6636
|
+
* // $ npm install googleapis
|
|
6637
|
+
* // ```
|
|
6638
|
+
*
|
|
6639
|
+
* const {google} = require('googleapis');
|
|
6640
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
6641
|
+
*
|
|
6642
|
+
* async function main() {
|
|
6643
|
+
* const auth = new google.auth.GoogleAuth({
|
|
6644
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
6645
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
6646
|
+
* });
|
|
6647
|
+
*
|
|
6648
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
6649
|
+
* const authClient = await auth.getClient();
|
|
6650
|
+
* google.options({auth: authClient});
|
|
6651
|
+
*
|
|
6652
|
+
* // Do the magic
|
|
6653
|
+
* const res = await alloydb.projects.locations.endpoints.delete({
|
|
6654
|
+
* // 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.
|
|
6655
|
+
* etag: 'placeholder-value',
|
|
6656
|
+
* // Required. The name of the resource. For the required format, see the comment on the Endpoint.name field.
|
|
6657
|
+
* name: 'projects/my-project/locations/my-location/endpoints/my-endpoint',
|
|
6658
|
+
* // 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).
|
|
6659
|
+
* requestId: 'placeholder-value',
|
|
6660
|
+
* // Optional. If set, the backend validates the request, but doesn't actually execute it.
|
|
6661
|
+
* validateOnly: 'placeholder-value',
|
|
6662
|
+
* });
|
|
6663
|
+
* console.log(res.data);
|
|
6664
|
+
*
|
|
6665
|
+
* // Example response
|
|
6666
|
+
* // {
|
|
6667
|
+
* // "done": false,
|
|
6668
|
+
* // "error": {},
|
|
6669
|
+
* // "metadata": {},
|
|
6670
|
+
* // "name": "my_name",
|
|
6671
|
+
* // "response": {}
|
|
6672
|
+
* // }
|
|
6673
|
+
* }
|
|
6674
|
+
*
|
|
6675
|
+
* main().catch(e => {
|
|
6676
|
+
* console.error(e);
|
|
6677
|
+
* throw e;
|
|
6678
|
+
* });
|
|
6679
|
+
*
|
|
6680
|
+
* ```
|
|
6681
|
+
*
|
|
6682
|
+
* @param params - Parameters for request
|
|
6683
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6684
|
+
* @param callback - Optional callback that handles the response.
|
|
6685
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6686
|
+
*/
|
|
6687
|
+
delete(params: Params$Resource$Projects$Locations$Endpoints$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
6688
|
+
delete(params?: Params$Resource$Projects$Locations$Endpoints$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
6689
|
+
delete(params: Params$Resource$Projects$Locations$Endpoints$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6690
|
+
delete(params: Params$Resource$Projects$Locations$Endpoints$Delete, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
6691
|
+
delete(params: Params$Resource$Projects$Locations$Endpoints$Delete, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
6692
|
+
delete(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
6693
|
+
/**
|
|
6694
|
+
* Gets details of a single Endpoint.
|
|
6695
|
+
* @example
|
|
6696
|
+
* ```js
|
|
6697
|
+
* // Before running the sample:
|
|
6698
|
+
* // - Enable the API at:
|
|
6699
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
6700
|
+
* // - Login into gcloud by running:
|
|
6701
|
+
* // ```sh
|
|
6702
|
+
* // $ gcloud auth application-default login
|
|
6703
|
+
* // ```
|
|
6704
|
+
* // - Install the npm module by running:
|
|
6705
|
+
* // ```sh
|
|
6706
|
+
* // $ npm install googleapis
|
|
6707
|
+
* // ```
|
|
6708
|
+
*
|
|
6709
|
+
* const {google} = require('googleapis');
|
|
6710
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
6711
|
+
*
|
|
6712
|
+
* async function main() {
|
|
6713
|
+
* const auth = new google.auth.GoogleAuth({
|
|
6714
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
6715
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
6716
|
+
* });
|
|
6717
|
+
*
|
|
6718
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
6719
|
+
* const authClient = await auth.getClient();
|
|
6720
|
+
* google.options({auth: authClient});
|
|
6721
|
+
*
|
|
6722
|
+
* // Do the magic
|
|
6723
|
+
* const res = await alloydb.projects.locations.endpoints.get({
|
|
6724
|
+
* // Required. The name of the resource. For the required format, see the comment on the Endpoint.name field.
|
|
6725
|
+
* name: 'projects/my-project/locations/my-location/endpoints/my-endpoint',
|
|
6726
|
+
* });
|
|
6727
|
+
* console.log(res.data);
|
|
6728
|
+
*
|
|
6729
|
+
* // Example response
|
|
6730
|
+
* // {
|
|
6731
|
+
* // "annotations": {},
|
|
6732
|
+
* // "createTime": "my_createTime",
|
|
6733
|
+
* // "deleteTime": "my_deleteTime",
|
|
6734
|
+
* // "displayName": "my_displayName",
|
|
6735
|
+
* // "dnsConfig": {},
|
|
6736
|
+
* // "effectiveTargetInstances": [],
|
|
6737
|
+
* // "endpointType": "my_endpointType",
|
|
6738
|
+
* // "etag": "my_etag",
|
|
6739
|
+
* // "name": "my_name",
|
|
6740
|
+
* // "reconciling": false,
|
|
6741
|
+
* // "state": "my_state",
|
|
6742
|
+
* // "targetInstances": [],
|
|
6743
|
+
* // "uid": "my_uid",
|
|
6744
|
+
* // "updateTime": "my_updateTime"
|
|
6745
|
+
* // }
|
|
6746
|
+
* }
|
|
6747
|
+
*
|
|
6748
|
+
* main().catch(e => {
|
|
6749
|
+
* console.error(e);
|
|
6750
|
+
* throw e;
|
|
6751
|
+
* });
|
|
6752
|
+
*
|
|
6753
|
+
* ```
|
|
6754
|
+
*
|
|
6755
|
+
* @param params - Parameters for request
|
|
6756
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6757
|
+
* @param callback - Optional callback that handles the response.
|
|
6758
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6759
|
+
*/
|
|
6760
|
+
get(params: Params$Resource$Projects$Locations$Endpoints$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
6761
|
+
get(params?: Params$Resource$Projects$Locations$Endpoints$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Endpoint>>;
|
|
6762
|
+
get(params: Params$Resource$Projects$Locations$Endpoints$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6763
|
+
get(params: Params$Resource$Projects$Locations$Endpoints$Get, options: MethodOptions | BodyResponseCallback<Schema$Endpoint>, callback: BodyResponseCallback<Schema$Endpoint>): void;
|
|
6764
|
+
get(params: Params$Resource$Projects$Locations$Endpoints$Get, callback: BodyResponseCallback<Schema$Endpoint>): void;
|
|
6765
|
+
get(callback: BodyResponseCallback<Schema$Endpoint>): void;
|
|
6766
|
+
/**
|
|
6767
|
+
* Lists Endpoints in a given project and location.
|
|
6768
|
+
* @example
|
|
6769
|
+
* ```js
|
|
6770
|
+
* // Before running the sample:
|
|
6771
|
+
* // - Enable the API at:
|
|
6772
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
6773
|
+
* // - Login into gcloud by running:
|
|
6774
|
+
* // ```sh
|
|
6775
|
+
* // $ gcloud auth application-default login
|
|
6776
|
+
* // ```
|
|
6777
|
+
* // - Install the npm module by running:
|
|
6778
|
+
* // ```sh
|
|
6779
|
+
* // $ npm install googleapis
|
|
6780
|
+
* // ```
|
|
6781
|
+
*
|
|
6782
|
+
* const {google} = require('googleapis');
|
|
6783
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
6784
|
+
*
|
|
6785
|
+
* async function main() {
|
|
6786
|
+
* const auth = new google.auth.GoogleAuth({
|
|
6787
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
6788
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
6789
|
+
* });
|
|
6790
|
+
*
|
|
6791
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
6792
|
+
* const authClient = await auth.getClient();
|
|
6793
|
+
* google.options({auth: authClient});
|
|
6794
|
+
*
|
|
6795
|
+
* // Do the magic
|
|
6796
|
+
* const res = await alloydb.projects.locations.endpoints.list({
|
|
6797
|
+
* // Optional. Filtering results. This field is currently not supported, its value will be ignored if passed.
|
|
6798
|
+
* filter: 'placeholder-value',
|
|
6799
|
+
* // Optional. Hint for how to order the results
|
|
6800
|
+
* orderBy: 'placeholder-value',
|
|
6801
|
+
* // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
|
|
6802
|
+
* pageSize: 'placeholder-value',
|
|
6803
|
+
* // 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.
|
|
6804
|
+
* pageToken: 'placeholder-value',
|
|
6805
|
+
* // 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/-
|
|
6806
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
6807
|
+
* });
|
|
6808
|
+
* console.log(res.data);
|
|
6809
|
+
*
|
|
6810
|
+
* // Example response
|
|
6811
|
+
* // {
|
|
6812
|
+
* // "endpoints": [],
|
|
6813
|
+
* // "nextPageToken": "my_nextPageToken",
|
|
6814
|
+
* // "unreachable": []
|
|
6815
|
+
* // }
|
|
6816
|
+
* }
|
|
6817
|
+
*
|
|
6818
|
+
* main().catch(e => {
|
|
6819
|
+
* console.error(e);
|
|
6820
|
+
* throw e;
|
|
6821
|
+
* });
|
|
6822
|
+
*
|
|
6823
|
+
* ```
|
|
6824
|
+
*
|
|
6825
|
+
* @param params - Parameters for request
|
|
6826
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6827
|
+
* @param callback - Optional callback that handles the response.
|
|
6828
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6829
|
+
*/
|
|
6830
|
+
list(params: Params$Resource$Projects$Locations$Endpoints$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
6831
|
+
list(params?: Params$Resource$Projects$Locations$Endpoints$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ListEndpointsResponse>>;
|
|
6832
|
+
list(params: Params$Resource$Projects$Locations$Endpoints$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6833
|
+
list(params: Params$Resource$Projects$Locations$Endpoints$List, options: MethodOptions | BodyResponseCallback<Schema$ListEndpointsResponse>, callback: BodyResponseCallback<Schema$ListEndpointsResponse>): void;
|
|
6834
|
+
list(params: Params$Resource$Projects$Locations$Endpoints$List, callback: BodyResponseCallback<Schema$ListEndpointsResponse>): void;
|
|
6835
|
+
list(callback: BodyResponseCallback<Schema$ListEndpointsResponse>): void;
|
|
6836
|
+
/**
|
|
6837
|
+
* Updates the parameters of a single Endpoint.
|
|
6838
|
+
* @example
|
|
6839
|
+
* ```js
|
|
6840
|
+
* // Before running the sample:
|
|
6841
|
+
* // - Enable the API at:
|
|
6842
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
6843
|
+
* // - Login into gcloud by running:
|
|
6844
|
+
* // ```sh
|
|
6845
|
+
* // $ gcloud auth application-default login
|
|
6846
|
+
* // ```
|
|
6847
|
+
* // - Install the npm module by running:
|
|
6848
|
+
* // ```sh
|
|
6849
|
+
* // $ npm install googleapis
|
|
6850
|
+
* // ```
|
|
6851
|
+
*
|
|
6852
|
+
* const {google} = require('googleapis');
|
|
6853
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
6854
|
+
*
|
|
6855
|
+
* async function main() {
|
|
6856
|
+
* const auth = new google.auth.GoogleAuth({
|
|
6857
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
6858
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
6859
|
+
* });
|
|
6860
|
+
*
|
|
6861
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
6862
|
+
* const authClient = await auth.getClient();
|
|
6863
|
+
* google.options({auth: authClient});
|
|
6864
|
+
*
|
|
6865
|
+
* // Do the magic
|
|
6866
|
+
* const res = await alloydb.projects.locations.endpoints.patch({
|
|
6867
|
+
* // 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.
|
|
6868
|
+
* allowMissing: 'placeholder-value',
|
|
6869
|
+
* // 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\}
|
|
6870
|
+
* name: 'projects/my-project/locations/my-location/endpoints/my-endpoint',
|
|
6871
|
+
* // 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).
|
|
6872
|
+
* requestId: 'placeholder-value',
|
|
6873
|
+
* // 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.
|
|
6874
|
+
* updateMask: 'placeholder-value',
|
|
6875
|
+
* // Optional. If set, the backend validates the request, but doesn't actually execute it.
|
|
6876
|
+
* validateOnly: 'placeholder-value',
|
|
6877
|
+
*
|
|
6878
|
+
* // Request body metadata
|
|
6879
|
+
* requestBody: {
|
|
6880
|
+
* // request body parameters
|
|
6881
|
+
* // {
|
|
6882
|
+
* // "annotations": {},
|
|
6883
|
+
* // "createTime": "my_createTime",
|
|
6884
|
+
* // "deleteTime": "my_deleteTime",
|
|
6885
|
+
* // "displayName": "my_displayName",
|
|
6886
|
+
* // "dnsConfig": {},
|
|
6887
|
+
* // "effectiveTargetInstances": [],
|
|
6888
|
+
* // "endpointType": "my_endpointType",
|
|
6889
|
+
* // "etag": "my_etag",
|
|
6890
|
+
* // "name": "my_name",
|
|
6891
|
+
* // "reconciling": false,
|
|
6892
|
+
* // "state": "my_state",
|
|
6893
|
+
* // "targetInstances": [],
|
|
6894
|
+
* // "uid": "my_uid",
|
|
6895
|
+
* // "updateTime": "my_updateTime"
|
|
6896
|
+
* // }
|
|
6897
|
+
* },
|
|
6898
|
+
* });
|
|
6899
|
+
* console.log(res.data);
|
|
6900
|
+
*
|
|
6901
|
+
* // Example response
|
|
6902
|
+
* // {
|
|
6903
|
+
* // "done": false,
|
|
6904
|
+
* // "error": {},
|
|
6905
|
+
* // "metadata": {},
|
|
6906
|
+
* // "name": "my_name",
|
|
6907
|
+
* // "response": {}
|
|
6908
|
+
* // }
|
|
6909
|
+
* }
|
|
6910
|
+
*
|
|
6911
|
+
* main().catch(e => {
|
|
6912
|
+
* console.error(e);
|
|
6913
|
+
* throw e;
|
|
6914
|
+
* });
|
|
6915
|
+
*
|
|
6916
|
+
* ```
|
|
6917
|
+
*
|
|
6918
|
+
* @param params - Parameters for request
|
|
6919
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
6920
|
+
* @param callback - Optional callback that handles the response.
|
|
6921
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
6922
|
+
*/
|
|
6923
|
+
patch(params: Params$Resource$Projects$Locations$Endpoints$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
6924
|
+
patch(params?: Params$Resource$Projects$Locations$Endpoints$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
6925
|
+
patch(params: Params$Resource$Projects$Locations$Endpoints$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
6926
|
+
patch(params: Params$Resource$Projects$Locations$Endpoints$Patch, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
6927
|
+
patch(params: Params$Resource$Projects$Locations$Endpoints$Patch, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
6928
|
+
patch(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
6929
|
+
}
|
|
6930
|
+
export interface Params$Resource$Projects$Locations$Endpoints$Create extends StandardParameters {
|
|
6931
|
+
/**
|
|
6932
|
+
* Required. ID of the requesting object.
|
|
6933
|
+
*/
|
|
6934
|
+
endpointId?: string;
|
|
6935
|
+
/**
|
|
6936
|
+
* Required. The location of the new endpoint. For the required format, see the comment on the Endpoint.name field.
|
|
6937
|
+
*/
|
|
6938
|
+
parent?: string;
|
|
6939
|
+
/**
|
|
6940
|
+
* 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).
|
|
6941
|
+
*/
|
|
6942
|
+
requestId?: string;
|
|
6943
|
+
/**
|
|
6944
|
+
* Optional. If set, the backend validates the request, but doesn't actually execute it.
|
|
6945
|
+
*/
|
|
6946
|
+
validateOnly?: boolean;
|
|
6947
|
+
/**
|
|
6948
|
+
* Request body metadata
|
|
6949
|
+
*/
|
|
6950
|
+
requestBody?: Schema$Endpoint;
|
|
6951
|
+
}
|
|
6952
|
+
export interface Params$Resource$Projects$Locations$Endpoints$Delete extends StandardParameters {
|
|
6953
|
+
/**
|
|
6954
|
+
* 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.
|
|
6955
|
+
*/
|
|
6956
|
+
etag?: string;
|
|
6957
|
+
/**
|
|
6958
|
+
* Required. The name of the resource. For the required format, see the comment on the Endpoint.name field.
|
|
6959
|
+
*/
|
|
6960
|
+
name?: string;
|
|
6961
|
+
/**
|
|
6962
|
+
* 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).
|
|
6963
|
+
*/
|
|
6964
|
+
requestId?: string;
|
|
6965
|
+
/**
|
|
6966
|
+
* Optional. If set, the backend validates the request, but doesn't actually execute it.
|
|
6967
|
+
*/
|
|
6968
|
+
validateOnly?: boolean;
|
|
6969
|
+
}
|
|
6970
|
+
export interface Params$Resource$Projects$Locations$Endpoints$Get extends StandardParameters {
|
|
6971
|
+
/**
|
|
6972
|
+
* Required. The name of the resource. For the required format, see the comment on the Endpoint.name field.
|
|
6973
|
+
*/
|
|
6974
|
+
name?: string;
|
|
6975
|
+
}
|
|
6976
|
+
export interface Params$Resource$Projects$Locations$Endpoints$List extends StandardParameters {
|
|
6977
|
+
/**
|
|
6978
|
+
* Optional. Filtering results. This field is currently not supported, its value will be ignored if passed.
|
|
6979
|
+
*/
|
|
6980
|
+
filter?: string;
|
|
6981
|
+
/**
|
|
6982
|
+
* Optional. Hint for how to order the results
|
|
6983
|
+
*/
|
|
6984
|
+
orderBy?: string;
|
|
6985
|
+
/**
|
|
6986
|
+
* Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
|
|
6987
|
+
*/
|
|
6988
|
+
pageSize?: number;
|
|
6989
|
+
/**
|
|
6990
|
+
* 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.
|
|
6991
|
+
*/
|
|
6992
|
+
pageToken?: string;
|
|
6993
|
+
/**
|
|
6994
|
+
* 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/-
|
|
6995
|
+
*/
|
|
6996
|
+
parent?: string;
|
|
6997
|
+
}
|
|
6998
|
+
export interface Params$Resource$Projects$Locations$Endpoints$Patch extends StandardParameters {
|
|
6999
|
+
/**
|
|
7000
|
+
* 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.
|
|
7001
|
+
*/
|
|
7002
|
+
allowMissing?: boolean;
|
|
7003
|
+
/**
|
|
7004
|
+
* 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\}
|
|
7005
|
+
*/
|
|
7006
|
+
name?: string;
|
|
7007
|
+
/**
|
|
7008
|
+
* 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).
|
|
7009
|
+
*/
|
|
7010
|
+
requestId?: string;
|
|
7011
|
+
/**
|
|
7012
|
+
* 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.
|
|
7013
|
+
*/
|
|
7014
|
+
updateMask?: string;
|
|
7015
|
+
/**
|
|
7016
|
+
* Optional. If set, the backend validates the request, but doesn't actually execute it.
|
|
7017
|
+
*/
|
|
7018
|
+
validateOnly?: boolean;
|
|
7019
|
+
/**
|
|
7020
|
+
* Request body metadata
|
|
7021
|
+
*/
|
|
7022
|
+
requestBody?: Schema$Endpoint;
|
|
7023
|
+
}
|
|
6408
7024
|
export class Resource$Projects$Locations$Operations {
|
|
6409
7025
|
context: APIRequestContext;
|
|
6410
7026
|
constructor(context: APIRequestContext);
|