@googleapis/alloydb 13.0.1 → 14.0.1
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 +24 -0
- package/build/v1.d.ts +2630 -5
- package/build/v1.js.map +1 -1
- package/build/v1alpha.d.ts +2685 -15
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +2673 -16
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1.ts +2630 -5
- package/v1alpha.ts +2685 -15
- package/v1beta.ts +2673 -16
package/v1.ts
CHANGED
|
@@ -541,7 +541,7 @@ export namespace alloydb_v1 {
|
|
|
541
541
|
*/
|
|
542
542
|
export interface Schema$ContinuousBackupInfo {
|
|
543
543
|
/**
|
|
544
|
-
* Output only. The earliest restorable time that can be restored to.
|
|
544
|
+
* Output only. The earliest restorable time that can be restored to. If continuous backups and recovery was recently enabled, the earliest restorable time is the creation time of the earliest eligible backup within this cluster's continuous backup recovery window. After a cluster has had continuous backups enabled for the duration of its recovery window, the earliest restorable time becomes "now minus the recovery window". For example, assuming a point in time recovery is attempted at 04/16/2025 3:23:00PM with a 14d recovery window, the earliest restorable time would be 04/02/2025 3:23:00PM. This field is only visible if the CLUSTER_VIEW_CONTINUOUS_BACKUP cluster view is provided.
|
|
545
545
|
*/
|
|
546
546
|
earliestRestorableTime?: string | null;
|
|
547
547
|
/**
|
|
@@ -553,7 +553,7 @@ export namespace alloydb_v1 {
|
|
|
553
553
|
*/
|
|
554
554
|
encryptionInfo?: Schema$EncryptionInfo;
|
|
555
555
|
/**
|
|
556
|
-
* Output only. Days of the week on which a continuous backup is taken.
|
|
556
|
+
* Output only. Days of the week on which a continuous backup is taken.
|
|
557
557
|
*/
|
|
558
558
|
schedule?: string[] | null;
|
|
559
559
|
}
|
|
@@ -963,6 +963,10 @@ export namespace alloydb_v1 {
|
|
|
963
963
|
* Metadata related to instance-level network configuration.
|
|
964
964
|
*/
|
|
965
965
|
export interface Schema$InstanceNetworkConfig {
|
|
966
|
+
/**
|
|
967
|
+
* Optional. Name of the allocated IP range for the private IP AlloyDB instance, for example: "google-managed-services-default". If set, the instance IPs will be created from this allocated range and will override the IP range used by the parent cluster. The range name must comply with [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.
|
|
968
|
+
*/
|
|
969
|
+
allocatedIpRangeOverride?: string | null;
|
|
966
970
|
/**
|
|
967
971
|
* Optional. A list of external network authorized to access this instance.
|
|
968
972
|
*/
|
|
@@ -981,7 +985,7 @@ export namespace alloydb_v1 {
|
|
|
981
985
|
network?: string | null;
|
|
982
986
|
}
|
|
983
987
|
/**
|
|
984
|
-
* Details regarding the upgrade of
|
|
988
|
+
* Details regarding the upgrade of instances associated with a cluster.
|
|
985
989
|
*/
|
|
986
990
|
export interface Schema$InstanceUpgradeDetails {
|
|
987
991
|
/**
|
|
@@ -1720,7 +1724,7 @@ export namespace alloydb_v1 {
|
|
|
1720
1724
|
internalResourceMetadata?: Schema$StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata[];
|
|
1721
1725
|
}
|
|
1722
1726
|
/**
|
|
1723
|
-
* DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform.
|
|
1727
|
+
* DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 8
|
|
1724
1728
|
*/
|
|
1725
1729
|
export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed {
|
|
1726
1730
|
/**
|
|
@@ -1764,6 +1768,10 @@ export namespace alloydb_v1 {
|
|
|
1764
1768
|
* The external-uri of the signal, using which more information about this signal can be obtained. In GCP, this will take user to SCC page to get more details about signals.
|
|
1765
1769
|
*/
|
|
1766
1770
|
externalUri?: string | null;
|
|
1771
|
+
/**
|
|
1772
|
+
* This is used to identify the location of the resource. Example: "us-central1"
|
|
1773
|
+
*/
|
|
1774
|
+
location?: string | null;
|
|
1767
1775
|
/**
|
|
1768
1776
|
* Required. The name of the signal, ex: PUBLIC_SQL_INSTANCE, SQL_LOG_ERROR_VERBOSITY etc.
|
|
1769
1777
|
*/
|
|
@@ -1811,7 +1819,7 @@ export namespace alloydb_v1 {
|
|
|
1811
1819
|
*/
|
|
1812
1820
|
providerDescription?: string | null;
|
|
1813
1821
|
/**
|
|
1814
|
-
* Required. The type of resource this ID is identifying. Ex
|
|
1822
|
+
* Required. The type of resource this ID is identifying. Ex go/keep-sorted start alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance compute.googleapis.com/Instance firestore.googleapis.com/Database, redis.googleapis.com/Instance, redis.googleapis.com/Cluster, oracledatabase.googleapis.com/CloudExadataInfrastructure oracledatabase.googleapis.com/CloudVmCluster oracledatabase.googleapis.com/AutonomousDatabase spanner.googleapis.com/Instance, spanner.googleapis.com/Database, sqladmin.googleapis.com/Instance, go/keep-sorted end REQUIRED Please refer go/condor-common-datamodel
|
|
1815
1823
|
*/
|
|
1816
1824
|
resourceType?: string | null;
|
|
1817
1825
|
/**
|
|
@@ -2365,6 +2373,56 @@ export namespace alloydb_v1 {
|
|
|
2365
2373
|
|
|
2366
2374
|
/**
|
|
2367
2375
|
* Gets information about a location.
|
|
2376
|
+
* @example
|
|
2377
|
+
* ```js
|
|
2378
|
+
* // Before running the sample:
|
|
2379
|
+
* // - Enable the API at:
|
|
2380
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
2381
|
+
* // - Login into gcloud by running:
|
|
2382
|
+
* // ```sh
|
|
2383
|
+
* // $ gcloud auth application-default login
|
|
2384
|
+
* // ```
|
|
2385
|
+
* // - Install the npm module by running:
|
|
2386
|
+
* // ```sh
|
|
2387
|
+
* // $ npm install googleapis
|
|
2388
|
+
* // ```
|
|
2389
|
+
*
|
|
2390
|
+
* const {google} = require('googleapis');
|
|
2391
|
+
* const alloydb = google.alloydb('v1');
|
|
2392
|
+
*
|
|
2393
|
+
* async function main() {
|
|
2394
|
+
* const auth = new google.auth.GoogleAuth({
|
|
2395
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2396
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
2397
|
+
* });
|
|
2398
|
+
*
|
|
2399
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
2400
|
+
* const authClient = await auth.getClient();
|
|
2401
|
+
* google.options({auth: authClient});
|
|
2402
|
+
*
|
|
2403
|
+
* // Do the magic
|
|
2404
|
+
* const res = await alloydb.projects.locations.get({
|
|
2405
|
+
* // Resource name for the location.
|
|
2406
|
+
* name: 'projects/my-project/locations/my-location',
|
|
2407
|
+
* });
|
|
2408
|
+
* console.log(res.data);
|
|
2409
|
+
*
|
|
2410
|
+
* // Example response
|
|
2411
|
+
* // {
|
|
2412
|
+
* // "displayName": "my_displayName",
|
|
2413
|
+
* // "labels": {},
|
|
2414
|
+
* // "locationId": "my_locationId",
|
|
2415
|
+
* // "metadata": {},
|
|
2416
|
+
* // "name": "my_name"
|
|
2417
|
+
* // }
|
|
2418
|
+
* }
|
|
2419
|
+
*
|
|
2420
|
+
* main().catch(e => {
|
|
2421
|
+
* console.error(e);
|
|
2422
|
+
* throw e;
|
|
2423
|
+
* });
|
|
2424
|
+
*
|
|
2425
|
+
* ```
|
|
2368
2426
|
*
|
|
2369
2427
|
* @param params - Parameters for request
|
|
2370
2428
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -2457,6 +2515,61 @@ export namespace alloydb_v1 {
|
|
|
2457
2515
|
|
|
2458
2516
|
/**
|
|
2459
2517
|
* Lists information about the supported locations for this service.
|
|
2518
|
+
* @example
|
|
2519
|
+
* ```js
|
|
2520
|
+
* // Before running the sample:
|
|
2521
|
+
* // - Enable the API at:
|
|
2522
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
2523
|
+
* // - Login into gcloud by running:
|
|
2524
|
+
* // ```sh
|
|
2525
|
+
* // $ gcloud auth application-default login
|
|
2526
|
+
* // ```
|
|
2527
|
+
* // - Install the npm module by running:
|
|
2528
|
+
* // ```sh
|
|
2529
|
+
* // $ npm install googleapis
|
|
2530
|
+
* // ```
|
|
2531
|
+
*
|
|
2532
|
+
* const {google} = require('googleapis');
|
|
2533
|
+
* const alloydb = google.alloydb('v1');
|
|
2534
|
+
*
|
|
2535
|
+
* async function main() {
|
|
2536
|
+
* const auth = new google.auth.GoogleAuth({
|
|
2537
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2538
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
2539
|
+
* });
|
|
2540
|
+
*
|
|
2541
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
2542
|
+
* const authClient = await auth.getClient();
|
|
2543
|
+
* google.options({auth: authClient});
|
|
2544
|
+
*
|
|
2545
|
+
* // Do the magic
|
|
2546
|
+
* const res = await alloydb.projects.locations.list({
|
|
2547
|
+
* // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.
|
|
2548
|
+
* extraLocationTypes: 'placeholder-value',
|
|
2549
|
+
* // 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).
|
|
2550
|
+
* filter: 'placeholder-value',
|
|
2551
|
+
* // The resource that owns the locations collection, if applicable.
|
|
2552
|
+
* name: 'projects/my-project',
|
|
2553
|
+
* // The maximum number of results to return. If not set, the service selects a default.
|
|
2554
|
+
* pageSize: 'placeholder-value',
|
|
2555
|
+
* // A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
|
|
2556
|
+
* pageToken: 'placeholder-value',
|
|
2557
|
+
* });
|
|
2558
|
+
* console.log(res.data);
|
|
2559
|
+
*
|
|
2560
|
+
* // Example response
|
|
2561
|
+
* // {
|
|
2562
|
+
* // "locations": [],
|
|
2563
|
+
* // "nextPageToken": "my_nextPageToken"
|
|
2564
|
+
* // }
|
|
2565
|
+
* }
|
|
2566
|
+
*
|
|
2567
|
+
* main().catch(e => {
|
|
2568
|
+
* console.error(e);
|
|
2569
|
+
* throw e;
|
|
2570
|
+
* });
|
|
2571
|
+
*
|
|
2572
|
+
* ```
|
|
2460
2573
|
*
|
|
2461
2574
|
* @param params - Parameters for request
|
|
2462
2575
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -2596,6 +2709,93 @@ export namespace alloydb_v1 {
|
|
|
2596
2709
|
|
|
2597
2710
|
/**
|
|
2598
2711
|
* Creates a new Backup in a given project and location.
|
|
2712
|
+
* @example
|
|
2713
|
+
* ```js
|
|
2714
|
+
* // Before running the sample:
|
|
2715
|
+
* // - Enable the API at:
|
|
2716
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
2717
|
+
* // - Login into gcloud by running:
|
|
2718
|
+
* // ```sh
|
|
2719
|
+
* // $ gcloud auth application-default login
|
|
2720
|
+
* // ```
|
|
2721
|
+
* // - Install the npm module by running:
|
|
2722
|
+
* // ```sh
|
|
2723
|
+
* // $ npm install googleapis
|
|
2724
|
+
* // ```
|
|
2725
|
+
*
|
|
2726
|
+
* const {google} = require('googleapis');
|
|
2727
|
+
* const alloydb = google.alloydb('v1');
|
|
2728
|
+
*
|
|
2729
|
+
* async function main() {
|
|
2730
|
+
* const auth = new google.auth.GoogleAuth({
|
|
2731
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2732
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
2733
|
+
* });
|
|
2734
|
+
*
|
|
2735
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
2736
|
+
* const authClient = await auth.getClient();
|
|
2737
|
+
* google.options({auth: authClient});
|
|
2738
|
+
*
|
|
2739
|
+
* // Do the magic
|
|
2740
|
+
* const res = await alloydb.projects.locations.backups.create({
|
|
2741
|
+
* // Required. ID of the requesting object.
|
|
2742
|
+
* backupId: 'placeholder-value',
|
|
2743
|
+
* // Required. Value for parent.
|
|
2744
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
2745
|
+
* // 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).
|
|
2746
|
+
* requestId: 'placeholder-value',
|
|
2747
|
+
* // Optional. If set, the backend validates the request, but doesn't actually execute it.
|
|
2748
|
+
* validateOnly: 'placeholder-value',
|
|
2749
|
+
*
|
|
2750
|
+
* // Request body metadata
|
|
2751
|
+
* requestBody: {
|
|
2752
|
+
* // request body parameters
|
|
2753
|
+
* // {
|
|
2754
|
+
* // "annotations": {},
|
|
2755
|
+
* // "clusterName": "my_clusterName",
|
|
2756
|
+
* // "clusterUid": "my_clusterUid",
|
|
2757
|
+
* // "createCompletionTime": "my_createCompletionTime",
|
|
2758
|
+
* // "createTime": "my_createTime",
|
|
2759
|
+
* // "databaseVersion": "my_databaseVersion",
|
|
2760
|
+
* // "deleteTime": "my_deleteTime",
|
|
2761
|
+
* // "description": "my_description",
|
|
2762
|
+
* // "displayName": "my_displayName",
|
|
2763
|
+
* // "encryptionConfig": {},
|
|
2764
|
+
* // "encryptionInfo": {},
|
|
2765
|
+
* // "etag": "my_etag",
|
|
2766
|
+
* // "expiryQuantity": {},
|
|
2767
|
+
* // "expiryTime": "my_expiryTime",
|
|
2768
|
+
* // "labels": {},
|
|
2769
|
+
* // "name": "my_name",
|
|
2770
|
+
* // "reconciling": false,
|
|
2771
|
+
* // "satisfiesPzs": false,
|
|
2772
|
+
* // "sizeBytes": "my_sizeBytes",
|
|
2773
|
+
* // "state": "my_state",
|
|
2774
|
+
* // "tags": {},
|
|
2775
|
+
* // "type": "my_type",
|
|
2776
|
+
* // "uid": "my_uid",
|
|
2777
|
+
* // "updateTime": "my_updateTime"
|
|
2778
|
+
* // }
|
|
2779
|
+
* },
|
|
2780
|
+
* });
|
|
2781
|
+
* console.log(res.data);
|
|
2782
|
+
*
|
|
2783
|
+
* // Example response
|
|
2784
|
+
* // {
|
|
2785
|
+
* // "done": false,
|
|
2786
|
+
* // "error": {},
|
|
2787
|
+
* // "metadata": {},
|
|
2788
|
+
* // "name": "my_name",
|
|
2789
|
+
* // "response": {}
|
|
2790
|
+
* // }
|
|
2791
|
+
* }
|
|
2792
|
+
*
|
|
2793
|
+
* main().catch(e => {
|
|
2794
|
+
* console.error(e);
|
|
2795
|
+
* throw e;
|
|
2796
|
+
* });
|
|
2797
|
+
*
|
|
2798
|
+
* ```
|
|
2599
2799
|
*
|
|
2600
2800
|
* @param params - Parameters for request
|
|
2601
2801
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -2687,6 +2887,62 @@ export namespace alloydb_v1 {
|
|
|
2687
2887
|
|
|
2688
2888
|
/**
|
|
2689
2889
|
* Deletes a single Backup.
|
|
2890
|
+
* @example
|
|
2891
|
+
* ```js
|
|
2892
|
+
* // Before running the sample:
|
|
2893
|
+
* // - Enable the API at:
|
|
2894
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
2895
|
+
* // - Login into gcloud by running:
|
|
2896
|
+
* // ```sh
|
|
2897
|
+
* // $ gcloud auth application-default login
|
|
2898
|
+
* // ```
|
|
2899
|
+
* // - Install the npm module by running:
|
|
2900
|
+
* // ```sh
|
|
2901
|
+
* // $ npm install googleapis
|
|
2902
|
+
* // ```
|
|
2903
|
+
*
|
|
2904
|
+
* const {google} = require('googleapis');
|
|
2905
|
+
* const alloydb = google.alloydb('v1');
|
|
2906
|
+
*
|
|
2907
|
+
* async function main() {
|
|
2908
|
+
* const auth = new google.auth.GoogleAuth({
|
|
2909
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2910
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
2911
|
+
* });
|
|
2912
|
+
*
|
|
2913
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
2914
|
+
* const authClient = await auth.getClient();
|
|
2915
|
+
* google.options({auth: authClient});
|
|
2916
|
+
*
|
|
2917
|
+
* // Do the magic
|
|
2918
|
+
* const res = await alloydb.projects.locations.backups.delete({
|
|
2919
|
+
* // Optional. The current etag of the Backup. If an etag is provided and does not match the current etag of the Backup, deletion will be blocked and an ABORTED error will be returned.
|
|
2920
|
+
* etag: 'placeholder-value',
|
|
2921
|
+
* // Required. Name of the resource. For the required format, see the comment on the Backup.name field.
|
|
2922
|
+
* name: 'projects/my-project/locations/my-location/backups/my-backup',
|
|
2923
|
+
* // 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).
|
|
2924
|
+
* requestId: 'placeholder-value',
|
|
2925
|
+
* // Optional. If set, the backend validates the request, but doesn't actually execute it.
|
|
2926
|
+
* validateOnly: 'placeholder-value',
|
|
2927
|
+
* });
|
|
2928
|
+
* console.log(res.data);
|
|
2929
|
+
*
|
|
2930
|
+
* // Example response
|
|
2931
|
+
* // {
|
|
2932
|
+
* // "done": false,
|
|
2933
|
+
* // "error": {},
|
|
2934
|
+
* // "metadata": {},
|
|
2935
|
+
* // "name": "my_name",
|
|
2936
|
+
* // "response": {}
|
|
2937
|
+
* // }
|
|
2938
|
+
* }
|
|
2939
|
+
*
|
|
2940
|
+
* main().catch(e => {
|
|
2941
|
+
* console.error(e);
|
|
2942
|
+
* throw e;
|
|
2943
|
+
* });
|
|
2944
|
+
*
|
|
2945
|
+
* ```
|
|
2690
2946
|
*
|
|
2691
2947
|
* @param params - Parameters for request
|
|
2692
2948
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -2775,6 +3031,75 @@ export namespace alloydb_v1 {
|
|
|
2775
3031
|
|
|
2776
3032
|
/**
|
|
2777
3033
|
* Gets details of a single Backup.
|
|
3034
|
+
* @example
|
|
3035
|
+
* ```js
|
|
3036
|
+
* // Before running the sample:
|
|
3037
|
+
* // - Enable the API at:
|
|
3038
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
3039
|
+
* // - Login into gcloud by running:
|
|
3040
|
+
* // ```sh
|
|
3041
|
+
* // $ gcloud auth application-default login
|
|
3042
|
+
* // ```
|
|
3043
|
+
* // - Install the npm module by running:
|
|
3044
|
+
* // ```sh
|
|
3045
|
+
* // $ npm install googleapis
|
|
3046
|
+
* // ```
|
|
3047
|
+
*
|
|
3048
|
+
* const {google} = require('googleapis');
|
|
3049
|
+
* const alloydb = google.alloydb('v1');
|
|
3050
|
+
*
|
|
3051
|
+
* async function main() {
|
|
3052
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3053
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3054
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
3055
|
+
* });
|
|
3056
|
+
*
|
|
3057
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3058
|
+
* const authClient = await auth.getClient();
|
|
3059
|
+
* google.options({auth: authClient});
|
|
3060
|
+
*
|
|
3061
|
+
* // Do the magic
|
|
3062
|
+
* const res = await alloydb.projects.locations.backups.get({
|
|
3063
|
+
* // Required. Name of the resource
|
|
3064
|
+
* name: 'projects/my-project/locations/my-location/backups/my-backup',
|
|
3065
|
+
* });
|
|
3066
|
+
* console.log(res.data);
|
|
3067
|
+
*
|
|
3068
|
+
* // Example response
|
|
3069
|
+
* // {
|
|
3070
|
+
* // "annotations": {},
|
|
3071
|
+
* // "clusterName": "my_clusterName",
|
|
3072
|
+
* // "clusterUid": "my_clusterUid",
|
|
3073
|
+
* // "createCompletionTime": "my_createCompletionTime",
|
|
3074
|
+
* // "createTime": "my_createTime",
|
|
3075
|
+
* // "databaseVersion": "my_databaseVersion",
|
|
3076
|
+
* // "deleteTime": "my_deleteTime",
|
|
3077
|
+
* // "description": "my_description",
|
|
3078
|
+
* // "displayName": "my_displayName",
|
|
3079
|
+
* // "encryptionConfig": {},
|
|
3080
|
+
* // "encryptionInfo": {},
|
|
3081
|
+
* // "etag": "my_etag",
|
|
3082
|
+
* // "expiryQuantity": {},
|
|
3083
|
+
* // "expiryTime": "my_expiryTime",
|
|
3084
|
+
* // "labels": {},
|
|
3085
|
+
* // "name": "my_name",
|
|
3086
|
+
* // "reconciling": false,
|
|
3087
|
+
* // "satisfiesPzs": false,
|
|
3088
|
+
* // "sizeBytes": "my_sizeBytes",
|
|
3089
|
+
* // "state": "my_state",
|
|
3090
|
+
* // "tags": {},
|
|
3091
|
+
* // "type": "my_type",
|
|
3092
|
+
* // "uid": "my_uid",
|
|
3093
|
+
* // "updateTime": "my_updateTime"
|
|
3094
|
+
* // }
|
|
3095
|
+
* }
|
|
3096
|
+
*
|
|
3097
|
+
* main().catch(e => {
|
|
3098
|
+
* console.error(e);
|
|
3099
|
+
* throw e;
|
|
3100
|
+
* });
|
|
3101
|
+
*
|
|
3102
|
+
* ```
|
|
2778
3103
|
*
|
|
2779
3104
|
* @param params - Parameters for request
|
|
2780
3105
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -2863,6 +3188,62 @@ export namespace alloydb_v1 {
|
|
|
2863
3188
|
|
|
2864
3189
|
/**
|
|
2865
3190
|
* Lists Backups in a given project and location.
|
|
3191
|
+
* @example
|
|
3192
|
+
* ```js
|
|
3193
|
+
* // Before running the sample:
|
|
3194
|
+
* // - Enable the API at:
|
|
3195
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
3196
|
+
* // - Login into gcloud by running:
|
|
3197
|
+
* // ```sh
|
|
3198
|
+
* // $ gcloud auth application-default login
|
|
3199
|
+
* // ```
|
|
3200
|
+
* // - Install the npm module by running:
|
|
3201
|
+
* // ```sh
|
|
3202
|
+
* // $ npm install googleapis
|
|
3203
|
+
* // ```
|
|
3204
|
+
*
|
|
3205
|
+
* const {google} = require('googleapis');
|
|
3206
|
+
* const alloydb = google.alloydb('v1');
|
|
3207
|
+
*
|
|
3208
|
+
* async function main() {
|
|
3209
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3210
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3211
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
3212
|
+
* });
|
|
3213
|
+
*
|
|
3214
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3215
|
+
* const authClient = await auth.getClient();
|
|
3216
|
+
* google.options({auth: authClient});
|
|
3217
|
+
*
|
|
3218
|
+
* // Do the magic
|
|
3219
|
+
* const res = await alloydb.projects.locations.backups.list({
|
|
3220
|
+
* // Filtering results
|
|
3221
|
+
* filter: 'placeholder-value',
|
|
3222
|
+
* // Hint for how to order the results
|
|
3223
|
+
* orderBy: 'placeholder-value',
|
|
3224
|
+
* // Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
|
|
3225
|
+
* pageSize: 'placeholder-value',
|
|
3226
|
+
* // A token identifying a page of results the server should return.
|
|
3227
|
+
* pageToken: 'placeholder-value',
|
|
3228
|
+
* // Required. Parent value for ListBackupsRequest
|
|
3229
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
3230
|
+
* });
|
|
3231
|
+
* console.log(res.data);
|
|
3232
|
+
*
|
|
3233
|
+
* // Example response
|
|
3234
|
+
* // {
|
|
3235
|
+
* // "backups": [],
|
|
3236
|
+
* // "nextPageToken": "my_nextPageToken",
|
|
3237
|
+
* // "unreachable": []
|
|
3238
|
+
* // }
|
|
3239
|
+
* }
|
|
3240
|
+
*
|
|
3241
|
+
* main().catch(e => {
|
|
3242
|
+
* console.error(e);
|
|
3243
|
+
* throw e;
|
|
3244
|
+
* });
|
|
3245
|
+
*
|
|
3246
|
+
* ```
|
|
2866
3247
|
*
|
|
2867
3248
|
* @param params - Parameters for request
|
|
2868
3249
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -2954,6 +3335,95 @@ export namespace alloydb_v1 {
|
|
|
2954
3335
|
|
|
2955
3336
|
/**
|
|
2956
3337
|
* Updates the parameters of a single Backup.
|
|
3338
|
+
* @example
|
|
3339
|
+
* ```js
|
|
3340
|
+
* // Before running the sample:
|
|
3341
|
+
* // - Enable the API at:
|
|
3342
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
3343
|
+
* // - Login into gcloud by running:
|
|
3344
|
+
* // ```sh
|
|
3345
|
+
* // $ gcloud auth application-default login
|
|
3346
|
+
* // ```
|
|
3347
|
+
* // - Install the npm module by running:
|
|
3348
|
+
* // ```sh
|
|
3349
|
+
* // $ npm install googleapis
|
|
3350
|
+
* // ```
|
|
3351
|
+
*
|
|
3352
|
+
* const {google} = require('googleapis');
|
|
3353
|
+
* const alloydb = google.alloydb('v1');
|
|
3354
|
+
*
|
|
3355
|
+
* async function main() {
|
|
3356
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3357
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3358
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
3359
|
+
* });
|
|
3360
|
+
*
|
|
3361
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3362
|
+
* const authClient = await auth.getClient();
|
|
3363
|
+
* google.options({auth: authClient});
|
|
3364
|
+
*
|
|
3365
|
+
* // Do the magic
|
|
3366
|
+
* const res = await alloydb.projects.locations.backups.patch({
|
|
3367
|
+
* // Optional. If set to true, update succeeds even if instance is not found. In that case, a new backup is created and `update_mask` is ignored.
|
|
3368
|
+
* allowMissing: 'placeholder-value',
|
|
3369
|
+
* // Output only. The name of the backup resource with the format: * projects/{project\}/locations/{region\}/backups/{backup_id\} where the cluster and backup ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61\}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource: * projects/{project\}/locations/{region\}
|
|
3370
|
+
* name: 'projects/my-project/locations/my-location/backups/my-backup',
|
|
3371
|
+
* // 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).
|
|
3372
|
+
* requestId: 'placeholder-value',
|
|
3373
|
+
* // Optional. Field mask is used to specify the fields to be overwritten in the Backup 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.
|
|
3374
|
+
* updateMask: 'placeholder-value',
|
|
3375
|
+
* // Optional. If set, the backend validates the request, but doesn't actually execute it.
|
|
3376
|
+
* validateOnly: 'placeholder-value',
|
|
3377
|
+
*
|
|
3378
|
+
* // Request body metadata
|
|
3379
|
+
* requestBody: {
|
|
3380
|
+
* // request body parameters
|
|
3381
|
+
* // {
|
|
3382
|
+
* // "annotations": {},
|
|
3383
|
+
* // "clusterName": "my_clusterName",
|
|
3384
|
+
* // "clusterUid": "my_clusterUid",
|
|
3385
|
+
* // "createCompletionTime": "my_createCompletionTime",
|
|
3386
|
+
* // "createTime": "my_createTime",
|
|
3387
|
+
* // "databaseVersion": "my_databaseVersion",
|
|
3388
|
+
* // "deleteTime": "my_deleteTime",
|
|
3389
|
+
* // "description": "my_description",
|
|
3390
|
+
* // "displayName": "my_displayName",
|
|
3391
|
+
* // "encryptionConfig": {},
|
|
3392
|
+
* // "encryptionInfo": {},
|
|
3393
|
+
* // "etag": "my_etag",
|
|
3394
|
+
* // "expiryQuantity": {},
|
|
3395
|
+
* // "expiryTime": "my_expiryTime",
|
|
3396
|
+
* // "labels": {},
|
|
3397
|
+
* // "name": "my_name",
|
|
3398
|
+
* // "reconciling": false,
|
|
3399
|
+
* // "satisfiesPzs": false,
|
|
3400
|
+
* // "sizeBytes": "my_sizeBytes",
|
|
3401
|
+
* // "state": "my_state",
|
|
3402
|
+
* // "tags": {},
|
|
3403
|
+
* // "type": "my_type",
|
|
3404
|
+
* // "uid": "my_uid",
|
|
3405
|
+
* // "updateTime": "my_updateTime"
|
|
3406
|
+
* // }
|
|
3407
|
+
* },
|
|
3408
|
+
* });
|
|
3409
|
+
* console.log(res.data);
|
|
3410
|
+
*
|
|
3411
|
+
* // Example response
|
|
3412
|
+
* // {
|
|
3413
|
+
* // "done": false,
|
|
3414
|
+
* // "error": {},
|
|
3415
|
+
* // "metadata": {},
|
|
3416
|
+
* // "name": "my_name",
|
|
3417
|
+
* // "response": {}
|
|
3418
|
+
* // }
|
|
3419
|
+
* }
|
|
3420
|
+
*
|
|
3421
|
+
* main().catch(e => {
|
|
3422
|
+
* console.error(e);
|
|
3423
|
+
* throw e;
|
|
3424
|
+
* });
|
|
3425
|
+
*
|
|
3426
|
+
* ```
|
|
2957
3427
|
*
|
|
2958
3428
|
* @param params - Parameters for request
|
|
2959
3429
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -3157,6 +3627,103 @@ export namespace alloydb_v1 {
|
|
|
3157
3627
|
|
|
3158
3628
|
/**
|
|
3159
3629
|
* Creates a new Cluster in a given project and location.
|
|
3630
|
+
* @example
|
|
3631
|
+
* ```js
|
|
3632
|
+
* // Before running the sample:
|
|
3633
|
+
* // - Enable the API at:
|
|
3634
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
3635
|
+
* // - Login into gcloud by running:
|
|
3636
|
+
* // ```sh
|
|
3637
|
+
* // $ gcloud auth application-default login
|
|
3638
|
+
* // ```
|
|
3639
|
+
* // - Install the npm module by running:
|
|
3640
|
+
* // ```sh
|
|
3641
|
+
* // $ npm install googleapis
|
|
3642
|
+
* // ```
|
|
3643
|
+
*
|
|
3644
|
+
* const {google} = require('googleapis');
|
|
3645
|
+
* const alloydb = google.alloydb('v1');
|
|
3646
|
+
*
|
|
3647
|
+
* async function main() {
|
|
3648
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3649
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3650
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
3651
|
+
* });
|
|
3652
|
+
*
|
|
3653
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3654
|
+
* const authClient = await auth.getClient();
|
|
3655
|
+
* google.options({auth: authClient});
|
|
3656
|
+
*
|
|
3657
|
+
* // Do the magic
|
|
3658
|
+
* const res = await alloydb.projects.locations.clusters.create({
|
|
3659
|
+
* // Required. ID of the requesting object.
|
|
3660
|
+
* clusterId: 'placeholder-value',
|
|
3661
|
+
* // Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field.
|
|
3662
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
3663
|
+
* // 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).
|
|
3664
|
+
* requestId: 'placeholder-value',
|
|
3665
|
+
* // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
|
|
3666
|
+
* validateOnly: 'placeholder-value',
|
|
3667
|
+
*
|
|
3668
|
+
* // Request body metadata
|
|
3669
|
+
* requestBody: {
|
|
3670
|
+
* // request body parameters
|
|
3671
|
+
* // {
|
|
3672
|
+
* // "annotations": {},
|
|
3673
|
+
* // "automatedBackupPolicy": {},
|
|
3674
|
+
* // "backupSource": {},
|
|
3675
|
+
* // "cloudsqlBackupRunSource": {},
|
|
3676
|
+
* // "clusterType": "my_clusterType",
|
|
3677
|
+
* // "continuousBackupConfig": {},
|
|
3678
|
+
* // "continuousBackupInfo": {},
|
|
3679
|
+
* // "createTime": "my_createTime",
|
|
3680
|
+
* // "databaseVersion": "my_databaseVersion",
|
|
3681
|
+
* // "deleteTime": "my_deleteTime",
|
|
3682
|
+
* // "displayName": "my_displayName",
|
|
3683
|
+
* // "encryptionConfig": {},
|
|
3684
|
+
* // "encryptionInfo": {},
|
|
3685
|
+
* // "etag": "my_etag",
|
|
3686
|
+
* // "initialUser": {},
|
|
3687
|
+
* // "labels": {},
|
|
3688
|
+
* // "maintenanceSchedule": {},
|
|
3689
|
+
* // "maintenanceUpdatePolicy": {},
|
|
3690
|
+
* // "migrationSource": {},
|
|
3691
|
+
* // "name": "my_name",
|
|
3692
|
+
* // "network": "my_network",
|
|
3693
|
+
* // "networkConfig": {},
|
|
3694
|
+
* // "primaryConfig": {},
|
|
3695
|
+
* // "pscConfig": {},
|
|
3696
|
+
* // "reconciling": false,
|
|
3697
|
+
* // "satisfiesPzs": false,
|
|
3698
|
+
* // "secondaryConfig": {},
|
|
3699
|
+
* // "sslConfig": {},
|
|
3700
|
+
* // "state": "my_state",
|
|
3701
|
+
* // "subscriptionType": "my_subscriptionType",
|
|
3702
|
+
* // "tags": {},
|
|
3703
|
+
* // "trialMetadata": {},
|
|
3704
|
+
* // "uid": "my_uid",
|
|
3705
|
+
* // "updateTime": "my_updateTime"
|
|
3706
|
+
* // }
|
|
3707
|
+
* },
|
|
3708
|
+
* });
|
|
3709
|
+
* console.log(res.data);
|
|
3710
|
+
*
|
|
3711
|
+
* // Example response
|
|
3712
|
+
* // {
|
|
3713
|
+
* // "done": false,
|
|
3714
|
+
* // "error": {},
|
|
3715
|
+
* // "metadata": {},
|
|
3716
|
+
* // "name": "my_name",
|
|
3717
|
+
* // "response": {}
|
|
3718
|
+
* // }
|
|
3719
|
+
* }
|
|
3720
|
+
*
|
|
3721
|
+
* main().catch(e => {
|
|
3722
|
+
* console.error(e);
|
|
3723
|
+
* throw e;
|
|
3724
|
+
* });
|
|
3725
|
+
*
|
|
3726
|
+
* ```
|
|
3160
3727
|
*
|
|
3161
3728
|
* @param params - Parameters for request
|
|
3162
3729
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -3248,6 +3815,103 @@ export namespace alloydb_v1 {
|
|
|
3248
3815
|
|
|
3249
3816
|
/**
|
|
3250
3817
|
* Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.
|
|
3818
|
+
* @example
|
|
3819
|
+
* ```js
|
|
3820
|
+
* // Before running the sample:
|
|
3821
|
+
* // - Enable the API at:
|
|
3822
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
3823
|
+
* // - Login into gcloud by running:
|
|
3824
|
+
* // ```sh
|
|
3825
|
+
* // $ gcloud auth application-default login
|
|
3826
|
+
* // ```
|
|
3827
|
+
* // - Install the npm module by running:
|
|
3828
|
+
* // ```sh
|
|
3829
|
+
* // $ npm install googleapis
|
|
3830
|
+
* // ```
|
|
3831
|
+
*
|
|
3832
|
+
* const {google} = require('googleapis');
|
|
3833
|
+
* const alloydb = google.alloydb('v1');
|
|
3834
|
+
*
|
|
3835
|
+
* async function main() {
|
|
3836
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3837
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3838
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
3839
|
+
* });
|
|
3840
|
+
*
|
|
3841
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3842
|
+
* const authClient = await auth.getClient();
|
|
3843
|
+
* google.options({auth: authClient});
|
|
3844
|
+
*
|
|
3845
|
+
* // Do the magic
|
|
3846
|
+
* const res = await alloydb.projects.locations.clusters.createsecondary({
|
|
3847
|
+
* // Required. ID of the requesting object (the secondary cluster).
|
|
3848
|
+
* clusterId: 'placeholder-value',
|
|
3849
|
+
* // Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field.
|
|
3850
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
3851
|
+
* // 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).
|
|
3852
|
+
* requestId: 'placeholder-value',
|
|
3853
|
+
* // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
|
|
3854
|
+
* validateOnly: 'placeholder-value',
|
|
3855
|
+
*
|
|
3856
|
+
* // Request body metadata
|
|
3857
|
+
* requestBody: {
|
|
3858
|
+
* // request body parameters
|
|
3859
|
+
* // {
|
|
3860
|
+
* // "annotations": {},
|
|
3861
|
+
* // "automatedBackupPolicy": {},
|
|
3862
|
+
* // "backupSource": {},
|
|
3863
|
+
* // "cloudsqlBackupRunSource": {},
|
|
3864
|
+
* // "clusterType": "my_clusterType",
|
|
3865
|
+
* // "continuousBackupConfig": {},
|
|
3866
|
+
* // "continuousBackupInfo": {},
|
|
3867
|
+
* // "createTime": "my_createTime",
|
|
3868
|
+
* // "databaseVersion": "my_databaseVersion",
|
|
3869
|
+
* // "deleteTime": "my_deleteTime",
|
|
3870
|
+
* // "displayName": "my_displayName",
|
|
3871
|
+
* // "encryptionConfig": {},
|
|
3872
|
+
* // "encryptionInfo": {},
|
|
3873
|
+
* // "etag": "my_etag",
|
|
3874
|
+
* // "initialUser": {},
|
|
3875
|
+
* // "labels": {},
|
|
3876
|
+
* // "maintenanceSchedule": {},
|
|
3877
|
+
* // "maintenanceUpdatePolicy": {},
|
|
3878
|
+
* // "migrationSource": {},
|
|
3879
|
+
* // "name": "my_name",
|
|
3880
|
+
* // "network": "my_network",
|
|
3881
|
+
* // "networkConfig": {},
|
|
3882
|
+
* // "primaryConfig": {},
|
|
3883
|
+
* // "pscConfig": {},
|
|
3884
|
+
* // "reconciling": false,
|
|
3885
|
+
* // "satisfiesPzs": false,
|
|
3886
|
+
* // "secondaryConfig": {},
|
|
3887
|
+
* // "sslConfig": {},
|
|
3888
|
+
* // "state": "my_state",
|
|
3889
|
+
* // "subscriptionType": "my_subscriptionType",
|
|
3890
|
+
* // "tags": {},
|
|
3891
|
+
* // "trialMetadata": {},
|
|
3892
|
+
* // "uid": "my_uid",
|
|
3893
|
+
* // "updateTime": "my_updateTime"
|
|
3894
|
+
* // }
|
|
3895
|
+
* },
|
|
3896
|
+
* });
|
|
3897
|
+
* console.log(res.data);
|
|
3898
|
+
*
|
|
3899
|
+
* // Example response
|
|
3900
|
+
* // {
|
|
3901
|
+
* // "done": false,
|
|
3902
|
+
* // "error": {},
|
|
3903
|
+
* // "metadata": {},
|
|
3904
|
+
* // "name": "my_name",
|
|
3905
|
+
* // "response": {}
|
|
3906
|
+
* // }
|
|
3907
|
+
* }
|
|
3908
|
+
*
|
|
3909
|
+
* main().catch(e => {
|
|
3910
|
+
* console.error(e);
|
|
3911
|
+
* throw e;
|
|
3912
|
+
* });
|
|
3913
|
+
*
|
|
3914
|
+
* ```
|
|
3251
3915
|
*
|
|
3252
3916
|
* @param params - Parameters for request
|
|
3253
3917
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -3340,6 +4004,64 @@ export namespace alloydb_v1 {
|
|
|
3340
4004
|
|
|
3341
4005
|
/**
|
|
3342
4006
|
* Deletes a single Cluster.
|
|
4007
|
+
* @example
|
|
4008
|
+
* ```js
|
|
4009
|
+
* // Before running the sample:
|
|
4010
|
+
* // - Enable the API at:
|
|
4011
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
4012
|
+
* // - Login into gcloud by running:
|
|
4013
|
+
* // ```sh
|
|
4014
|
+
* // $ gcloud auth application-default login
|
|
4015
|
+
* // ```
|
|
4016
|
+
* // - Install the npm module by running:
|
|
4017
|
+
* // ```sh
|
|
4018
|
+
* // $ npm install googleapis
|
|
4019
|
+
* // ```
|
|
4020
|
+
*
|
|
4021
|
+
* const {google} = require('googleapis');
|
|
4022
|
+
* const alloydb = google.alloydb('v1');
|
|
4023
|
+
*
|
|
4024
|
+
* async function main() {
|
|
4025
|
+
* const auth = new google.auth.GoogleAuth({
|
|
4026
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
4027
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
4028
|
+
* });
|
|
4029
|
+
*
|
|
4030
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
4031
|
+
* const authClient = await auth.getClient();
|
|
4032
|
+
* google.options({auth: authClient});
|
|
4033
|
+
*
|
|
4034
|
+
* // Do the magic
|
|
4035
|
+
* const res = await alloydb.projects.locations.clusters.delete({
|
|
4036
|
+
* // 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.
|
|
4037
|
+
* etag: 'placeholder-value',
|
|
4038
|
+
* // Optional. Whether to cascade delete child instances for given cluster.
|
|
4039
|
+
* force: 'placeholder-value',
|
|
4040
|
+
* // Required. The name of the resource. For the required format, see the comment on the Cluster.name field.
|
|
4041
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster',
|
|
4042
|
+
* // 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).
|
|
4043
|
+
* requestId: 'placeholder-value',
|
|
4044
|
+
* // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
|
|
4045
|
+
* validateOnly: 'placeholder-value',
|
|
4046
|
+
* });
|
|
4047
|
+
* console.log(res.data);
|
|
4048
|
+
*
|
|
4049
|
+
* // Example response
|
|
4050
|
+
* // {
|
|
4051
|
+
* // "done": false,
|
|
4052
|
+
* // "error": {},
|
|
4053
|
+
* // "metadata": {},
|
|
4054
|
+
* // "name": "my_name",
|
|
4055
|
+
* // "response": {}
|
|
4056
|
+
* // }
|
|
4057
|
+
* }
|
|
4058
|
+
*
|
|
4059
|
+
* main().catch(e => {
|
|
4060
|
+
* console.error(e);
|
|
4061
|
+
* throw e;
|
|
4062
|
+
* });
|
|
4063
|
+
*
|
|
4064
|
+
* ```
|
|
3343
4065
|
*
|
|
3344
4066
|
* @param params - Parameters for request
|
|
3345
4067
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -3428,6 +4150,67 @@ export namespace alloydb_v1 {
|
|
|
3428
4150
|
|
|
3429
4151
|
/**
|
|
3430
4152
|
* Exports data from the cluster. Imperative only.
|
|
4153
|
+
* @example
|
|
4154
|
+
* ```js
|
|
4155
|
+
* // Before running the sample:
|
|
4156
|
+
* // - Enable the API at:
|
|
4157
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
4158
|
+
* // - Login into gcloud by running:
|
|
4159
|
+
* // ```sh
|
|
4160
|
+
* // $ gcloud auth application-default login
|
|
4161
|
+
* // ```
|
|
4162
|
+
* // - Install the npm module by running:
|
|
4163
|
+
* // ```sh
|
|
4164
|
+
* // $ npm install googleapis
|
|
4165
|
+
* // ```
|
|
4166
|
+
*
|
|
4167
|
+
* const {google} = require('googleapis');
|
|
4168
|
+
* const alloydb = google.alloydb('v1');
|
|
4169
|
+
*
|
|
4170
|
+
* async function main() {
|
|
4171
|
+
* const auth = new google.auth.GoogleAuth({
|
|
4172
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
4173
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
4174
|
+
* });
|
|
4175
|
+
*
|
|
4176
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
4177
|
+
* const authClient = await auth.getClient();
|
|
4178
|
+
* google.options({auth: authClient});
|
|
4179
|
+
*
|
|
4180
|
+
* // Do the magic
|
|
4181
|
+
* const res = await alloydb.projects.locations.clusters.export({
|
|
4182
|
+
* // Required. The resource name of the cluster.
|
|
4183
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster',
|
|
4184
|
+
*
|
|
4185
|
+
* // Request body metadata
|
|
4186
|
+
* requestBody: {
|
|
4187
|
+
* // request body parameters
|
|
4188
|
+
* // {
|
|
4189
|
+
* // "csvExportOptions": {},
|
|
4190
|
+
* // "database": "my_database",
|
|
4191
|
+
* // "gcsDestination": {},
|
|
4192
|
+
* // "sqlExportOptions": {}
|
|
4193
|
+
* // }
|
|
4194
|
+
* },
|
|
4195
|
+
* });
|
|
4196
|
+
* console.log(res.data);
|
|
4197
|
+
*
|
|
4198
|
+
* // Example response
|
|
4199
|
+
* // {
|
|
4200
|
+
* // "done": false,
|
|
4201
|
+
* // "error": {},
|
|
4202
|
+
* // "metadata": {},
|
|
4203
|
+
* // "name": "my_name",
|
|
4204
|
+
* // "response": {}
|
|
4205
|
+
* // }
|
|
4206
|
+
* }
|
|
4207
|
+
*
|
|
4208
|
+
* main().catch(e => {
|
|
4209
|
+
* console.error(e);
|
|
4210
|
+
* throw e;
|
|
4211
|
+
* });
|
|
4212
|
+
*
|
|
4213
|
+
* ```
|
|
3431
4214
|
*
|
|
3432
4215
|
* @param params - Parameters for request
|
|
3433
4216
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -3516,6 +4299,87 @@ export namespace alloydb_v1 {
|
|
|
3516
4299
|
|
|
3517
4300
|
/**
|
|
3518
4301
|
* Gets details of a single Cluster.
|
|
4302
|
+
* @example
|
|
4303
|
+
* ```js
|
|
4304
|
+
* // Before running the sample:
|
|
4305
|
+
* // - Enable the API at:
|
|
4306
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
4307
|
+
* // - Login into gcloud by running:
|
|
4308
|
+
* // ```sh
|
|
4309
|
+
* // $ gcloud auth application-default login
|
|
4310
|
+
* // ```
|
|
4311
|
+
* // - Install the npm module by running:
|
|
4312
|
+
* // ```sh
|
|
4313
|
+
* // $ npm install googleapis
|
|
4314
|
+
* // ```
|
|
4315
|
+
*
|
|
4316
|
+
* const {google} = require('googleapis');
|
|
4317
|
+
* const alloydb = google.alloydb('v1');
|
|
4318
|
+
*
|
|
4319
|
+
* async function main() {
|
|
4320
|
+
* const auth = new google.auth.GoogleAuth({
|
|
4321
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
4322
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
4323
|
+
* });
|
|
4324
|
+
*
|
|
4325
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
4326
|
+
* const authClient = await auth.getClient();
|
|
4327
|
+
* google.options({auth: authClient});
|
|
4328
|
+
*
|
|
4329
|
+
* // Do the magic
|
|
4330
|
+
* const res = await alloydb.projects.locations.clusters.get({
|
|
4331
|
+
* // Required. The name of the resource. For the required format, see the comment on the Cluster.name field.
|
|
4332
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster',
|
|
4333
|
+
* // Optional. The view of the cluster to return. Returns all default fields if not set.
|
|
4334
|
+
* view: 'placeholder-value',
|
|
4335
|
+
* });
|
|
4336
|
+
* console.log(res.data);
|
|
4337
|
+
*
|
|
4338
|
+
* // Example response
|
|
4339
|
+
* // {
|
|
4340
|
+
* // "annotations": {},
|
|
4341
|
+
* // "automatedBackupPolicy": {},
|
|
4342
|
+
* // "backupSource": {},
|
|
4343
|
+
* // "cloudsqlBackupRunSource": {},
|
|
4344
|
+
* // "clusterType": "my_clusterType",
|
|
4345
|
+
* // "continuousBackupConfig": {},
|
|
4346
|
+
* // "continuousBackupInfo": {},
|
|
4347
|
+
* // "createTime": "my_createTime",
|
|
4348
|
+
* // "databaseVersion": "my_databaseVersion",
|
|
4349
|
+
* // "deleteTime": "my_deleteTime",
|
|
4350
|
+
* // "displayName": "my_displayName",
|
|
4351
|
+
* // "encryptionConfig": {},
|
|
4352
|
+
* // "encryptionInfo": {},
|
|
4353
|
+
* // "etag": "my_etag",
|
|
4354
|
+
* // "initialUser": {},
|
|
4355
|
+
* // "labels": {},
|
|
4356
|
+
* // "maintenanceSchedule": {},
|
|
4357
|
+
* // "maintenanceUpdatePolicy": {},
|
|
4358
|
+
* // "migrationSource": {},
|
|
4359
|
+
* // "name": "my_name",
|
|
4360
|
+
* // "network": "my_network",
|
|
4361
|
+
* // "networkConfig": {},
|
|
4362
|
+
* // "primaryConfig": {},
|
|
4363
|
+
* // "pscConfig": {},
|
|
4364
|
+
* // "reconciling": false,
|
|
4365
|
+
* // "satisfiesPzs": false,
|
|
4366
|
+
* // "secondaryConfig": {},
|
|
4367
|
+
* // "sslConfig": {},
|
|
4368
|
+
* // "state": "my_state",
|
|
4369
|
+
* // "subscriptionType": "my_subscriptionType",
|
|
4370
|
+
* // "tags": {},
|
|
4371
|
+
* // "trialMetadata": {},
|
|
4372
|
+
* // "uid": "my_uid",
|
|
4373
|
+
* // "updateTime": "my_updateTime"
|
|
4374
|
+
* // }
|
|
4375
|
+
* }
|
|
4376
|
+
*
|
|
4377
|
+
* main().catch(e => {
|
|
4378
|
+
* console.error(e);
|
|
4379
|
+
* throw e;
|
|
4380
|
+
* });
|
|
4381
|
+
*
|
|
4382
|
+
* ```
|
|
3519
4383
|
*
|
|
3520
4384
|
* @param params - Parameters for request
|
|
3521
4385
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -3604,6 +4468,68 @@ export namespace alloydb_v1 {
|
|
|
3604
4468
|
|
|
3605
4469
|
/**
|
|
3606
4470
|
* Imports data to the cluster. Imperative only.
|
|
4471
|
+
* @example
|
|
4472
|
+
* ```js
|
|
4473
|
+
* // Before running the sample:
|
|
4474
|
+
* // - Enable the API at:
|
|
4475
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
4476
|
+
* // - Login into gcloud by running:
|
|
4477
|
+
* // ```sh
|
|
4478
|
+
* // $ gcloud auth application-default login
|
|
4479
|
+
* // ```
|
|
4480
|
+
* // - Install the npm module by running:
|
|
4481
|
+
* // ```sh
|
|
4482
|
+
* // $ npm install googleapis
|
|
4483
|
+
* // ```
|
|
4484
|
+
*
|
|
4485
|
+
* const {google} = require('googleapis');
|
|
4486
|
+
* const alloydb = google.alloydb('v1');
|
|
4487
|
+
*
|
|
4488
|
+
* async function main() {
|
|
4489
|
+
* const auth = new google.auth.GoogleAuth({
|
|
4490
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
4491
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
4492
|
+
* });
|
|
4493
|
+
*
|
|
4494
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
4495
|
+
* const authClient = await auth.getClient();
|
|
4496
|
+
* google.options({auth: authClient});
|
|
4497
|
+
*
|
|
4498
|
+
* // Do the magic
|
|
4499
|
+
* const res = await alloydb.projects.locations.clusters.import({
|
|
4500
|
+
* // Required. The resource name of the cluster.
|
|
4501
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster',
|
|
4502
|
+
*
|
|
4503
|
+
* // Request body metadata
|
|
4504
|
+
* requestBody: {
|
|
4505
|
+
* // request body parameters
|
|
4506
|
+
* // {
|
|
4507
|
+
* // "csvImportOptions": {},
|
|
4508
|
+
* // "database": "my_database",
|
|
4509
|
+
* // "gcsUri": "my_gcsUri",
|
|
4510
|
+
* // "sqlImportOptions": {},
|
|
4511
|
+
* // "user": "my_user"
|
|
4512
|
+
* // }
|
|
4513
|
+
* },
|
|
4514
|
+
* });
|
|
4515
|
+
* console.log(res.data);
|
|
4516
|
+
*
|
|
4517
|
+
* // Example response
|
|
4518
|
+
* // {
|
|
4519
|
+
* // "done": false,
|
|
4520
|
+
* // "error": {},
|
|
4521
|
+
* // "metadata": {},
|
|
4522
|
+
* // "name": "my_name",
|
|
4523
|
+
* // "response": {}
|
|
4524
|
+
* // }
|
|
4525
|
+
* }
|
|
4526
|
+
*
|
|
4527
|
+
* main().catch(e => {
|
|
4528
|
+
* console.error(e);
|
|
4529
|
+
* throw e;
|
|
4530
|
+
* });
|
|
4531
|
+
*
|
|
4532
|
+
* ```
|
|
3607
4533
|
*
|
|
3608
4534
|
* @param params - Parameters for request
|
|
3609
4535
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -3692,6 +4618,62 @@ export namespace alloydb_v1 {
|
|
|
3692
4618
|
|
|
3693
4619
|
/**
|
|
3694
4620
|
* Lists Clusters in a given project and location.
|
|
4621
|
+
* @example
|
|
4622
|
+
* ```js
|
|
4623
|
+
* // Before running the sample:
|
|
4624
|
+
* // - Enable the API at:
|
|
4625
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
4626
|
+
* // - Login into gcloud by running:
|
|
4627
|
+
* // ```sh
|
|
4628
|
+
* // $ gcloud auth application-default login
|
|
4629
|
+
* // ```
|
|
4630
|
+
* // - Install the npm module by running:
|
|
4631
|
+
* // ```sh
|
|
4632
|
+
* // $ npm install googleapis
|
|
4633
|
+
* // ```
|
|
4634
|
+
*
|
|
4635
|
+
* const {google} = require('googleapis');
|
|
4636
|
+
* const alloydb = google.alloydb('v1');
|
|
4637
|
+
*
|
|
4638
|
+
* async function main() {
|
|
4639
|
+
* const auth = new google.auth.GoogleAuth({
|
|
4640
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
4641
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
4642
|
+
* });
|
|
4643
|
+
*
|
|
4644
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
4645
|
+
* const authClient = await auth.getClient();
|
|
4646
|
+
* google.options({auth: authClient});
|
|
4647
|
+
*
|
|
4648
|
+
* // Do the magic
|
|
4649
|
+
* const res = await alloydb.projects.locations.clusters.list({
|
|
4650
|
+
* // Optional. Filtering results
|
|
4651
|
+
* filter: 'placeholder-value',
|
|
4652
|
+
* // Optional. Hint for how to order the results
|
|
4653
|
+
* orderBy: 'placeholder-value',
|
|
4654
|
+
* // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
|
|
4655
|
+
* pageSize: 'placeholder-value',
|
|
4656
|
+
* // A token identifying a page of results the server should return.
|
|
4657
|
+
* pageToken: 'placeholder-value',
|
|
4658
|
+
* // Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field. Additionally, you can perform an aggregated list operation by specifying a value with the following format: * projects/{project\}/locations/-
|
|
4659
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
4660
|
+
* });
|
|
4661
|
+
* console.log(res.data);
|
|
4662
|
+
*
|
|
4663
|
+
* // Example response
|
|
4664
|
+
* // {
|
|
4665
|
+
* // "clusters": [],
|
|
4666
|
+
* // "nextPageToken": "my_nextPageToken",
|
|
4667
|
+
* // "unreachable": []
|
|
4668
|
+
* // }
|
|
4669
|
+
* }
|
|
4670
|
+
*
|
|
4671
|
+
* main().catch(e => {
|
|
4672
|
+
* console.error(e);
|
|
4673
|
+
* throw e;
|
|
4674
|
+
* });
|
|
4675
|
+
*
|
|
4676
|
+
* ```
|
|
3695
4677
|
*
|
|
3696
4678
|
* @param params - Parameters for request
|
|
3697
4679
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -3785,6 +4767,105 @@ export namespace alloydb_v1 {
|
|
|
3785
4767
|
|
|
3786
4768
|
/**
|
|
3787
4769
|
* Updates the parameters of a single Cluster.
|
|
4770
|
+
* @example
|
|
4771
|
+
* ```js
|
|
4772
|
+
* // Before running the sample:
|
|
4773
|
+
* // - Enable the API at:
|
|
4774
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
4775
|
+
* // - Login into gcloud by running:
|
|
4776
|
+
* // ```sh
|
|
4777
|
+
* // $ gcloud auth application-default login
|
|
4778
|
+
* // ```
|
|
4779
|
+
* // - Install the npm module by running:
|
|
4780
|
+
* // ```sh
|
|
4781
|
+
* // $ npm install googleapis
|
|
4782
|
+
* // ```
|
|
4783
|
+
*
|
|
4784
|
+
* const {google} = require('googleapis');
|
|
4785
|
+
* const alloydb = google.alloydb('v1');
|
|
4786
|
+
*
|
|
4787
|
+
* async function main() {
|
|
4788
|
+
* const auth = new google.auth.GoogleAuth({
|
|
4789
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
4790
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
4791
|
+
* });
|
|
4792
|
+
*
|
|
4793
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
4794
|
+
* const authClient = await auth.getClient();
|
|
4795
|
+
* google.options({auth: authClient});
|
|
4796
|
+
*
|
|
4797
|
+
* // Do the magic
|
|
4798
|
+
* const res = await alloydb.projects.locations.clusters.patch({
|
|
4799
|
+
* // Optional. If set to true, update succeeds even if cluster is not found. In that case, a new cluster is created and `update_mask` is ignored.
|
|
4800
|
+
* allowMissing: 'placeholder-value',
|
|
4801
|
+
* // Output only. The name of the cluster resource with the format: * projects/{project\}/locations/{region\}/clusters/{cluster_id\} where the cluster ID segment should satisfy the regex expression `[a-z0-9-]+`. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project\}/locations/{region\}
|
|
4802
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster',
|
|
4803
|
+
* // 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).
|
|
4804
|
+
* requestId: 'placeholder-value',
|
|
4805
|
+
* // Optional. Field mask is used to specify the fields to be overwritten in the Cluster 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.
|
|
4806
|
+
* updateMask: 'placeholder-value',
|
|
4807
|
+
* // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
|
|
4808
|
+
* validateOnly: 'placeholder-value',
|
|
4809
|
+
*
|
|
4810
|
+
* // Request body metadata
|
|
4811
|
+
* requestBody: {
|
|
4812
|
+
* // request body parameters
|
|
4813
|
+
* // {
|
|
4814
|
+
* // "annotations": {},
|
|
4815
|
+
* // "automatedBackupPolicy": {},
|
|
4816
|
+
* // "backupSource": {},
|
|
4817
|
+
* // "cloudsqlBackupRunSource": {},
|
|
4818
|
+
* // "clusterType": "my_clusterType",
|
|
4819
|
+
* // "continuousBackupConfig": {},
|
|
4820
|
+
* // "continuousBackupInfo": {},
|
|
4821
|
+
* // "createTime": "my_createTime",
|
|
4822
|
+
* // "databaseVersion": "my_databaseVersion",
|
|
4823
|
+
* // "deleteTime": "my_deleteTime",
|
|
4824
|
+
* // "displayName": "my_displayName",
|
|
4825
|
+
* // "encryptionConfig": {},
|
|
4826
|
+
* // "encryptionInfo": {},
|
|
4827
|
+
* // "etag": "my_etag",
|
|
4828
|
+
* // "initialUser": {},
|
|
4829
|
+
* // "labels": {},
|
|
4830
|
+
* // "maintenanceSchedule": {},
|
|
4831
|
+
* // "maintenanceUpdatePolicy": {},
|
|
4832
|
+
* // "migrationSource": {},
|
|
4833
|
+
* // "name": "my_name",
|
|
4834
|
+
* // "network": "my_network",
|
|
4835
|
+
* // "networkConfig": {},
|
|
4836
|
+
* // "primaryConfig": {},
|
|
4837
|
+
* // "pscConfig": {},
|
|
4838
|
+
* // "reconciling": false,
|
|
4839
|
+
* // "satisfiesPzs": false,
|
|
4840
|
+
* // "secondaryConfig": {},
|
|
4841
|
+
* // "sslConfig": {},
|
|
4842
|
+
* // "state": "my_state",
|
|
4843
|
+
* // "subscriptionType": "my_subscriptionType",
|
|
4844
|
+
* // "tags": {},
|
|
4845
|
+
* // "trialMetadata": {},
|
|
4846
|
+
* // "uid": "my_uid",
|
|
4847
|
+
* // "updateTime": "my_updateTime"
|
|
4848
|
+
* // }
|
|
4849
|
+
* },
|
|
4850
|
+
* });
|
|
4851
|
+
* console.log(res.data);
|
|
4852
|
+
*
|
|
4853
|
+
* // Example response
|
|
4854
|
+
* // {
|
|
4855
|
+
* // "done": false,
|
|
4856
|
+
* // "error": {},
|
|
4857
|
+
* // "metadata": {},
|
|
4858
|
+
* // "name": "my_name",
|
|
4859
|
+
* // "response": {}
|
|
4860
|
+
* // }
|
|
4861
|
+
* }
|
|
4862
|
+
*
|
|
4863
|
+
* main().catch(e => {
|
|
4864
|
+
* console.error(e);
|
|
4865
|
+
* throw e;
|
|
4866
|
+
* });
|
|
4867
|
+
*
|
|
4868
|
+
* ```
|
|
3788
4869
|
*
|
|
3789
4870
|
* @param params - Parameters for request
|
|
3790
4871
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -3873,6 +4954,66 @@ export namespace alloydb_v1 {
|
|
|
3873
4954
|
|
|
3874
4955
|
/**
|
|
3875
4956
|
* Promotes a SECONDARY cluster. This turns down replication from the PRIMARY cluster and promotes a secondary cluster into its own standalone cluster. Imperative only.
|
|
4957
|
+
* @example
|
|
4958
|
+
* ```js
|
|
4959
|
+
* // Before running the sample:
|
|
4960
|
+
* // - Enable the API at:
|
|
4961
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
4962
|
+
* // - Login into gcloud by running:
|
|
4963
|
+
* // ```sh
|
|
4964
|
+
* // $ gcloud auth application-default login
|
|
4965
|
+
* // ```
|
|
4966
|
+
* // - Install the npm module by running:
|
|
4967
|
+
* // ```sh
|
|
4968
|
+
* // $ npm install googleapis
|
|
4969
|
+
* // ```
|
|
4970
|
+
*
|
|
4971
|
+
* const {google} = require('googleapis');
|
|
4972
|
+
* const alloydb = google.alloydb('v1');
|
|
4973
|
+
*
|
|
4974
|
+
* async function main() {
|
|
4975
|
+
* const auth = new google.auth.GoogleAuth({
|
|
4976
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
4977
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
4978
|
+
* });
|
|
4979
|
+
*
|
|
4980
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
4981
|
+
* const authClient = await auth.getClient();
|
|
4982
|
+
* google.options({auth: authClient});
|
|
4983
|
+
*
|
|
4984
|
+
* // Do the magic
|
|
4985
|
+
* const res = await alloydb.projects.locations.clusters.promote({
|
|
4986
|
+
* // Required. The name of the resource. For the required format, see the comment on the Cluster.name field
|
|
4987
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster',
|
|
4988
|
+
*
|
|
4989
|
+
* // Request body metadata
|
|
4990
|
+
* requestBody: {
|
|
4991
|
+
* // request body parameters
|
|
4992
|
+
* // {
|
|
4993
|
+
* // "etag": "my_etag",
|
|
4994
|
+
* // "requestId": "my_requestId",
|
|
4995
|
+
* // "validateOnly": false
|
|
4996
|
+
* // }
|
|
4997
|
+
* },
|
|
4998
|
+
* });
|
|
4999
|
+
* console.log(res.data);
|
|
5000
|
+
*
|
|
5001
|
+
* // Example response
|
|
5002
|
+
* // {
|
|
5003
|
+
* // "done": false,
|
|
5004
|
+
* // "error": {},
|
|
5005
|
+
* // "metadata": {},
|
|
5006
|
+
* // "name": "my_name",
|
|
5007
|
+
* // "response": {}
|
|
5008
|
+
* // }
|
|
5009
|
+
* }
|
|
5010
|
+
*
|
|
5011
|
+
* main().catch(e => {
|
|
5012
|
+
* console.error(e);
|
|
5013
|
+
* throw e;
|
|
5014
|
+
* });
|
|
5015
|
+
*
|
|
5016
|
+
* ```
|
|
3876
5017
|
*
|
|
3877
5018
|
* @param params - Parameters for request
|
|
3878
5019
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -3964,6 +5105,69 @@ export namespace alloydb_v1 {
|
|
|
3964
5105
|
|
|
3965
5106
|
/**
|
|
3966
5107
|
* Creates a new Cluster in a given project and location, with a volume restored from the provided source, either a backup ID or a point-in-time and a source cluster.
|
|
5108
|
+
* @example
|
|
5109
|
+
* ```js
|
|
5110
|
+
* // Before running the sample:
|
|
5111
|
+
* // - Enable the API at:
|
|
5112
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
5113
|
+
* // - Login into gcloud by running:
|
|
5114
|
+
* // ```sh
|
|
5115
|
+
* // $ gcloud auth application-default login
|
|
5116
|
+
* // ```
|
|
5117
|
+
* // - Install the npm module by running:
|
|
5118
|
+
* // ```sh
|
|
5119
|
+
* // $ npm install googleapis
|
|
5120
|
+
* // ```
|
|
5121
|
+
*
|
|
5122
|
+
* const {google} = require('googleapis');
|
|
5123
|
+
* const alloydb = google.alloydb('v1');
|
|
5124
|
+
*
|
|
5125
|
+
* async function main() {
|
|
5126
|
+
* const auth = new google.auth.GoogleAuth({
|
|
5127
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
5128
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
5129
|
+
* });
|
|
5130
|
+
*
|
|
5131
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
5132
|
+
* const authClient = await auth.getClient();
|
|
5133
|
+
* google.options({auth: authClient});
|
|
5134
|
+
*
|
|
5135
|
+
* // Do the magic
|
|
5136
|
+
* const res = await alloydb.projects.locations.clusters.restore({
|
|
5137
|
+
* // Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field.
|
|
5138
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
5139
|
+
*
|
|
5140
|
+
* // Request body metadata
|
|
5141
|
+
* requestBody: {
|
|
5142
|
+
* // request body parameters
|
|
5143
|
+
* // {
|
|
5144
|
+
* // "backupSource": {},
|
|
5145
|
+
* // "cluster": {},
|
|
5146
|
+
* // "clusterId": "my_clusterId",
|
|
5147
|
+
* // "continuousBackupSource": {},
|
|
5148
|
+
* // "requestId": "my_requestId",
|
|
5149
|
+
* // "validateOnly": false
|
|
5150
|
+
* // }
|
|
5151
|
+
* },
|
|
5152
|
+
* });
|
|
5153
|
+
* console.log(res.data);
|
|
5154
|
+
*
|
|
5155
|
+
* // Example response
|
|
5156
|
+
* // {
|
|
5157
|
+
* // "done": false,
|
|
5158
|
+
* // "error": {},
|
|
5159
|
+
* // "metadata": {},
|
|
5160
|
+
* // "name": "my_name",
|
|
5161
|
+
* // "response": {}
|
|
5162
|
+
* // }
|
|
5163
|
+
* }
|
|
5164
|
+
*
|
|
5165
|
+
* main().catch(e => {
|
|
5166
|
+
* console.error(e);
|
|
5167
|
+
* throw e;
|
|
5168
|
+
* });
|
|
5169
|
+
*
|
|
5170
|
+
* ```
|
|
3967
5171
|
*
|
|
3968
5172
|
* @param params - Parameters for request
|
|
3969
5173
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -4055,6 +5259,66 @@ export namespace alloydb_v1 {
|
|
|
4055
5259
|
|
|
4056
5260
|
/**
|
|
4057
5261
|
* Restores an AlloyDB cluster from a CloudSQL resource.
|
|
5262
|
+
* @example
|
|
5263
|
+
* ```js
|
|
5264
|
+
* // Before running the sample:
|
|
5265
|
+
* // - Enable the API at:
|
|
5266
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
5267
|
+
* // - Login into gcloud by running:
|
|
5268
|
+
* // ```sh
|
|
5269
|
+
* // $ gcloud auth application-default login
|
|
5270
|
+
* // ```
|
|
5271
|
+
* // - Install the npm module by running:
|
|
5272
|
+
* // ```sh
|
|
5273
|
+
* // $ npm install googleapis
|
|
5274
|
+
* // ```
|
|
5275
|
+
*
|
|
5276
|
+
* const {google} = require('googleapis');
|
|
5277
|
+
* const alloydb = google.alloydb('v1');
|
|
5278
|
+
*
|
|
5279
|
+
* async function main() {
|
|
5280
|
+
* const auth = new google.auth.GoogleAuth({
|
|
5281
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
5282
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
5283
|
+
* });
|
|
5284
|
+
*
|
|
5285
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
5286
|
+
* const authClient = await auth.getClient();
|
|
5287
|
+
* google.options({auth: authClient});
|
|
5288
|
+
*
|
|
5289
|
+
* // Do the magic
|
|
5290
|
+
* const res = await alloydb.projects.locations.clusters.restoreFromCloudSQL({
|
|
5291
|
+
* // Required. The location of the new cluster. For the required format, see the comment on Cluster.name field.
|
|
5292
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
5293
|
+
*
|
|
5294
|
+
* // Request body metadata
|
|
5295
|
+
* requestBody: {
|
|
5296
|
+
* // request body parameters
|
|
5297
|
+
* // {
|
|
5298
|
+
* // "cloudsqlBackupRunSource": {},
|
|
5299
|
+
* // "cluster": {},
|
|
5300
|
+
* // "clusterId": "my_clusterId"
|
|
5301
|
+
* // }
|
|
5302
|
+
* },
|
|
5303
|
+
* });
|
|
5304
|
+
* console.log(res.data);
|
|
5305
|
+
*
|
|
5306
|
+
* // Example response
|
|
5307
|
+
* // {
|
|
5308
|
+
* // "done": false,
|
|
5309
|
+
* // "error": {},
|
|
5310
|
+
* // "metadata": {},
|
|
5311
|
+
* // "name": "my_name",
|
|
5312
|
+
* // "response": {}
|
|
5313
|
+
* // }
|
|
5314
|
+
* }
|
|
5315
|
+
*
|
|
5316
|
+
* main().catch(e => {
|
|
5317
|
+
* console.error(e);
|
|
5318
|
+
* throw e;
|
|
5319
|
+
* });
|
|
5320
|
+
*
|
|
5321
|
+
* ```
|
|
4058
5322
|
*
|
|
4059
5323
|
* @param params - Parameters for request
|
|
4060
5324
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -4146,6 +5410,65 @@ export namespace alloydb_v1 {
|
|
|
4146
5410
|
|
|
4147
5411
|
/**
|
|
4148
5412
|
* Switches the roles of PRIMARY and SECONDARY clusters without any data loss. This promotes the SECONDARY cluster to PRIMARY and sets up the original PRIMARY cluster to replicate from this newly promoted cluster.
|
|
5413
|
+
* @example
|
|
5414
|
+
* ```js
|
|
5415
|
+
* // Before running the sample:
|
|
5416
|
+
* // - Enable the API at:
|
|
5417
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
5418
|
+
* // - Login into gcloud by running:
|
|
5419
|
+
* // ```sh
|
|
5420
|
+
* // $ gcloud auth application-default login
|
|
5421
|
+
* // ```
|
|
5422
|
+
* // - Install the npm module by running:
|
|
5423
|
+
* // ```sh
|
|
5424
|
+
* // $ npm install googleapis
|
|
5425
|
+
* // ```
|
|
5426
|
+
*
|
|
5427
|
+
* const {google} = require('googleapis');
|
|
5428
|
+
* const alloydb = google.alloydb('v1');
|
|
5429
|
+
*
|
|
5430
|
+
* async function main() {
|
|
5431
|
+
* const auth = new google.auth.GoogleAuth({
|
|
5432
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
5433
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
5434
|
+
* });
|
|
5435
|
+
*
|
|
5436
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
5437
|
+
* const authClient = await auth.getClient();
|
|
5438
|
+
* google.options({auth: authClient});
|
|
5439
|
+
*
|
|
5440
|
+
* // Do the magic
|
|
5441
|
+
* const res = await alloydb.projects.locations.clusters.switchover({
|
|
5442
|
+
* // Required. The name of the resource. For the required format, see the comment on the Cluster.name field
|
|
5443
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster',
|
|
5444
|
+
*
|
|
5445
|
+
* // Request body metadata
|
|
5446
|
+
* requestBody: {
|
|
5447
|
+
* // request body parameters
|
|
5448
|
+
* // {
|
|
5449
|
+
* // "requestId": "my_requestId",
|
|
5450
|
+
* // "validateOnly": false
|
|
5451
|
+
* // }
|
|
5452
|
+
* },
|
|
5453
|
+
* });
|
|
5454
|
+
* console.log(res.data);
|
|
5455
|
+
*
|
|
5456
|
+
* // Example response
|
|
5457
|
+
* // {
|
|
5458
|
+
* // "done": false,
|
|
5459
|
+
* // "error": {},
|
|
5460
|
+
* // "metadata": {},
|
|
5461
|
+
* // "name": "my_name",
|
|
5462
|
+
* // "response": {}
|
|
5463
|
+
* // }
|
|
5464
|
+
* }
|
|
5465
|
+
*
|
|
5466
|
+
* main().catch(e => {
|
|
5467
|
+
* console.error(e);
|
|
5468
|
+
* throw e;
|
|
5469
|
+
* });
|
|
5470
|
+
*
|
|
5471
|
+
* ```
|
|
4149
5472
|
*
|
|
4150
5473
|
* @param params - Parameters for request
|
|
4151
5474
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -4237,6 +5560,67 @@ export namespace alloydb_v1 {
|
|
|
4237
5560
|
|
|
4238
5561
|
/**
|
|
4239
5562
|
* Upgrades a single Cluster. Imperative only.
|
|
5563
|
+
* @example
|
|
5564
|
+
* ```js
|
|
5565
|
+
* // Before running the sample:
|
|
5566
|
+
* // - Enable the API at:
|
|
5567
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
5568
|
+
* // - Login into gcloud by running:
|
|
5569
|
+
* // ```sh
|
|
5570
|
+
* // $ gcloud auth application-default login
|
|
5571
|
+
* // ```
|
|
5572
|
+
* // - Install the npm module by running:
|
|
5573
|
+
* // ```sh
|
|
5574
|
+
* // $ npm install googleapis
|
|
5575
|
+
* // ```
|
|
5576
|
+
*
|
|
5577
|
+
* const {google} = require('googleapis');
|
|
5578
|
+
* const alloydb = google.alloydb('v1');
|
|
5579
|
+
*
|
|
5580
|
+
* async function main() {
|
|
5581
|
+
* const auth = new google.auth.GoogleAuth({
|
|
5582
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
5583
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
5584
|
+
* });
|
|
5585
|
+
*
|
|
5586
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
5587
|
+
* const authClient = await auth.getClient();
|
|
5588
|
+
* google.options({auth: authClient});
|
|
5589
|
+
*
|
|
5590
|
+
* // Do the magic
|
|
5591
|
+
* const res = await alloydb.projects.locations.clusters.upgrade({
|
|
5592
|
+
* // Required. The resource name of the cluster.
|
|
5593
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster',
|
|
5594
|
+
*
|
|
5595
|
+
* // Request body metadata
|
|
5596
|
+
* requestBody: {
|
|
5597
|
+
* // request body parameters
|
|
5598
|
+
* // {
|
|
5599
|
+
* // "etag": "my_etag",
|
|
5600
|
+
* // "requestId": "my_requestId",
|
|
5601
|
+
* // "validateOnly": false,
|
|
5602
|
+
* // "version": "my_version"
|
|
5603
|
+
* // }
|
|
5604
|
+
* },
|
|
5605
|
+
* });
|
|
5606
|
+
* console.log(res.data);
|
|
5607
|
+
*
|
|
5608
|
+
* // Example response
|
|
5609
|
+
* // {
|
|
5610
|
+
* // "done": false,
|
|
5611
|
+
* // "error": {},
|
|
5612
|
+
* // "metadata": {},
|
|
5613
|
+
* // "name": "my_name",
|
|
5614
|
+
* // "response": {}
|
|
5615
|
+
* // }
|
|
5616
|
+
* }
|
|
5617
|
+
*
|
|
5618
|
+
* main().catch(e => {
|
|
5619
|
+
* console.error(e);
|
|
5620
|
+
* throw e;
|
|
5621
|
+
* });
|
|
5622
|
+
*
|
|
5623
|
+
* ```
|
|
4240
5624
|
*
|
|
4241
5625
|
* @param params - Parameters for request
|
|
4242
5626
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -4553,6 +5937,98 @@ export namespace alloydb_v1 {
|
|
|
4553
5937
|
|
|
4554
5938
|
/**
|
|
4555
5939
|
* Creates a new Instance in a given project and location.
|
|
5940
|
+
* @example
|
|
5941
|
+
* ```js
|
|
5942
|
+
* // Before running the sample:
|
|
5943
|
+
* // - Enable the API at:
|
|
5944
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
5945
|
+
* // - Login into gcloud by running:
|
|
5946
|
+
* // ```sh
|
|
5947
|
+
* // $ gcloud auth application-default login
|
|
5948
|
+
* // ```
|
|
5949
|
+
* // - Install the npm module by running:
|
|
5950
|
+
* // ```sh
|
|
5951
|
+
* // $ npm install googleapis
|
|
5952
|
+
* // ```
|
|
5953
|
+
*
|
|
5954
|
+
* const {google} = require('googleapis');
|
|
5955
|
+
* const alloydb = google.alloydb('v1');
|
|
5956
|
+
*
|
|
5957
|
+
* async function main() {
|
|
5958
|
+
* const auth = new google.auth.GoogleAuth({
|
|
5959
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
5960
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
5961
|
+
* });
|
|
5962
|
+
*
|
|
5963
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
5964
|
+
* const authClient = await auth.getClient();
|
|
5965
|
+
* google.options({auth: authClient});
|
|
5966
|
+
*
|
|
5967
|
+
* // Do the magic
|
|
5968
|
+
* const res = await alloydb.projects.locations.clusters.instances.create({
|
|
5969
|
+
* // Required. ID of the requesting object.
|
|
5970
|
+
* instanceId: 'placeholder-value',
|
|
5971
|
+
* // Required. The name of the parent resource. For the required format, see the comment on the Instance.name field.
|
|
5972
|
+
* parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
|
|
5973
|
+
* // 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).
|
|
5974
|
+
* requestId: 'placeholder-value',
|
|
5975
|
+
* // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
|
|
5976
|
+
* validateOnly: 'placeholder-value',
|
|
5977
|
+
*
|
|
5978
|
+
* // Request body metadata
|
|
5979
|
+
* requestBody: {
|
|
5980
|
+
* // request body parameters
|
|
5981
|
+
* // {
|
|
5982
|
+
* // "activationPolicy": "my_activationPolicy",
|
|
5983
|
+
* // "annotations": {},
|
|
5984
|
+
* // "availabilityType": "my_availabilityType",
|
|
5985
|
+
* // "clientConnectionConfig": {},
|
|
5986
|
+
* // "createTime": "my_createTime",
|
|
5987
|
+
* // "databaseFlags": {},
|
|
5988
|
+
* // "deleteTime": "my_deleteTime",
|
|
5989
|
+
* // "displayName": "my_displayName",
|
|
5990
|
+
* // "etag": "my_etag",
|
|
5991
|
+
* // "gceZone": "my_gceZone",
|
|
5992
|
+
* // "instanceType": "my_instanceType",
|
|
5993
|
+
* // "ipAddress": "my_ipAddress",
|
|
5994
|
+
* // "labels": {},
|
|
5995
|
+
* // "machineConfig": {},
|
|
5996
|
+
* // "name": "my_name",
|
|
5997
|
+
* // "networkConfig": {},
|
|
5998
|
+
* // "nodes": [],
|
|
5999
|
+
* // "observabilityConfig": {},
|
|
6000
|
+
* // "outboundPublicIpAddresses": [],
|
|
6001
|
+
* // "pscInstanceConfig": {},
|
|
6002
|
+
* // "publicIpAddress": "my_publicIpAddress",
|
|
6003
|
+
* // "queryInsightsConfig": {},
|
|
6004
|
+
* // "readPoolConfig": {},
|
|
6005
|
+
* // "reconciling": false,
|
|
6006
|
+
* // "satisfiesPzs": false,
|
|
6007
|
+
* // "state": "my_state",
|
|
6008
|
+
* // "uid": "my_uid",
|
|
6009
|
+
* // "updateTime": "my_updateTime",
|
|
6010
|
+
* // "writableNode": {}
|
|
6011
|
+
* // }
|
|
6012
|
+
* },
|
|
6013
|
+
* });
|
|
6014
|
+
* console.log(res.data);
|
|
6015
|
+
*
|
|
6016
|
+
* // Example response
|
|
6017
|
+
* // {
|
|
6018
|
+
* // "done": false,
|
|
6019
|
+
* // "error": {},
|
|
6020
|
+
* // "metadata": {},
|
|
6021
|
+
* // "name": "my_name",
|
|
6022
|
+
* // "response": {}
|
|
6023
|
+
* // }
|
|
6024
|
+
* }
|
|
6025
|
+
*
|
|
6026
|
+
* main().catch(e => {
|
|
6027
|
+
* console.error(e);
|
|
6028
|
+
* throw e;
|
|
6029
|
+
* });
|
|
6030
|
+
*
|
|
6031
|
+
* ```
|
|
4556
6032
|
*
|
|
4557
6033
|
* @param params - Parameters for request
|
|
4558
6034
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -4645,6 +6121,99 @@ export namespace alloydb_v1 {
|
|
|
4645
6121
|
|
|
4646
6122
|
/**
|
|
4647
6123
|
* Creates a new SECONDARY Instance in a given project and location.
|
|
6124
|
+
* @example
|
|
6125
|
+
* ```js
|
|
6126
|
+
* // Before running the sample:
|
|
6127
|
+
* // - Enable the API at:
|
|
6128
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
6129
|
+
* // - Login into gcloud by running:
|
|
6130
|
+
* // ```sh
|
|
6131
|
+
* // $ gcloud auth application-default login
|
|
6132
|
+
* // ```
|
|
6133
|
+
* // - Install the npm module by running:
|
|
6134
|
+
* // ```sh
|
|
6135
|
+
* // $ npm install googleapis
|
|
6136
|
+
* // ```
|
|
6137
|
+
*
|
|
6138
|
+
* const {google} = require('googleapis');
|
|
6139
|
+
* const alloydb = google.alloydb('v1');
|
|
6140
|
+
*
|
|
6141
|
+
* async function main() {
|
|
6142
|
+
* const auth = new google.auth.GoogleAuth({
|
|
6143
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
6144
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
6145
|
+
* });
|
|
6146
|
+
*
|
|
6147
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
6148
|
+
* const authClient = await auth.getClient();
|
|
6149
|
+
* google.options({auth: authClient});
|
|
6150
|
+
*
|
|
6151
|
+
* // Do the magic
|
|
6152
|
+
* const res =
|
|
6153
|
+
* await alloydb.projects.locations.clusters.instances.createsecondary({
|
|
6154
|
+
* // Required. ID of the requesting object.
|
|
6155
|
+
* instanceId: 'placeholder-value',
|
|
6156
|
+
* // Required. The name of the parent resource. For the required format, see the comment on the Instance.name field.
|
|
6157
|
+
* parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
|
|
6158
|
+
* // 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).
|
|
6159
|
+
* requestId: 'placeholder-value',
|
|
6160
|
+
* // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
|
|
6161
|
+
* validateOnly: 'placeholder-value',
|
|
6162
|
+
*
|
|
6163
|
+
* // Request body metadata
|
|
6164
|
+
* requestBody: {
|
|
6165
|
+
* // request body parameters
|
|
6166
|
+
* // {
|
|
6167
|
+
* // "activationPolicy": "my_activationPolicy",
|
|
6168
|
+
* // "annotations": {},
|
|
6169
|
+
* // "availabilityType": "my_availabilityType",
|
|
6170
|
+
* // "clientConnectionConfig": {},
|
|
6171
|
+
* // "createTime": "my_createTime",
|
|
6172
|
+
* // "databaseFlags": {},
|
|
6173
|
+
* // "deleteTime": "my_deleteTime",
|
|
6174
|
+
* // "displayName": "my_displayName",
|
|
6175
|
+
* // "etag": "my_etag",
|
|
6176
|
+
* // "gceZone": "my_gceZone",
|
|
6177
|
+
* // "instanceType": "my_instanceType",
|
|
6178
|
+
* // "ipAddress": "my_ipAddress",
|
|
6179
|
+
* // "labels": {},
|
|
6180
|
+
* // "machineConfig": {},
|
|
6181
|
+
* // "name": "my_name",
|
|
6182
|
+
* // "networkConfig": {},
|
|
6183
|
+
* // "nodes": [],
|
|
6184
|
+
* // "observabilityConfig": {},
|
|
6185
|
+
* // "outboundPublicIpAddresses": [],
|
|
6186
|
+
* // "pscInstanceConfig": {},
|
|
6187
|
+
* // "publicIpAddress": "my_publicIpAddress",
|
|
6188
|
+
* // "queryInsightsConfig": {},
|
|
6189
|
+
* // "readPoolConfig": {},
|
|
6190
|
+
* // "reconciling": false,
|
|
6191
|
+
* // "satisfiesPzs": false,
|
|
6192
|
+
* // "state": "my_state",
|
|
6193
|
+
* // "uid": "my_uid",
|
|
6194
|
+
* // "updateTime": "my_updateTime",
|
|
6195
|
+
* // "writableNode": {}
|
|
6196
|
+
* // }
|
|
6197
|
+
* },
|
|
6198
|
+
* });
|
|
6199
|
+
* console.log(res.data);
|
|
6200
|
+
*
|
|
6201
|
+
* // Example response
|
|
6202
|
+
* // {
|
|
6203
|
+
* // "done": false,
|
|
6204
|
+
* // "error": {},
|
|
6205
|
+
* // "metadata": {},
|
|
6206
|
+
* // "name": "my_name",
|
|
6207
|
+
* // "response": {}
|
|
6208
|
+
* // }
|
|
6209
|
+
* }
|
|
6210
|
+
*
|
|
6211
|
+
* main().catch(e => {
|
|
6212
|
+
* console.error(e);
|
|
6213
|
+
* throw e;
|
|
6214
|
+
* });
|
|
6215
|
+
*
|
|
6216
|
+
* ```
|
|
4648
6217
|
*
|
|
4649
6218
|
* @param params - Parameters for request
|
|
4650
6219
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -4737,6 +6306,62 @@ export namespace alloydb_v1 {
|
|
|
4737
6306
|
|
|
4738
6307
|
/**
|
|
4739
6308
|
* Deletes a single Instance.
|
|
6309
|
+
* @example
|
|
6310
|
+
* ```js
|
|
6311
|
+
* // Before running the sample:
|
|
6312
|
+
* // - Enable the API at:
|
|
6313
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
6314
|
+
* // - Login into gcloud by running:
|
|
6315
|
+
* // ```sh
|
|
6316
|
+
* // $ gcloud auth application-default login
|
|
6317
|
+
* // ```
|
|
6318
|
+
* // - Install the npm module by running:
|
|
6319
|
+
* // ```sh
|
|
6320
|
+
* // $ npm install googleapis
|
|
6321
|
+
* // ```
|
|
6322
|
+
*
|
|
6323
|
+
* const {google} = require('googleapis');
|
|
6324
|
+
* const alloydb = google.alloydb('v1');
|
|
6325
|
+
*
|
|
6326
|
+
* async function main() {
|
|
6327
|
+
* const auth = new google.auth.GoogleAuth({
|
|
6328
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
6329
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
6330
|
+
* });
|
|
6331
|
+
*
|
|
6332
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
6333
|
+
* const authClient = await auth.getClient();
|
|
6334
|
+
* google.options({auth: authClient});
|
|
6335
|
+
*
|
|
6336
|
+
* // Do the magic
|
|
6337
|
+
* const res = await alloydb.projects.locations.clusters.instances.delete({
|
|
6338
|
+
* // Optional. The current etag of the Instance. If an etag is provided and does not match the current etag of the Instance, deletion will be blocked and an ABORTED error will be returned.
|
|
6339
|
+
* etag: 'placeholder-value',
|
|
6340
|
+
* // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
|
|
6341
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
|
|
6342
|
+
* // 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).
|
|
6343
|
+
* requestId: 'placeholder-value',
|
|
6344
|
+
* // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
|
|
6345
|
+
* validateOnly: 'placeholder-value',
|
|
6346
|
+
* });
|
|
6347
|
+
* console.log(res.data);
|
|
6348
|
+
*
|
|
6349
|
+
* // Example response
|
|
6350
|
+
* // {
|
|
6351
|
+
* // "done": false,
|
|
6352
|
+
* // "error": {},
|
|
6353
|
+
* // "metadata": {},
|
|
6354
|
+
* // "name": "my_name",
|
|
6355
|
+
* // "response": {}
|
|
6356
|
+
* // }
|
|
6357
|
+
* }
|
|
6358
|
+
*
|
|
6359
|
+
* main().catch(e => {
|
|
6360
|
+
* console.error(e);
|
|
6361
|
+
* throw e;
|
|
6362
|
+
* });
|
|
6363
|
+
*
|
|
6364
|
+
* ```
|
|
4740
6365
|
*
|
|
4741
6366
|
* @param params - Parameters for request
|
|
4742
6367
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -4826,6 +6451,65 @@ export namespace alloydb_v1 {
|
|
|
4826
6451
|
|
|
4827
6452
|
/**
|
|
4828
6453
|
* Forces a Failover for a highly available instance. Failover promotes the HA standby instance as the new primary. Imperative only.
|
|
6454
|
+
* @example
|
|
6455
|
+
* ```js
|
|
6456
|
+
* // Before running the sample:
|
|
6457
|
+
* // - Enable the API at:
|
|
6458
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
6459
|
+
* // - Login into gcloud by running:
|
|
6460
|
+
* // ```sh
|
|
6461
|
+
* // $ gcloud auth application-default login
|
|
6462
|
+
* // ```
|
|
6463
|
+
* // - Install the npm module by running:
|
|
6464
|
+
* // ```sh
|
|
6465
|
+
* // $ npm install googleapis
|
|
6466
|
+
* // ```
|
|
6467
|
+
*
|
|
6468
|
+
* const {google} = require('googleapis');
|
|
6469
|
+
* const alloydb = google.alloydb('v1');
|
|
6470
|
+
*
|
|
6471
|
+
* async function main() {
|
|
6472
|
+
* const auth = new google.auth.GoogleAuth({
|
|
6473
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
6474
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
6475
|
+
* });
|
|
6476
|
+
*
|
|
6477
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
6478
|
+
* const authClient = await auth.getClient();
|
|
6479
|
+
* google.options({auth: authClient});
|
|
6480
|
+
*
|
|
6481
|
+
* // Do the magic
|
|
6482
|
+
* const res = await alloydb.projects.locations.clusters.instances.failover({
|
|
6483
|
+
* // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
|
|
6484
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
|
|
6485
|
+
*
|
|
6486
|
+
* // Request body metadata
|
|
6487
|
+
* requestBody: {
|
|
6488
|
+
* // request body parameters
|
|
6489
|
+
* // {
|
|
6490
|
+
* // "requestId": "my_requestId",
|
|
6491
|
+
* // "validateOnly": false
|
|
6492
|
+
* // }
|
|
6493
|
+
* },
|
|
6494
|
+
* });
|
|
6495
|
+
* console.log(res.data);
|
|
6496
|
+
*
|
|
6497
|
+
* // Example response
|
|
6498
|
+
* // {
|
|
6499
|
+
* // "done": false,
|
|
6500
|
+
* // "error": {},
|
|
6501
|
+
* // "metadata": {},
|
|
6502
|
+
* // "name": "my_name",
|
|
6503
|
+
* // "response": {}
|
|
6504
|
+
* // }
|
|
6505
|
+
* }
|
|
6506
|
+
*
|
|
6507
|
+
* main().catch(e => {
|
|
6508
|
+
* console.error(e);
|
|
6509
|
+
* throw e;
|
|
6510
|
+
* });
|
|
6511
|
+
*
|
|
6512
|
+
* ```
|
|
4829
6513
|
*
|
|
4830
6514
|
* @param params - Parameters for request
|
|
4831
6515
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -4918,6 +6602,82 @@ export namespace alloydb_v1 {
|
|
|
4918
6602
|
|
|
4919
6603
|
/**
|
|
4920
6604
|
* Gets details of a single Instance.
|
|
6605
|
+
* @example
|
|
6606
|
+
* ```js
|
|
6607
|
+
* // Before running the sample:
|
|
6608
|
+
* // - Enable the API at:
|
|
6609
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
6610
|
+
* // - Login into gcloud by running:
|
|
6611
|
+
* // ```sh
|
|
6612
|
+
* // $ gcloud auth application-default login
|
|
6613
|
+
* // ```
|
|
6614
|
+
* // - Install the npm module by running:
|
|
6615
|
+
* // ```sh
|
|
6616
|
+
* // $ npm install googleapis
|
|
6617
|
+
* // ```
|
|
6618
|
+
*
|
|
6619
|
+
* const {google} = require('googleapis');
|
|
6620
|
+
* const alloydb = google.alloydb('v1');
|
|
6621
|
+
*
|
|
6622
|
+
* async function main() {
|
|
6623
|
+
* const auth = new google.auth.GoogleAuth({
|
|
6624
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
6625
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
6626
|
+
* });
|
|
6627
|
+
*
|
|
6628
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
6629
|
+
* const authClient = await auth.getClient();
|
|
6630
|
+
* google.options({auth: authClient});
|
|
6631
|
+
*
|
|
6632
|
+
* // Do the magic
|
|
6633
|
+
* const res = await alloydb.projects.locations.clusters.instances.get({
|
|
6634
|
+
* // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
|
|
6635
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
|
|
6636
|
+
* // The view of the instance to return.
|
|
6637
|
+
* view: 'placeholder-value',
|
|
6638
|
+
* });
|
|
6639
|
+
* console.log(res.data);
|
|
6640
|
+
*
|
|
6641
|
+
* // Example response
|
|
6642
|
+
* // {
|
|
6643
|
+
* // "activationPolicy": "my_activationPolicy",
|
|
6644
|
+
* // "annotations": {},
|
|
6645
|
+
* // "availabilityType": "my_availabilityType",
|
|
6646
|
+
* // "clientConnectionConfig": {},
|
|
6647
|
+
* // "createTime": "my_createTime",
|
|
6648
|
+
* // "databaseFlags": {},
|
|
6649
|
+
* // "deleteTime": "my_deleteTime",
|
|
6650
|
+
* // "displayName": "my_displayName",
|
|
6651
|
+
* // "etag": "my_etag",
|
|
6652
|
+
* // "gceZone": "my_gceZone",
|
|
6653
|
+
* // "instanceType": "my_instanceType",
|
|
6654
|
+
* // "ipAddress": "my_ipAddress",
|
|
6655
|
+
* // "labels": {},
|
|
6656
|
+
* // "machineConfig": {},
|
|
6657
|
+
* // "name": "my_name",
|
|
6658
|
+
* // "networkConfig": {},
|
|
6659
|
+
* // "nodes": [],
|
|
6660
|
+
* // "observabilityConfig": {},
|
|
6661
|
+
* // "outboundPublicIpAddresses": [],
|
|
6662
|
+
* // "pscInstanceConfig": {},
|
|
6663
|
+
* // "publicIpAddress": "my_publicIpAddress",
|
|
6664
|
+
* // "queryInsightsConfig": {},
|
|
6665
|
+
* // "readPoolConfig": {},
|
|
6666
|
+
* // "reconciling": false,
|
|
6667
|
+
* // "satisfiesPzs": false,
|
|
6668
|
+
* // "state": "my_state",
|
|
6669
|
+
* // "uid": "my_uid",
|
|
6670
|
+
* // "updateTime": "my_updateTime",
|
|
6671
|
+
* // "writableNode": {}
|
|
6672
|
+
* // }
|
|
6673
|
+
* }
|
|
6674
|
+
*
|
|
6675
|
+
* main().catch(e => {
|
|
6676
|
+
* console.error(e);
|
|
6677
|
+
* throw e;
|
|
6678
|
+
* });
|
|
6679
|
+
*
|
|
6680
|
+
* ```
|
|
4921
6681
|
*
|
|
4922
6682
|
* @param params - Parameters for request
|
|
4923
6683
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -5007,6 +6767,59 @@ export namespace alloydb_v1 {
|
|
|
5007
6767
|
|
|
5008
6768
|
/**
|
|
5009
6769
|
* Get instance metadata used for a connection.
|
|
6770
|
+
* @example
|
|
6771
|
+
* ```js
|
|
6772
|
+
* // Before running the sample:
|
|
6773
|
+
* // - Enable the API at:
|
|
6774
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
6775
|
+
* // - Login into gcloud by running:
|
|
6776
|
+
* // ```sh
|
|
6777
|
+
* // $ gcloud auth application-default login
|
|
6778
|
+
* // ```
|
|
6779
|
+
* // - Install the npm module by running:
|
|
6780
|
+
* // ```sh
|
|
6781
|
+
* // $ npm install googleapis
|
|
6782
|
+
* // ```
|
|
6783
|
+
*
|
|
6784
|
+
* const {google} = require('googleapis');
|
|
6785
|
+
* const alloydb = google.alloydb('v1');
|
|
6786
|
+
*
|
|
6787
|
+
* async function main() {
|
|
6788
|
+
* const auth = new google.auth.GoogleAuth({
|
|
6789
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
6790
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
6791
|
+
* });
|
|
6792
|
+
*
|
|
6793
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
6794
|
+
* const authClient = await auth.getClient();
|
|
6795
|
+
* google.options({auth: authClient});
|
|
6796
|
+
*
|
|
6797
|
+
* // Do the magic
|
|
6798
|
+
* const res =
|
|
6799
|
+
* await alloydb.projects.locations.clusters.instances.getConnectionInfo({
|
|
6800
|
+
* // Required. The name of the parent resource. The required format is: projects/{project\}/locations/{location\}/clusters/{cluster\}/instances/{instance\}
|
|
6801
|
+
* parent:
|
|
6802
|
+
* 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
|
|
6803
|
+
* // 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).
|
|
6804
|
+
* requestId: 'placeholder-value',
|
|
6805
|
+
* });
|
|
6806
|
+
* console.log(res.data);
|
|
6807
|
+
*
|
|
6808
|
+
* // Example response
|
|
6809
|
+
* // {
|
|
6810
|
+
* // "instanceUid": "my_instanceUid",
|
|
6811
|
+
* // "ipAddress": "my_ipAddress",
|
|
6812
|
+
* // "name": "my_name",
|
|
6813
|
+
* // "publicIpAddress": "my_publicIpAddress"
|
|
6814
|
+
* // }
|
|
6815
|
+
* }
|
|
6816
|
+
*
|
|
6817
|
+
* main().catch(e => {
|
|
6818
|
+
* console.error(e);
|
|
6819
|
+
* throw e;
|
|
6820
|
+
* });
|
|
6821
|
+
*
|
|
6822
|
+
* ```
|
|
5010
6823
|
*
|
|
5011
6824
|
* @param params - Parameters for request
|
|
5012
6825
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -5101,6 +6914,66 @@ export namespace alloydb_v1 {
|
|
|
5101
6914
|
|
|
5102
6915
|
/**
|
|
5103
6916
|
* Injects fault in an instance. Imperative only.
|
|
6917
|
+
* @example
|
|
6918
|
+
* ```js
|
|
6919
|
+
* // Before running the sample:
|
|
6920
|
+
* // - Enable the API at:
|
|
6921
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
6922
|
+
* // - Login into gcloud by running:
|
|
6923
|
+
* // ```sh
|
|
6924
|
+
* // $ gcloud auth application-default login
|
|
6925
|
+
* // ```
|
|
6926
|
+
* // - Install the npm module by running:
|
|
6927
|
+
* // ```sh
|
|
6928
|
+
* // $ npm install googleapis
|
|
6929
|
+
* // ```
|
|
6930
|
+
*
|
|
6931
|
+
* const {google} = require('googleapis');
|
|
6932
|
+
* const alloydb = google.alloydb('v1');
|
|
6933
|
+
*
|
|
6934
|
+
* async function main() {
|
|
6935
|
+
* const auth = new google.auth.GoogleAuth({
|
|
6936
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
6937
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
6938
|
+
* });
|
|
6939
|
+
*
|
|
6940
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
6941
|
+
* const authClient = await auth.getClient();
|
|
6942
|
+
* google.options({auth: authClient});
|
|
6943
|
+
*
|
|
6944
|
+
* // Do the magic
|
|
6945
|
+
* const res = await alloydb.projects.locations.clusters.instances.injectFault({
|
|
6946
|
+
* // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
|
|
6947
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
|
|
6948
|
+
*
|
|
6949
|
+
* // Request body metadata
|
|
6950
|
+
* requestBody: {
|
|
6951
|
+
* // request body parameters
|
|
6952
|
+
* // {
|
|
6953
|
+
* // "faultType": "my_faultType",
|
|
6954
|
+
* // "requestId": "my_requestId",
|
|
6955
|
+
* // "validateOnly": false
|
|
6956
|
+
* // }
|
|
6957
|
+
* },
|
|
6958
|
+
* });
|
|
6959
|
+
* console.log(res.data);
|
|
6960
|
+
*
|
|
6961
|
+
* // Example response
|
|
6962
|
+
* // {
|
|
6963
|
+
* // "done": false,
|
|
6964
|
+
* // "error": {},
|
|
6965
|
+
* // "metadata": {},
|
|
6966
|
+
* // "name": "my_name",
|
|
6967
|
+
* // "response": {}
|
|
6968
|
+
* // }
|
|
6969
|
+
* }
|
|
6970
|
+
*
|
|
6971
|
+
* main().catch(e => {
|
|
6972
|
+
* console.error(e);
|
|
6973
|
+
* throw e;
|
|
6974
|
+
* });
|
|
6975
|
+
*
|
|
6976
|
+
* ```
|
|
5104
6977
|
*
|
|
5105
6978
|
* @param params - Parameters for request
|
|
5106
6979
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -5193,6 +7066,62 @@ export namespace alloydb_v1 {
|
|
|
5193
7066
|
|
|
5194
7067
|
/**
|
|
5195
7068
|
* Lists Instances in a given project and location.
|
|
7069
|
+
* @example
|
|
7070
|
+
* ```js
|
|
7071
|
+
* // Before running the sample:
|
|
7072
|
+
* // - Enable the API at:
|
|
7073
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
7074
|
+
* // - Login into gcloud by running:
|
|
7075
|
+
* // ```sh
|
|
7076
|
+
* // $ gcloud auth application-default login
|
|
7077
|
+
* // ```
|
|
7078
|
+
* // - Install the npm module by running:
|
|
7079
|
+
* // ```sh
|
|
7080
|
+
* // $ npm install googleapis
|
|
7081
|
+
* // ```
|
|
7082
|
+
*
|
|
7083
|
+
* const {google} = require('googleapis');
|
|
7084
|
+
* const alloydb = google.alloydb('v1');
|
|
7085
|
+
*
|
|
7086
|
+
* async function main() {
|
|
7087
|
+
* const auth = new google.auth.GoogleAuth({
|
|
7088
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
7089
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
7090
|
+
* });
|
|
7091
|
+
*
|
|
7092
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
7093
|
+
* const authClient = await auth.getClient();
|
|
7094
|
+
* google.options({auth: authClient});
|
|
7095
|
+
*
|
|
7096
|
+
* // Do the magic
|
|
7097
|
+
* const res = await alloydb.projects.locations.clusters.instances.list({
|
|
7098
|
+
* // Optional. Filtering results
|
|
7099
|
+
* filter: 'placeholder-value',
|
|
7100
|
+
* // Optional. Hint for how to order the results
|
|
7101
|
+
* orderBy: 'placeholder-value',
|
|
7102
|
+
* // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
|
|
7103
|
+
* pageSize: 'placeholder-value',
|
|
7104
|
+
* // A token identifying a page of results the server should return.
|
|
7105
|
+
* pageToken: 'placeholder-value',
|
|
7106
|
+
* // Required. The name of the parent resource. For the required format, see the comment on the Instance.name field. Additionally, you can perform an aggregated list operation by specifying a value with one of the following formats: * projects/{project\}/locations/-/clusters/- * projects/{project\}/locations/{region\}/clusters/-
|
|
7107
|
+
* parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
|
|
7108
|
+
* });
|
|
7109
|
+
* console.log(res.data);
|
|
7110
|
+
*
|
|
7111
|
+
* // Example response
|
|
7112
|
+
* // {
|
|
7113
|
+
* // "instances": [],
|
|
7114
|
+
* // "nextPageToken": "my_nextPageToken",
|
|
7115
|
+
* // "unreachable": []
|
|
7116
|
+
* // }
|
|
7117
|
+
* }
|
|
7118
|
+
*
|
|
7119
|
+
* main().catch(e => {
|
|
7120
|
+
* console.error(e);
|
|
7121
|
+
* throw e;
|
|
7122
|
+
* });
|
|
7123
|
+
*
|
|
7124
|
+
* ```
|
|
5196
7125
|
*
|
|
5197
7126
|
* @param params - Parameters for request
|
|
5198
7127
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -5287,6 +7216,100 @@ export namespace alloydb_v1 {
|
|
|
5287
7216
|
|
|
5288
7217
|
/**
|
|
5289
7218
|
* Updates the parameters of a single Instance.
|
|
7219
|
+
* @example
|
|
7220
|
+
* ```js
|
|
7221
|
+
* // Before running the sample:
|
|
7222
|
+
* // - Enable the API at:
|
|
7223
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
7224
|
+
* // - Login into gcloud by running:
|
|
7225
|
+
* // ```sh
|
|
7226
|
+
* // $ gcloud auth application-default login
|
|
7227
|
+
* // ```
|
|
7228
|
+
* // - Install the npm module by running:
|
|
7229
|
+
* // ```sh
|
|
7230
|
+
* // $ npm install googleapis
|
|
7231
|
+
* // ```
|
|
7232
|
+
*
|
|
7233
|
+
* const {google} = require('googleapis');
|
|
7234
|
+
* const alloydb = google.alloydb('v1');
|
|
7235
|
+
*
|
|
7236
|
+
* async function main() {
|
|
7237
|
+
* const auth = new google.auth.GoogleAuth({
|
|
7238
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
7239
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
7240
|
+
* });
|
|
7241
|
+
*
|
|
7242
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
7243
|
+
* const authClient = await auth.getClient();
|
|
7244
|
+
* google.options({auth: authClient});
|
|
7245
|
+
*
|
|
7246
|
+
* // Do the magic
|
|
7247
|
+
* const res = await alloydb.projects.locations.clusters.instances.patch({
|
|
7248
|
+
* // Optional. If set to true, update succeeds even if instance is not found. In that case, a new instance is created and `update_mask` is ignored.
|
|
7249
|
+
* allowMissing: 'placeholder-value',
|
|
7250
|
+
* // Output only. The name of the instance resource with the format: * projects/{project\}/locations/{region\}/clusters/{cluster_id\}/instances/{instance_id\} where the cluster and instance ID segments should satisfy the regex expression `[a-z]([a-z0-9-]{0,61\}[a-z0-9])?`, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project\}/locations/{region\}/clusters/{cluster_id\}
|
|
7251
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
|
|
7252
|
+
* // 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).
|
|
7253
|
+
* requestId: 'placeholder-value',
|
|
7254
|
+
* // Optional. Field mask is used to specify the fields to be overwritten in the Instance 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.
|
|
7255
|
+
* updateMask: 'placeholder-value',
|
|
7256
|
+
* // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
|
|
7257
|
+
* validateOnly: 'placeholder-value',
|
|
7258
|
+
*
|
|
7259
|
+
* // Request body metadata
|
|
7260
|
+
* requestBody: {
|
|
7261
|
+
* // request body parameters
|
|
7262
|
+
* // {
|
|
7263
|
+
* // "activationPolicy": "my_activationPolicy",
|
|
7264
|
+
* // "annotations": {},
|
|
7265
|
+
* // "availabilityType": "my_availabilityType",
|
|
7266
|
+
* // "clientConnectionConfig": {},
|
|
7267
|
+
* // "createTime": "my_createTime",
|
|
7268
|
+
* // "databaseFlags": {},
|
|
7269
|
+
* // "deleteTime": "my_deleteTime",
|
|
7270
|
+
* // "displayName": "my_displayName",
|
|
7271
|
+
* // "etag": "my_etag",
|
|
7272
|
+
* // "gceZone": "my_gceZone",
|
|
7273
|
+
* // "instanceType": "my_instanceType",
|
|
7274
|
+
* // "ipAddress": "my_ipAddress",
|
|
7275
|
+
* // "labels": {},
|
|
7276
|
+
* // "machineConfig": {},
|
|
7277
|
+
* // "name": "my_name",
|
|
7278
|
+
* // "networkConfig": {},
|
|
7279
|
+
* // "nodes": [],
|
|
7280
|
+
* // "observabilityConfig": {},
|
|
7281
|
+
* // "outboundPublicIpAddresses": [],
|
|
7282
|
+
* // "pscInstanceConfig": {},
|
|
7283
|
+
* // "publicIpAddress": "my_publicIpAddress",
|
|
7284
|
+
* // "queryInsightsConfig": {},
|
|
7285
|
+
* // "readPoolConfig": {},
|
|
7286
|
+
* // "reconciling": false,
|
|
7287
|
+
* // "satisfiesPzs": false,
|
|
7288
|
+
* // "state": "my_state",
|
|
7289
|
+
* // "uid": "my_uid",
|
|
7290
|
+
* // "updateTime": "my_updateTime",
|
|
7291
|
+
* // "writableNode": {}
|
|
7292
|
+
* // }
|
|
7293
|
+
* },
|
|
7294
|
+
* });
|
|
7295
|
+
* console.log(res.data);
|
|
7296
|
+
*
|
|
7297
|
+
* // Example response
|
|
7298
|
+
* // {
|
|
7299
|
+
* // "done": false,
|
|
7300
|
+
* // "error": {},
|
|
7301
|
+
* // "metadata": {},
|
|
7302
|
+
* // "name": "my_name",
|
|
7303
|
+
* // "response": {}
|
|
7304
|
+
* // }
|
|
7305
|
+
* }
|
|
7306
|
+
*
|
|
7307
|
+
* main().catch(e => {
|
|
7308
|
+
* console.error(e);
|
|
7309
|
+
* throw e;
|
|
7310
|
+
* });
|
|
7311
|
+
*
|
|
7312
|
+
* ```
|
|
5290
7313
|
*
|
|
5291
7314
|
* @param params - Parameters for request
|
|
5292
7315
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -5376,6 +7399,66 @@ export namespace alloydb_v1 {
|
|
|
5376
7399
|
|
|
5377
7400
|
/**
|
|
5378
7401
|
* Restart an Instance in a cluster. Imperative only.
|
|
7402
|
+
* @example
|
|
7403
|
+
* ```js
|
|
7404
|
+
* // Before running the sample:
|
|
7405
|
+
* // - Enable the API at:
|
|
7406
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
7407
|
+
* // - Login into gcloud by running:
|
|
7408
|
+
* // ```sh
|
|
7409
|
+
* // $ gcloud auth application-default login
|
|
7410
|
+
* // ```
|
|
7411
|
+
* // - Install the npm module by running:
|
|
7412
|
+
* // ```sh
|
|
7413
|
+
* // $ npm install googleapis
|
|
7414
|
+
* // ```
|
|
7415
|
+
*
|
|
7416
|
+
* const {google} = require('googleapis');
|
|
7417
|
+
* const alloydb = google.alloydb('v1');
|
|
7418
|
+
*
|
|
7419
|
+
* async function main() {
|
|
7420
|
+
* const auth = new google.auth.GoogleAuth({
|
|
7421
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
7422
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
7423
|
+
* });
|
|
7424
|
+
*
|
|
7425
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
7426
|
+
* const authClient = await auth.getClient();
|
|
7427
|
+
* google.options({auth: authClient});
|
|
7428
|
+
*
|
|
7429
|
+
* // Do the magic
|
|
7430
|
+
* const res = await alloydb.projects.locations.clusters.instances.restart({
|
|
7431
|
+
* // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
|
|
7432
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
|
|
7433
|
+
*
|
|
7434
|
+
* // Request body metadata
|
|
7435
|
+
* requestBody: {
|
|
7436
|
+
* // request body parameters
|
|
7437
|
+
* // {
|
|
7438
|
+
* // "nodeIds": [],
|
|
7439
|
+
* // "requestId": "my_requestId",
|
|
7440
|
+
* // "validateOnly": false
|
|
7441
|
+
* // }
|
|
7442
|
+
* },
|
|
7443
|
+
* });
|
|
7444
|
+
* console.log(res.data);
|
|
7445
|
+
*
|
|
7446
|
+
* // Example response
|
|
7447
|
+
* // {
|
|
7448
|
+
* // "done": false,
|
|
7449
|
+
* // "error": {},
|
|
7450
|
+
* // "metadata": {},
|
|
7451
|
+
* // "name": "my_name",
|
|
7452
|
+
* // "response": {}
|
|
7453
|
+
* // }
|
|
7454
|
+
* }
|
|
7455
|
+
*
|
|
7456
|
+
* main().catch(e => {
|
|
7457
|
+
* console.error(e);
|
|
7458
|
+
* throw e;
|
|
7459
|
+
* });
|
|
7460
|
+
*
|
|
7461
|
+
* ```
|
|
5379
7462
|
*
|
|
5380
7463
|
* @param params - Parameters for request
|
|
5381
7464
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -5652,6 +7735,74 @@ export namespace alloydb_v1 {
|
|
|
5652
7735
|
|
|
5653
7736
|
/**
|
|
5654
7737
|
* Creates a new User in a given project, location, and cluster.
|
|
7738
|
+
* @example
|
|
7739
|
+
* ```js
|
|
7740
|
+
* // Before running the sample:
|
|
7741
|
+
* // - Enable the API at:
|
|
7742
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
7743
|
+
* // - Login into gcloud by running:
|
|
7744
|
+
* // ```sh
|
|
7745
|
+
* // $ gcloud auth application-default login
|
|
7746
|
+
* // ```
|
|
7747
|
+
* // - Install the npm module by running:
|
|
7748
|
+
* // ```sh
|
|
7749
|
+
* // $ npm install googleapis
|
|
7750
|
+
* // ```
|
|
7751
|
+
*
|
|
7752
|
+
* const {google} = require('googleapis');
|
|
7753
|
+
* const alloydb = google.alloydb('v1');
|
|
7754
|
+
*
|
|
7755
|
+
* async function main() {
|
|
7756
|
+
* const auth = new google.auth.GoogleAuth({
|
|
7757
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
7758
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
7759
|
+
* });
|
|
7760
|
+
*
|
|
7761
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
7762
|
+
* const authClient = await auth.getClient();
|
|
7763
|
+
* google.options({auth: authClient});
|
|
7764
|
+
*
|
|
7765
|
+
* // Do the magic
|
|
7766
|
+
* const res = await alloydb.projects.locations.clusters.users.create({
|
|
7767
|
+
* // Required. Value for parent.
|
|
7768
|
+
* parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
|
|
7769
|
+
* // 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).
|
|
7770
|
+
* requestId: 'placeholder-value',
|
|
7771
|
+
* // Required. ID of the requesting object.
|
|
7772
|
+
* userId: 'placeholder-value',
|
|
7773
|
+
* // Optional. If set, the backend validates the request, but doesn't actually execute it.
|
|
7774
|
+
* validateOnly: 'placeholder-value',
|
|
7775
|
+
*
|
|
7776
|
+
* // Request body metadata
|
|
7777
|
+
* requestBody: {
|
|
7778
|
+
* // request body parameters
|
|
7779
|
+
* // {
|
|
7780
|
+
* // "databaseRoles": [],
|
|
7781
|
+
* // "keepExtraRoles": false,
|
|
7782
|
+
* // "name": "my_name",
|
|
7783
|
+
* // "password": "my_password",
|
|
7784
|
+
* // "userType": "my_userType"
|
|
7785
|
+
* // }
|
|
7786
|
+
* },
|
|
7787
|
+
* });
|
|
7788
|
+
* console.log(res.data);
|
|
7789
|
+
*
|
|
7790
|
+
* // Example response
|
|
7791
|
+
* // {
|
|
7792
|
+
* // "databaseRoles": [],
|
|
7793
|
+
* // "keepExtraRoles": false,
|
|
7794
|
+
* // "name": "my_name",
|
|
7795
|
+
* // "password": "my_password",
|
|
7796
|
+
* // "userType": "my_userType"
|
|
7797
|
+
* // }
|
|
7798
|
+
* }
|
|
7799
|
+
*
|
|
7800
|
+
* main().catch(e => {
|
|
7801
|
+
* console.error(e);
|
|
7802
|
+
* throw e;
|
|
7803
|
+
* });
|
|
7804
|
+
*
|
|
7805
|
+
* ```
|
|
5655
7806
|
*
|
|
5656
7807
|
* @param params - Parameters for request
|
|
5657
7808
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -5743,6 +7894,54 @@ export namespace alloydb_v1 {
|
|
|
5743
7894
|
|
|
5744
7895
|
/**
|
|
5745
7896
|
* Deletes a single User.
|
|
7897
|
+
* @example
|
|
7898
|
+
* ```js
|
|
7899
|
+
* // Before running the sample:
|
|
7900
|
+
* // - Enable the API at:
|
|
7901
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
7902
|
+
* // - Login into gcloud by running:
|
|
7903
|
+
* // ```sh
|
|
7904
|
+
* // $ gcloud auth application-default login
|
|
7905
|
+
* // ```
|
|
7906
|
+
* // - Install the npm module by running:
|
|
7907
|
+
* // ```sh
|
|
7908
|
+
* // $ npm install googleapis
|
|
7909
|
+
* // ```
|
|
7910
|
+
*
|
|
7911
|
+
* const {google} = require('googleapis');
|
|
7912
|
+
* const alloydb = google.alloydb('v1');
|
|
7913
|
+
*
|
|
7914
|
+
* async function main() {
|
|
7915
|
+
* const auth = new google.auth.GoogleAuth({
|
|
7916
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
7917
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
7918
|
+
* });
|
|
7919
|
+
*
|
|
7920
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
7921
|
+
* const authClient = await auth.getClient();
|
|
7922
|
+
* google.options({auth: authClient});
|
|
7923
|
+
*
|
|
7924
|
+
* // Do the magic
|
|
7925
|
+
* const res = await alloydb.projects.locations.clusters.users.delete({
|
|
7926
|
+
* // Required. The name of the resource. For the required format, see the comment on the User.name field.
|
|
7927
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster/users/my-user',
|
|
7928
|
+
* // 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).
|
|
7929
|
+
* requestId: 'placeholder-value',
|
|
7930
|
+
* // Optional. If set, the backend validates the request, but doesn't actually execute it.
|
|
7931
|
+
* validateOnly: 'placeholder-value',
|
|
7932
|
+
* });
|
|
7933
|
+
* console.log(res.data);
|
|
7934
|
+
*
|
|
7935
|
+
* // Example response
|
|
7936
|
+
* // {}
|
|
7937
|
+
* }
|
|
7938
|
+
*
|
|
7939
|
+
* main().catch(e => {
|
|
7940
|
+
* console.error(e);
|
|
7941
|
+
* throw e;
|
|
7942
|
+
* });
|
|
7943
|
+
*
|
|
7944
|
+
* ```
|
|
5746
7945
|
*
|
|
5747
7946
|
* @param params - Parameters for request
|
|
5748
7947
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -5831,6 +8030,56 @@ export namespace alloydb_v1 {
|
|
|
5831
8030
|
|
|
5832
8031
|
/**
|
|
5833
8032
|
* Gets details of a single User.
|
|
8033
|
+
* @example
|
|
8034
|
+
* ```js
|
|
8035
|
+
* // Before running the sample:
|
|
8036
|
+
* // - Enable the API at:
|
|
8037
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
8038
|
+
* // - Login into gcloud by running:
|
|
8039
|
+
* // ```sh
|
|
8040
|
+
* // $ gcloud auth application-default login
|
|
8041
|
+
* // ```
|
|
8042
|
+
* // - Install the npm module by running:
|
|
8043
|
+
* // ```sh
|
|
8044
|
+
* // $ npm install googleapis
|
|
8045
|
+
* // ```
|
|
8046
|
+
*
|
|
8047
|
+
* const {google} = require('googleapis');
|
|
8048
|
+
* const alloydb = google.alloydb('v1');
|
|
8049
|
+
*
|
|
8050
|
+
* async function main() {
|
|
8051
|
+
* const auth = new google.auth.GoogleAuth({
|
|
8052
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
8053
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
8054
|
+
* });
|
|
8055
|
+
*
|
|
8056
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
8057
|
+
* const authClient = await auth.getClient();
|
|
8058
|
+
* google.options({auth: authClient});
|
|
8059
|
+
*
|
|
8060
|
+
* // Do the magic
|
|
8061
|
+
* const res = await alloydb.projects.locations.clusters.users.get({
|
|
8062
|
+
* // Required. The name of the resource. For the required format, see the comment on the User.name field.
|
|
8063
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster/users/my-user',
|
|
8064
|
+
* });
|
|
8065
|
+
* console.log(res.data);
|
|
8066
|
+
*
|
|
8067
|
+
* // Example response
|
|
8068
|
+
* // {
|
|
8069
|
+
* // "databaseRoles": [],
|
|
8070
|
+
* // "keepExtraRoles": false,
|
|
8071
|
+
* // "name": "my_name",
|
|
8072
|
+
* // "password": "my_password",
|
|
8073
|
+
* // "userType": "my_userType"
|
|
8074
|
+
* // }
|
|
8075
|
+
* }
|
|
8076
|
+
*
|
|
8077
|
+
* main().catch(e => {
|
|
8078
|
+
* console.error(e);
|
|
8079
|
+
* throw e;
|
|
8080
|
+
* });
|
|
8081
|
+
*
|
|
8082
|
+
* ```
|
|
5834
8083
|
*
|
|
5835
8084
|
* @param params - Parameters for request
|
|
5836
8085
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -5919,6 +8168,62 @@ export namespace alloydb_v1 {
|
|
|
5919
8168
|
|
|
5920
8169
|
/**
|
|
5921
8170
|
* Lists Users in a given project and location.
|
|
8171
|
+
* @example
|
|
8172
|
+
* ```js
|
|
8173
|
+
* // Before running the sample:
|
|
8174
|
+
* // - Enable the API at:
|
|
8175
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
8176
|
+
* // - Login into gcloud by running:
|
|
8177
|
+
* // ```sh
|
|
8178
|
+
* // $ gcloud auth application-default login
|
|
8179
|
+
* // ```
|
|
8180
|
+
* // - Install the npm module by running:
|
|
8181
|
+
* // ```sh
|
|
8182
|
+
* // $ npm install googleapis
|
|
8183
|
+
* // ```
|
|
8184
|
+
*
|
|
8185
|
+
* const {google} = require('googleapis');
|
|
8186
|
+
* const alloydb = google.alloydb('v1');
|
|
8187
|
+
*
|
|
8188
|
+
* async function main() {
|
|
8189
|
+
* const auth = new google.auth.GoogleAuth({
|
|
8190
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
8191
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
8192
|
+
* });
|
|
8193
|
+
*
|
|
8194
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
8195
|
+
* const authClient = await auth.getClient();
|
|
8196
|
+
* google.options({auth: authClient});
|
|
8197
|
+
*
|
|
8198
|
+
* // Do the magic
|
|
8199
|
+
* const res = await alloydb.projects.locations.clusters.users.list({
|
|
8200
|
+
* // Optional. Filtering results
|
|
8201
|
+
* filter: 'placeholder-value',
|
|
8202
|
+
* // Optional. Hint for how to order the results
|
|
8203
|
+
* orderBy: 'placeholder-value',
|
|
8204
|
+
* // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
|
|
8205
|
+
* pageSize: 'placeholder-value',
|
|
8206
|
+
* // Optional. A token identifying a page of results the server should return.
|
|
8207
|
+
* pageToken: 'placeholder-value',
|
|
8208
|
+
* // Required. Parent value for ListUsersRequest
|
|
8209
|
+
* parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
|
|
8210
|
+
* });
|
|
8211
|
+
* console.log(res.data);
|
|
8212
|
+
*
|
|
8213
|
+
* // Example response
|
|
8214
|
+
* // {
|
|
8215
|
+
* // "nextPageToken": "my_nextPageToken",
|
|
8216
|
+
* // "unreachable": [],
|
|
8217
|
+
* // "users": []
|
|
8218
|
+
* // }
|
|
8219
|
+
* }
|
|
8220
|
+
*
|
|
8221
|
+
* main().catch(e => {
|
|
8222
|
+
* console.error(e);
|
|
8223
|
+
* throw e;
|
|
8224
|
+
* });
|
|
8225
|
+
*
|
|
8226
|
+
* ```
|
|
5922
8227
|
*
|
|
5923
8228
|
* @param params - Parameters for request
|
|
5924
8229
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -6010,6 +8315,76 @@ export namespace alloydb_v1 {
|
|
|
6010
8315
|
|
|
6011
8316
|
/**
|
|
6012
8317
|
* Updates the parameters of a single User.
|
|
8318
|
+
* @example
|
|
8319
|
+
* ```js
|
|
8320
|
+
* // Before running the sample:
|
|
8321
|
+
* // - Enable the API at:
|
|
8322
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
8323
|
+
* // - Login into gcloud by running:
|
|
8324
|
+
* // ```sh
|
|
8325
|
+
* // $ gcloud auth application-default login
|
|
8326
|
+
* // ```
|
|
8327
|
+
* // - Install the npm module by running:
|
|
8328
|
+
* // ```sh
|
|
8329
|
+
* // $ npm install googleapis
|
|
8330
|
+
* // ```
|
|
8331
|
+
*
|
|
8332
|
+
* const {google} = require('googleapis');
|
|
8333
|
+
* const alloydb = google.alloydb('v1');
|
|
8334
|
+
*
|
|
8335
|
+
* async function main() {
|
|
8336
|
+
* const auth = new google.auth.GoogleAuth({
|
|
8337
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
8338
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
8339
|
+
* });
|
|
8340
|
+
*
|
|
8341
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
8342
|
+
* const authClient = await auth.getClient();
|
|
8343
|
+
* google.options({auth: authClient});
|
|
8344
|
+
*
|
|
8345
|
+
* // Do the magic
|
|
8346
|
+
* const res = await alloydb.projects.locations.clusters.users.patch({
|
|
8347
|
+
* // Optional. Allow missing fields in the update mask.
|
|
8348
|
+
* allowMissing: 'placeholder-value',
|
|
8349
|
+
* // Output only. Name of the resource in the form of projects/{project\}/locations/{location\}/cluster/{cluster\}/users/{user\}.
|
|
8350
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster/users/my-user',
|
|
8351
|
+
* // 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).
|
|
8352
|
+
* requestId: 'placeholder-value',
|
|
8353
|
+
* // Optional. Field mask is used to specify the fields to be overwritten in the User 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.
|
|
8354
|
+
* updateMask: 'placeholder-value',
|
|
8355
|
+
* // Optional. If set, the backend validates the request, but doesn't actually execute it.
|
|
8356
|
+
* validateOnly: 'placeholder-value',
|
|
8357
|
+
*
|
|
8358
|
+
* // Request body metadata
|
|
8359
|
+
* requestBody: {
|
|
8360
|
+
* // request body parameters
|
|
8361
|
+
* // {
|
|
8362
|
+
* // "databaseRoles": [],
|
|
8363
|
+
* // "keepExtraRoles": false,
|
|
8364
|
+
* // "name": "my_name",
|
|
8365
|
+
* // "password": "my_password",
|
|
8366
|
+
* // "userType": "my_userType"
|
|
8367
|
+
* // }
|
|
8368
|
+
* },
|
|
8369
|
+
* });
|
|
8370
|
+
* console.log(res.data);
|
|
8371
|
+
*
|
|
8372
|
+
* // Example response
|
|
8373
|
+
* // {
|
|
8374
|
+
* // "databaseRoles": [],
|
|
8375
|
+
* // "keepExtraRoles": false,
|
|
8376
|
+
* // "name": "my_name",
|
|
8377
|
+
* // "password": "my_password",
|
|
8378
|
+
* // "userType": "my_userType"
|
|
8379
|
+
* // }
|
|
8380
|
+
* }
|
|
8381
|
+
*
|
|
8382
|
+
* main().catch(e => {
|
|
8383
|
+
* console.error(e);
|
|
8384
|
+
* throw e;
|
|
8385
|
+
* });
|
|
8386
|
+
*
|
|
8387
|
+
* ```
|
|
6013
8388
|
*
|
|
6014
8389
|
* @param params - Parameters for request
|
|
6015
8390
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -6203,6 +8578,56 @@ export namespace alloydb_v1 {
|
|
|
6203
8578
|
|
|
6204
8579
|
/**
|
|
6205
8580
|
* Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
|
|
8581
|
+
* @example
|
|
8582
|
+
* ```js
|
|
8583
|
+
* // Before running the sample:
|
|
8584
|
+
* // - Enable the API at:
|
|
8585
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
8586
|
+
* // - Login into gcloud by running:
|
|
8587
|
+
* // ```sh
|
|
8588
|
+
* // $ gcloud auth application-default login
|
|
8589
|
+
* // ```
|
|
8590
|
+
* // - Install the npm module by running:
|
|
8591
|
+
* // ```sh
|
|
8592
|
+
* // $ npm install googleapis
|
|
8593
|
+
* // ```
|
|
8594
|
+
*
|
|
8595
|
+
* const {google} = require('googleapis');
|
|
8596
|
+
* const alloydb = google.alloydb('v1');
|
|
8597
|
+
*
|
|
8598
|
+
* async function main() {
|
|
8599
|
+
* const auth = new google.auth.GoogleAuth({
|
|
8600
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
8601
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
8602
|
+
* });
|
|
8603
|
+
*
|
|
8604
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
8605
|
+
* const authClient = await auth.getClient();
|
|
8606
|
+
* google.options({auth: authClient});
|
|
8607
|
+
*
|
|
8608
|
+
* // Do the magic
|
|
8609
|
+
* const res = await alloydb.projects.locations.operations.cancel({
|
|
8610
|
+
* // The name of the operation resource to be cancelled.
|
|
8611
|
+
* name: 'projects/my-project/locations/my-location/operations/my-operation',
|
|
8612
|
+
*
|
|
8613
|
+
* // Request body metadata
|
|
8614
|
+
* requestBody: {
|
|
8615
|
+
* // request body parameters
|
|
8616
|
+
* // {}
|
|
8617
|
+
* },
|
|
8618
|
+
* });
|
|
8619
|
+
* console.log(res.data);
|
|
8620
|
+
*
|
|
8621
|
+
* // Example response
|
|
8622
|
+
* // {}
|
|
8623
|
+
* }
|
|
8624
|
+
*
|
|
8625
|
+
* main().catch(e => {
|
|
8626
|
+
* console.error(e);
|
|
8627
|
+
* throw e;
|
|
8628
|
+
* });
|
|
8629
|
+
*
|
|
8630
|
+
* ```
|
|
6206
8631
|
*
|
|
6207
8632
|
* @param params - Parameters for request
|
|
6208
8633
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -6291,6 +8716,50 @@ export namespace alloydb_v1 {
|
|
|
6291
8716
|
|
|
6292
8717
|
/**
|
|
6293
8718
|
* Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
|
8719
|
+
* @example
|
|
8720
|
+
* ```js
|
|
8721
|
+
* // Before running the sample:
|
|
8722
|
+
* // - Enable the API at:
|
|
8723
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
8724
|
+
* // - Login into gcloud by running:
|
|
8725
|
+
* // ```sh
|
|
8726
|
+
* // $ gcloud auth application-default login
|
|
8727
|
+
* // ```
|
|
8728
|
+
* // - Install the npm module by running:
|
|
8729
|
+
* // ```sh
|
|
8730
|
+
* // $ npm install googleapis
|
|
8731
|
+
* // ```
|
|
8732
|
+
*
|
|
8733
|
+
* const {google} = require('googleapis');
|
|
8734
|
+
* const alloydb = google.alloydb('v1');
|
|
8735
|
+
*
|
|
8736
|
+
* async function main() {
|
|
8737
|
+
* const auth = new google.auth.GoogleAuth({
|
|
8738
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
8739
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
8740
|
+
* });
|
|
8741
|
+
*
|
|
8742
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
8743
|
+
* const authClient = await auth.getClient();
|
|
8744
|
+
* google.options({auth: authClient});
|
|
8745
|
+
*
|
|
8746
|
+
* // Do the magic
|
|
8747
|
+
* const res = await alloydb.projects.locations.operations.delete({
|
|
8748
|
+
* // The name of the operation resource to be deleted.
|
|
8749
|
+
* name: 'projects/my-project/locations/my-location/operations/my-operation',
|
|
8750
|
+
* });
|
|
8751
|
+
* console.log(res.data);
|
|
8752
|
+
*
|
|
8753
|
+
* // Example response
|
|
8754
|
+
* // {}
|
|
8755
|
+
* }
|
|
8756
|
+
*
|
|
8757
|
+
* main().catch(e => {
|
|
8758
|
+
* console.error(e);
|
|
8759
|
+
* throw e;
|
|
8760
|
+
* });
|
|
8761
|
+
*
|
|
8762
|
+
* ```
|
|
6294
8763
|
*
|
|
6295
8764
|
* @param params - Parameters for request
|
|
6296
8765
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -6379,6 +8848,56 @@ export namespace alloydb_v1 {
|
|
|
6379
8848
|
|
|
6380
8849
|
/**
|
|
6381
8850
|
* Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
|
|
8851
|
+
* @example
|
|
8852
|
+
* ```js
|
|
8853
|
+
* // Before running the sample:
|
|
8854
|
+
* // - Enable the API at:
|
|
8855
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
8856
|
+
* // - Login into gcloud by running:
|
|
8857
|
+
* // ```sh
|
|
8858
|
+
* // $ gcloud auth application-default login
|
|
8859
|
+
* // ```
|
|
8860
|
+
* // - Install the npm module by running:
|
|
8861
|
+
* // ```sh
|
|
8862
|
+
* // $ npm install googleapis
|
|
8863
|
+
* // ```
|
|
8864
|
+
*
|
|
8865
|
+
* const {google} = require('googleapis');
|
|
8866
|
+
* const alloydb = google.alloydb('v1');
|
|
8867
|
+
*
|
|
8868
|
+
* async function main() {
|
|
8869
|
+
* const auth = new google.auth.GoogleAuth({
|
|
8870
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
8871
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
8872
|
+
* });
|
|
8873
|
+
*
|
|
8874
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
8875
|
+
* const authClient = await auth.getClient();
|
|
8876
|
+
* google.options({auth: authClient});
|
|
8877
|
+
*
|
|
8878
|
+
* // Do the magic
|
|
8879
|
+
* const res = await alloydb.projects.locations.operations.get({
|
|
8880
|
+
* // The name of the operation resource.
|
|
8881
|
+
* name: 'projects/my-project/locations/my-location/operations/my-operation',
|
|
8882
|
+
* });
|
|
8883
|
+
* console.log(res.data);
|
|
8884
|
+
*
|
|
8885
|
+
* // Example response
|
|
8886
|
+
* // {
|
|
8887
|
+
* // "done": false,
|
|
8888
|
+
* // "error": {},
|
|
8889
|
+
* // "metadata": {},
|
|
8890
|
+
* // "name": "my_name",
|
|
8891
|
+
* // "response": {}
|
|
8892
|
+
* // }
|
|
8893
|
+
* }
|
|
8894
|
+
*
|
|
8895
|
+
* main().catch(e => {
|
|
8896
|
+
* console.error(e);
|
|
8897
|
+
* throw e;
|
|
8898
|
+
* });
|
|
8899
|
+
*
|
|
8900
|
+
* ```
|
|
6382
8901
|
*
|
|
6383
8902
|
* @param params - Parameters for request
|
|
6384
8903
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -6467,6 +8986,59 @@ export namespace alloydb_v1 {
|
|
|
6467
8986
|
|
|
6468
8987
|
/**
|
|
6469
8988
|
* Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
8989
|
+
* @example
|
|
8990
|
+
* ```js
|
|
8991
|
+
* // Before running the sample:
|
|
8992
|
+
* // - Enable the API at:
|
|
8993
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
8994
|
+
* // - Login into gcloud by running:
|
|
8995
|
+
* // ```sh
|
|
8996
|
+
* // $ gcloud auth application-default login
|
|
8997
|
+
* // ```
|
|
8998
|
+
* // - Install the npm module by running:
|
|
8999
|
+
* // ```sh
|
|
9000
|
+
* // $ npm install googleapis
|
|
9001
|
+
* // ```
|
|
9002
|
+
*
|
|
9003
|
+
* const {google} = require('googleapis');
|
|
9004
|
+
* const alloydb = google.alloydb('v1');
|
|
9005
|
+
*
|
|
9006
|
+
* async function main() {
|
|
9007
|
+
* const auth = new google.auth.GoogleAuth({
|
|
9008
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
9009
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
9010
|
+
* });
|
|
9011
|
+
*
|
|
9012
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
9013
|
+
* const authClient = await auth.getClient();
|
|
9014
|
+
* google.options({auth: authClient});
|
|
9015
|
+
*
|
|
9016
|
+
* // Do the magic
|
|
9017
|
+
* const res = await alloydb.projects.locations.operations.list({
|
|
9018
|
+
* // The standard list filter.
|
|
9019
|
+
* filter: 'placeholder-value',
|
|
9020
|
+
* // The name of the operation's parent resource.
|
|
9021
|
+
* name: 'projects/my-project/locations/my-location',
|
|
9022
|
+
* // The standard list page size.
|
|
9023
|
+
* pageSize: 'placeholder-value',
|
|
9024
|
+
* // The standard list page token.
|
|
9025
|
+
* pageToken: 'placeholder-value',
|
|
9026
|
+
* });
|
|
9027
|
+
* console.log(res.data);
|
|
9028
|
+
*
|
|
9029
|
+
* // Example response
|
|
9030
|
+
* // {
|
|
9031
|
+
* // "nextPageToken": "my_nextPageToken",
|
|
9032
|
+
* // "operations": []
|
|
9033
|
+
* // }
|
|
9034
|
+
* }
|
|
9035
|
+
*
|
|
9036
|
+
* main().catch(e => {
|
|
9037
|
+
* console.error(e);
|
|
9038
|
+
* throw e;
|
|
9039
|
+
* });
|
|
9040
|
+
*
|
|
9041
|
+
* ```
|
|
6470
9042
|
*
|
|
6471
9043
|
* @param params - Parameters for request
|
|
6472
9044
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
@@ -6613,6 +9185,59 @@ export namespace alloydb_v1 {
|
|
|
6613
9185
|
|
|
6614
9186
|
/**
|
|
6615
9187
|
* Lists SupportedDatabaseFlags for a given project and location.
|
|
9188
|
+
* @example
|
|
9189
|
+
* ```js
|
|
9190
|
+
* // Before running the sample:
|
|
9191
|
+
* // - Enable the API at:
|
|
9192
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
9193
|
+
* // - Login into gcloud by running:
|
|
9194
|
+
* // ```sh
|
|
9195
|
+
* // $ gcloud auth application-default login
|
|
9196
|
+
* // ```
|
|
9197
|
+
* // - Install the npm module by running:
|
|
9198
|
+
* // ```sh
|
|
9199
|
+
* // $ npm install googleapis
|
|
9200
|
+
* // ```
|
|
9201
|
+
*
|
|
9202
|
+
* const {google} = require('googleapis');
|
|
9203
|
+
* const alloydb = google.alloydb('v1');
|
|
9204
|
+
*
|
|
9205
|
+
* async function main() {
|
|
9206
|
+
* const auth = new google.auth.GoogleAuth({
|
|
9207
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
9208
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
9209
|
+
* });
|
|
9210
|
+
*
|
|
9211
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
9212
|
+
* const authClient = await auth.getClient();
|
|
9213
|
+
* google.options({auth: authClient});
|
|
9214
|
+
*
|
|
9215
|
+
* // Do the magic
|
|
9216
|
+
* const res = await alloydb.projects.locations.supportedDatabaseFlags.list({
|
|
9217
|
+
* // Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
|
|
9218
|
+
* pageSize: 'placeholder-value',
|
|
9219
|
+
* // A token identifying a page of results the server should return.
|
|
9220
|
+
* pageToken: 'placeholder-value',
|
|
9221
|
+
* // Required. The name of the parent resource. The required format is: * projects/{project\}/locations/{location\} Regardless of the parent specified here, as long it is contains a valid project and location, the service will return a static list of supported flags resources. Note that we do not yet support region-specific flags.
|
|
9222
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
9223
|
+
* // Optional. The scope for which supported flags are requested. If not specified, default is DATABASE.
|
|
9224
|
+
* scope: 'placeholder-value',
|
|
9225
|
+
* });
|
|
9226
|
+
* console.log(res.data);
|
|
9227
|
+
*
|
|
9228
|
+
* // Example response
|
|
9229
|
+
* // {
|
|
9230
|
+
* // "nextPageToken": "my_nextPageToken",
|
|
9231
|
+
* // "supportedDatabaseFlags": []
|
|
9232
|
+
* // }
|
|
9233
|
+
* }
|
|
9234
|
+
*
|
|
9235
|
+
* main().catch(e => {
|
|
9236
|
+
* console.error(e);
|
|
9237
|
+
* throw e;
|
|
9238
|
+
* });
|
|
9239
|
+
*
|
|
9240
|
+
* ```
|
|
6616
9241
|
*
|
|
6617
9242
|
* @param params - Parameters for request
|
|
6618
9243
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|