@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/CHANGELOG.md +25 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v1.d.ts +94 -7
- package/build/v1.js.map +1 -1
- package/build/v1alpha.d.ts +692 -47
- package/build/v1alpha.js +169 -0
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +692 -47
- package/build/v1beta.js +169 -0
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1.ts +94 -7
- package/v1alpha.ts +1075 -47
- package/v1beta.ts +1075 -47
package/v1beta.ts
CHANGED
|
@@ -644,14 +644,6 @@ export namespace alloydb_v1beta {
|
|
|
644
644
|
* Configuration for Managed Connection Pool (MCP).
|
|
645
645
|
*/
|
|
646
646
|
export interface Schema$ConnectionPoolConfig {
|
|
647
|
-
/**
|
|
648
|
-
* 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.
|
|
649
|
-
*/
|
|
650
|
-
defaultPoolSize?: string | null;
|
|
651
|
-
/**
|
|
652
|
-
* Optional. Deprecated; Prefer 'enabled' as this will be removed soon.
|
|
653
|
-
*/
|
|
654
|
-
enable?: boolean | null;
|
|
655
647
|
/**
|
|
656
648
|
* Optional. Whether to enable Managed Connection Pool (MCP).
|
|
657
649
|
*/
|
|
@@ -660,42 +652,10 @@ export namespace alloydb_v1beta {
|
|
|
660
652
|
* Optional. Connection Pool flags, as a list of "key": "value" pairs.
|
|
661
653
|
*/
|
|
662
654
|
flags?: {[key: string]: string} | null;
|
|
663
|
-
/**
|
|
664
|
-
* 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.
|
|
665
|
-
*/
|
|
666
|
-
ignoreStartupParameters?: string[] | null;
|
|
667
|
-
/**
|
|
668
|
-
* 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.
|
|
669
|
-
*/
|
|
670
|
-
maxClientConn?: string | null;
|
|
671
|
-
/**
|
|
672
|
-
* 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.
|
|
673
|
-
*/
|
|
674
|
-
maxPreparedStatements?: string | null;
|
|
675
|
-
/**
|
|
676
|
-
* 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.
|
|
677
|
-
*/
|
|
678
|
-
minPoolSize?: string | null;
|
|
679
655
|
/**
|
|
680
656
|
* Output only. The number of running poolers per instance.
|
|
681
657
|
*/
|
|
682
658
|
poolerCount?: number | null;
|
|
683
|
-
/**
|
|
684
|
-
* 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.
|
|
685
|
-
*/
|
|
686
|
-
poolMode?: string | null;
|
|
687
|
-
/**
|
|
688
|
-
* 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.
|
|
689
|
-
*/
|
|
690
|
-
queryWaitTimeout?: string | null;
|
|
691
|
-
/**
|
|
692
|
-
* 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.
|
|
693
|
-
*/
|
|
694
|
-
serverIdleTimeout?: string | null;
|
|
695
|
-
/**
|
|
696
|
-
* 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.
|
|
697
|
-
*/
|
|
698
|
-
statsUsers?: string[] | null;
|
|
699
659
|
}
|
|
700
660
|
/**
|
|
701
661
|
* ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster.
|
|
@@ -829,6 +789,19 @@ export namespace alloydb_v1beta {
|
|
|
829
789
|
*/
|
|
830
790
|
time?: Schema$GoogleTypeTimeOfDay;
|
|
831
791
|
}
|
|
792
|
+
/**
|
|
793
|
+
* The DNS config for the endpoint, containing the DNS record name, type and targets.
|
|
794
|
+
*/
|
|
795
|
+
export interface Schema$DNSConfig {
|
|
796
|
+
/**
|
|
797
|
+
* The fully qualified domain name (FQDN) of the DNS record, e.g., ".location.alloydb-psa.goog".
|
|
798
|
+
*/
|
|
799
|
+
dnsName?: string | null;
|
|
800
|
+
/**
|
|
801
|
+
* The type of the DNS record, e.g., "A", "AAAA", "CNAME".
|
|
802
|
+
*/
|
|
803
|
+
dnsRecordType?: string | null;
|
|
804
|
+
}
|
|
832
805
|
/**
|
|
833
806
|
* 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); \}
|
|
834
807
|
*/
|
|
@@ -855,6 +828,67 @@ export namespace alloydb_v1beta {
|
|
|
855
828
|
*/
|
|
856
829
|
kmsKeyVersions?: string[] | null;
|
|
857
830
|
}
|
|
831
|
+
/**
|
|
832
|
+
* Endpoint resource.
|
|
833
|
+
*/
|
|
834
|
+
export interface Schema$Endpoint {
|
|
835
|
+
/**
|
|
836
|
+
* Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
|
|
837
|
+
*/
|
|
838
|
+
annotations?: {[key: string]: string} | null;
|
|
839
|
+
/**
|
|
840
|
+
* Output only. Create time stamp
|
|
841
|
+
*/
|
|
842
|
+
createTime?: string | null;
|
|
843
|
+
/**
|
|
844
|
+
* Output only. Delete time stamp
|
|
845
|
+
*/
|
|
846
|
+
deleteTime?: string | null;
|
|
847
|
+
/**
|
|
848
|
+
* User-settable and human-readable display name for the Endpoint.
|
|
849
|
+
*/
|
|
850
|
+
displayName?: string | null;
|
|
851
|
+
/**
|
|
852
|
+
* 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.
|
|
853
|
+
*/
|
|
854
|
+
dnsConfig?: Schema$DNSConfig;
|
|
855
|
+
/**
|
|
856
|
+
* 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.
|
|
857
|
+
*/
|
|
858
|
+
effectiveTargetInstances?: string[] | null;
|
|
859
|
+
/**
|
|
860
|
+
* The type of the endpoint, either write or read.
|
|
861
|
+
*/
|
|
862
|
+
endpointType?: string | null;
|
|
863
|
+
/**
|
|
864
|
+
* For Resource freshness validation (https://google.aip.dev/154)
|
|
865
|
+
*/
|
|
866
|
+
etag?: string | null;
|
|
867
|
+
/**
|
|
868
|
+
* 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\}
|
|
869
|
+
*/
|
|
870
|
+
name?: string | null;
|
|
871
|
+
/**
|
|
872
|
+
* 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.
|
|
873
|
+
*/
|
|
874
|
+
reconciling?: boolean | null;
|
|
875
|
+
/**
|
|
876
|
+
* Output only. The state of the endpoint.
|
|
877
|
+
*/
|
|
878
|
+
state?: string | null;
|
|
879
|
+
/**
|
|
880
|
+
* 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.
|
|
881
|
+
*/
|
|
882
|
+
targetInstances?: string[] | null;
|
|
883
|
+
/**
|
|
884
|
+
* 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.
|
|
885
|
+
*/
|
|
886
|
+
uid?: string | null;
|
|
887
|
+
/**
|
|
888
|
+
* Output only. Update time stamp
|
|
889
|
+
*/
|
|
890
|
+
updateTime?: string | null;
|
|
891
|
+
}
|
|
858
892
|
/**
|
|
859
893
|
* Export cluster request.
|
|
860
894
|
*/
|
|
@@ -1071,6 +1105,10 @@ export namespace alloydb_v1beta {
|
|
|
1071
1105
|
* Output only. Create time stamp
|
|
1072
1106
|
*/
|
|
1073
1107
|
createTime?: string | null;
|
|
1108
|
+
/**
|
|
1109
|
+
* 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.
|
|
1110
|
+
*/
|
|
1111
|
+
dataApiAccess?: string | null;
|
|
1074
1112
|
/**
|
|
1075
1113
|
* 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.
|
|
1076
1114
|
*/
|
|
@@ -1189,7 +1227,7 @@ export namespace alloydb_v1beta {
|
|
|
1189
1227
|
*/
|
|
1190
1228
|
export interface Schema$InstanceNetworkConfig {
|
|
1191
1229
|
/**
|
|
1192
|
-
* 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](
|
|
1230
|
+
* 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])?.
|
|
1193
1231
|
*/
|
|
1194
1232
|
allocatedIpRangeOverride?: string | null;
|
|
1195
1233
|
/**
|
|
@@ -1273,6 +1311,23 @@ export namespace alloydb_v1beta {
|
|
|
1273
1311
|
*/
|
|
1274
1312
|
unreachable?: string[] | null;
|
|
1275
1313
|
}
|
|
1314
|
+
/**
|
|
1315
|
+
* Message for response to listing Endpoints
|
|
1316
|
+
*/
|
|
1317
|
+
export interface Schema$ListEndpointsResponse {
|
|
1318
|
+
/**
|
|
1319
|
+
* The list of Endpoints
|
|
1320
|
+
*/
|
|
1321
|
+
endpoints?: Schema$Endpoint[];
|
|
1322
|
+
/**
|
|
1323
|
+
* A token identifying a page of results the server should return.
|
|
1324
|
+
*/
|
|
1325
|
+
nextPageToken?: string | null;
|
|
1326
|
+
/**
|
|
1327
|
+
* Locations that could not be reached.
|
|
1328
|
+
*/
|
|
1329
|
+
unreachable?: string[] | null;
|
|
1330
|
+
}
|
|
1276
1331
|
/**
|
|
1277
1332
|
* Message for response to listing Instances
|
|
1278
1333
|
*/
|
|
@@ -1427,6 +1482,10 @@ export namespace alloydb_v1beta {
|
|
|
1427
1482
|
* Output only. The private IP address of the VM e.g. "10.57.0.34".
|
|
1428
1483
|
*/
|
|
1429
1484
|
ip?: string | null;
|
|
1485
|
+
/**
|
|
1486
|
+
* Output only. Indicates whether the node set up to be configured as a hot standby.
|
|
1487
|
+
*/
|
|
1488
|
+
isHotStandby?: boolean | null;
|
|
1430
1489
|
/**
|
|
1431
1490
|
* 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.
|
|
1432
1491
|
*/
|
|
@@ -1468,6 +1527,10 @@ export namespace alloydb_v1beta {
|
|
|
1468
1527
|
* Track actively running queries on the instance. If not set, this flag is "off" by default.
|
|
1469
1528
|
*/
|
|
1470
1529
|
trackActiveQueries?: boolean | null;
|
|
1530
|
+
/**
|
|
1531
|
+
* 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.
|
|
1532
|
+
*/
|
|
1533
|
+
trackActiveQueryPlan?: boolean | null;
|
|
1471
1534
|
/**
|
|
1472
1535
|
* Track client address for an instance. If not set, default value is "off".
|
|
1473
1536
|
*/
|
|
@@ -1581,6 +1644,10 @@ export namespace alloydb_v1beta {
|
|
|
1581
1644
|
* 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.
|
|
1582
1645
|
*/
|
|
1583
1646
|
etag?: string | null;
|
|
1647
|
+
/**
|
|
1648
|
+
* 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.
|
|
1649
|
+
*/
|
|
1650
|
+
failover?: boolean | null;
|
|
1584
1651
|
/**
|
|
1585
1652
|
* 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).
|
|
1586
1653
|
*/
|
|
@@ -2210,7 +2277,7 @@ export namespace alloydb_v1beta {
|
|
|
2210
2277
|
uniqueId?: string | null;
|
|
2211
2278
|
}
|
|
2212
2279
|
/**
|
|
2213
|
-
* Common model for database resource instance metadata. Next ID:
|
|
2280
|
+
* Common model for database resource instance metadata. Next ID: 32
|
|
2214
2281
|
*/
|
|
2215
2282
|
export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata {
|
|
2216
2283
|
/**
|
|
@@ -2281,6 +2348,10 @@ export namespace alloydb_v1beta {
|
|
|
2281
2348
|
* Optional. Maintenance info for the resource.
|
|
2282
2349
|
*/
|
|
2283
2350
|
maintenanceInfo?: Schema$StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo;
|
|
2351
|
+
/**
|
|
2352
|
+
* Optional. The modes of the database resource.
|
|
2353
|
+
*/
|
|
2354
|
+
modes?: string[] | null;
|
|
2284
2355
|
/**
|
|
2285
2356
|
* 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.
|
|
2286
2357
|
*/
|
|
@@ -2297,6 +2368,10 @@ export namespace alloydb_v1beta {
|
|
|
2297
2368
|
* 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.
|
|
2298
2369
|
*/
|
|
2299
2370
|
resourceContainer?: string | null;
|
|
2371
|
+
/**
|
|
2372
|
+
* Optional. List of resource flags for the database resource.
|
|
2373
|
+
*/
|
|
2374
|
+
resourceFlags?: Schema$StorageDatabasecenterPartnerapiV1mainResourceFlags[];
|
|
2300
2375
|
/**
|
|
2301
2376
|
* 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
|
|
2302
2377
|
*/
|
|
@@ -2360,9 +2435,13 @@ export namespace alloydb_v1beta {
|
|
|
2360
2435
|
signalType?: string | null;
|
|
2361
2436
|
}
|
|
2362
2437
|
/**
|
|
2363
|
-
* 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:
|
|
2438
|
+
* 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
|
|
2364
2439
|
*/
|
|
2365
2440
|
export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceSignalData {
|
|
2441
|
+
/**
|
|
2442
|
+
* Deprecated: Use signal_metadata_list instead.
|
|
2443
|
+
*/
|
|
2444
|
+
backupRun?: Schema$StorageDatabasecenterPartnerapiV1mainBackupRun;
|
|
2366
2445
|
/**
|
|
2367
2446
|
* Required. Full Resource name of the source resource.
|
|
2368
2447
|
*/
|
|
@@ -2371,14 +2450,22 @@ export namespace alloydb_v1beta {
|
|
|
2371
2450
|
* Required. Last time signal was refreshed
|
|
2372
2451
|
*/
|
|
2373
2452
|
lastRefreshTime?: string | null;
|
|
2453
|
+
/**
|
|
2454
|
+
* Required. Resource location.
|
|
2455
|
+
*/
|
|
2456
|
+
location?: string | null;
|
|
2374
2457
|
/**
|
|
2375
2458
|
* Database resource id.
|
|
2376
2459
|
*/
|
|
2377
2460
|
resourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId;
|
|
2378
2461
|
/**
|
|
2379
|
-
*
|
|
2462
|
+
* Deprecated: Use signal_metadata_list instead.
|
|
2380
2463
|
*/
|
|
2381
2464
|
signalBoolValue?: boolean | null;
|
|
2465
|
+
/**
|
|
2466
|
+
* This will support array of OneOf signal metadata information for a given signal type.
|
|
2467
|
+
*/
|
|
2468
|
+
signalMetadataList?: Schema$StorageDatabasecenterPartnerapiV1mainSignalMetadata[];
|
|
2382
2469
|
/**
|
|
2383
2470
|
* Required. Output only. Signal state of the signal
|
|
2384
2471
|
*/
|
|
@@ -2498,6 +2585,19 @@ export namespace alloydb_v1beta {
|
|
|
2498
2585
|
*/
|
|
2499
2586
|
message?: string | null;
|
|
2500
2587
|
}
|
|
2588
|
+
/**
|
|
2589
|
+
* Message type for storing resource flags.
|
|
2590
|
+
*/
|
|
2591
|
+
export interface Schema$StorageDatabasecenterPartnerapiV1mainResourceFlags {
|
|
2592
|
+
/**
|
|
2593
|
+
* Optional. Key of the resource flag.
|
|
2594
|
+
*/
|
|
2595
|
+
key?: string | null;
|
|
2596
|
+
/**
|
|
2597
|
+
* Optional. Value of the resource flag.
|
|
2598
|
+
*/
|
|
2599
|
+
value?: string | null;
|
|
2600
|
+
}
|
|
2501
2601
|
/**
|
|
2502
2602
|
* Deny maintenance period for the database resource. It specifies the time range during which the maintenance cannot start. This is configured by the customer.
|
|
2503
2603
|
*/
|
|
@@ -2519,18 +2619,34 @@ export namespace alloydb_v1beta {
|
|
|
2519
2619
|
* MaintenanceInfo to capture the maintenance details of database resource.
|
|
2520
2620
|
*/
|
|
2521
2621
|
export interface Schema$StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo {
|
|
2622
|
+
/**
|
|
2623
|
+
* Optional. The date when the current maintenance version was released.
|
|
2624
|
+
*/
|
|
2625
|
+
currentVersionReleaseDate?: Schema$GoogleTypeDate;
|
|
2522
2626
|
/**
|
|
2523
2627
|
* Optional. List of Deny maintenance period for the database resource.
|
|
2524
2628
|
*/
|
|
2525
2629
|
denyMaintenanceSchedules?: Schema$StorageDatabasecenterPartnerapiV1mainResourceMaintenanceDenySchedule[];
|
|
2630
|
+
/**
|
|
2631
|
+
* Optional. Whether the instance is in stopped state. This information is temporarily being captured in maintenanceInfo, till STOPPED state is supported by DB Center.
|
|
2632
|
+
*/
|
|
2633
|
+
isInstanceStopped?: boolean | null;
|
|
2526
2634
|
/**
|
|
2527
2635
|
* Optional. Maintenance window for the database resource.
|
|
2528
2636
|
*/
|
|
2529
2637
|
maintenanceSchedule?: Schema$StorageDatabasecenterPartnerapiV1mainResourceMaintenanceSchedule;
|
|
2638
|
+
/**
|
|
2639
|
+
* Output only. Current state of maintenance on the database resource.
|
|
2640
|
+
*/
|
|
2641
|
+
maintenanceState?: string | null;
|
|
2530
2642
|
/**
|
|
2531
2643
|
* Optional. Current Maintenance version of the database resource. Example: "MYSQL_8_0_41.R20250531.01_15"
|
|
2532
2644
|
*/
|
|
2533
2645
|
maintenanceVersion?: string | null;
|
|
2646
|
+
/**
|
|
2647
|
+
* Optional. Upcoming maintenance for the database resource. This field is populated once SLM generates and publishes upcoming maintenance window.
|
|
2648
|
+
*/
|
|
2649
|
+
upcomingMaintenance?: Schema$StorageDatabasecenterPartnerapiV1mainUpcomingMaintenance;
|
|
2534
2650
|
}
|
|
2535
2651
|
/**
|
|
2536
2652
|
* 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.
|
|
@@ -2565,6 +2681,19 @@ export namespace alloydb_v1beta {
|
|
|
2565
2681
|
*/
|
|
2566
2682
|
timestampBasedRetentionTime?: string | null;
|
|
2567
2683
|
}
|
|
2684
|
+
/**
|
|
2685
|
+
* 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
|
|
2686
|
+
*/
|
|
2687
|
+
export interface Schema$StorageDatabasecenterPartnerapiV1mainSignalMetadata {
|
|
2688
|
+
/**
|
|
2689
|
+
* Signal data for backup runs.
|
|
2690
|
+
*/
|
|
2691
|
+
backupRun?: Schema$StorageDatabasecenterPartnerapiV1mainBackupRun;
|
|
2692
|
+
/**
|
|
2693
|
+
* Signal data for boolean signals.
|
|
2694
|
+
*/
|
|
2695
|
+
signalBoolValue?: boolean | null;
|
|
2696
|
+
}
|
|
2568
2697
|
/**
|
|
2569
2698
|
* 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.
|
|
2570
2699
|
*/
|
|
@@ -2574,6 +2703,19 @@ export namespace alloydb_v1beta {
|
|
|
2574
2703
|
*/
|
|
2575
2704
|
tags?: {[key: string]: string} | null;
|
|
2576
2705
|
}
|
|
2706
|
+
/**
|
|
2707
|
+
* Upcoming maintenance for the database resource. This is generated by SLM once the upcoming maintenance schedule is published.
|
|
2708
|
+
*/
|
|
2709
|
+
export interface Schema$StorageDatabasecenterPartnerapiV1mainUpcomingMaintenance {
|
|
2710
|
+
/**
|
|
2711
|
+
* Optional. The end time of the upcoming maintenance.
|
|
2712
|
+
*/
|
|
2713
|
+
endTime?: string | null;
|
|
2714
|
+
/**
|
|
2715
|
+
* Optional. The start time of the upcoming maintenance.
|
|
2716
|
+
*/
|
|
2717
|
+
startTime?: string | null;
|
|
2718
|
+
}
|
|
2577
2719
|
/**
|
|
2578
2720
|
* 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.
|
|
2579
2721
|
*/
|
|
@@ -2857,12 +2999,14 @@ export namespace alloydb_v1beta {
|
|
|
2857
2999
|
context: APIRequestContext;
|
|
2858
3000
|
backups: Resource$Projects$Locations$Backups;
|
|
2859
3001
|
clusters: Resource$Projects$Locations$Clusters;
|
|
3002
|
+
endpoints: Resource$Projects$Locations$Endpoints;
|
|
2860
3003
|
operations: Resource$Projects$Locations$Operations;
|
|
2861
3004
|
supportedDatabaseFlags: Resource$Projects$Locations$Supporteddatabaseflags;
|
|
2862
3005
|
constructor(context: APIRequestContext) {
|
|
2863
3006
|
this.context = context;
|
|
2864
3007
|
this.backups = new Resource$Projects$Locations$Backups(this.context);
|
|
2865
3008
|
this.clusters = new Resource$Projects$Locations$Clusters(this.context);
|
|
3009
|
+
this.endpoints = new Resource$Projects$Locations$Endpoints(this.context);
|
|
2866
3010
|
this.operations = new Resource$Projects$Locations$Operations(
|
|
2867
3011
|
this.context
|
|
2868
3012
|
);
|
|
@@ -3013,7 +3157,7 @@ export namespace alloydb_v1beta {
|
|
|
3013
3157
|
}
|
|
3014
3158
|
|
|
3015
3159
|
/**
|
|
3016
|
-
* Lists information about the supported locations for this service.
|
|
3160
|
+
* 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.
|
|
3017
3161
|
* @example
|
|
3018
3162
|
* ```js
|
|
3019
3163
|
* // Before running the sample:
|
|
@@ -3043,7 +3187,7 @@ export namespace alloydb_v1beta {
|
|
|
3043
3187
|
*
|
|
3044
3188
|
* // Do the magic
|
|
3045
3189
|
* const res = await alloydb.projects.locations.list({
|
|
3046
|
-
* // Optional. Do not use this field
|
|
3190
|
+
* // Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
|
|
3047
3191
|
* extraLocationTypes: 'placeholder-value',
|
|
3048
3192
|
* // 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).
|
|
3049
3193
|
* filter: 'placeholder-value',
|
|
@@ -3177,7 +3321,7 @@ export namespace alloydb_v1beta {
|
|
|
3177
3321
|
}
|
|
3178
3322
|
export interface Params$Resource$Projects$Locations$List extends StandardParameters {
|
|
3179
3323
|
/**
|
|
3180
|
-
* Optional. Do not use this field
|
|
3324
|
+
* Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
|
|
3181
3325
|
*/
|
|
3182
3326
|
extraLocationTypes?: string[];
|
|
3183
3327
|
/**
|
|
@@ -5527,6 +5671,7 @@ export namespace alloydb_v1beta {
|
|
|
5527
5671
|
* // request body parameters
|
|
5528
5672
|
* // {
|
|
5529
5673
|
* // "etag": "my_etag",
|
|
5674
|
+
* // "failover": false,
|
|
5530
5675
|
* // "requestId": "my_requestId",
|
|
5531
5676
|
* // "validateOnly": false
|
|
5532
5677
|
* // }
|
|
@@ -6510,6 +6655,7 @@ export namespace alloydb_v1beta {
|
|
|
6510
6655
|
* // "clientConnectionConfig": {},
|
|
6511
6656
|
* // "connectionPoolConfig": {},
|
|
6512
6657
|
* // "createTime": "my_createTime",
|
|
6658
|
+
* // "dataApiAccess": "my_dataApiAccess",
|
|
6513
6659
|
* // "databaseFlags": {},
|
|
6514
6660
|
* // "deleteTime": "my_deleteTime",
|
|
6515
6661
|
* // "displayName": "my_displayName",
|
|
@@ -6700,6 +6846,7 @@ export namespace alloydb_v1beta {
|
|
|
6700
6846
|
* // "clientConnectionConfig": {},
|
|
6701
6847
|
* // "connectionPoolConfig": {},
|
|
6702
6848
|
* // "createTime": "my_createTime",
|
|
6849
|
+
* // "dataApiAccess": "my_dataApiAccess",
|
|
6703
6850
|
* // "databaseFlags": {},
|
|
6704
6851
|
* // "deleteTime": "my_deleteTime",
|
|
6705
6852
|
* // "displayName": "my_displayName",
|
|
@@ -7180,6 +7327,7 @@ export namespace alloydb_v1beta {
|
|
|
7180
7327
|
* // "clientConnectionConfig": {},
|
|
7181
7328
|
* // "connectionPoolConfig": {},
|
|
7182
7329
|
* // "createTime": "my_createTime",
|
|
7330
|
+
* // "dataApiAccess": "my_dataApiAccess",
|
|
7183
7331
|
* // "databaseFlags": {},
|
|
7184
7332
|
* // "deleteTime": "my_deleteTime",
|
|
7185
7333
|
* // "displayName": "my_displayName",
|
|
@@ -7807,6 +7955,7 @@ export namespace alloydb_v1beta {
|
|
|
7807
7955
|
* // "clientConnectionConfig": {},
|
|
7808
7956
|
* // "connectionPoolConfig": {},
|
|
7809
7957
|
* // "createTime": "my_createTime",
|
|
7958
|
+
* // "dataApiAccess": "my_dataApiAccess",
|
|
7810
7959
|
* // "databaseFlags": {},
|
|
7811
7960
|
* // "deleteTime": "my_deleteTime",
|
|
7812
7961
|
* // "displayName": "my_displayName",
|
|
@@ -9101,6 +9250,885 @@ export namespace alloydb_v1beta {
|
|
|
9101
9250
|
requestBody?: Schema$User;
|
|
9102
9251
|
}
|
|
9103
9252
|
|
|
9253
|
+
export class Resource$Projects$Locations$Endpoints {
|
|
9254
|
+
context: APIRequestContext;
|
|
9255
|
+
constructor(context: APIRequestContext) {
|
|
9256
|
+
this.context = context;
|
|
9257
|
+
}
|
|
9258
|
+
|
|
9259
|
+
/**
|
|
9260
|
+
* Creates a new Endpoint in a given project and location.
|
|
9261
|
+
* @example
|
|
9262
|
+
* ```js
|
|
9263
|
+
* // Before running the sample:
|
|
9264
|
+
* // - Enable the API at:
|
|
9265
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
9266
|
+
* // - Login into gcloud by running:
|
|
9267
|
+
* // ```sh
|
|
9268
|
+
* // $ gcloud auth application-default login
|
|
9269
|
+
* // ```
|
|
9270
|
+
* // - Install the npm module by running:
|
|
9271
|
+
* // ```sh
|
|
9272
|
+
* // $ npm install googleapis
|
|
9273
|
+
* // ```
|
|
9274
|
+
*
|
|
9275
|
+
* const {google} = require('googleapis');
|
|
9276
|
+
* const alloydb = google.alloydb('v1beta');
|
|
9277
|
+
*
|
|
9278
|
+
* async function main() {
|
|
9279
|
+
* const auth = new google.auth.GoogleAuth({
|
|
9280
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
9281
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
9282
|
+
* });
|
|
9283
|
+
*
|
|
9284
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
9285
|
+
* const authClient = await auth.getClient();
|
|
9286
|
+
* google.options({auth: authClient});
|
|
9287
|
+
*
|
|
9288
|
+
* // Do the magic
|
|
9289
|
+
* const res = await alloydb.projects.locations.endpoints.create({
|
|
9290
|
+
* // Required. ID of the requesting object.
|
|
9291
|
+
* endpointId: 'placeholder-value',
|
|
9292
|
+
* // Required. The location of the new endpoint. For the required format, see the comment on the Endpoint.name field.
|
|
9293
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
9294
|
+
* // 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).
|
|
9295
|
+
* requestId: 'placeholder-value',
|
|
9296
|
+
* // Optional. If set, the backend validates the request, but doesn't actually execute it.
|
|
9297
|
+
* validateOnly: 'placeholder-value',
|
|
9298
|
+
*
|
|
9299
|
+
* // Request body metadata
|
|
9300
|
+
* requestBody: {
|
|
9301
|
+
* // request body parameters
|
|
9302
|
+
* // {
|
|
9303
|
+
* // "annotations": {},
|
|
9304
|
+
* // "createTime": "my_createTime",
|
|
9305
|
+
* // "deleteTime": "my_deleteTime",
|
|
9306
|
+
* // "displayName": "my_displayName",
|
|
9307
|
+
* // "dnsConfig": {},
|
|
9308
|
+
* // "effectiveTargetInstances": [],
|
|
9309
|
+
* // "endpointType": "my_endpointType",
|
|
9310
|
+
* // "etag": "my_etag",
|
|
9311
|
+
* // "name": "my_name",
|
|
9312
|
+
* // "reconciling": false,
|
|
9313
|
+
* // "state": "my_state",
|
|
9314
|
+
* // "targetInstances": [],
|
|
9315
|
+
* // "uid": "my_uid",
|
|
9316
|
+
* // "updateTime": "my_updateTime"
|
|
9317
|
+
* // }
|
|
9318
|
+
* },
|
|
9319
|
+
* });
|
|
9320
|
+
* console.log(res.data);
|
|
9321
|
+
*
|
|
9322
|
+
* // Example response
|
|
9323
|
+
* // {
|
|
9324
|
+
* // "done": false,
|
|
9325
|
+
* // "error": {},
|
|
9326
|
+
* // "metadata": {},
|
|
9327
|
+
* // "name": "my_name",
|
|
9328
|
+
* // "response": {}
|
|
9329
|
+
* // }
|
|
9330
|
+
* }
|
|
9331
|
+
*
|
|
9332
|
+
* main().catch(e => {
|
|
9333
|
+
* console.error(e);
|
|
9334
|
+
* throw e;
|
|
9335
|
+
* });
|
|
9336
|
+
*
|
|
9337
|
+
* ```
|
|
9338
|
+
*
|
|
9339
|
+
* @param params - Parameters for request
|
|
9340
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
9341
|
+
* @param callback - Optional callback that handles the response.
|
|
9342
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
9343
|
+
*/
|
|
9344
|
+
create(
|
|
9345
|
+
params: Params$Resource$Projects$Locations$Endpoints$Create,
|
|
9346
|
+
options: StreamMethodOptions
|
|
9347
|
+
): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
9348
|
+
create(
|
|
9349
|
+
params?: Params$Resource$Projects$Locations$Endpoints$Create,
|
|
9350
|
+
options?: MethodOptions
|
|
9351
|
+
): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
9352
|
+
create(
|
|
9353
|
+
params: Params$Resource$Projects$Locations$Endpoints$Create,
|
|
9354
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
9355
|
+
callback: BodyResponseCallback<Readable>
|
|
9356
|
+
): void;
|
|
9357
|
+
create(
|
|
9358
|
+
params: Params$Resource$Projects$Locations$Endpoints$Create,
|
|
9359
|
+
options: MethodOptions | BodyResponseCallback<Schema$Operation>,
|
|
9360
|
+
callback: BodyResponseCallback<Schema$Operation>
|
|
9361
|
+
): void;
|
|
9362
|
+
create(
|
|
9363
|
+
params: Params$Resource$Projects$Locations$Endpoints$Create,
|
|
9364
|
+
callback: BodyResponseCallback<Schema$Operation>
|
|
9365
|
+
): void;
|
|
9366
|
+
create(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
9367
|
+
create(
|
|
9368
|
+
paramsOrCallback?:
|
|
9369
|
+
| Params$Resource$Projects$Locations$Endpoints$Create
|
|
9370
|
+
| BodyResponseCallback<Schema$Operation>
|
|
9371
|
+
| BodyResponseCallback<Readable>,
|
|
9372
|
+
optionsOrCallback?:
|
|
9373
|
+
| MethodOptions
|
|
9374
|
+
| StreamMethodOptions
|
|
9375
|
+
| BodyResponseCallback<Schema$Operation>
|
|
9376
|
+
| BodyResponseCallback<Readable>,
|
|
9377
|
+
callback?:
|
|
9378
|
+
| BodyResponseCallback<Schema$Operation>
|
|
9379
|
+
| BodyResponseCallback<Readable>
|
|
9380
|
+
):
|
|
9381
|
+
| void
|
|
9382
|
+
| Promise<GaxiosResponseWithHTTP2<Schema$Operation>>
|
|
9383
|
+
| Promise<GaxiosResponseWithHTTP2<Readable>> {
|
|
9384
|
+
let params = (paramsOrCallback ||
|
|
9385
|
+
{}) as Params$Resource$Projects$Locations$Endpoints$Create;
|
|
9386
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
9387
|
+
|
|
9388
|
+
if (typeof paramsOrCallback === 'function') {
|
|
9389
|
+
callback = paramsOrCallback;
|
|
9390
|
+
params = {} as Params$Resource$Projects$Locations$Endpoints$Create;
|
|
9391
|
+
options = {};
|
|
9392
|
+
}
|
|
9393
|
+
|
|
9394
|
+
if (typeof optionsOrCallback === 'function') {
|
|
9395
|
+
callback = optionsOrCallback;
|
|
9396
|
+
options = {};
|
|
9397
|
+
}
|
|
9398
|
+
|
|
9399
|
+
const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/';
|
|
9400
|
+
const parameters = {
|
|
9401
|
+
options: Object.assign(
|
|
9402
|
+
{
|
|
9403
|
+
url: (rootUrl + '/v1beta/{+parent}/endpoints').replace(
|
|
9404
|
+
/([^:]\/)\/+/g,
|
|
9405
|
+
'$1'
|
|
9406
|
+
),
|
|
9407
|
+
method: 'POST',
|
|
9408
|
+
apiVersion: '',
|
|
9409
|
+
},
|
|
9410
|
+
options
|
|
9411
|
+
),
|
|
9412
|
+
params,
|
|
9413
|
+
requiredParams: ['parent'],
|
|
9414
|
+
pathParams: ['parent'],
|
|
9415
|
+
context: this.context,
|
|
9416
|
+
};
|
|
9417
|
+
if (callback) {
|
|
9418
|
+
createAPIRequest<Schema$Operation>(
|
|
9419
|
+
parameters,
|
|
9420
|
+
callback as BodyResponseCallback<unknown>
|
|
9421
|
+
);
|
|
9422
|
+
} else {
|
|
9423
|
+
return createAPIRequest<Schema$Operation>(parameters);
|
|
9424
|
+
}
|
|
9425
|
+
}
|
|
9426
|
+
|
|
9427
|
+
/**
|
|
9428
|
+
* Deletes a single Endpoint.
|
|
9429
|
+
* @example
|
|
9430
|
+
* ```js
|
|
9431
|
+
* // Before running the sample:
|
|
9432
|
+
* // - Enable the API at:
|
|
9433
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
9434
|
+
* // - Login into gcloud by running:
|
|
9435
|
+
* // ```sh
|
|
9436
|
+
* // $ gcloud auth application-default login
|
|
9437
|
+
* // ```
|
|
9438
|
+
* // - Install the npm module by running:
|
|
9439
|
+
* // ```sh
|
|
9440
|
+
* // $ npm install googleapis
|
|
9441
|
+
* // ```
|
|
9442
|
+
*
|
|
9443
|
+
* const {google} = require('googleapis');
|
|
9444
|
+
* const alloydb = google.alloydb('v1beta');
|
|
9445
|
+
*
|
|
9446
|
+
* async function main() {
|
|
9447
|
+
* const auth = new google.auth.GoogleAuth({
|
|
9448
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
9449
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
9450
|
+
* });
|
|
9451
|
+
*
|
|
9452
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
9453
|
+
* const authClient = await auth.getClient();
|
|
9454
|
+
* google.options({auth: authClient});
|
|
9455
|
+
*
|
|
9456
|
+
* // Do the magic
|
|
9457
|
+
* const res = await alloydb.projects.locations.endpoints.delete({
|
|
9458
|
+
* // 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.
|
|
9459
|
+
* etag: 'placeholder-value',
|
|
9460
|
+
* // Required. The name of the resource. For the required format, see the comment on the Endpoint.name field.
|
|
9461
|
+
* name: 'projects/my-project/locations/my-location/endpoints/my-endpoint',
|
|
9462
|
+
* // 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).
|
|
9463
|
+
* requestId: 'placeholder-value',
|
|
9464
|
+
* // Optional. If set, the backend validates the request, but doesn't actually execute it.
|
|
9465
|
+
* validateOnly: 'placeholder-value',
|
|
9466
|
+
* });
|
|
9467
|
+
* console.log(res.data);
|
|
9468
|
+
*
|
|
9469
|
+
* // Example response
|
|
9470
|
+
* // {
|
|
9471
|
+
* // "done": false,
|
|
9472
|
+
* // "error": {},
|
|
9473
|
+
* // "metadata": {},
|
|
9474
|
+
* // "name": "my_name",
|
|
9475
|
+
* // "response": {}
|
|
9476
|
+
* // }
|
|
9477
|
+
* }
|
|
9478
|
+
*
|
|
9479
|
+
* main().catch(e => {
|
|
9480
|
+
* console.error(e);
|
|
9481
|
+
* throw e;
|
|
9482
|
+
* });
|
|
9483
|
+
*
|
|
9484
|
+
* ```
|
|
9485
|
+
*
|
|
9486
|
+
* @param params - Parameters for request
|
|
9487
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
9488
|
+
* @param callback - Optional callback that handles the response.
|
|
9489
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
9490
|
+
*/
|
|
9491
|
+
delete(
|
|
9492
|
+
params: Params$Resource$Projects$Locations$Endpoints$Delete,
|
|
9493
|
+
options: StreamMethodOptions
|
|
9494
|
+
): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
9495
|
+
delete(
|
|
9496
|
+
params?: Params$Resource$Projects$Locations$Endpoints$Delete,
|
|
9497
|
+
options?: MethodOptions
|
|
9498
|
+
): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
9499
|
+
delete(
|
|
9500
|
+
params: Params$Resource$Projects$Locations$Endpoints$Delete,
|
|
9501
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
9502
|
+
callback: BodyResponseCallback<Readable>
|
|
9503
|
+
): void;
|
|
9504
|
+
delete(
|
|
9505
|
+
params: Params$Resource$Projects$Locations$Endpoints$Delete,
|
|
9506
|
+
options: MethodOptions | BodyResponseCallback<Schema$Operation>,
|
|
9507
|
+
callback: BodyResponseCallback<Schema$Operation>
|
|
9508
|
+
): void;
|
|
9509
|
+
delete(
|
|
9510
|
+
params: Params$Resource$Projects$Locations$Endpoints$Delete,
|
|
9511
|
+
callback: BodyResponseCallback<Schema$Operation>
|
|
9512
|
+
): void;
|
|
9513
|
+
delete(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
9514
|
+
delete(
|
|
9515
|
+
paramsOrCallback?:
|
|
9516
|
+
| Params$Resource$Projects$Locations$Endpoints$Delete
|
|
9517
|
+
| BodyResponseCallback<Schema$Operation>
|
|
9518
|
+
| BodyResponseCallback<Readable>,
|
|
9519
|
+
optionsOrCallback?:
|
|
9520
|
+
| MethodOptions
|
|
9521
|
+
| StreamMethodOptions
|
|
9522
|
+
| BodyResponseCallback<Schema$Operation>
|
|
9523
|
+
| BodyResponseCallback<Readable>,
|
|
9524
|
+
callback?:
|
|
9525
|
+
| BodyResponseCallback<Schema$Operation>
|
|
9526
|
+
| BodyResponseCallback<Readable>
|
|
9527
|
+
):
|
|
9528
|
+
| void
|
|
9529
|
+
| Promise<GaxiosResponseWithHTTP2<Schema$Operation>>
|
|
9530
|
+
| Promise<GaxiosResponseWithHTTP2<Readable>> {
|
|
9531
|
+
let params = (paramsOrCallback ||
|
|
9532
|
+
{}) as Params$Resource$Projects$Locations$Endpoints$Delete;
|
|
9533
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
9534
|
+
|
|
9535
|
+
if (typeof paramsOrCallback === 'function') {
|
|
9536
|
+
callback = paramsOrCallback;
|
|
9537
|
+
params = {} as Params$Resource$Projects$Locations$Endpoints$Delete;
|
|
9538
|
+
options = {};
|
|
9539
|
+
}
|
|
9540
|
+
|
|
9541
|
+
if (typeof optionsOrCallback === 'function') {
|
|
9542
|
+
callback = optionsOrCallback;
|
|
9543
|
+
options = {};
|
|
9544
|
+
}
|
|
9545
|
+
|
|
9546
|
+
const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/';
|
|
9547
|
+
const parameters = {
|
|
9548
|
+
options: Object.assign(
|
|
9549
|
+
{
|
|
9550
|
+
url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
9551
|
+
method: 'DELETE',
|
|
9552
|
+
apiVersion: '',
|
|
9553
|
+
},
|
|
9554
|
+
options
|
|
9555
|
+
),
|
|
9556
|
+
params,
|
|
9557
|
+
requiredParams: ['name'],
|
|
9558
|
+
pathParams: ['name'],
|
|
9559
|
+
context: this.context,
|
|
9560
|
+
};
|
|
9561
|
+
if (callback) {
|
|
9562
|
+
createAPIRequest<Schema$Operation>(
|
|
9563
|
+
parameters,
|
|
9564
|
+
callback as BodyResponseCallback<unknown>
|
|
9565
|
+
);
|
|
9566
|
+
} else {
|
|
9567
|
+
return createAPIRequest<Schema$Operation>(parameters);
|
|
9568
|
+
}
|
|
9569
|
+
}
|
|
9570
|
+
|
|
9571
|
+
/**
|
|
9572
|
+
* Gets details of a single Endpoint.
|
|
9573
|
+
* @example
|
|
9574
|
+
* ```js
|
|
9575
|
+
* // Before running the sample:
|
|
9576
|
+
* // - Enable the API at:
|
|
9577
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
9578
|
+
* // - Login into gcloud by running:
|
|
9579
|
+
* // ```sh
|
|
9580
|
+
* // $ gcloud auth application-default login
|
|
9581
|
+
* // ```
|
|
9582
|
+
* // - Install the npm module by running:
|
|
9583
|
+
* // ```sh
|
|
9584
|
+
* // $ npm install googleapis
|
|
9585
|
+
* // ```
|
|
9586
|
+
*
|
|
9587
|
+
* const {google} = require('googleapis');
|
|
9588
|
+
* const alloydb = google.alloydb('v1beta');
|
|
9589
|
+
*
|
|
9590
|
+
* async function main() {
|
|
9591
|
+
* const auth = new google.auth.GoogleAuth({
|
|
9592
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
9593
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
9594
|
+
* });
|
|
9595
|
+
*
|
|
9596
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
9597
|
+
* const authClient = await auth.getClient();
|
|
9598
|
+
* google.options({auth: authClient});
|
|
9599
|
+
*
|
|
9600
|
+
* // Do the magic
|
|
9601
|
+
* const res = await alloydb.projects.locations.endpoints.get({
|
|
9602
|
+
* // Required. The name of the resource. For the required format, see the comment on the Endpoint.name field.
|
|
9603
|
+
* name: 'projects/my-project/locations/my-location/endpoints/my-endpoint',
|
|
9604
|
+
* });
|
|
9605
|
+
* console.log(res.data);
|
|
9606
|
+
*
|
|
9607
|
+
* // Example response
|
|
9608
|
+
* // {
|
|
9609
|
+
* // "annotations": {},
|
|
9610
|
+
* // "createTime": "my_createTime",
|
|
9611
|
+
* // "deleteTime": "my_deleteTime",
|
|
9612
|
+
* // "displayName": "my_displayName",
|
|
9613
|
+
* // "dnsConfig": {},
|
|
9614
|
+
* // "effectiveTargetInstances": [],
|
|
9615
|
+
* // "endpointType": "my_endpointType",
|
|
9616
|
+
* // "etag": "my_etag",
|
|
9617
|
+
* // "name": "my_name",
|
|
9618
|
+
* // "reconciling": false,
|
|
9619
|
+
* // "state": "my_state",
|
|
9620
|
+
* // "targetInstances": [],
|
|
9621
|
+
* // "uid": "my_uid",
|
|
9622
|
+
* // "updateTime": "my_updateTime"
|
|
9623
|
+
* // }
|
|
9624
|
+
* }
|
|
9625
|
+
*
|
|
9626
|
+
* main().catch(e => {
|
|
9627
|
+
* console.error(e);
|
|
9628
|
+
* throw e;
|
|
9629
|
+
* });
|
|
9630
|
+
*
|
|
9631
|
+
* ```
|
|
9632
|
+
*
|
|
9633
|
+
* @param params - Parameters for request
|
|
9634
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
9635
|
+
* @param callback - Optional callback that handles the response.
|
|
9636
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
9637
|
+
*/
|
|
9638
|
+
get(
|
|
9639
|
+
params: Params$Resource$Projects$Locations$Endpoints$Get,
|
|
9640
|
+
options: StreamMethodOptions
|
|
9641
|
+
): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
9642
|
+
get(
|
|
9643
|
+
params?: Params$Resource$Projects$Locations$Endpoints$Get,
|
|
9644
|
+
options?: MethodOptions
|
|
9645
|
+
): Promise<GaxiosResponseWithHTTP2<Schema$Endpoint>>;
|
|
9646
|
+
get(
|
|
9647
|
+
params: Params$Resource$Projects$Locations$Endpoints$Get,
|
|
9648
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
9649
|
+
callback: BodyResponseCallback<Readable>
|
|
9650
|
+
): void;
|
|
9651
|
+
get(
|
|
9652
|
+
params: Params$Resource$Projects$Locations$Endpoints$Get,
|
|
9653
|
+
options: MethodOptions | BodyResponseCallback<Schema$Endpoint>,
|
|
9654
|
+
callback: BodyResponseCallback<Schema$Endpoint>
|
|
9655
|
+
): void;
|
|
9656
|
+
get(
|
|
9657
|
+
params: Params$Resource$Projects$Locations$Endpoints$Get,
|
|
9658
|
+
callback: BodyResponseCallback<Schema$Endpoint>
|
|
9659
|
+
): void;
|
|
9660
|
+
get(callback: BodyResponseCallback<Schema$Endpoint>): void;
|
|
9661
|
+
get(
|
|
9662
|
+
paramsOrCallback?:
|
|
9663
|
+
| Params$Resource$Projects$Locations$Endpoints$Get
|
|
9664
|
+
| BodyResponseCallback<Schema$Endpoint>
|
|
9665
|
+
| BodyResponseCallback<Readable>,
|
|
9666
|
+
optionsOrCallback?:
|
|
9667
|
+
| MethodOptions
|
|
9668
|
+
| StreamMethodOptions
|
|
9669
|
+
| BodyResponseCallback<Schema$Endpoint>
|
|
9670
|
+
| BodyResponseCallback<Readable>,
|
|
9671
|
+
callback?:
|
|
9672
|
+
| BodyResponseCallback<Schema$Endpoint>
|
|
9673
|
+
| BodyResponseCallback<Readable>
|
|
9674
|
+
):
|
|
9675
|
+
| void
|
|
9676
|
+
| Promise<GaxiosResponseWithHTTP2<Schema$Endpoint>>
|
|
9677
|
+
| Promise<GaxiosResponseWithHTTP2<Readable>> {
|
|
9678
|
+
let params = (paramsOrCallback ||
|
|
9679
|
+
{}) as Params$Resource$Projects$Locations$Endpoints$Get;
|
|
9680
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
9681
|
+
|
|
9682
|
+
if (typeof paramsOrCallback === 'function') {
|
|
9683
|
+
callback = paramsOrCallback;
|
|
9684
|
+
params = {} as Params$Resource$Projects$Locations$Endpoints$Get;
|
|
9685
|
+
options = {};
|
|
9686
|
+
}
|
|
9687
|
+
|
|
9688
|
+
if (typeof optionsOrCallback === 'function') {
|
|
9689
|
+
callback = optionsOrCallback;
|
|
9690
|
+
options = {};
|
|
9691
|
+
}
|
|
9692
|
+
|
|
9693
|
+
const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/';
|
|
9694
|
+
const parameters = {
|
|
9695
|
+
options: Object.assign(
|
|
9696
|
+
{
|
|
9697
|
+
url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
9698
|
+
method: 'GET',
|
|
9699
|
+
apiVersion: '',
|
|
9700
|
+
},
|
|
9701
|
+
options
|
|
9702
|
+
),
|
|
9703
|
+
params,
|
|
9704
|
+
requiredParams: ['name'],
|
|
9705
|
+
pathParams: ['name'],
|
|
9706
|
+
context: this.context,
|
|
9707
|
+
};
|
|
9708
|
+
if (callback) {
|
|
9709
|
+
createAPIRequest<Schema$Endpoint>(
|
|
9710
|
+
parameters,
|
|
9711
|
+
callback as BodyResponseCallback<unknown>
|
|
9712
|
+
);
|
|
9713
|
+
} else {
|
|
9714
|
+
return createAPIRequest<Schema$Endpoint>(parameters);
|
|
9715
|
+
}
|
|
9716
|
+
}
|
|
9717
|
+
|
|
9718
|
+
/**
|
|
9719
|
+
* Lists Endpoints in a given project and location.
|
|
9720
|
+
* @example
|
|
9721
|
+
* ```js
|
|
9722
|
+
* // Before running the sample:
|
|
9723
|
+
* // - Enable the API at:
|
|
9724
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
9725
|
+
* // - Login into gcloud by running:
|
|
9726
|
+
* // ```sh
|
|
9727
|
+
* // $ gcloud auth application-default login
|
|
9728
|
+
* // ```
|
|
9729
|
+
* // - Install the npm module by running:
|
|
9730
|
+
* // ```sh
|
|
9731
|
+
* // $ npm install googleapis
|
|
9732
|
+
* // ```
|
|
9733
|
+
*
|
|
9734
|
+
* const {google} = require('googleapis');
|
|
9735
|
+
* const alloydb = google.alloydb('v1beta');
|
|
9736
|
+
*
|
|
9737
|
+
* async function main() {
|
|
9738
|
+
* const auth = new google.auth.GoogleAuth({
|
|
9739
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
9740
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
9741
|
+
* });
|
|
9742
|
+
*
|
|
9743
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
9744
|
+
* const authClient = await auth.getClient();
|
|
9745
|
+
* google.options({auth: authClient});
|
|
9746
|
+
*
|
|
9747
|
+
* // Do the magic
|
|
9748
|
+
* const res = await alloydb.projects.locations.endpoints.list({
|
|
9749
|
+
* // Optional. Filtering results. This field is currently not supported, its value will be ignored if passed.
|
|
9750
|
+
* filter: 'placeholder-value',
|
|
9751
|
+
* // Optional. Hint for how to order the results
|
|
9752
|
+
* orderBy: 'placeholder-value',
|
|
9753
|
+
* // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
|
|
9754
|
+
* pageSize: 'placeholder-value',
|
|
9755
|
+
* // 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.
|
|
9756
|
+
* pageToken: 'placeholder-value',
|
|
9757
|
+
* // 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/-
|
|
9758
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
9759
|
+
* });
|
|
9760
|
+
* console.log(res.data);
|
|
9761
|
+
*
|
|
9762
|
+
* // Example response
|
|
9763
|
+
* // {
|
|
9764
|
+
* // "endpoints": [],
|
|
9765
|
+
* // "nextPageToken": "my_nextPageToken",
|
|
9766
|
+
* // "unreachable": []
|
|
9767
|
+
* // }
|
|
9768
|
+
* }
|
|
9769
|
+
*
|
|
9770
|
+
* main().catch(e => {
|
|
9771
|
+
* console.error(e);
|
|
9772
|
+
* throw e;
|
|
9773
|
+
* });
|
|
9774
|
+
*
|
|
9775
|
+
* ```
|
|
9776
|
+
*
|
|
9777
|
+
* @param params - Parameters for request
|
|
9778
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
9779
|
+
* @param callback - Optional callback that handles the response.
|
|
9780
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
9781
|
+
*/
|
|
9782
|
+
list(
|
|
9783
|
+
params: Params$Resource$Projects$Locations$Endpoints$List,
|
|
9784
|
+
options: StreamMethodOptions
|
|
9785
|
+
): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
9786
|
+
list(
|
|
9787
|
+
params?: Params$Resource$Projects$Locations$Endpoints$List,
|
|
9788
|
+
options?: MethodOptions
|
|
9789
|
+
): Promise<GaxiosResponseWithHTTP2<Schema$ListEndpointsResponse>>;
|
|
9790
|
+
list(
|
|
9791
|
+
params: Params$Resource$Projects$Locations$Endpoints$List,
|
|
9792
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
9793
|
+
callback: BodyResponseCallback<Readable>
|
|
9794
|
+
): void;
|
|
9795
|
+
list(
|
|
9796
|
+
params: Params$Resource$Projects$Locations$Endpoints$List,
|
|
9797
|
+
options:
|
|
9798
|
+
| MethodOptions
|
|
9799
|
+
| BodyResponseCallback<Schema$ListEndpointsResponse>,
|
|
9800
|
+
callback: BodyResponseCallback<Schema$ListEndpointsResponse>
|
|
9801
|
+
): void;
|
|
9802
|
+
list(
|
|
9803
|
+
params: Params$Resource$Projects$Locations$Endpoints$List,
|
|
9804
|
+
callback: BodyResponseCallback<Schema$ListEndpointsResponse>
|
|
9805
|
+
): void;
|
|
9806
|
+
list(callback: BodyResponseCallback<Schema$ListEndpointsResponse>): void;
|
|
9807
|
+
list(
|
|
9808
|
+
paramsOrCallback?:
|
|
9809
|
+
| Params$Resource$Projects$Locations$Endpoints$List
|
|
9810
|
+
| BodyResponseCallback<Schema$ListEndpointsResponse>
|
|
9811
|
+
| BodyResponseCallback<Readable>,
|
|
9812
|
+
optionsOrCallback?:
|
|
9813
|
+
| MethodOptions
|
|
9814
|
+
| StreamMethodOptions
|
|
9815
|
+
| BodyResponseCallback<Schema$ListEndpointsResponse>
|
|
9816
|
+
| BodyResponseCallback<Readable>,
|
|
9817
|
+
callback?:
|
|
9818
|
+
| BodyResponseCallback<Schema$ListEndpointsResponse>
|
|
9819
|
+
| BodyResponseCallback<Readable>
|
|
9820
|
+
):
|
|
9821
|
+
| void
|
|
9822
|
+
| Promise<GaxiosResponseWithHTTP2<Schema$ListEndpointsResponse>>
|
|
9823
|
+
| Promise<GaxiosResponseWithHTTP2<Readable>> {
|
|
9824
|
+
let params = (paramsOrCallback ||
|
|
9825
|
+
{}) as Params$Resource$Projects$Locations$Endpoints$List;
|
|
9826
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
9827
|
+
|
|
9828
|
+
if (typeof paramsOrCallback === 'function') {
|
|
9829
|
+
callback = paramsOrCallback;
|
|
9830
|
+
params = {} as Params$Resource$Projects$Locations$Endpoints$List;
|
|
9831
|
+
options = {};
|
|
9832
|
+
}
|
|
9833
|
+
|
|
9834
|
+
if (typeof optionsOrCallback === 'function') {
|
|
9835
|
+
callback = optionsOrCallback;
|
|
9836
|
+
options = {};
|
|
9837
|
+
}
|
|
9838
|
+
|
|
9839
|
+
const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/';
|
|
9840
|
+
const parameters = {
|
|
9841
|
+
options: Object.assign(
|
|
9842
|
+
{
|
|
9843
|
+
url: (rootUrl + '/v1beta/{+parent}/endpoints').replace(
|
|
9844
|
+
/([^:]\/)\/+/g,
|
|
9845
|
+
'$1'
|
|
9846
|
+
),
|
|
9847
|
+
method: 'GET',
|
|
9848
|
+
apiVersion: '',
|
|
9849
|
+
},
|
|
9850
|
+
options
|
|
9851
|
+
),
|
|
9852
|
+
params,
|
|
9853
|
+
requiredParams: ['parent'],
|
|
9854
|
+
pathParams: ['parent'],
|
|
9855
|
+
context: this.context,
|
|
9856
|
+
};
|
|
9857
|
+
if (callback) {
|
|
9858
|
+
createAPIRequest<Schema$ListEndpointsResponse>(
|
|
9859
|
+
parameters,
|
|
9860
|
+
callback as BodyResponseCallback<unknown>
|
|
9861
|
+
);
|
|
9862
|
+
} else {
|
|
9863
|
+
return createAPIRequest<Schema$ListEndpointsResponse>(parameters);
|
|
9864
|
+
}
|
|
9865
|
+
}
|
|
9866
|
+
|
|
9867
|
+
/**
|
|
9868
|
+
* Updates the parameters of a single Endpoint.
|
|
9869
|
+
* @example
|
|
9870
|
+
* ```js
|
|
9871
|
+
* // Before running the sample:
|
|
9872
|
+
* // - Enable the API at:
|
|
9873
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
9874
|
+
* // - Login into gcloud by running:
|
|
9875
|
+
* // ```sh
|
|
9876
|
+
* // $ gcloud auth application-default login
|
|
9877
|
+
* // ```
|
|
9878
|
+
* // - Install the npm module by running:
|
|
9879
|
+
* // ```sh
|
|
9880
|
+
* // $ npm install googleapis
|
|
9881
|
+
* // ```
|
|
9882
|
+
*
|
|
9883
|
+
* const {google} = require('googleapis');
|
|
9884
|
+
* const alloydb = google.alloydb('v1beta');
|
|
9885
|
+
*
|
|
9886
|
+
* async function main() {
|
|
9887
|
+
* const auth = new google.auth.GoogleAuth({
|
|
9888
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
9889
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
9890
|
+
* });
|
|
9891
|
+
*
|
|
9892
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
9893
|
+
* const authClient = await auth.getClient();
|
|
9894
|
+
* google.options({auth: authClient});
|
|
9895
|
+
*
|
|
9896
|
+
* // Do the magic
|
|
9897
|
+
* const res = await alloydb.projects.locations.endpoints.patch({
|
|
9898
|
+
* // 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.
|
|
9899
|
+
* allowMissing: 'placeholder-value',
|
|
9900
|
+
* // 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\}
|
|
9901
|
+
* name: 'projects/my-project/locations/my-location/endpoints/my-endpoint',
|
|
9902
|
+
* // 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).
|
|
9903
|
+
* requestId: 'placeholder-value',
|
|
9904
|
+
* // 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.
|
|
9905
|
+
* updateMask: 'placeholder-value',
|
|
9906
|
+
* // Optional. If set, the backend validates the request, but doesn't actually execute it.
|
|
9907
|
+
* validateOnly: 'placeholder-value',
|
|
9908
|
+
*
|
|
9909
|
+
* // Request body metadata
|
|
9910
|
+
* requestBody: {
|
|
9911
|
+
* // request body parameters
|
|
9912
|
+
* // {
|
|
9913
|
+
* // "annotations": {},
|
|
9914
|
+
* // "createTime": "my_createTime",
|
|
9915
|
+
* // "deleteTime": "my_deleteTime",
|
|
9916
|
+
* // "displayName": "my_displayName",
|
|
9917
|
+
* // "dnsConfig": {},
|
|
9918
|
+
* // "effectiveTargetInstances": [],
|
|
9919
|
+
* // "endpointType": "my_endpointType",
|
|
9920
|
+
* // "etag": "my_etag",
|
|
9921
|
+
* // "name": "my_name",
|
|
9922
|
+
* // "reconciling": false,
|
|
9923
|
+
* // "state": "my_state",
|
|
9924
|
+
* // "targetInstances": [],
|
|
9925
|
+
* // "uid": "my_uid",
|
|
9926
|
+
* // "updateTime": "my_updateTime"
|
|
9927
|
+
* // }
|
|
9928
|
+
* },
|
|
9929
|
+
* });
|
|
9930
|
+
* console.log(res.data);
|
|
9931
|
+
*
|
|
9932
|
+
* // Example response
|
|
9933
|
+
* // {
|
|
9934
|
+
* // "done": false,
|
|
9935
|
+
* // "error": {},
|
|
9936
|
+
* // "metadata": {},
|
|
9937
|
+
* // "name": "my_name",
|
|
9938
|
+
* // "response": {}
|
|
9939
|
+
* // }
|
|
9940
|
+
* }
|
|
9941
|
+
*
|
|
9942
|
+
* main().catch(e => {
|
|
9943
|
+
* console.error(e);
|
|
9944
|
+
* throw e;
|
|
9945
|
+
* });
|
|
9946
|
+
*
|
|
9947
|
+
* ```
|
|
9948
|
+
*
|
|
9949
|
+
* @param params - Parameters for request
|
|
9950
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
9951
|
+
* @param callback - Optional callback that handles the response.
|
|
9952
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
9953
|
+
*/
|
|
9954
|
+
patch(
|
|
9955
|
+
params: Params$Resource$Projects$Locations$Endpoints$Patch,
|
|
9956
|
+
options: StreamMethodOptions
|
|
9957
|
+
): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
9958
|
+
patch(
|
|
9959
|
+
params?: Params$Resource$Projects$Locations$Endpoints$Patch,
|
|
9960
|
+
options?: MethodOptions
|
|
9961
|
+
): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
9962
|
+
patch(
|
|
9963
|
+
params: Params$Resource$Projects$Locations$Endpoints$Patch,
|
|
9964
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
9965
|
+
callback: BodyResponseCallback<Readable>
|
|
9966
|
+
): void;
|
|
9967
|
+
patch(
|
|
9968
|
+
params: Params$Resource$Projects$Locations$Endpoints$Patch,
|
|
9969
|
+
options: MethodOptions | BodyResponseCallback<Schema$Operation>,
|
|
9970
|
+
callback: BodyResponseCallback<Schema$Operation>
|
|
9971
|
+
): void;
|
|
9972
|
+
patch(
|
|
9973
|
+
params: Params$Resource$Projects$Locations$Endpoints$Patch,
|
|
9974
|
+
callback: BodyResponseCallback<Schema$Operation>
|
|
9975
|
+
): void;
|
|
9976
|
+
patch(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
9977
|
+
patch(
|
|
9978
|
+
paramsOrCallback?:
|
|
9979
|
+
| Params$Resource$Projects$Locations$Endpoints$Patch
|
|
9980
|
+
| BodyResponseCallback<Schema$Operation>
|
|
9981
|
+
| BodyResponseCallback<Readable>,
|
|
9982
|
+
optionsOrCallback?:
|
|
9983
|
+
| MethodOptions
|
|
9984
|
+
| StreamMethodOptions
|
|
9985
|
+
| BodyResponseCallback<Schema$Operation>
|
|
9986
|
+
| BodyResponseCallback<Readable>,
|
|
9987
|
+
callback?:
|
|
9988
|
+
| BodyResponseCallback<Schema$Operation>
|
|
9989
|
+
| BodyResponseCallback<Readable>
|
|
9990
|
+
):
|
|
9991
|
+
| void
|
|
9992
|
+
| Promise<GaxiosResponseWithHTTP2<Schema$Operation>>
|
|
9993
|
+
| Promise<GaxiosResponseWithHTTP2<Readable>> {
|
|
9994
|
+
let params = (paramsOrCallback ||
|
|
9995
|
+
{}) as Params$Resource$Projects$Locations$Endpoints$Patch;
|
|
9996
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
9997
|
+
|
|
9998
|
+
if (typeof paramsOrCallback === 'function') {
|
|
9999
|
+
callback = paramsOrCallback;
|
|
10000
|
+
params = {} as Params$Resource$Projects$Locations$Endpoints$Patch;
|
|
10001
|
+
options = {};
|
|
10002
|
+
}
|
|
10003
|
+
|
|
10004
|
+
if (typeof optionsOrCallback === 'function') {
|
|
10005
|
+
callback = optionsOrCallback;
|
|
10006
|
+
options = {};
|
|
10007
|
+
}
|
|
10008
|
+
|
|
10009
|
+
const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/';
|
|
10010
|
+
const parameters = {
|
|
10011
|
+
options: Object.assign(
|
|
10012
|
+
{
|
|
10013
|
+
url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
10014
|
+
method: 'PATCH',
|
|
10015
|
+
apiVersion: '',
|
|
10016
|
+
},
|
|
10017
|
+
options
|
|
10018
|
+
),
|
|
10019
|
+
params,
|
|
10020
|
+
requiredParams: ['name'],
|
|
10021
|
+
pathParams: ['name'],
|
|
10022
|
+
context: this.context,
|
|
10023
|
+
};
|
|
10024
|
+
if (callback) {
|
|
10025
|
+
createAPIRequest<Schema$Operation>(
|
|
10026
|
+
parameters,
|
|
10027
|
+
callback as BodyResponseCallback<unknown>
|
|
10028
|
+
);
|
|
10029
|
+
} else {
|
|
10030
|
+
return createAPIRequest<Schema$Operation>(parameters);
|
|
10031
|
+
}
|
|
10032
|
+
}
|
|
10033
|
+
}
|
|
10034
|
+
|
|
10035
|
+
export interface Params$Resource$Projects$Locations$Endpoints$Create extends StandardParameters {
|
|
10036
|
+
/**
|
|
10037
|
+
* Required. ID of the requesting object.
|
|
10038
|
+
*/
|
|
10039
|
+
endpointId?: string;
|
|
10040
|
+
/**
|
|
10041
|
+
* Required. The location of the new endpoint. For the required format, see the comment on the Endpoint.name field.
|
|
10042
|
+
*/
|
|
10043
|
+
parent?: string;
|
|
10044
|
+
/**
|
|
10045
|
+
* 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).
|
|
10046
|
+
*/
|
|
10047
|
+
requestId?: string;
|
|
10048
|
+
/**
|
|
10049
|
+
* Optional. If set, the backend validates the request, but doesn't actually execute it.
|
|
10050
|
+
*/
|
|
10051
|
+
validateOnly?: boolean;
|
|
10052
|
+
|
|
10053
|
+
/**
|
|
10054
|
+
* Request body metadata
|
|
10055
|
+
*/
|
|
10056
|
+
requestBody?: Schema$Endpoint;
|
|
10057
|
+
}
|
|
10058
|
+
export interface Params$Resource$Projects$Locations$Endpoints$Delete extends StandardParameters {
|
|
10059
|
+
/**
|
|
10060
|
+
* 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.
|
|
10061
|
+
*/
|
|
10062
|
+
etag?: string;
|
|
10063
|
+
/**
|
|
10064
|
+
* Required. The name of the resource. For the required format, see the comment on the Endpoint.name field.
|
|
10065
|
+
*/
|
|
10066
|
+
name?: string;
|
|
10067
|
+
/**
|
|
10068
|
+
* 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).
|
|
10069
|
+
*/
|
|
10070
|
+
requestId?: string;
|
|
10071
|
+
/**
|
|
10072
|
+
* Optional. If set, the backend validates the request, but doesn't actually execute it.
|
|
10073
|
+
*/
|
|
10074
|
+
validateOnly?: boolean;
|
|
10075
|
+
}
|
|
10076
|
+
export interface Params$Resource$Projects$Locations$Endpoints$Get extends StandardParameters {
|
|
10077
|
+
/**
|
|
10078
|
+
* Required. The name of the resource. For the required format, see the comment on the Endpoint.name field.
|
|
10079
|
+
*/
|
|
10080
|
+
name?: string;
|
|
10081
|
+
}
|
|
10082
|
+
export interface Params$Resource$Projects$Locations$Endpoints$List extends StandardParameters {
|
|
10083
|
+
/**
|
|
10084
|
+
* Optional. Filtering results. This field is currently not supported, its value will be ignored if passed.
|
|
10085
|
+
*/
|
|
10086
|
+
filter?: string;
|
|
10087
|
+
/**
|
|
10088
|
+
* Optional. Hint for how to order the results
|
|
10089
|
+
*/
|
|
10090
|
+
orderBy?: string;
|
|
10091
|
+
/**
|
|
10092
|
+
* Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
|
|
10093
|
+
*/
|
|
10094
|
+
pageSize?: number;
|
|
10095
|
+
/**
|
|
10096
|
+
* 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.
|
|
10097
|
+
*/
|
|
10098
|
+
pageToken?: string;
|
|
10099
|
+
/**
|
|
10100
|
+
* 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/-
|
|
10101
|
+
*/
|
|
10102
|
+
parent?: string;
|
|
10103
|
+
}
|
|
10104
|
+
export interface Params$Resource$Projects$Locations$Endpoints$Patch extends StandardParameters {
|
|
10105
|
+
/**
|
|
10106
|
+
* 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.
|
|
10107
|
+
*/
|
|
10108
|
+
allowMissing?: boolean;
|
|
10109
|
+
/**
|
|
10110
|
+
* 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\}
|
|
10111
|
+
*/
|
|
10112
|
+
name?: string;
|
|
10113
|
+
/**
|
|
10114
|
+
* 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).
|
|
10115
|
+
*/
|
|
10116
|
+
requestId?: string;
|
|
10117
|
+
/**
|
|
10118
|
+
* 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.
|
|
10119
|
+
*/
|
|
10120
|
+
updateMask?: string;
|
|
10121
|
+
/**
|
|
10122
|
+
* Optional. If set, the backend validates the request, but doesn't actually execute it.
|
|
10123
|
+
*/
|
|
10124
|
+
validateOnly?: boolean;
|
|
10125
|
+
|
|
10126
|
+
/**
|
|
10127
|
+
* Request body metadata
|
|
10128
|
+
*/
|
|
10129
|
+
requestBody?: Schema$Endpoint;
|
|
10130
|
+
}
|
|
10131
|
+
|
|
9104
10132
|
export class Resource$Projects$Locations$Operations {
|
|
9105
10133
|
context: APIRequestContext;
|
|
9106
10134
|
constructor(context: APIRequestContext) {
|