@googleapis/alloydb 13.0.1 → 14.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/build/v1.d.ts CHANGED
@@ -503,7 +503,7 @@ export declare namespace alloydb_v1 {
503
503
  */
504
504
  export interface Schema$ContinuousBackupInfo {
505
505
  /**
506
- * Output only. The earliest restorable time that can be restored to. Output only field.
506
+ * 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.
507
507
  */
508
508
  earliestRestorableTime?: string | null;
509
509
  /**
@@ -515,7 +515,7 @@ export declare namespace alloydb_v1 {
515
515
  */
516
516
  encryptionInfo?: Schema$EncryptionInfo;
517
517
  /**
518
- * Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
518
+ * Output only. Days of the week on which a continuous backup is taken.
519
519
  */
520
520
  schedule?: string[] | null;
521
521
  }
@@ -936,6 +936,10 @@ export declare namespace alloydb_v1 {
936
936
  * Metadata related to instance-level network configuration.
937
937
  */
938
938
  export interface Schema$InstanceNetworkConfig {
939
+ /**
940
+ * 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])?.
941
+ */
942
+ allocatedIpRangeOverride?: string | null;
939
943
  /**
940
944
  * Optional. A list of external network authorized to access this instance.
941
945
  */
@@ -954,7 +958,7 @@ export declare namespace alloydb_v1 {
954
958
  network?: string | null;
955
959
  }
956
960
  /**
957
- * Details regarding the upgrade of instaces associated with a cluster.
961
+ * Details regarding the upgrade of instances associated with a cluster.
958
962
  */
959
963
  export interface Schema$InstanceUpgradeDetails {
960
964
  /**
@@ -1563,6 +1567,27 @@ export declare namespace alloydb_v1 {
1563
1567
  */
1564
1568
  status?: string | null;
1565
1569
  }
1570
+ /**
1571
+ * Timing information for the stage execution.
1572
+ */
1573
+ export interface Schema$StageSchedule {
1574
+ /**
1575
+ * Actual end time of the stage. Set only if the stage has completed.
1576
+ */
1577
+ actualEndTime?: string | null;
1578
+ /**
1579
+ * Actual start time of the stage. Set only if the stage has started.
1580
+ */
1581
+ actualStartTime?: string | null;
1582
+ /**
1583
+ * When the stage is expected to end. Set only if the stage has not completed yet.
1584
+ */
1585
+ estimatedEndTime?: string | null;
1586
+ /**
1587
+ * When the stage is expected to start. Set only if the stage has not started yet.
1588
+ */
1589
+ estimatedStartTime?: string | null;
1590
+ }
1566
1591
  /**
1567
1592
  * Status of an upgrade stage.
1568
1593
  */
@@ -1571,6 +1596,10 @@ export declare namespace alloydb_v1 {
1571
1596
  * Read pool instances upgrade metadata.
1572
1597
  */
1573
1598
  readPoolInstancesUpgrade?: Schema$ReadPoolInstancesUpgradeStageStatus;
1599
+ /**
1600
+ * Output only. Timing information for the stage execution.
1601
+ */
1602
+ schedule?: Schema$StageSchedule;
1574
1603
  /**
1575
1604
  * Upgrade stage.
1576
1605
  */
@@ -1656,6 +1685,15 @@ export declare namespace alloydb_v1 {
1656
1685
  */
1657
1686
  pointInTimeRecoveryEnabled?: boolean | null;
1658
1687
  }
1688
+ /**
1689
+ * BackupDRConfiguration to capture the backup and disaster recovery details of database resource.
1690
+ */
1691
+ export interface Schema$StorageDatabasecenterPartnerapiV1mainBackupDRConfiguration {
1692
+ /**
1693
+ * Indicates if the resource is managed by BackupDR.
1694
+ */
1695
+ backupdrManaged?: boolean | null;
1696
+ }
1659
1697
  /**
1660
1698
  * A backup run.
1661
1699
  */
@@ -1690,6 +1728,31 @@ export declare namespace alloydb_v1 {
1690
1728
  */
1691
1729
  version?: string | null;
1692
1730
  }
1731
+ /**
1732
+ * Config based signal data. This is used to send signals to Condor which are based on the DB level configurations. These will be used to send signals for self managed databases.
1733
+ */
1734
+ export interface Schema$StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData {
1735
+ /**
1736
+ * Required. Full Resource name of the source resource.
1737
+ */
1738
+ fullResourceName?: string | null;
1739
+ /**
1740
+ * Required. Last time signal was refreshed
1741
+ */
1742
+ lastRefreshTime?: string | null;
1743
+ /**
1744
+ * Database resource id.
1745
+ */
1746
+ resourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId;
1747
+ /**
1748
+ * Signal data for boolean signals.
1749
+ */
1750
+ signalBoolValue?: boolean | null;
1751
+ /**
1752
+ * Required. Signal type of the signal
1753
+ */
1754
+ signalType?: string | null;
1755
+ }
1693
1756
  /**
1694
1757
  * Any custom metadata associated with the resource. e.g. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data
1695
1758
  */
@@ -1700,9 +1763,13 @@ export declare namespace alloydb_v1 {
1700
1763
  internalResourceMetadata?: Schema$StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata[];
1701
1764
  }
1702
1765
  /**
1703
- * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform.
1766
+ * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 9
1704
1767
  */
1705
1768
  export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed {
1769
+ /**
1770
+ * Config based signal data is used to ingest signals that are generated based on the configuration of the database resource.
1771
+ */
1772
+ configBasedSignalData?: Schema$StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData;
1706
1773
  /**
1707
1774
  * Required. Timestamp when feed is generated.
1708
1775
  */
@@ -1746,6 +1813,10 @@ export declare namespace alloydb_v1 {
1746
1813
  * 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.
1747
1814
  */
1748
1815
  externalUri?: string | null;
1816
+ /**
1817
+ * This is used to identify the location of the resource. Example: "us-central1"
1818
+ */
1819
+ location?: string | null;
1749
1820
  /**
1750
1821
  * Required. The name of the signal, ex: PUBLIC_SQL_INSTANCE, SQL_LOG_ERROR_VERBOSITY etc.
1751
1822
  */
@@ -1793,7 +1864,7 @@ export declare namespace alloydb_v1 {
1793
1864
  */
1794
1865
  providerDescription?: string | null;
1795
1866
  /**
1796
- * Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance, spanner.googleapis.com/Database, firestore.googleapis.com/Database, sqladmin.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel
1867
+ * 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
1797
1868
  */
1798
1869
  resourceType?: string | null;
1799
1870
  /**
@@ -1802,7 +1873,7 @@ export declare namespace alloydb_v1 {
1802
1873
  uniqueId?: string | null;
1803
1874
  }
1804
1875
  /**
1805
- * Common model for database resource instance metadata. Next ID: 25
1876
+ * Common model for database resource instance metadata. Next ID: 26
1806
1877
  */
1807
1878
  export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata {
1808
1879
  /**
@@ -1813,6 +1884,10 @@ export declare namespace alloydb_v1 {
1813
1884
  * Backup configuration for this instance
1814
1885
  */
1815
1886
  backupConfiguration?: Schema$StorageDatabasecenterPartnerapiV1mainBackupConfiguration;
1887
+ /**
1888
+ * Optional. BackupDR Configuration for the resource.
1889
+ */
1890
+ backupdrConfiguration?: Schema$StorageDatabasecenterPartnerapiV1mainBackupDRConfiguration;
1816
1891
  /**
1817
1892
  * Latest backup run information for this instance
1818
1893
  */
@@ -2082,6 +2157,10 @@ export declare namespace alloydb_v1 {
2082
2157
  * The specific engine that the underlying database is running.
2083
2158
  */
2084
2159
  engine?: string | null;
2160
+ /**
2161
+ * Minor version of the underlying database engine. Example values: For MySQL, it could be "8.0.32", "5.7.32" etc.. For Postgres, it could be "14.3", "15.3" etc..
2162
+ */
2163
+ minorVersion?: string | null;
2085
2164
  /**
2086
2165
  * Type of specific database product. It could be CloudSQL, AlloyDB etc..
2087
2166
  */
@@ -2338,6 +2417,56 @@ export declare namespace alloydb_v1 {
2338
2417
  constructor(context: APIRequestContext);
2339
2418
  /**
2340
2419
  * Gets information about a location.
2420
+ * @example
2421
+ * ```js
2422
+ * // Before running the sample:
2423
+ * // - Enable the API at:
2424
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
2425
+ * // - Login into gcloud by running:
2426
+ * // ```sh
2427
+ * // $ gcloud auth application-default login
2428
+ * // ```
2429
+ * // - Install the npm module by running:
2430
+ * // ```sh
2431
+ * // $ npm install googleapis
2432
+ * // ```
2433
+ *
2434
+ * const {google} = require('googleapis');
2435
+ * const alloydb = google.alloydb('v1');
2436
+ *
2437
+ * async function main() {
2438
+ * const auth = new google.auth.GoogleAuth({
2439
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2440
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2441
+ * });
2442
+ *
2443
+ * // Acquire an auth client, and bind it to all future calls
2444
+ * const authClient = await auth.getClient();
2445
+ * google.options({auth: authClient});
2446
+ *
2447
+ * // Do the magic
2448
+ * const res = await alloydb.projects.locations.get({
2449
+ * // Resource name for the location.
2450
+ * name: 'projects/my-project/locations/my-location',
2451
+ * });
2452
+ * console.log(res.data);
2453
+ *
2454
+ * // Example response
2455
+ * // {
2456
+ * // "displayName": "my_displayName",
2457
+ * // "labels": {},
2458
+ * // "locationId": "my_locationId",
2459
+ * // "metadata": {},
2460
+ * // "name": "my_name"
2461
+ * // }
2462
+ * }
2463
+ *
2464
+ * main().catch(e => {
2465
+ * console.error(e);
2466
+ * throw e;
2467
+ * });
2468
+ *
2469
+ * ```
2341
2470
  *
2342
2471
  * @param params - Parameters for request
2343
2472
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2352,6 +2481,61 @@ export declare namespace alloydb_v1 {
2352
2481
  get(callback: BodyResponseCallback<Schema$GoogleCloudLocationLocation>): void;
2353
2482
  /**
2354
2483
  * Lists information about the supported locations for this service.
2484
+ * @example
2485
+ * ```js
2486
+ * // Before running the sample:
2487
+ * // - Enable the API at:
2488
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
2489
+ * // - Login into gcloud by running:
2490
+ * // ```sh
2491
+ * // $ gcloud auth application-default login
2492
+ * // ```
2493
+ * // - Install the npm module by running:
2494
+ * // ```sh
2495
+ * // $ npm install googleapis
2496
+ * // ```
2497
+ *
2498
+ * const {google} = require('googleapis');
2499
+ * const alloydb = google.alloydb('v1');
2500
+ *
2501
+ * async function main() {
2502
+ * const auth = new google.auth.GoogleAuth({
2503
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2504
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2505
+ * });
2506
+ *
2507
+ * // Acquire an auth client, and bind it to all future calls
2508
+ * const authClient = await auth.getClient();
2509
+ * google.options({auth: authClient});
2510
+ *
2511
+ * // Do the magic
2512
+ * const res = await alloydb.projects.locations.list({
2513
+ * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.
2514
+ * extraLocationTypes: 'placeholder-value',
2515
+ * // 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).
2516
+ * filter: 'placeholder-value',
2517
+ * // The resource that owns the locations collection, if applicable.
2518
+ * name: 'projects/my-project',
2519
+ * // The maximum number of results to return. If not set, the service selects a default.
2520
+ * pageSize: 'placeholder-value',
2521
+ * // A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
2522
+ * pageToken: 'placeholder-value',
2523
+ * });
2524
+ * console.log(res.data);
2525
+ *
2526
+ * // Example response
2527
+ * // {
2528
+ * // "locations": [],
2529
+ * // "nextPageToken": "my_nextPageToken"
2530
+ * // }
2531
+ * }
2532
+ *
2533
+ * main().catch(e => {
2534
+ * console.error(e);
2535
+ * throw e;
2536
+ * });
2537
+ *
2538
+ * ```
2355
2539
  *
2356
2540
  * @param params - Parameters for request
2357
2541
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2398,6 +2582,93 @@ export declare namespace alloydb_v1 {
2398
2582
  constructor(context: APIRequestContext);
2399
2583
  /**
2400
2584
  * Creates a new Backup in a given project and location.
2585
+ * @example
2586
+ * ```js
2587
+ * // Before running the sample:
2588
+ * // - Enable the API at:
2589
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
2590
+ * // - Login into gcloud by running:
2591
+ * // ```sh
2592
+ * // $ gcloud auth application-default login
2593
+ * // ```
2594
+ * // - Install the npm module by running:
2595
+ * // ```sh
2596
+ * // $ npm install googleapis
2597
+ * // ```
2598
+ *
2599
+ * const {google} = require('googleapis');
2600
+ * const alloydb = google.alloydb('v1');
2601
+ *
2602
+ * async function main() {
2603
+ * const auth = new google.auth.GoogleAuth({
2604
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2605
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2606
+ * });
2607
+ *
2608
+ * // Acquire an auth client, and bind it to all future calls
2609
+ * const authClient = await auth.getClient();
2610
+ * google.options({auth: authClient});
2611
+ *
2612
+ * // Do the magic
2613
+ * const res = await alloydb.projects.locations.backups.create({
2614
+ * // Required. ID of the requesting object.
2615
+ * backupId: 'placeholder-value',
2616
+ * // Required. Value for parent.
2617
+ * parent: 'projects/my-project/locations/my-location',
2618
+ * // 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).
2619
+ * requestId: 'placeholder-value',
2620
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
2621
+ * validateOnly: 'placeholder-value',
2622
+ *
2623
+ * // Request body metadata
2624
+ * requestBody: {
2625
+ * // request body parameters
2626
+ * // {
2627
+ * // "annotations": {},
2628
+ * // "clusterName": "my_clusterName",
2629
+ * // "clusterUid": "my_clusterUid",
2630
+ * // "createCompletionTime": "my_createCompletionTime",
2631
+ * // "createTime": "my_createTime",
2632
+ * // "databaseVersion": "my_databaseVersion",
2633
+ * // "deleteTime": "my_deleteTime",
2634
+ * // "description": "my_description",
2635
+ * // "displayName": "my_displayName",
2636
+ * // "encryptionConfig": {},
2637
+ * // "encryptionInfo": {},
2638
+ * // "etag": "my_etag",
2639
+ * // "expiryQuantity": {},
2640
+ * // "expiryTime": "my_expiryTime",
2641
+ * // "labels": {},
2642
+ * // "name": "my_name",
2643
+ * // "reconciling": false,
2644
+ * // "satisfiesPzs": false,
2645
+ * // "sizeBytes": "my_sizeBytes",
2646
+ * // "state": "my_state",
2647
+ * // "tags": {},
2648
+ * // "type": "my_type",
2649
+ * // "uid": "my_uid",
2650
+ * // "updateTime": "my_updateTime"
2651
+ * // }
2652
+ * },
2653
+ * });
2654
+ * console.log(res.data);
2655
+ *
2656
+ * // Example response
2657
+ * // {
2658
+ * // "done": false,
2659
+ * // "error": {},
2660
+ * // "metadata": {},
2661
+ * // "name": "my_name",
2662
+ * // "response": {}
2663
+ * // }
2664
+ * }
2665
+ *
2666
+ * main().catch(e => {
2667
+ * console.error(e);
2668
+ * throw e;
2669
+ * });
2670
+ *
2671
+ * ```
2401
2672
  *
2402
2673
  * @param params - Parameters for request
2403
2674
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2412,6 +2683,62 @@ export declare namespace alloydb_v1 {
2412
2683
  create(callback: BodyResponseCallback<Schema$Operation>): void;
2413
2684
  /**
2414
2685
  * Deletes a single Backup.
2686
+ * @example
2687
+ * ```js
2688
+ * // Before running the sample:
2689
+ * // - Enable the API at:
2690
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
2691
+ * // - Login into gcloud by running:
2692
+ * // ```sh
2693
+ * // $ gcloud auth application-default login
2694
+ * // ```
2695
+ * // - Install the npm module by running:
2696
+ * // ```sh
2697
+ * // $ npm install googleapis
2698
+ * // ```
2699
+ *
2700
+ * const {google} = require('googleapis');
2701
+ * const alloydb = google.alloydb('v1');
2702
+ *
2703
+ * async function main() {
2704
+ * const auth = new google.auth.GoogleAuth({
2705
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2706
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2707
+ * });
2708
+ *
2709
+ * // Acquire an auth client, and bind it to all future calls
2710
+ * const authClient = await auth.getClient();
2711
+ * google.options({auth: authClient});
2712
+ *
2713
+ * // Do the magic
2714
+ * const res = await alloydb.projects.locations.backups.delete({
2715
+ * // 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.
2716
+ * etag: 'placeholder-value',
2717
+ * // Required. Name of the resource. For the required format, see the comment on the Backup.name field.
2718
+ * name: 'projects/my-project/locations/my-location/backups/my-backup',
2719
+ * // 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).
2720
+ * requestId: 'placeholder-value',
2721
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
2722
+ * validateOnly: 'placeholder-value',
2723
+ * });
2724
+ * console.log(res.data);
2725
+ *
2726
+ * // Example response
2727
+ * // {
2728
+ * // "done": false,
2729
+ * // "error": {},
2730
+ * // "metadata": {},
2731
+ * // "name": "my_name",
2732
+ * // "response": {}
2733
+ * // }
2734
+ * }
2735
+ *
2736
+ * main().catch(e => {
2737
+ * console.error(e);
2738
+ * throw e;
2739
+ * });
2740
+ *
2741
+ * ```
2415
2742
  *
2416
2743
  * @param params - Parameters for request
2417
2744
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2426,6 +2753,75 @@ export declare namespace alloydb_v1 {
2426
2753
  delete(callback: BodyResponseCallback<Schema$Operation>): void;
2427
2754
  /**
2428
2755
  * Gets details of a single Backup.
2756
+ * @example
2757
+ * ```js
2758
+ * // Before running the sample:
2759
+ * // - Enable the API at:
2760
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
2761
+ * // - Login into gcloud by running:
2762
+ * // ```sh
2763
+ * // $ gcloud auth application-default login
2764
+ * // ```
2765
+ * // - Install the npm module by running:
2766
+ * // ```sh
2767
+ * // $ npm install googleapis
2768
+ * // ```
2769
+ *
2770
+ * const {google} = require('googleapis');
2771
+ * const alloydb = google.alloydb('v1');
2772
+ *
2773
+ * async function main() {
2774
+ * const auth = new google.auth.GoogleAuth({
2775
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2776
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2777
+ * });
2778
+ *
2779
+ * // Acquire an auth client, and bind it to all future calls
2780
+ * const authClient = await auth.getClient();
2781
+ * google.options({auth: authClient});
2782
+ *
2783
+ * // Do the magic
2784
+ * const res = await alloydb.projects.locations.backups.get({
2785
+ * // Required. Name of the resource
2786
+ * name: 'projects/my-project/locations/my-location/backups/my-backup',
2787
+ * });
2788
+ * console.log(res.data);
2789
+ *
2790
+ * // Example response
2791
+ * // {
2792
+ * // "annotations": {},
2793
+ * // "clusterName": "my_clusterName",
2794
+ * // "clusterUid": "my_clusterUid",
2795
+ * // "createCompletionTime": "my_createCompletionTime",
2796
+ * // "createTime": "my_createTime",
2797
+ * // "databaseVersion": "my_databaseVersion",
2798
+ * // "deleteTime": "my_deleteTime",
2799
+ * // "description": "my_description",
2800
+ * // "displayName": "my_displayName",
2801
+ * // "encryptionConfig": {},
2802
+ * // "encryptionInfo": {},
2803
+ * // "etag": "my_etag",
2804
+ * // "expiryQuantity": {},
2805
+ * // "expiryTime": "my_expiryTime",
2806
+ * // "labels": {},
2807
+ * // "name": "my_name",
2808
+ * // "reconciling": false,
2809
+ * // "satisfiesPzs": false,
2810
+ * // "sizeBytes": "my_sizeBytes",
2811
+ * // "state": "my_state",
2812
+ * // "tags": {},
2813
+ * // "type": "my_type",
2814
+ * // "uid": "my_uid",
2815
+ * // "updateTime": "my_updateTime"
2816
+ * // }
2817
+ * }
2818
+ *
2819
+ * main().catch(e => {
2820
+ * console.error(e);
2821
+ * throw e;
2822
+ * });
2823
+ *
2824
+ * ```
2429
2825
  *
2430
2826
  * @param params - Parameters for request
2431
2827
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2440,6 +2836,62 @@ export declare namespace alloydb_v1 {
2440
2836
  get(callback: BodyResponseCallback<Schema$Backup>): void;
2441
2837
  /**
2442
2838
  * Lists Backups in a given project and location.
2839
+ * @example
2840
+ * ```js
2841
+ * // Before running the sample:
2842
+ * // - Enable the API at:
2843
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
2844
+ * // - Login into gcloud by running:
2845
+ * // ```sh
2846
+ * // $ gcloud auth application-default login
2847
+ * // ```
2848
+ * // - Install the npm module by running:
2849
+ * // ```sh
2850
+ * // $ npm install googleapis
2851
+ * // ```
2852
+ *
2853
+ * const {google} = require('googleapis');
2854
+ * const alloydb = google.alloydb('v1');
2855
+ *
2856
+ * async function main() {
2857
+ * const auth = new google.auth.GoogleAuth({
2858
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2859
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2860
+ * });
2861
+ *
2862
+ * // Acquire an auth client, and bind it to all future calls
2863
+ * const authClient = await auth.getClient();
2864
+ * google.options({auth: authClient});
2865
+ *
2866
+ * // Do the magic
2867
+ * const res = await alloydb.projects.locations.backups.list({
2868
+ * // Filtering results
2869
+ * filter: 'placeholder-value',
2870
+ * // Hint for how to order the results
2871
+ * orderBy: 'placeholder-value',
2872
+ * // Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
2873
+ * pageSize: 'placeholder-value',
2874
+ * // A token identifying a page of results the server should return.
2875
+ * pageToken: 'placeholder-value',
2876
+ * // Required. Parent value for ListBackupsRequest
2877
+ * parent: 'projects/my-project/locations/my-location',
2878
+ * });
2879
+ * console.log(res.data);
2880
+ *
2881
+ * // Example response
2882
+ * // {
2883
+ * // "backups": [],
2884
+ * // "nextPageToken": "my_nextPageToken",
2885
+ * // "unreachable": []
2886
+ * // }
2887
+ * }
2888
+ *
2889
+ * main().catch(e => {
2890
+ * console.error(e);
2891
+ * throw e;
2892
+ * });
2893
+ *
2894
+ * ```
2443
2895
  *
2444
2896
  * @param params - Parameters for request
2445
2897
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2454,6 +2906,95 @@ export declare namespace alloydb_v1 {
2454
2906
  list(callback: BodyResponseCallback<Schema$ListBackupsResponse>): void;
2455
2907
  /**
2456
2908
  * Updates the parameters of a single Backup.
2909
+ * @example
2910
+ * ```js
2911
+ * // Before running the sample:
2912
+ * // - Enable the API at:
2913
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
2914
+ * // - Login into gcloud by running:
2915
+ * // ```sh
2916
+ * // $ gcloud auth application-default login
2917
+ * // ```
2918
+ * // - Install the npm module by running:
2919
+ * // ```sh
2920
+ * // $ npm install googleapis
2921
+ * // ```
2922
+ *
2923
+ * const {google} = require('googleapis');
2924
+ * const alloydb = google.alloydb('v1');
2925
+ *
2926
+ * async function main() {
2927
+ * const auth = new google.auth.GoogleAuth({
2928
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2929
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2930
+ * });
2931
+ *
2932
+ * // Acquire an auth client, and bind it to all future calls
2933
+ * const authClient = await auth.getClient();
2934
+ * google.options({auth: authClient});
2935
+ *
2936
+ * // Do the magic
2937
+ * const res = await alloydb.projects.locations.backups.patch({
2938
+ * // 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.
2939
+ * allowMissing: 'placeholder-value',
2940
+ * // 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\}
2941
+ * name: 'projects/my-project/locations/my-location/backups/my-backup',
2942
+ * // 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).
2943
+ * requestId: 'placeholder-value',
2944
+ * // 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.
2945
+ * updateMask: 'placeholder-value',
2946
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
2947
+ * validateOnly: 'placeholder-value',
2948
+ *
2949
+ * // Request body metadata
2950
+ * requestBody: {
2951
+ * // request body parameters
2952
+ * // {
2953
+ * // "annotations": {},
2954
+ * // "clusterName": "my_clusterName",
2955
+ * // "clusterUid": "my_clusterUid",
2956
+ * // "createCompletionTime": "my_createCompletionTime",
2957
+ * // "createTime": "my_createTime",
2958
+ * // "databaseVersion": "my_databaseVersion",
2959
+ * // "deleteTime": "my_deleteTime",
2960
+ * // "description": "my_description",
2961
+ * // "displayName": "my_displayName",
2962
+ * // "encryptionConfig": {},
2963
+ * // "encryptionInfo": {},
2964
+ * // "etag": "my_etag",
2965
+ * // "expiryQuantity": {},
2966
+ * // "expiryTime": "my_expiryTime",
2967
+ * // "labels": {},
2968
+ * // "name": "my_name",
2969
+ * // "reconciling": false,
2970
+ * // "satisfiesPzs": false,
2971
+ * // "sizeBytes": "my_sizeBytes",
2972
+ * // "state": "my_state",
2973
+ * // "tags": {},
2974
+ * // "type": "my_type",
2975
+ * // "uid": "my_uid",
2976
+ * // "updateTime": "my_updateTime"
2977
+ * // }
2978
+ * },
2979
+ * });
2980
+ * console.log(res.data);
2981
+ *
2982
+ * // Example response
2983
+ * // {
2984
+ * // "done": false,
2985
+ * // "error": {},
2986
+ * // "metadata": {},
2987
+ * // "name": "my_name",
2988
+ * // "response": {}
2989
+ * // }
2990
+ * }
2991
+ *
2992
+ * main().catch(e => {
2993
+ * console.error(e);
2994
+ * throw e;
2995
+ * });
2996
+ *
2997
+ * ```
2457
2998
  *
2458
2999
  * @param params - Parameters for request
2459
3000
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2568,6 +3109,103 @@ export declare namespace alloydb_v1 {
2568
3109
  constructor(context: APIRequestContext);
2569
3110
  /**
2570
3111
  * Creates a new Cluster in a given project and location.
3112
+ * @example
3113
+ * ```js
3114
+ * // Before running the sample:
3115
+ * // - Enable the API at:
3116
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3117
+ * // - Login into gcloud by running:
3118
+ * // ```sh
3119
+ * // $ gcloud auth application-default login
3120
+ * // ```
3121
+ * // - Install the npm module by running:
3122
+ * // ```sh
3123
+ * // $ npm install googleapis
3124
+ * // ```
3125
+ *
3126
+ * const {google} = require('googleapis');
3127
+ * const alloydb = google.alloydb('v1');
3128
+ *
3129
+ * async function main() {
3130
+ * const auth = new google.auth.GoogleAuth({
3131
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3132
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3133
+ * });
3134
+ *
3135
+ * // Acquire an auth client, and bind it to all future calls
3136
+ * const authClient = await auth.getClient();
3137
+ * google.options({auth: authClient});
3138
+ *
3139
+ * // Do the magic
3140
+ * const res = await alloydb.projects.locations.clusters.create({
3141
+ * // Required. ID of the requesting object.
3142
+ * clusterId: 'placeholder-value',
3143
+ * // Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field.
3144
+ * parent: 'projects/my-project/locations/my-location',
3145
+ * // 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).
3146
+ * requestId: 'placeholder-value',
3147
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
3148
+ * validateOnly: 'placeholder-value',
3149
+ *
3150
+ * // Request body metadata
3151
+ * requestBody: {
3152
+ * // request body parameters
3153
+ * // {
3154
+ * // "annotations": {},
3155
+ * // "automatedBackupPolicy": {},
3156
+ * // "backupSource": {},
3157
+ * // "cloudsqlBackupRunSource": {},
3158
+ * // "clusterType": "my_clusterType",
3159
+ * // "continuousBackupConfig": {},
3160
+ * // "continuousBackupInfo": {},
3161
+ * // "createTime": "my_createTime",
3162
+ * // "databaseVersion": "my_databaseVersion",
3163
+ * // "deleteTime": "my_deleteTime",
3164
+ * // "displayName": "my_displayName",
3165
+ * // "encryptionConfig": {},
3166
+ * // "encryptionInfo": {},
3167
+ * // "etag": "my_etag",
3168
+ * // "initialUser": {},
3169
+ * // "labels": {},
3170
+ * // "maintenanceSchedule": {},
3171
+ * // "maintenanceUpdatePolicy": {},
3172
+ * // "migrationSource": {},
3173
+ * // "name": "my_name",
3174
+ * // "network": "my_network",
3175
+ * // "networkConfig": {},
3176
+ * // "primaryConfig": {},
3177
+ * // "pscConfig": {},
3178
+ * // "reconciling": false,
3179
+ * // "satisfiesPzs": false,
3180
+ * // "secondaryConfig": {},
3181
+ * // "sslConfig": {},
3182
+ * // "state": "my_state",
3183
+ * // "subscriptionType": "my_subscriptionType",
3184
+ * // "tags": {},
3185
+ * // "trialMetadata": {},
3186
+ * // "uid": "my_uid",
3187
+ * // "updateTime": "my_updateTime"
3188
+ * // }
3189
+ * },
3190
+ * });
3191
+ * console.log(res.data);
3192
+ *
3193
+ * // Example response
3194
+ * // {
3195
+ * // "done": false,
3196
+ * // "error": {},
3197
+ * // "metadata": {},
3198
+ * // "name": "my_name",
3199
+ * // "response": {}
3200
+ * // }
3201
+ * }
3202
+ *
3203
+ * main().catch(e => {
3204
+ * console.error(e);
3205
+ * throw e;
3206
+ * });
3207
+ *
3208
+ * ```
2571
3209
  *
2572
3210
  * @param params - Parameters for request
2573
3211
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2582,6 +3220,103 @@ export declare namespace alloydb_v1 {
2582
3220
  create(callback: BodyResponseCallback<Schema$Operation>): void;
2583
3221
  /**
2584
3222
  * Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.
3223
+ * @example
3224
+ * ```js
3225
+ * // Before running the sample:
3226
+ * // - Enable the API at:
3227
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3228
+ * // - Login into gcloud by running:
3229
+ * // ```sh
3230
+ * // $ gcloud auth application-default login
3231
+ * // ```
3232
+ * // - Install the npm module by running:
3233
+ * // ```sh
3234
+ * // $ npm install googleapis
3235
+ * // ```
3236
+ *
3237
+ * const {google} = require('googleapis');
3238
+ * const alloydb = google.alloydb('v1');
3239
+ *
3240
+ * async function main() {
3241
+ * const auth = new google.auth.GoogleAuth({
3242
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3243
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3244
+ * });
3245
+ *
3246
+ * // Acquire an auth client, and bind it to all future calls
3247
+ * const authClient = await auth.getClient();
3248
+ * google.options({auth: authClient});
3249
+ *
3250
+ * // Do the magic
3251
+ * const res = await alloydb.projects.locations.clusters.createsecondary({
3252
+ * // Required. ID of the requesting object (the secondary cluster).
3253
+ * clusterId: 'placeholder-value',
3254
+ * // Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field.
3255
+ * parent: 'projects/my-project/locations/my-location',
3256
+ * // 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).
3257
+ * requestId: 'placeholder-value',
3258
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
3259
+ * validateOnly: 'placeholder-value',
3260
+ *
3261
+ * // Request body metadata
3262
+ * requestBody: {
3263
+ * // request body parameters
3264
+ * // {
3265
+ * // "annotations": {},
3266
+ * // "automatedBackupPolicy": {},
3267
+ * // "backupSource": {},
3268
+ * // "cloudsqlBackupRunSource": {},
3269
+ * // "clusterType": "my_clusterType",
3270
+ * // "continuousBackupConfig": {},
3271
+ * // "continuousBackupInfo": {},
3272
+ * // "createTime": "my_createTime",
3273
+ * // "databaseVersion": "my_databaseVersion",
3274
+ * // "deleteTime": "my_deleteTime",
3275
+ * // "displayName": "my_displayName",
3276
+ * // "encryptionConfig": {},
3277
+ * // "encryptionInfo": {},
3278
+ * // "etag": "my_etag",
3279
+ * // "initialUser": {},
3280
+ * // "labels": {},
3281
+ * // "maintenanceSchedule": {},
3282
+ * // "maintenanceUpdatePolicy": {},
3283
+ * // "migrationSource": {},
3284
+ * // "name": "my_name",
3285
+ * // "network": "my_network",
3286
+ * // "networkConfig": {},
3287
+ * // "primaryConfig": {},
3288
+ * // "pscConfig": {},
3289
+ * // "reconciling": false,
3290
+ * // "satisfiesPzs": false,
3291
+ * // "secondaryConfig": {},
3292
+ * // "sslConfig": {},
3293
+ * // "state": "my_state",
3294
+ * // "subscriptionType": "my_subscriptionType",
3295
+ * // "tags": {},
3296
+ * // "trialMetadata": {},
3297
+ * // "uid": "my_uid",
3298
+ * // "updateTime": "my_updateTime"
3299
+ * // }
3300
+ * },
3301
+ * });
3302
+ * console.log(res.data);
3303
+ *
3304
+ * // Example response
3305
+ * // {
3306
+ * // "done": false,
3307
+ * // "error": {},
3308
+ * // "metadata": {},
3309
+ * // "name": "my_name",
3310
+ * // "response": {}
3311
+ * // }
3312
+ * }
3313
+ *
3314
+ * main().catch(e => {
3315
+ * console.error(e);
3316
+ * throw e;
3317
+ * });
3318
+ *
3319
+ * ```
2585
3320
  *
2586
3321
  * @param params - Parameters for request
2587
3322
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2596,6 +3331,64 @@ export declare namespace alloydb_v1 {
2596
3331
  createsecondary(callback: BodyResponseCallback<Schema$Operation>): void;
2597
3332
  /**
2598
3333
  * Deletes a single Cluster.
3334
+ * @example
3335
+ * ```js
3336
+ * // Before running the sample:
3337
+ * // - Enable the API at:
3338
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3339
+ * // - Login into gcloud by running:
3340
+ * // ```sh
3341
+ * // $ gcloud auth application-default login
3342
+ * // ```
3343
+ * // - Install the npm module by running:
3344
+ * // ```sh
3345
+ * // $ npm install googleapis
3346
+ * // ```
3347
+ *
3348
+ * const {google} = require('googleapis');
3349
+ * const alloydb = google.alloydb('v1');
3350
+ *
3351
+ * async function main() {
3352
+ * const auth = new google.auth.GoogleAuth({
3353
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3354
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3355
+ * });
3356
+ *
3357
+ * // Acquire an auth client, and bind it to all future calls
3358
+ * const authClient = await auth.getClient();
3359
+ * google.options({auth: authClient});
3360
+ *
3361
+ * // Do the magic
3362
+ * const res = await alloydb.projects.locations.clusters.delete({
3363
+ * // 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.
3364
+ * etag: 'placeholder-value',
3365
+ * // Optional. Whether to cascade delete child instances for given cluster.
3366
+ * force: 'placeholder-value',
3367
+ * // Required. The name of the resource. For the required format, see the comment on the Cluster.name field.
3368
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
3369
+ * // 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).
3370
+ * requestId: 'placeholder-value',
3371
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
3372
+ * validateOnly: 'placeholder-value',
3373
+ * });
3374
+ * console.log(res.data);
3375
+ *
3376
+ * // Example response
3377
+ * // {
3378
+ * // "done": false,
3379
+ * // "error": {},
3380
+ * // "metadata": {},
3381
+ * // "name": "my_name",
3382
+ * // "response": {}
3383
+ * // }
3384
+ * }
3385
+ *
3386
+ * main().catch(e => {
3387
+ * console.error(e);
3388
+ * throw e;
3389
+ * });
3390
+ *
3391
+ * ```
2599
3392
  *
2600
3393
  * @param params - Parameters for request
2601
3394
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2610,6 +3403,67 @@ export declare namespace alloydb_v1 {
2610
3403
  delete(callback: BodyResponseCallback<Schema$Operation>): void;
2611
3404
  /**
2612
3405
  * Exports data from the cluster. Imperative only.
3406
+ * @example
3407
+ * ```js
3408
+ * // Before running the sample:
3409
+ * // - Enable the API at:
3410
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3411
+ * // - Login into gcloud by running:
3412
+ * // ```sh
3413
+ * // $ gcloud auth application-default login
3414
+ * // ```
3415
+ * // - Install the npm module by running:
3416
+ * // ```sh
3417
+ * // $ npm install googleapis
3418
+ * // ```
3419
+ *
3420
+ * const {google} = require('googleapis');
3421
+ * const alloydb = google.alloydb('v1');
3422
+ *
3423
+ * async function main() {
3424
+ * const auth = new google.auth.GoogleAuth({
3425
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3426
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3427
+ * });
3428
+ *
3429
+ * // Acquire an auth client, and bind it to all future calls
3430
+ * const authClient = await auth.getClient();
3431
+ * google.options({auth: authClient});
3432
+ *
3433
+ * // Do the magic
3434
+ * const res = await alloydb.projects.locations.clusters.export({
3435
+ * // Required. The resource name of the cluster.
3436
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
3437
+ *
3438
+ * // Request body metadata
3439
+ * requestBody: {
3440
+ * // request body parameters
3441
+ * // {
3442
+ * // "csvExportOptions": {},
3443
+ * // "database": "my_database",
3444
+ * // "gcsDestination": {},
3445
+ * // "sqlExportOptions": {}
3446
+ * // }
3447
+ * },
3448
+ * });
3449
+ * console.log(res.data);
3450
+ *
3451
+ * // Example response
3452
+ * // {
3453
+ * // "done": false,
3454
+ * // "error": {},
3455
+ * // "metadata": {},
3456
+ * // "name": "my_name",
3457
+ * // "response": {}
3458
+ * // }
3459
+ * }
3460
+ *
3461
+ * main().catch(e => {
3462
+ * console.error(e);
3463
+ * throw e;
3464
+ * });
3465
+ *
3466
+ * ```
2613
3467
  *
2614
3468
  * @param params - Parameters for request
2615
3469
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2624,6 +3478,87 @@ export declare namespace alloydb_v1 {
2624
3478
  export(callback: BodyResponseCallback<Schema$Operation>): void;
2625
3479
  /**
2626
3480
  * Gets details of a single Cluster.
3481
+ * @example
3482
+ * ```js
3483
+ * // Before running the sample:
3484
+ * // - Enable the API at:
3485
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3486
+ * // - Login into gcloud by running:
3487
+ * // ```sh
3488
+ * // $ gcloud auth application-default login
3489
+ * // ```
3490
+ * // - Install the npm module by running:
3491
+ * // ```sh
3492
+ * // $ npm install googleapis
3493
+ * // ```
3494
+ *
3495
+ * const {google} = require('googleapis');
3496
+ * const alloydb = google.alloydb('v1');
3497
+ *
3498
+ * async function main() {
3499
+ * const auth = new google.auth.GoogleAuth({
3500
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3501
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3502
+ * });
3503
+ *
3504
+ * // Acquire an auth client, and bind it to all future calls
3505
+ * const authClient = await auth.getClient();
3506
+ * google.options({auth: authClient});
3507
+ *
3508
+ * // Do the magic
3509
+ * const res = await alloydb.projects.locations.clusters.get({
3510
+ * // Required. The name of the resource. For the required format, see the comment on the Cluster.name field.
3511
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
3512
+ * // Optional. The view of the cluster to return. Returns all default fields if not set.
3513
+ * view: 'placeholder-value',
3514
+ * });
3515
+ * console.log(res.data);
3516
+ *
3517
+ * // Example response
3518
+ * // {
3519
+ * // "annotations": {},
3520
+ * // "automatedBackupPolicy": {},
3521
+ * // "backupSource": {},
3522
+ * // "cloudsqlBackupRunSource": {},
3523
+ * // "clusterType": "my_clusterType",
3524
+ * // "continuousBackupConfig": {},
3525
+ * // "continuousBackupInfo": {},
3526
+ * // "createTime": "my_createTime",
3527
+ * // "databaseVersion": "my_databaseVersion",
3528
+ * // "deleteTime": "my_deleteTime",
3529
+ * // "displayName": "my_displayName",
3530
+ * // "encryptionConfig": {},
3531
+ * // "encryptionInfo": {},
3532
+ * // "etag": "my_etag",
3533
+ * // "initialUser": {},
3534
+ * // "labels": {},
3535
+ * // "maintenanceSchedule": {},
3536
+ * // "maintenanceUpdatePolicy": {},
3537
+ * // "migrationSource": {},
3538
+ * // "name": "my_name",
3539
+ * // "network": "my_network",
3540
+ * // "networkConfig": {},
3541
+ * // "primaryConfig": {},
3542
+ * // "pscConfig": {},
3543
+ * // "reconciling": false,
3544
+ * // "satisfiesPzs": false,
3545
+ * // "secondaryConfig": {},
3546
+ * // "sslConfig": {},
3547
+ * // "state": "my_state",
3548
+ * // "subscriptionType": "my_subscriptionType",
3549
+ * // "tags": {},
3550
+ * // "trialMetadata": {},
3551
+ * // "uid": "my_uid",
3552
+ * // "updateTime": "my_updateTime"
3553
+ * // }
3554
+ * }
3555
+ *
3556
+ * main().catch(e => {
3557
+ * console.error(e);
3558
+ * throw e;
3559
+ * });
3560
+ *
3561
+ * ```
2627
3562
  *
2628
3563
  * @param params - Parameters for request
2629
3564
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2638,6 +3573,68 @@ export declare namespace alloydb_v1 {
2638
3573
  get(callback: BodyResponseCallback<Schema$Cluster>): void;
2639
3574
  /**
2640
3575
  * Imports data to the cluster. Imperative only.
3576
+ * @example
3577
+ * ```js
3578
+ * // Before running the sample:
3579
+ * // - Enable the API at:
3580
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3581
+ * // - Login into gcloud by running:
3582
+ * // ```sh
3583
+ * // $ gcloud auth application-default login
3584
+ * // ```
3585
+ * // - Install the npm module by running:
3586
+ * // ```sh
3587
+ * // $ npm install googleapis
3588
+ * // ```
3589
+ *
3590
+ * const {google} = require('googleapis');
3591
+ * const alloydb = google.alloydb('v1');
3592
+ *
3593
+ * async function main() {
3594
+ * const auth = new google.auth.GoogleAuth({
3595
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3596
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3597
+ * });
3598
+ *
3599
+ * // Acquire an auth client, and bind it to all future calls
3600
+ * const authClient = await auth.getClient();
3601
+ * google.options({auth: authClient});
3602
+ *
3603
+ * // Do the magic
3604
+ * const res = await alloydb.projects.locations.clusters.import({
3605
+ * // Required. The resource name of the cluster.
3606
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
3607
+ *
3608
+ * // Request body metadata
3609
+ * requestBody: {
3610
+ * // request body parameters
3611
+ * // {
3612
+ * // "csvImportOptions": {},
3613
+ * // "database": "my_database",
3614
+ * // "gcsUri": "my_gcsUri",
3615
+ * // "sqlImportOptions": {},
3616
+ * // "user": "my_user"
3617
+ * // }
3618
+ * },
3619
+ * });
3620
+ * console.log(res.data);
3621
+ *
3622
+ * // Example response
3623
+ * // {
3624
+ * // "done": false,
3625
+ * // "error": {},
3626
+ * // "metadata": {},
3627
+ * // "name": "my_name",
3628
+ * // "response": {}
3629
+ * // }
3630
+ * }
3631
+ *
3632
+ * main().catch(e => {
3633
+ * console.error(e);
3634
+ * throw e;
3635
+ * });
3636
+ *
3637
+ * ```
2641
3638
  *
2642
3639
  * @param params - Parameters for request
2643
3640
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2652,6 +3649,62 @@ export declare namespace alloydb_v1 {
2652
3649
  import(callback: BodyResponseCallback<Schema$Operation>): void;
2653
3650
  /**
2654
3651
  * Lists Clusters in a given project and location.
3652
+ * @example
3653
+ * ```js
3654
+ * // Before running the sample:
3655
+ * // - Enable the API at:
3656
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3657
+ * // - Login into gcloud by running:
3658
+ * // ```sh
3659
+ * // $ gcloud auth application-default login
3660
+ * // ```
3661
+ * // - Install the npm module by running:
3662
+ * // ```sh
3663
+ * // $ npm install googleapis
3664
+ * // ```
3665
+ *
3666
+ * const {google} = require('googleapis');
3667
+ * const alloydb = google.alloydb('v1');
3668
+ *
3669
+ * async function main() {
3670
+ * const auth = new google.auth.GoogleAuth({
3671
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3672
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3673
+ * });
3674
+ *
3675
+ * // Acquire an auth client, and bind it to all future calls
3676
+ * const authClient = await auth.getClient();
3677
+ * google.options({auth: authClient});
3678
+ *
3679
+ * // Do the magic
3680
+ * const res = await alloydb.projects.locations.clusters.list({
3681
+ * // Optional. Filtering results
3682
+ * filter: 'placeholder-value',
3683
+ * // Optional. Hint for how to order the results
3684
+ * orderBy: 'placeholder-value',
3685
+ * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
3686
+ * pageSize: 'placeholder-value',
3687
+ * // A token identifying a page of results the server should return.
3688
+ * pageToken: 'placeholder-value',
3689
+ * // 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/-
3690
+ * parent: 'projects/my-project/locations/my-location',
3691
+ * });
3692
+ * console.log(res.data);
3693
+ *
3694
+ * // Example response
3695
+ * // {
3696
+ * // "clusters": [],
3697
+ * // "nextPageToken": "my_nextPageToken",
3698
+ * // "unreachable": []
3699
+ * // }
3700
+ * }
3701
+ *
3702
+ * main().catch(e => {
3703
+ * console.error(e);
3704
+ * throw e;
3705
+ * });
3706
+ *
3707
+ * ```
2655
3708
  *
2656
3709
  * @param params - Parameters for request
2657
3710
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2666,6 +3719,105 @@ export declare namespace alloydb_v1 {
2666
3719
  list(callback: BodyResponseCallback<Schema$ListClustersResponse>): void;
2667
3720
  /**
2668
3721
  * Updates the parameters of a single Cluster.
3722
+ * @example
3723
+ * ```js
3724
+ * // Before running the sample:
3725
+ * // - Enable the API at:
3726
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3727
+ * // - Login into gcloud by running:
3728
+ * // ```sh
3729
+ * // $ gcloud auth application-default login
3730
+ * // ```
3731
+ * // - Install the npm module by running:
3732
+ * // ```sh
3733
+ * // $ npm install googleapis
3734
+ * // ```
3735
+ *
3736
+ * const {google} = require('googleapis');
3737
+ * const alloydb = google.alloydb('v1');
3738
+ *
3739
+ * async function main() {
3740
+ * const auth = new google.auth.GoogleAuth({
3741
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3742
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3743
+ * });
3744
+ *
3745
+ * // Acquire an auth client, and bind it to all future calls
3746
+ * const authClient = await auth.getClient();
3747
+ * google.options({auth: authClient});
3748
+ *
3749
+ * // Do the magic
3750
+ * const res = await alloydb.projects.locations.clusters.patch({
3751
+ * // 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.
3752
+ * allowMissing: 'placeholder-value',
3753
+ * // 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\}
3754
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
3755
+ * // 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).
3756
+ * requestId: 'placeholder-value',
3757
+ * // 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.
3758
+ * updateMask: 'placeholder-value',
3759
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
3760
+ * validateOnly: 'placeholder-value',
3761
+ *
3762
+ * // Request body metadata
3763
+ * requestBody: {
3764
+ * // request body parameters
3765
+ * // {
3766
+ * // "annotations": {},
3767
+ * // "automatedBackupPolicy": {},
3768
+ * // "backupSource": {},
3769
+ * // "cloudsqlBackupRunSource": {},
3770
+ * // "clusterType": "my_clusterType",
3771
+ * // "continuousBackupConfig": {},
3772
+ * // "continuousBackupInfo": {},
3773
+ * // "createTime": "my_createTime",
3774
+ * // "databaseVersion": "my_databaseVersion",
3775
+ * // "deleteTime": "my_deleteTime",
3776
+ * // "displayName": "my_displayName",
3777
+ * // "encryptionConfig": {},
3778
+ * // "encryptionInfo": {},
3779
+ * // "etag": "my_etag",
3780
+ * // "initialUser": {},
3781
+ * // "labels": {},
3782
+ * // "maintenanceSchedule": {},
3783
+ * // "maintenanceUpdatePolicy": {},
3784
+ * // "migrationSource": {},
3785
+ * // "name": "my_name",
3786
+ * // "network": "my_network",
3787
+ * // "networkConfig": {},
3788
+ * // "primaryConfig": {},
3789
+ * // "pscConfig": {},
3790
+ * // "reconciling": false,
3791
+ * // "satisfiesPzs": false,
3792
+ * // "secondaryConfig": {},
3793
+ * // "sslConfig": {},
3794
+ * // "state": "my_state",
3795
+ * // "subscriptionType": "my_subscriptionType",
3796
+ * // "tags": {},
3797
+ * // "trialMetadata": {},
3798
+ * // "uid": "my_uid",
3799
+ * // "updateTime": "my_updateTime"
3800
+ * // }
3801
+ * },
3802
+ * });
3803
+ * console.log(res.data);
3804
+ *
3805
+ * // Example response
3806
+ * // {
3807
+ * // "done": false,
3808
+ * // "error": {},
3809
+ * // "metadata": {},
3810
+ * // "name": "my_name",
3811
+ * // "response": {}
3812
+ * // }
3813
+ * }
3814
+ *
3815
+ * main().catch(e => {
3816
+ * console.error(e);
3817
+ * throw e;
3818
+ * });
3819
+ *
3820
+ * ```
2669
3821
  *
2670
3822
  * @param params - Parameters for request
2671
3823
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2680,6 +3832,66 @@ export declare namespace alloydb_v1 {
2680
3832
  patch(callback: BodyResponseCallback<Schema$Operation>): void;
2681
3833
  /**
2682
3834
  * Promotes a SECONDARY cluster. This turns down replication from the PRIMARY cluster and promotes a secondary cluster into its own standalone cluster. Imperative only.
3835
+ * @example
3836
+ * ```js
3837
+ * // Before running the sample:
3838
+ * // - Enable the API at:
3839
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3840
+ * // - Login into gcloud by running:
3841
+ * // ```sh
3842
+ * // $ gcloud auth application-default login
3843
+ * // ```
3844
+ * // - Install the npm module by running:
3845
+ * // ```sh
3846
+ * // $ npm install googleapis
3847
+ * // ```
3848
+ *
3849
+ * const {google} = require('googleapis');
3850
+ * const alloydb = google.alloydb('v1');
3851
+ *
3852
+ * async function main() {
3853
+ * const auth = new google.auth.GoogleAuth({
3854
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3855
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3856
+ * });
3857
+ *
3858
+ * // Acquire an auth client, and bind it to all future calls
3859
+ * const authClient = await auth.getClient();
3860
+ * google.options({auth: authClient});
3861
+ *
3862
+ * // Do the magic
3863
+ * const res = await alloydb.projects.locations.clusters.promote({
3864
+ * // Required. The name of the resource. For the required format, see the comment on the Cluster.name field
3865
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
3866
+ *
3867
+ * // Request body metadata
3868
+ * requestBody: {
3869
+ * // request body parameters
3870
+ * // {
3871
+ * // "etag": "my_etag",
3872
+ * // "requestId": "my_requestId",
3873
+ * // "validateOnly": false
3874
+ * // }
3875
+ * },
3876
+ * });
3877
+ * console.log(res.data);
3878
+ *
3879
+ * // Example response
3880
+ * // {
3881
+ * // "done": false,
3882
+ * // "error": {},
3883
+ * // "metadata": {},
3884
+ * // "name": "my_name",
3885
+ * // "response": {}
3886
+ * // }
3887
+ * }
3888
+ *
3889
+ * main().catch(e => {
3890
+ * console.error(e);
3891
+ * throw e;
3892
+ * });
3893
+ *
3894
+ * ```
2683
3895
  *
2684
3896
  * @param params - Parameters for request
2685
3897
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2694,6 +3906,69 @@ export declare namespace alloydb_v1 {
2694
3906
  promote(callback: BodyResponseCallback<Schema$Operation>): void;
2695
3907
  /**
2696
3908
  * 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.
3909
+ * @example
3910
+ * ```js
3911
+ * // Before running the sample:
3912
+ * // - Enable the API at:
3913
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3914
+ * // - Login into gcloud by running:
3915
+ * // ```sh
3916
+ * // $ gcloud auth application-default login
3917
+ * // ```
3918
+ * // - Install the npm module by running:
3919
+ * // ```sh
3920
+ * // $ npm install googleapis
3921
+ * // ```
3922
+ *
3923
+ * const {google} = require('googleapis');
3924
+ * const alloydb = google.alloydb('v1');
3925
+ *
3926
+ * async function main() {
3927
+ * const auth = new google.auth.GoogleAuth({
3928
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3929
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3930
+ * });
3931
+ *
3932
+ * // Acquire an auth client, and bind it to all future calls
3933
+ * const authClient = await auth.getClient();
3934
+ * google.options({auth: authClient});
3935
+ *
3936
+ * // Do the magic
3937
+ * const res = await alloydb.projects.locations.clusters.restore({
3938
+ * // Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field.
3939
+ * parent: 'projects/my-project/locations/my-location',
3940
+ *
3941
+ * // Request body metadata
3942
+ * requestBody: {
3943
+ * // request body parameters
3944
+ * // {
3945
+ * // "backupSource": {},
3946
+ * // "cluster": {},
3947
+ * // "clusterId": "my_clusterId",
3948
+ * // "continuousBackupSource": {},
3949
+ * // "requestId": "my_requestId",
3950
+ * // "validateOnly": false
3951
+ * // }
3952
+ * },
3953
+ * });
3954
+ * console.log(res.data);
3955
+ *
3956
+ * // Example response
3957
+ * // {
3958
+ * // "done": false,
3959
+ * // "error": {},
3960
+ * // "metadata": {},
3961
+ * // "name": "my_name",
3962
+ * // "response": {}
3963
+ * // }
3964
+ * }
3965
+ *
3966
+ * main().catch(e => {
3967
+ * console.error(e);
3968
+ * throw e;
3969
+ * });
3970
+ *
3971
+ * ```
2697
3972
  *
2698
3973
  * @param params - Parameters for request
2699
3974
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2708,6 +3983,66 @@ export declare namespace alloydb_v1 {
2708
3983
  restore(callback: BodyResponseCallback<Schema$Operation>): void;
2709
3984
  /**
2710
3985
  * Restores an AlloyDB cluster from a CloudSQL resource.
3986
+ * @example
3987
+ * ```js
3988
+ * // Before running the sample:
3989
+ * // - Enable the API at:
3990
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3991
+ * // - Login into gcloud by running:
3992
+ * // ```sh
3993
+ * // $ gcloud auth application-default login
3994
+ * // ```
3995
+ * // - Install the npm module by running:
3996
+ * // ```sh
3997
+ * // $ npm install googleapis
3998
+ * // ```
3999
+ *
4000
+ * const {google} = require('googleapis');
4001
+ * const alloydb = google.alloydb('v1');
4002
+ *
4003
+ * async function main() {
4004
+ * const auth = new google.auth.GoogleAuth({
4005
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4006
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4007
+ * });
4008
+ *
4009
+ * // Acquire an auth client, and bind it to all future calls
4010
+ * const authClient = await auth.getClient();
4011
+ * google.options({auth: authClient});
4012
+ *
4013
+ * // Do the magic
4014
+ * const res = await alloydb.projects.locations.clusters.restoreFromCloudSQL({
4015
+ * // Required. The location of the new cluster. For the required format, see the comment on Cluster.name field.
4016
+ * parent: 'projects/my-project/locations/my-location',
4017
+ *
4018
+ * // Request body metadata
4019
+ * requestBody: {
4020
+ * // request body parameters
4021
+ * // {
4022
+ * // "cloudsqlBackupRunSource": {},
4023
+ * // "cluster": {},
4024
+ * // "clusterId": "my_clusterId"
4025
+ * // }
4026
+ * },
4027
+ * });
4028
+ * console.log(res.data);
4029
+ *
4030
+ * // Example response
4031
+ * // {
4032
+ * // "done": false,
4033
+ * // "error": {},
4034
+ * // "metadata": {},
4035
+ * // "name": "my_name",
4036
+ * // "response": {}
4037
+ * // }
4038
+ * }
4039
+ *
4040
+ * main().catch(e => {
4041
+ * console.error(e);
4042
+ * throw e;
4043
+ * });
4044
+ *
4045
+ * ```
2711
4046
  *
2712
4047
  * @param params - Parameters for request
2713
4048
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2722,6 +4057,65 @@ export declare namespace alloydb_v1 {
2722
4057
  restoreFromCloudSQL(callback: BodyResponseCallback<Schema$Operation>): void;
2723
4058
  /**
2724
4059
  * 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.
4060
+ * @example
4061
+ * ```js
4062
+ * // Before running the sample:
4063
+ * // - Enable the API at:
4064
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4065
+ * // - Login into gcloud by running:
4066
+ * // ```sh
4067
+ * // $ gcloud auth application-default login
4068
+ * // ```
4069
+ * // - Install the npm module by running:
4070
+ * // ```sh
4071
+ * // $ npm install googleapis
4072
+ * // ```
4073
+ *
4074
+ * const {google} = require('googleapis');
4075
+ * const alloydb = google.alloydb('v1');
4076
+ *
4077
+ * async function main() {
4078
+ * const auth = new google.auth.GoogleAuth({
4079
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4080
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4081
+ * });
4082
+ *
4083
+ * // Acquire an auth client, and bind it to all future calls
4084
+ * const authClient = await auth.getClient();
4085
+ * google.options({auth: authClient});
4086
+ *
4087
+ * // Do the magic
4088
+ * const res = await alloydb.projects.locations.clusters.switchover({
4089
+ * // Required. The name of the resource. For the required format, see the comment on the Cluster.name field
4090
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
4091
+ *
4092
+ * // Request body metadata
4093
+ * requestBody: {
4094
+ * // request body parameters
4095
+ * // {
4096
+ * // "requestId": "my_requestId",
4097
+ * // "validateOnly": false
4098
+ * // }
4099
+ * },
4100
+ * });
4101
+ * console.log(res.data);
4102
+ *
4103
+ * // Example response
4104
+ * // {
4105
+ * // "done": false,
4106
+ * // "error": {},
4107
+ * // "metadata": {},
4108
+ * // "name": "my_name",
4109
+ * // "response": {}
4110
+ * // }
4111
+ * }
4112
+ *
4113
+ * main().catch(e => {
4114
+ * console.error(e);
4115
+ * throw e;
4116
+ * });
4117
+ *
4118
+ * ```
2725
4119
  *
2726
4120
  * @param params - Parameters for request
2727
4121
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2736,6 +4130,67 @@ export declare namespace alloydb_v1 {
2736
4130
  switchover(callback: BodyResponseCallback<Schema$Operation>): void;
2737
4131
  /**
2738
4132
  * Upgrades a single Cluster. Imperative only.
4133
+ * @example
4134
+ * ```js
4135
+ * // Before running the sample:
4136
+ * // - Enable the API at:
4137
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4138
+ * // - Login into gcloud by running:
4139
+ * // ```sh
4140
+ * // $ gcloud auth application-default login
4141
+ * // ```
4142
+ * // - Install the npm module by running:
4143
+ * // ```sh
4144
+ * // $ npm install googleapis
4145
+ * // ```
4146
+ *
4147
+ * const {google} = require('googleapis');
4148
+ * const alloydb = google.alloydb('v1');
4149
+ *
4150
+ * async function main() {
4151
+ * const auth = new google.auth.GoogleAuth({
4152
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4153
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4154
+ * });
4155
+ *
4156
+ * // Acquire an auth client, and bind it to all future calls
4157
+ * const authClient = await auth.getClient();
4158
+ * google.options({auth: authClient});
4159
+ *
4160
+ * // Do the magic
4161
+ * const res = await alloydb.projects.locations.clusters.upgrade({
4162
+ * // Required. The resource name of the cluster.
4163
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
4164
+ *
4165
+ * // Request body metadata
4166
+ * requestBody: {
4167
+ * // request body parameters
4168
+ * // {
4169
+ * // "etag": "my_etag",
4170
+ * // "requestId": "my_requestId",
4171
+ * // "validateOnly": false,
4172
+ * // "version": "my_version"
4173
+ * // }
4174
+ * },
4175
+ * });
4176
+ * console.log(res.data);
4177
+ *
4178
+ * // Example response
4179
+ * // {
4180
+ * // "done": false,
4181
+ * // "error": {},
4182
+ * // "metadata": {},
4183
+ * // "name": "my_name",
4184
+ * // "response": {}
4185
+ * // }
4186
+ * }
4187
+ *
4188
+ * main().catch(e => {
4189
+ * console.error(e);
4190
+ * throw e;
4191
+ * });
4192
+ *
4193
+ * ```
2739
4194
  *
2740
4195
  * @param params - Parameters for request
2741
4196
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2948,6 +4403,98 @@ export declare namespace alloydb_v1 {
2948
4403
  constructor(context: APIRequestContext);
2949
4404
  /**
2950
4405
  * Creates a new Instance in a given project and location.
4406
+ * @example
4407
+ * ```js
4408
+ * // Before running the sample:
4409
+ * // - Enable the API at:
4410
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4411
+ * // - Login into gcloud by running:
4412
+ * // ```sh
4413
+ * // $ gcloud auth application-default login
4414
+ * // ```
4415
+ * // - Install the npm module by running:
4416
+ * // ```sh
4417
+ * // $ npm install googleapis
4418
+ * // ```
4419
+ *
4420
+ * const {google} = require('googleapis');
4421
+ * const alloydb = google.alloydb('v1');
4422
+ *
4423
+ * async function main() {
4424
+ * const auth = new google.auth.GoogleAuth({
4425
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4426
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4427
+ * });
4428
+ *
4429
+ * // Acquire an auth client, and bind it to all future calls
4430
+ * const authClient = await auth.getClient();
4431
+ * google.options({auth: authClient});
4432
+ *
4433
+ * // Do the magic
4434
+ * const res = await alloydb.projects.locations.clusters.instances.create({
4435
+ * // Required. ID of the requesting object.
4436
+ * instanceId: 'placeholder-value',
4437
+ * // Required. The name of the parent resource. For the required format, see the comment on the Instance.name field.
4438
+ * parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
4439
+ * // 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).
4440
+ * requestId: 'placeholder-value',
4441
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
4442
+ * validateOnly: 'placeholder-value',
4443
+ *
4444
+ * // Request body metadata
4445
+ * requestBody: {
4446
+ * // request body parameters
4447
+ * // {
4448
+ * // "activationPolicy": "my_activationPolicy",
4449
+ * // "annotations": {},
4450
+ * // "availabilityType": "my_availabilityType",
4451
+ * // "clientConnectionConfig": {},
4452
+ * // "createTime": "my_createTime",
4453
+ * // "databaseFlags": {},
4454
+ * // "deleteTime": "my_deleteTime",
4455
+ * // "displayName": "my_displayName",
4456
+ * // "etag": "my_etag",
4457
+ * // "gceZone": "my_gceZone",
4458
+ * // "instanceType": "my_instanceType",
4459
+ * // "ipAddress": "my_ipAddress",
4460
+ * // "labels": {},
4461
+ * // "machineConfig": {},
4462
+ * // "name": "my_name",
4463
+ * // "networkConfig": {},
4464
+ * // "nodes": [],
4465
+ * // "observabilityConfig": {},
4466
+ * // "outboundPublicIpAddresses": [],
4467
+ * // "pscInstanceConfig": {},
4468
+ * // "publicIpAddress": "my_publicIpAddress",
4469
+ * // "queryInsightsConfig": {},
4470
+ * // "readPoolConfig": {},
4471
+ * // "reconciling": false,
4472
+ * // "satisfiesPzs": false,
4473
+ * // "state": "my_state",
4474
+ * // "uid": "my_uid",
4475
+ * // "updateTime": "my_updateTime",
4476
+ * // "writableNode": {}
4477
+ * // }
4478
+ * },
4479
+ * });
4480
+ * console.log(res.data);
4481
+ *
4482
+ * // Example response
4483
+ * // {
4484
+ * // "done": false,
4485
+ * // "error": {},
4486
+ * // "metadata": {},
4487
+ * // "name": "my_name",
4488
+ * // "response": {}
4489
+ * // }
4490
+ * }
4491
+ *
4492
+ * main().catch(e => {
4493
+ * console.error(e);
4494
+ * throw e;
4495
+ * });
4496
+ *
4497
+ * ```
2951
4498
  *
2952
4499
  * @param params - Parameters for request
2953
4500
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2962,6 +4509,99 @@ export declare namespace alloydb_v1 {
2962
4509
  create(callback: BodyResponseCallback<Schema$Operation>): void;
2963
4510
  /**
2964
4511
  * Creates a new SECONDARY Instance in a given project and location.
4512
+ * @example
4513
+ * ```js
4514
+ * // Before running the sample:
4515
+ * // - Enable the API at:
4516
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4517
+ * // - Login into gcloud by running:
4518
+ * // ```sh
4519
+ * // $ gcloud auth application-default login
4520
+ * // ```
4521
+ * // - Install the npm module by running:
4522
+ * // ```sh
4523
+ * // $ npm install googleapis
4524
+ * // ```
4525
+ *
4526
+ * const {google} = require('googleapis');
4527
+ * const alloydb = google.alloydb('v1');
4528
+ *
4529
+ * async function main() {
4530
+ * const auth = new google.auth.GoogleAuth({
4531
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4532
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4533
+ * });
4534
+ *
4535
+ * // Acquire an auth client, and bind it to all future calls
4536
+ * const authClient = await auth.getClient();
4537
+ * google.options({auth: authClient});
4538
+ *
4539
+ * // Do the magic
4540
+ * const res =
4541
+ * await alloydb.projects.locations.clusters.instances.createsecondary({
4542
+ * // Required. ID of the requesting object.
4543
+ * instanceId: 'placeholder-value',
4544
+ * // Required. The name of the parent resource. For the required format, see the comment on the Instance.name field.
4545
+ * parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
4546
+ * // 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).
4547
+ * requestId: 'placeholder-value',
4548
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
4549
+ * validateOnly: 'placeholder-value',
4550
+ *
4551
+ * // Request body metadata
4552
+ * requestBody: {
4553
+ * // request body parameters
4554
+ * // {
4555
+ * // "activationPolicy": "my_activationPolicy",
4556
+ * // "annotations": {},
4557
+ * // "availabilityType": "my_availabilityType",
4558
+ * // "clientConnectionConfig": {},
4559
+ * // "createTime": "my_createTime",
4560
+ * // "databaseFlags": {},
4561
+ * // "deleteTime": "my_deleteTime",
4562
+ * // "displayName": "my_displayName",
4563
+ * // "etag": "my_etag",
4564
+ * // "gceZone": "my_gceZone",
4565
+ * // "instanceType": "my_instanceType",
4566
+ * // "ipAddress": "my_ipAddress",
4567
+ * // "labels": {},
4568
+ * // "machineConfig": {},
4569
+ * // "name": "my_name",
4570
+ * // "networkConfig": {},
4571
+ * // "nodes": [],
4572
+ * // "observabilityConfig": {},
4573
+ * // "outboundPublicIpAddresses": [],
4574
+ * // "pscInstanceConfig": {},
4575
+ * // "publicIpAddress": "my_publicIpAddress",
4576
+ * // "queryInsightsConfig": {},
4577
+ * // "readPoolConfig": {},
4578
+ * // "reconciling": false,
4579
+ * // "satisfiesPzs": false,
4580
+ * // "state": "my_state",
4581
+ * // "uid": "my_uid",
4582
+ * // "updateTime": "my_updateTime",
4583
+ * // "writableNode": {}
4584
+ * // }
4585
+ * },
4586
+ * });
4587
+ * console.log(res.data);
4588
+ *
4589
+ * // Example response
4590
+ * // {
4591
+ * // "done": false,
4592
+ * // "error": {},
4593
+ * // "metadata": {},
4594
+ * // "name": "my_name",
4595
+ * // "response": {}
4596
+ * // }
4597
+ * }
4598
+ *
4599
+ * main().catch(e => {
4600
+ * console.error(e);
4601
+ * throw e;
4602
+ * });
4603
+ *
4604
+ * ```
2965
4605
  *
2966
4606
  * @param params - Parameters for request
2967
4607
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2976,6 +4616,62 @@ export declare namespace alloydb_v1 {
2976
4616
  createsecondary(callback: BodyResponseCallback<Schema$Operation>): void;
2977
4617
  /**
2978
4618
  * Deletes a single Instance.
4619
+ * @example
4620
+ * ```js
4621
+ * // Before running the sample:
4622
+ * // - Enable the API at:
4623
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4624
+ * // - Login into gcloud by running:
4625
+ * // ```sh
4626
+ * // $ gcloud auth application-default login
4627
+ * // ```
4628
+ * // - Install the npm module by running:
4629
+ * // ```sh
4630
+ * // $ npm install googleapis
4631
+ * // ```
4632
+ *
4633
+ * const {google} = require('googleapis');
4634
+ * const alloydb = google.alloydb('v1');
4635
+ *
4636
+ * async function main() {
4637
+ * const auth = new google.auth.GoogleAuth({
4638
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4639
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4640
+ * });
4641
+ *
4642
+ * // Acquire an auth client, and bind it to all future calls
4643
+ * const authClient = await auth.getClient();
4644
+ * google.options({auth: authClient});
4645
+ *
4646
+ * // Do the magic
4647
+ * const res = await alloydb.projects.locations.clusters.instances.delete({
4648
+ * // 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.
4649
+ * etag: 'placeholder-value',
4650
+ * // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
4651
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
4652
+ * // 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).
4653
+ * requestId: 'placeholder-value',
4654
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
4655
+ * validateOnly: 'placeholder-value',
4656
+ * });
4657
+ * console.log(res.data);
4658
+ *
4659
+ * // Example response
4660
+ * // {
4661
+ * // "done": false,
4662
+ * // "error": {},
4663
+ * // "metadata": {},
4664
+ * // "name": "my_name",
4665
+ * // "response": {}
4666
+ * // }
4667
+ * }
4668
+ *
4669
+ * main().catch(e => {
4670
+ * console.error(e);
4671
+ * throw e;
4672
+ * });
4673
+ *
4674
+ * ```
2979
4675
  *
2980
4676
  * @param params - Parameters for request
2981
4677
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2990,6 +4686,65 @@ export declare namespace alloydb_v1 {
2990
4686
  delete(callback: BodyResponseCallback<Schema$Operation>): void;
2991
4687
  /**
2992
4688
  * Forces a Failover for a highly available instance. Failover promotes the HA standby instance as the new primary. Imperative only.
4689
+ * @example
4690
+ * ```js
4691
+ * // Before running the sample:
4692
+ * // - Enable the API at:
4693
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4694
+ * // - Login into gcloud by running:
4695
+ * // ```sh
4696
+ * // $ gcloud auth application-default login
4697
+ * // ```
4698
+ * // - Install the npm module by running:
4699
+ * // ```sh
4700
+ * // $ npm install googleapis
4701
+ * // ```
4702
+ *
4703
+ * const {google} = require('googleapis');
4704
+ * const alloydb = google.alloydb('v1');
4705
+ *
4706
+ * async function main() {
4707
+ * const auth = new google.auth.GoogleAuth({
4708
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4709
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4710
+ * });
4711
+ *
4712
+ * // Acquire an auth client, and bind it to all future calls
4713
+ * const authClient = await auth.getClient();
4714
+ * google.options({auth: authClient});
4715
+ *
4716
+ * // Do the magic
4717
+ * const res = await alloydb.projects.locations.clusters.instances.failover({
4718
+ * // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
4719
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
4720
+ *
4721
+ * // Request body metadata
4722
+ * requestBody: {
4723
+ * // request body parameters
4724
+ * // {
4725
+ * // "requestId": "my_requestId",
4726
+ * // "validateOnly": false
4727
+ * // }
4728
+ * },
4729
+ * });
4730
+ * console.log(res.data);
4731
+ *
4732
+ * // Example response
4733
+ * // {
4734
+ * // "done": false,
4735
+ * // "error": {},
4736
+ * // "metadata": {},
4737
+ * // "name": "my_name",
4738
+ * // "response": {}
4739
+ * // }
4740
+ * }
4741
+ *
4742
+ * main().catch(e => {
4743
+ * console.error(e);
4744
+ * throw e;
4745
+ * });
4746
+ *
4747
+ * ```
2993
4748
  *
2994
4749
  * @param params - Parameters for request
2995
4750
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3004,6 +4759,82 @@ export declare namespace alloydb_v1 {
3004
4759
  failover(callback: BodyResponseCallback<Schema$Operation>): void;
3005
4760
  /**
3006
4761
  * Gets details of a single Instance.
4762
+ * @example
4763
+ * ```js
4764
+ * // Before running the sample:
4765
+ * // - Enable the API at:
4766
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4767
+ * // - Login into gcloud by running:
4768
+ * // ```sh
4769
+ * // $ gcloud auth application-default login
4770
+ * // ```
4771
+ * // - Install the npm module by running:
4772
+ * // ```sh
4773
+ * // $ npm install googleapis
4774
+ * // ```
4775
+ *
4776
+ * const {google} = require('googleapis');
4777
+ * const alloydb = google.alloydb('v1');
4778
+ *
4779
+ * async function main() {
4780
+ * const auth = new google.auth.GoogleAuth({
4781
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4782
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4783
+ * });
4784
+ *
4785
+ * // Acquire an auth client, and bind it to all future calls
4786
+ * const authClient = await auth.getClient();
4787
+ * google.options({auth: authClient});
4788
+ *
4789
+ * // Do the magic
4790
+ * const res = await alloydb.projects.locations.clusters.instances.get({
4791
+ * // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
4792
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
4793
+ * // The view of the instance to return.
4794
+ * view: 'placeholder-value',
4795
+ * });
4796
+ * console.log(res.data);
4797
+ *
4798
+ * // Example response
4799
+ * // {
4800
+ * // "activationPolicy": "my_activationPolicy",
4801
+ * // "annotations": {},
4802
+ * // "availabilityType": "my_availabilityType",
4803
+ * // "clientConnectionConfig": {},
4804
+ * // "createTime": "my_createTime",
4805
+ * // "databaseFlags": {},
4806
+ * // "deleteTime": "my_deleteTime",
4807
+ * // "displayName": "my_displayName",
4808
+ * // "etag": "my_etag",
4809
+ * // "gceZone": "my_gceZone",
4810
+ * // "instanceType": "my_instanceType",
4811
+ * // "ipAddress": "my_ipAddress",
4812
+ * // "labels": {},
4813
+ * // "machineConfig": {},
4814
+ * // "name": "my_name",
4815
+ * // "networkConfig": {},
4816
+ * // "nodes": [],
4817
+ * // "observabilityConfig": {},
4818
+ * // "outboundPublicIpAddresses": [],
4819
+ * // "pscInstanceConfig": {},
4820
+ * // "publicIpAddress": "my_publicIpAddress",
4821
+ * // "queryInsightsConfig": {},
4822
+ * // "readPoolConfig": {},
4823
+ * // "reconciling": false,
4824
+ * // "satisfiesPzs": false,
4825
+ * // "state": "my_state",
4826
+ * // "uid": "my_uid",
4827
+ * // "updateTime": "my_updateTime",
4828
+ * // "writableNode": {}
4829
+ * // }
4830
+ * }
4831
+ *
4832
+ * main().catch(e => {
4833
+ * console.error(e);
4834
+ * throw e;
4835
+ * });
4836
+ *
4837
+ * ```
3007
4838
  *
3008
4839
  * @param params - Parameters for request
3009
4840
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3018,6 +4849,59 @@ export declare namespace alloydb_v1 {
3018
4849
  get(callback: BodyResponseCallback<Schema$Instance>): void;
3019
4850
  /**
3020
4851
  * Get instance metadata used for a connection.
4852
+ * @example
4853
+ * ```js
4854
+ * // Before running the sample:
4855
+ * // - Enable the API at:
4856
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4857
+ * // - Login into gcloud by running:
4858
+ * // ```sh
4859
+ * // $ gcloud auth application-default login
4860
+ * // ```
4861
+ * // - Install the npm module by running:
4862
+ * // ```sh
4863
+ * // $ npm install googleapis
4864
+ * // ```
4865
+ *
4866
+ * const {google} = require('googleapis');
4867
+ * const alloydb = google.alloydb('v1');
4868
+ *
4869
+ * async function main() {
4870
+ * const auth = new google.auth.GoogleAuth({
4871
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4872
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4873
+ * });
4874
+ *
4875
+ * // Acquire an auth client, and bind it to all future calls
4876
+ * const authClient = await auth.getClient();
4877
+ * google.options({auth: authClient});
4878
+ *
4879
+ * // Do the magic
4880
+ * const res =
4881
+ * await alloydb.projects.locations.clusters.instances.getConnectionInfo({
4882
+ * // Required. The name of the parent resource. The required format is: projects/{project\}/locations/{location\}/clusters/{cluster\}/instances/{instance\}
4883
+ * parent:
4884
+ * 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
4885
+ * // 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).
4886
+ * requestId: 'placeholder-value',
4887
+ * });
4888
+ * console.log(res.data);
4889
+ *
4890
+ * // Example response
4891
+ * // {
4892
+ * // "instanceUid": "my_instanceUid",
4893
+ * // "ipAddress": "my_ipAddress",
4894
+ * // "name": "my_name",
4895
+ * // "publicIpAddress": "my_publicIpAddress"
4896
+ * // }
4897
+ * }
4898
+ *
4899
+ * main().catch(e => {
4900
+ * console.error(e);
4901
+ * throw e;
4902
+ * });
4903
+ *
4904
+ * ```
3021
4905
  *
3022
4906
  * @param params - Parameters for request
3023
4907
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3032,6 +4916,66 @@ export declare namespace alloydb_v1 {
3032
4916
  getConnectionInfo(callback: BodyResponseCallback<Schema$ConnectionInfo>): void;
3033
4917
  /**
3034
4918
  * Injects fault in an instance. Imperative only.
4919
+ * @example
4920
+ * ```js
4921
+ * // Before running the sample:
4922
+ * // - Enable the API at:
4923
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4924
+ * // - Login into gcloud by running:
4925
+ * // ```sh
4926
+ * // $ gcloud auth application-default login
4927
+ * // ```
4928
+ * // - Install the npm module by running:
4929
+ * // ```sh
4930
+ * // $ npm install googleapis
4931
+ * // ```
4932
+ *
4933
+ * const {google} = require('googleapis');
4934
+ * const alloydb = google.alloydb('v1');
4935
+ *
4936
+ * async function main() {
4937
+ * const auth = new google.auth.GoogleAuth({
4938
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4939
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4940
+ * });
4941
+ *
4942
+ * // Acquire an auth client, and bind it to all future calls
4943
+ * const authClient = await auth.getClient();
4944
+ * google.options({auth: authClient});
4945
+ *
4946
+ * // Do the magic
4947
+ * const res = await alloydb.projects.locations.clusters.instances.injectFault({
4948
+ * // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
4949
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
4950
+ *
4951
+ * // Request body metadata
4952
+ * requestBody: {
4953
+ * // request body parameters
4954
+ * // {
4955
+ * // "faultType": "my_faultType",
4956
+ * // "requestId": "my_requestId",
4957
+ * // "validateOnly": false
4958
+ * // }
4959
+ * },
4960
+ * });
4961
+ * console.log(res.data);
4962
+ *
4963
+ * // Example response
4964
+ * // {
4965
+ * // "done": false,
4966
+ * // "error": {},
4967
+ * // "metadata": {},
4968
+ * // "name": "my_name",
4969
+ * // "response": {}
4970
+ * // }
4971
+ * }
4972
+ *
4973
+ * main().catch(e => {
4974
+ * console.error(e);
4975
+ * throw e;
4976
+ * });
4977
+ *
4978
+ * ```
3035
4979
  *
3036
4980
  * @param params - Parameters for request
3037
4981
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3046,6 +4990,62 @@ export declare namespace alloydb_v1 {
3046
4990
  injectFault(callback: BodyResponseCallback<Schema$Operation>): void;
3047
4991
  /**
3048
4992
  * Lists Instances in a given project and location.
4993
+ * @example
4994
+ * ```js
4995
+ * // Before running the sample:
4996
+ * // - Enable the API at:
4997
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4998
+ * // - Login into gcloud by running:
4999
+ * // ```sh
5000
+ * // $ gcloud auth application-default login
5001
+ * // ```
5002
+ * // - Install the npm module by running:
5003
+ * // ```sh
5004
+ * // $ npm install googleapis
5005
+ * // ```
5006
+ *
5007
+ * const {google} = require('googleapis');
5008
+ * const alloydb = google.alloydb('v1');
5009
+ *
5010
+ * async function main() {
5011
+ * const auth = new google.auth.GoogleAuth({
5012
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5013
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5014
+ * });
5015
+ *
5016
+ * // Acquire an auth client, and bind it to all future calls
5017
+ * const authClient = await auth.getClient();
5018
+ * google.options({auth: authClient});
5019
+ *
5020
+ * // Do the magic
5021
+ * const res = await alloydb.projects.locations.clusters.instances.list({
5022
+ * // Optional. Filtering results
5023
+ * filter: 'placeholder-value',
5024
+ * // Optional. Hint for how to order the results
5025
+ * orderBy: 'placeholder-value',
5026
+ * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
5027
+ * pageSize: 'placeholder-value',
5028
+ * // A token identifying a page of results the server should return.
5029
+ * pageToken: 'placeholder-value',
5030
+ * // 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/-
5031
+ * parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
5032
+ * });
5033
+ * console.log(res.data);
5034
+ *
5035
+ * // Example response
5036
+ * // {
5037
+ * // "instances": [],
5038
+ * // "nextPageToken": "my_nextPageToken",
5039
+ * // "unreachable": []
5040
+ * // }
5041
+ * }
5042
+ *
5043
+ * main().catch(e => {
5044
+ * console.error(e);
5045
+ * throw e;
5046
+ * });
5047
+ *
5048
+ * ```
3049
5049
  *
3050
5050
  * @param params - Parameters for request
3051
5051
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3060,6 +5060,100 @@ export declare namespace alloydb_v1 {
3060
5060
  list(callback: BodyResponseCallback<Schema$ListInstancesResponse>): void;
3061
5061
  /**
3062
5062
  * Updates the parameters of a single Instance.
5063
+ * @example
5064
+ * ```js
5065
+ * // Before running the sample:
5066
+ * // - Enable the API at:
5067
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5068
+ * // - Login into gcloud by running:
5069
+ * // ```sh
5070
+ * // $ gcloud auth application-default login
5071
+ * // ```
5072
+ * // - Install the npm module by running:
5073
+ * // ```sh
5074
+ * // $ npm install googleapis
5075
+ * // ```
5076
+ *
5077
+ * const {google} = require('googleapis');
5078
+ * const alloydb = google.alloydb('v1');
5079
+ *
5080
+ * async function main() {
5081
+ * const auth = new google.auth.GoogleAuth({
5082
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5083
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5084
+ * });
5085
+ *
5086
+ * // Acquire an auth client, and bind it to all future calls
5087
+ * const authClient = await auth.getClient();
5088
+ * google.options({auth: authClient});
5089
+ *
5090
+ * // Do the magic
5091
+ * const res = await alloydb.projects.locations.clusters.instances.patch({
5092
+ * // 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.
5093
+ * allowMissing: 'placeholder-value',
5094
+ * // 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\}
5095
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
5096
+ * // 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).
5097
+ * requestId: 'placeholder-value',
5098
+ * // 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.
5099
+ * updateMask: 'placeholder-value',
5100
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
5101
+ * validateOnly: 'placeholder-value',
5102
+ *
5103
+ * // Request body metadata
5104
+ * requestBody: {
5105
+ * // request body parameters
5106
+ * // {
5107
+ * // "activationPolicy": "my_activationPolicy",
5108
+ * // "annotations": {},
5109
+ * // "availabilityType": "my_availabilityType",
5110
+ * // "clientConnectionConfig": {},
5111
+ * // "createTime": "my_createTime",
5112
+ * // "databaseFlags": {},
5113
+ * // "deleteTime": "my_deleteTime",
5114
+ * // "displayName": "my_displayName",
5115
+ * // "etag": "my_etag",
5116
+ * // "gceZone": "my_gceZone",
5117
+ * // "instanceType": "my_instanceType",
5118
+ * // "ipAddress": "my_ipAddress",
5119
+ * // "labels": {},
5120
+ * // "machineConfig": {},
5121
+ * // "name": "my_name",
5122
+ * // "networkConfig": {},
5123
+ * // "nodes": [],
5124
+ * // "observabilityConfig": {},
5125
+ * // "outboundPublicIpAddresses": [],
5126
+ * // "pscInstanceConfig": {},
5127
+ * // "publicIpAddress": "my_publicIpAddress",
5128
+ * // "queryInsightsConfig": {},
5129
+ * // "readPoolConfig": {},
5130
+ * // "reconciling": false,
5131
+ * // "satisfiesPzs": false,
5132
+ * // "state": "my_state",
5133
+ * // "uid": "my_uid",
5134
+ * // "updateTime": "my_updateTime",
5135
+ * // "writableNode": {}
5136
+ * // }
5137
+ * },
5138
+ * });
5139
+ * console.log(res.data);
5140
+ *
5141
+ * // Example response
5142
+ * // {
5143
+ * // "done": false,
5144
+ * // "error": {},
5145
+ * // "metadata": {},
5146
+ * // "name": "my_name",
5147
+ * // "response": {}
5148
+ * // }
5149
+ * }
5150
+ *
5151
+ * main().catch(e => {
5152
+ * console.error(e);
5153
+ * throw e;
5154
+ * });
5155
+ *
5156
+ * ```
3063
5157
  *
3064
5158
  * @param params - Parameters for request
3065
5159
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3074,6 +5168,66 @@ export declare namespace alloydb_v1 {
3074
5168
  patch(callback: BodyResponseCallback<Schema$Operation>): void;
3075
5169
  /**
3076
5170
  * Restart an Instance in a cluster. Imperative only.
5171
+ * @example
5172
+ * ```js
5173
+ * // Before running the sample:
5174
+ * // - Enable the API at:
5175
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5176
+ * // - Login into gcloud by running:
5177
+ * // ```sh
5178
+ * // $ gcloud auth application-default login
5179
+ * // ```
5180
+ * // - Install the npm module by running:
5181
+ * // ```sh
5182
+ * // $ npm install googleapis
5183
+ * // ```
5184
+ *
5185
+ * const {google} = require('googleapis');
5186
+ * const alloydb = google.alloydb('v1');
5187
+ *
5188
+ * async function main() {
5189
+ * const auth = new google.auth.GoogleAuth({
5190
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5191
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5192
+ * });
5193
+ *
5194
+ * // Acquire an auth client, and bind it to all future calls
5195
+ * const authClient = await auth.getClient();
5196
+ * google.options({auth: authClient});
5197
+ *
5198
+ * // Do the magic
5199
+ * const res = await alloydb.projects.locations.clusters.instances.restart({
5200
+ * // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
5201
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
5202
+ *
5203
+ * // Request body metadata
5204
+ * requestBody: {
5205
+ * // request body parameters
5206
+ * // {
5207
+ * // "nodeIds": [],
5208
+ * // "requestId": "my_requestId",
5209
+ * // "validateOnly": false
5210
+ * // }
5211
+ * },
5212
+ * });
5213
+ * console.log(res.data);
5214
+ *
5215
+ * // Example response
5216
+ * // {
5217
+ * // "done": false,
5218
+ * // "error": {},
5219
+ * // "metadata": {},
5220
+ * // "name": "my_name",
5221
+ * // "response": {}
5222
+ * // }
5223
+ * }
5224
+ *
5225
+ * main().catch(e => {
5226
+ * console.error(e);
5227
+ * throw e;
5228
+ * });
5229
+ *
5230
+ * ```
3077
5231
  *
3078
5232
  * @param params - Parameters for request
3079
5233
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3252,6 +5406,74 @@ export declare namespace alloydb_v1 {
3252
5406
  constructor(context: APIRequestContext);
3253
5407
  /**
3254
5408
  * Creates a new User in a given project, location, and cluster.
5409
+ * @example
5410
+ * ```js
5411
+ * // Before running the sample:
5412
+ * // - Enable the API at:
5413
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5414
+ * // - Login into gcloud by running:
5415
+ * // ```sh
5416
+ * // $ gcloud auth application-default login
5417
+ * // ```
5418
+ * // - Install the npm module by running:
5419
+ * // ```sh
5420
+ * // $ npm install googleapis
5421
+ * // ```
5422
+ *
5423
+ * const {google} = require('googleapis');
5424
+ * const alloydb = google.alloydb('v1');
5425
+ *
5426
+ * async function main() {
5427
+ * const auth = new google.auth.GoogleAuth({
5428
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5429
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5430
+ * });
5431
+ *
5432
+ * // Acquire an auth client, and bind it to all future calls
5433
+ * const authClient = await auth.getClient();
5434
+ * google.options({auth: authClient});
5435
+ *
5436
+ * // Do the magic
5437
+ * const res = await alloydb.projects.locations.clusters.users.create({
5438
+ * // Required. Value for parent.
5439
+ * parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
5440
+ * // 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).
5441
+ * requestId: 'placeholder-value',
5442
+ * // Required. ID of the requesting object.
5443
+ * userId: 'placeholder-value',
5444
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
5445
+ * validateOnly: 'placeholder-value',
5446
+ *
5447
+ * // Request body metadata
5448
+ * requestBody: {
5449
+ * // request body parameters
5450
+ * // {
5451
+ * // "databaseRoles": [],
5452
+ * // "keepExtraRoles": false,
5453
+ * // "name": "my_name",
5454
+ * // "password": "my_password",
5455
+ * // "userType": "my_userType"
5456
+ * // }
5457
+ * },
5458
+ * });
5459
+ * console.log(res.data);
5460
+ *
5461
+ * // Example response
5462
+ * // {
5463
+ * // "databaseRoles": [],
5464
+ * // "keepExtraRoles": false,
5465
+ * // "name": "my_name",
5466
+ * // "password": "my_password",
5467
+ * // "userType": "my_userType"
5468
+ * // }
5469
+ * }
5470
+ *
5471
+ * main().catch(e => {
5472
+ * console.error(e);
5473
+ * throw e;
5474
+ * });
5475
+ *
5476
+ * ```
3255
5477
  *
3256
5478
  * @param params - Parameters for request
3257
5479
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3266,6 +5488,54 @@ export declare namespace alloydb_v1 {
3266
5488
  create(callback: BodyResponseCallback<Schema$User>): void;
3267
5489
  /**
3268
5490
  * Deletes a single User.
5491
+ * @example
5492
+ * ```js
5493
+ * // Before running the sample:
5494
+ * // - Enable the API at:
5495
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5496
+ * // - Login into gcloud by running:
5497
+ * // ```sh
5498
+ * // $ gcloud auth application-default login
5499
+ * // ```
5500
+ * // - Install the npm module by running:
5501
+ * // ```sh
5502
+ * // $ npm install googleapis
5503
+ * // ```
5504
+ *
5505
+ * const {google} = require('googleapis');
5506
+ * const alloydb = google.alloydb('v1');
5507
+ *
5508
+ * async function main() {
5509
+ * const auth = new google.auth.GoogleAuth({
5510
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5511
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5512
+ * });
5513
+ *
5514
+ * // Acquire an auth client, and bind it to all future calls
5515
+ * const authClient = await auth.getClient();
5516
+ * google.options({auth: authClient});
5517
+ *
5518
+ * // Do the magic
5519
+ * const res = await alloydb.projects.locations.clusters.users.delete({
5520
+ * // Required. The name of the resource. For the required format, see the comment on the User.name field.
5521
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/users/my-user',
5522
+ * // 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).
5523
+ * requestId: 'placeholder-value',
5524
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
5525
+ * validateOnly: 'placeholder-value',
5526
+ * });
5527
+ * console.log(res.data);
5528
+ *
5529
+ * // Example response
5530
+ * // {}
5531
+ * }
5532
+ *
5533
+ * main().catch(e => {
5534
+ * console.error(e);
5535
+ * throw e;
5536
+ * });
5537
+ *
5538
+ * ```
3269
5539
  *
3270
5540
  * @param params - Parameters for request
3271
5541
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3280,6 +5550,56 @@ export declare namespace alloydb_v1 {
3280
5550
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
3281
5551
  /**
3282
5552
  * Gets details of a single User.
5553
+ * @example
5554
+ * ```js
5555
+ * // Before running the sample:
5556
+ * // - Enable the API at:
5557
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5558
+ * // - Login into gcloud by running:
5559
+ * // ```sh
5560
+ * // $ gcloud auth application-default login
5561
+ * // ```
5562
+ * // - Install the npm module by running:
5563
+ * // ```sh
5564
+ * // $ npm install googleapis
5565
+ * // ```
5566
+ *
5567
+ * const {google} = require('googleapis');
5568
+ * const alloydb = google.alloydb('v1');
5569
+ *
5570
+ * async function main() {
5571
+ * const auth = new google.auth.GoogleAuth({
5572
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5573
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5574
+ * });
5575
+ *
5576
+ * // Acquire an auth client, and bind it to all future calls
5577
+ * const authClient = await auth.getClient();
5578
+ * google.options({auth: authClient});
5579
+ *
5580
+ * // Do the magic
5581
+ * const res = await alloydb.projects.locations.clusters.users.get({
5582
+ * // Required. The name of the resource. For the required format, see the comment on the User.name field.
5583
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/users/my-user',
5584
+ * });
5585
+ * console.log(res.data);
5586
+ *
5587
+ * // Example response
5588
+ * // {
5589
+ * // "databaseRoles": [],
5590
+ * // "keepExtraRoles": false,
5591
+ * // "name": "my_name",
5592
+ * // "password": "my_password",
5593
+ * // "userType": "my_userType"
5594
+ * // }
5595
+ * }
5596
+ *
5597
+ * main().catch(e => {
5598
+ * console.error(e);
5599
+ * throw e;
5600
+ * });
5601
+ *
5602
+ * ```
3283
5603
  *
3284
5604
  * @param params - Parameters for request
3285
5605
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3294,6 +5614,62 @@ export declare namespace alloydb_v1 {
3294
5614
  get(callback: BodyResponseCallback<Schema$User>): void;
3295
5615
  /**
3296
5616
  * Lists Users in a given project and location.
5617
+ * @example
5618
+ * ```js
5619
+ * // Before running the sample:
5620
+ * // - Enable the API at:
5621
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5622
+ * // - Login into gcloud by running:
5623
+ * // ```sh
5624
+ * // $ gcloud auth application-default login
5625
+ * // ```
5626
+ * // - Install the npm module by running:
5627
+ * // ```sh
5628
+ * // $ npm install googleapis
5629
+ * // ```
5630
+ *
5631
+ * const {google} = require('googleapis');
5632
+ * const alloydb = google.alloydb('v1');
5633
+ *
5634
+ * async function main() {
5635
+ * const auth = new google.auth.GoogleAuth({
5636
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5637
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5638
+ * });
5639
+ *
5640
+ * // Acquire an auth client, and bind it to all future calls
5641
+ * const authClient = await auth.getClient();
5642
+ * google.options({auth: authClient});
5643
+ *
5644
+ * // Do the magic
5645
+ * const res = await alloydb.projects.locations.clusters.users.list({
5646
+ * // Optional. Filtering results
5647
+ * filter: 'placeholder-value',
5648
+ * // Optional. Hint for how to order the results
5649
+ * orderBy: 'placeholder-value',
5650
+ * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
5651
+ * pageSize: 'placeholder-value',
5652
+ * // Optional. A token identifying a page of results the server should return.
5653
+ * pageToken: 'placeholder-value',
5654
+ * // Required. Parent value for ListUsersRequest
5655
+ * parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
5656
+ * });
5657
+ * console.log(res.data);
5658
+ *
5659
+ * // Example response
5660
+ * // {
5661
+ * // "nextPageToken": "my_nextPageToken",
5662
+ * // "unreachable": [],
5663
+ * // "users": []
5664
+ * // }
5665
+ * }
5666
+ *
5667
+ * main().catch(e => {
5668
+ * console.error(e);
5669
+ * throw e;
5670
+ * });
5671
+ *
5672
+ * ```
3297
5673
  *
3298
5674
  * @param params - Parameters for request
3299
5675
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3308,6 +5684,76 @@ export declare namespace alloydb_v1 {
3308
5684
  list(callback: BodyResponseCallback<Schema$ListUsersResponse>): void;
3309
5685
  /**
3310
5686
  * Updates the parameters of a single User.
5687
+ * @example
5688
+ * ```js
5689
+ * // Before running the sample:
5690
+ * // - Enable the API at:
5691
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5692
+ * // - Login into gcloud by running:
5693
+ * // ```sh
5694
+ * // $ gcloud auth application-default login
5695
+ * // ```
5696
+ * // - Install the npm module by running:
5697
+ * // ```sh
5698
+ * // $ npm install googleapis
5699
+ * // ```
5700
+ *
5701
+ * const {google} = require('googleapis');
5702
+ * const alloydb = google.alloydb('v1');
5703
+ *
5704
+ * async function main() {
5705
+ * const auth = new google.auth.GoogleAuth({
5706
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5707
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5708
+ * });
5709
+ *
5710
+ * // Acquire an auth client, and bind it to all future calls
5711
+ * const authClient = await auth.getClient();
5712
+ * google.options({auth: authClient});
5713
+ *
5714
+ * // Do the magic
5715
+ * const res = await alloydb.projects.locations.clusters.users.patch({
5716
+ * // Optional. Allow missing fields in the update mask.
5717
+ * allowMissing: 'placeholder-value',
5718
+ * // Output only. Name of the resource in the form of projects/{project\}/locations/{location\}/cluster/{cluster\}/users/{user\}.
5719
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/users/my-user',
5720
+ * // 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).
5721
+ * requestId: 'placeholder-value',
5722
+ * // 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.
5723
+ * updateMask: 'placeholder-value',
5724
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
5725
+ * validateOnly: 'placeholder-value',
5726
+ *
5727
+ * // Request body metadata
5728
+ * requestBody: {
5729
+ * // request body parameters
5730
+ * // {
5731
+ * // "databaseRoles": [],
5732
+ * // "keepExtraRoles": false,
5733
+ * // "name": "my_name",
5734
+ * // "password": "my_password",
5735
+ * // "userType": "my_userType"
5736
+ * // }
5737
+ * },
5738
+ * });
5739
+ * console.log(res.data);
5740
+ *
5741
+ * // Example response
5742
+ * // {
5743
+ * // "databaseRoles": [],
5744
+ * // "keepExtraRoles": false,
5745
+ * // "name": "my_name",
5746
+ * // "password": "my_password",
5747
+ * // "userType": "my_userType"
5748
+ * // }
5749
+ * }
5750
+ *
5751
+ * main().catch(e => {
5752
+ * console.error(e);
5753
+ * throw e;
5754
+ * });
5755
+ *
5756
+ * ```
3311
5757
  *
3312
5758
  * @param params - Parameters for request
3313
5759
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3416,6 +5862,56 @@ export declare namespace alloydb_v1 {
3416
5862
  constructor(context: APIRequestContext);
3417
5863
  /**
3418
5864
  * 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`.
5865
+ * @example
5866
+ * ```js
5867
+ * // Before running the sample:
5868
+ * // - Enable the API at:
5869
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5870
+ * // - Login into gcloud by running:
5871
+ * // ```sh
5872
+ * // $ gcloud auth application-default login
5873
+ * // ```
5874
+ * // - Install the npm module by running:
5875
+ * // ```sh
5876
+ * // $ npm install googleapis
5877
+ * // ```
5878
+ *
5879
+ * const {google} = require('googleapis');
5880
+ * const alloydb = google.alloydb('v1');
5881
+ *
5882
+ * async function main() {
5883
+ * const auth = new google.auth.GoogleAuth({
5884
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5885
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5886
+ * });
5887
+ *
5888
+ * // Acquire an auth client, and bind it to all future calls
5889
+ * const authClient = await auth.getClient();
5890
+ * google.options({auth: authClient});
5891
+ *
5892
+ * // Do the magic
5893
+ * const res = await alloydb.projects.locations.operations.cancel({
5894
+ * // The name of the operation resource to be cancelled.
5895
+ * name: 'projects/my-project/locations/my-location/operations/my-operation',
5896
+ *
5897
+ * // Request body metadata
5898
+ * requestBody: {
5899
+ * // request body parameters
5900
+ * // {}
5901
+ * },
5902
+ * });
5903
+ * console.log(res.data);
5904
+ *
5905
+ * // Example response
5906
+ * // {}
5907
+ * }
5908
+ *
5909
+ * main().catch(e => {
5910
+ * console.error(e);
5911
+ * throw e;
5912
+ * });
5913
+ *
5914
+ * ```
3419
5915
  *
3420
5916
  * @param params - Parameters for request
3421
5917
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3430,6 +5926,50 @@ export declare namespace alloydb_v1 {
3430
5926
  cancel(callback: BodyResponseCallback<Schema$Empty>): void;
3431
5927
  /**
3432
5928
  * 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`.
5929
+ * @example
5930
+ * ```js
5931
+ * // Before running the sample:
5932
+ * // - Enable the API at:
5933
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5934
+ * // - Login into gcloud by running:
5935
+ * // ```sh
5936
+ * // $ gcloud auth application-default login
5937
+ * // ```
5938
+ * // - Install the npm module by running:
5939
+ * // ```sh
5940
+ * // $ npm install googleapis
5941
+ * // ```
5942
+ *
5943
+ * const {google} = require('googleapis');
5944
+ * const alloydb = google.alloydb('v1');
5945
+ *
5946
+ * async function main() {
5947
+ * const auth = new google.auth.GoogleAuth({
5948
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5949
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5950
+ * });
5951
+ *
5952
+ * // Acquire an auth client, and bind it to all future calls
5953
+ * const authClient = await auth.getClient();
5954
+ * google.options({auth: authClient});
5955
+ *
5956
+ * // Do the magic
5957
+ * const res = await alloydb.projects.locations.operations.delete({
5958
+ * // The name of the operation resource to be deleted.
5959
+ * name: 'projects/my-project/locations/my-location/operations/my-operation',
5960
+ * });
5961
+ * console.log(res.data);
5962
+ *
5963
+ * // Example response
5964
+ * // {}
5965
+ * }
5966
+ *
5967
+ * main().catch(e => {
5968
+ * console.error(e);
5969
+ * throw e;
5970
+ * });
5971
+ *
5972
+ * ```
3433
5973
  *
3434
5974
  * @param params - Parameters for request
3435
5975
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3444,6 +5984,56 @@ export declare namespace alloydb_v1 {
3444
5984
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
3445
5985
  /**
3446
5986
  * 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.
5987
+ * @example
5988
+ * ```js
5989
+ * // Before running the sample:
5990
+ * // - Enable the API at:
5991
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5992
+ * // - Login into gcloud by running:
5993
+ * // ```sh
5994
+ * // $ gcloud auth application-default login
5995
+ * // ```
5996
+ * // - Install the npm module by running:
5997
+ * // ```sh
5998
+ * // $ npm install googleapis
5999
+ * // ```
6000
+ *
6001
+ * const {google} = require('googleapis');
6002
+ * const alloydb = google.alloydb('v1');
6003
+ *
6004
+ * async function main() {
6005
+ * const auth = new google.auth.GoogleAuth({
6006
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6007
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
6008
+ * });
6009
+ *
6010
+ * // Acquire an auth client, and bind it to all future calls
6011
+ * const authClient = await auth.getClient();
6012
+ * google.options({auth: authClient});
6013
+ *
6014
+ * // Do the magic
6015
+ * const res = await alloydb.projects.locations.operations.get({
6016
+ * // The name of the operation resource.
6017
+ * name: 'projects/my-project/locations/my-location/operations/my-operation',
6018
+ * });
6019
+ * console.log(res.data);
6020
+ *
6021
+ * // Example response
6022
+ * // {
6023
+ * // "done": false,
6024
+ * // "error": {},
6025
+ * // "metadata": {},
6026
+ * // "name": "my_name",
6027
+ * // "response": {}
6028
+ * // }
6029
+ * }
6030
+ *
6031
+ * main().catch(e => {
6032
+ * console.error(e);
6033
+ * throw e;
6034
+ * });
6035
+ *
6036
+ * ```
3447
6037
  *
3448
6038
  * @param params - Parameters for request
3449
6039
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3458,6 +6048,59 @@ export declare namespace alloydb_v1 {
3458
6048
  get(callback: BodyResponseCallback<Schema$Operation>): void;
3459
6049
  /**
3460
6050
  * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
6051
+ * @example
6052
+ * ```js
6053
+ * // Before running the sample:
6054
+ * // - Enable the API at:
6055
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
6056
+ * // - Login into gcloud by running:
6057
+ * // ```sh
6058
+ * // $ gcloud auth application-default login
6059
+ * // ```
6060
+ * // - Install the npm module by running:
6061
+ * // ```sh
6062
+ * // $ npm install googleapis
6063
+ * // ```
6064
+ *
6065
+ * const {google} = require('googleapis');
6066
+ * const alloydb = google.alloydb('v1');
6067
+ *
6068
+ * async function main() {
6069
+ * const auth = new google.auth.GoogleAuth({
6070
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6071
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
6072
+ * });
6073
+ *
6074
+ * // Acquire an auth client, and bind it to all future calls
6075
+ * const authClient = await auth.getClient();
6076
+ * google.options({auth: authClient});
6077
+ *
6078
+ * // Do the magic
6079
+ * const res = await alloydb.projects.locations.operations.list({
6080
+ * // The standard list filter.
6081
+ * filter: 'placeholder-value',
6082
+ * // The name of the operation's parent resource.
6083
+ * name: 'projects/my-project/locations/my-location',
6084
+ * // The standard list page size.
6085
+ * pageSize: 'placeholder-value',
6086
+ * // The standard list page token.
6087
+ * pageToken: 'placeholder-value',
6088
+ * });
6089
+ * console.log(res.data);
6090
+ *
6091
+ * // Example response
6092
+ * // {
6093
+ * // "nextPageToken": "my_nextPageToken",
6094
+ * // "operations": []
6095
+ * // }
6096
+ * }
6097
+ *
6098
+ * main().catch(e => {
6099
+ * console.error(e);
6100
+ * throw e;
6101
+ * });
6102
+ *
6103
+ * ```
3461
6104
  *
3462
6105
  * @param params - Parameters for request
3463
6106
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3516,6 +6159,59 @@ export declare namespace alloydb_v1 {
3516
6159
  constructor(context: APIRequestContext);
3517
6160
  /**
3518
6161
  * Lists SupportedDatabaseFlags for a given project and location.
6162
+ * @example
6163
+ * ```js
6164
+ * // Before running the sample:
6165
+ * // - Enable the API at:
6166
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
6167
+ * // - Login into gcloud by running:
6168
+ * // ```sh
6169
+ * // $ gcloud auth application-default login
6170
+ * // ```
6171
+ * // - Install the npm module by running:
6172
+ * // ```sh
6173
+ * // $ npm install googleapis
6174
+ * // ```
6175
+ *
6176
+ * const {google} = require('googleapis');
6177
+ * const alloydb = google.alloydb('v1');
6178
+ *
6179
+ * async function main() {
6180
+ * const auth = new google.auth.GoogleAuth({
6181
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6182
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
6183
+ * });
6184
+ *
6185
+ * // Acquire an auth client, and bind it to all future calls
6186
+ * const authClient = await auth.getClient();
6187
+ * google.options({auth: authClient});
6188
+ *
6189
+ * // Do the magic
6190
+ * const res = await alloydb.projects.locations.supportedDatabaseFlags.list({
6191
+ * // Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
6192
+ * pageSize: 'placeholder-value',
6193
+ * // A token identifying a page of results the server should return.
6194
+ * pageToken: 'placeholder-value',
6195
+ * // 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.
6196
+ * parent: 'projects/my-project/locations/my-location',
6197
+ * // Optional. The scope for which supported flags are requested. If not specified, default is DATABASE.
6198
+ * scope: 'placeholder-value',
6199
+ * });
6200
+ * console.log(res.data);
6201
+ *
6202
+ * // Example response
6203
+ * // {
6204
+ * // "nextPageToken": "my_nextPageToken",
6205
+ * // "supportedDatabaseFlags": []
6206
+ * // }
6207
+ * }
6208
+ *
6209
+ * main().catch(e => {
6210
+ * console.error(e);
6211
+ * throw e;
6212
+ * });
6213
+ *
6214
+ * ```
3519
6215
  *
3520
6216
  * @param params - Parameters for request
3521
6217
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.