@googleapis/alloydb 13.0.1 → 14.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/build/v1beta.d.ts CHANGED
@@ -399,6 +399,10 @@ export declare namespace alloydb_v1beta {
399
399
  * Cross Region replication config specific to SECONDARY cluster.
400
400
  */
401
401
  secondaryConfig?: Schema$SecondaryConfig;
402
+ /**
403
+ * Output only. AlloyDB per-cluster service account. This service account is created per-cluster per-project, and is different from the per-project service account. The per-cluster service account naming format is subject to change.
404
+ */
405
+ serviceAccountEmail?: string | null;
402
406
  /**
403
407
  * SSL configuration for this AlloyDB cluster.
404
408
  */
@@ -493,7 +497,7 @@ export declare namespace alloydb_v1beta {
493
497
  */
494
498
  export interface Schema$ConnectionPoolConfig {
495
499
  /**
496
- * Optional. Deprecated. Use 'flags' instead. The default pool size. Defaults to 20.
500
+ * Optional. Deprecated. Use 'flags' instead. The default pool size. Defaults to 20. Note: This field should not be added to client libraries if not present already.
497
501
  */
498
502
  defaultPoolSize?: string | null;
499
503
  /**
@@ -511,35 +515,39 @@ export declare namespace alloydb_v1beta {
511
515
  [key: string]: string;
512
516
  } | null;
513
517
  /**
514
- * Optional. Deprecated. Use 'flags' instead. The list of startup parameters to ignore. Defaults to ["extra_float_digits"]
518
+ * Optional. Deprecated. Use 'flags' instead. The list of startup parameters to ignore. Defaults to ["extra_float_digits"] Note: This field should not be added to client libraries if not present already.
515
519
  */
516
520
  ignoreStartupParameters?: string[] | null;
517
521
  /**
518
- * Optional. Deprecated. Use 'flags' instead. The maximum number of client connections allowed.
522
+ * Optional. Deprecated. Use 'flags' instead. The maximum number of client connections allowed. Note: This field should not be added to client libraries if not present already.
519
523
  */
520
524
  maxClientConn?: string | null;
521
525
  /**
522
- * Optional. Deprecated. Use 'flags' instead. The maximum number of prepared statements allowed. MCP makes sure that any statement prepared by a client, up to this limit, is available on the backing server connection in transaction and statement pooling mode. Even if the statement was originally prepared on another server connection. Defaults to 0.
526
+ * Optional. Deprecated. Use 'flags' instead. The maximum number of prepared statements allowed. MCP makes sure that any statement prepared by a client, up to this limit, is available on the backing server connection in transaction and statement pooling mode. Even if the statement was originally prepared on another server connection. Defaults to 0. Note: This field should not be added to client libraries if not present already.
523
527
  */
524
528
  maxPreparedStatements?: string | null;
525
529
  /**
526
- * Optional. Deprecated. Use 'flags' instead. The minimum pool size. Defaults to 0.
530
+ * Optional. Deprecated. Use 'flags' instead. The minimum pool size. Defaults to 0. Note: This field should not be added to client libraries if not present already.
527
531
  */
528
532
  minPoolSize?: string | null;
529
533
  /**
530
- * Optional. Deprecated. Use 'flags' instead. The pool mode. Defaults to `POOL_MODE_TRANSACTION`.
534
+ * Output only. The number of running poolers per instance.
535
+ */
536
+ poolerCount?: number | null;
537
+ /**
538
+ * Optional. Deprecated. Use 'flags' instead. The pool mode. Defaults to `POOL_MODE_TRANSACTION`. Note: This field should not be added to client libraries if not present already.
531
539
  */
532
540
  poolMode?: string | null;
533
541
  /**
534
- * Optional. Deprecated. Use 'flags' instead. The maximum number of seconds queries are allowed to spend waiting for execution. If the query is not assigned to a server during that time, the client is disconnected. 0 disables.
542
+ * Optional. Deprecated. Use 'flags' instead. The maximum number of seconds queries are allowed to spend waiting for execution. If the query is not assigned to a server during that time, the client is disconnected. 0 disables. Note: This field should not be added to client libraries if not present already.
535
543
  */
536
544
  queryWaitTimeout?: string | null;
537
545
  /**
538
- * Optional. Deprecated. Use 'flags' instead. The maximum number of seconds a server is allowed to be idle before it is disconnected. 0 disables.
546
+ * Optional. Deprecated. Use 'flags' instead. The maximum number of seconds a server is allowed to be idle before it is disconnected. 0 disables. Note: This field should not be added to client libraries if not present already.
539
547
  */
540
548
  serverIdleTimeout?: string | null;
541
549
  /**
542
- * Optional. Deprecated. Use 'flags' instead. The list of users that are allowed to connect to the MCP stats console. The users must exist in the database.
550
+ * Optional. Deprecated. Use 'flags' instead. The list of users that are allowed to connect to the MCP stats console. The users must exist in the database. Note: This field should not be added to client libraries if not present already.
543
551
  */
544
552
  statsUsers?: string[] | null;
545
553
  }
@@ -565,7 +573,7 @@ export declare namespace alloydb_v1beta {
565
573
  */
566
574
  export interface Schema$ContinuousBackupInfo {
567
575
  /**
568
- * Output only. The earliest restorable time that can be restored to. Output only field.
576
+ * 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.
569
577
  */
570
578
  earliestRestorableTime?: string | null;
571
579
  /**
@@ -577,7 +585,7 @@ export declare namespace alloydb_v1beta {
577
585
  */
578
586
  encryptionInfo?: Schema$EncryptionInfo;
579
587
  /**
580
- * Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
588
+ * Output only. Days of the week on which a continuous backup is taken.
581
589
  */
582
590
  schedule?: string[] | null;
583
591
  }
@@ -737,7 +745,7 @@ export declare namespace alloydb_v1beta {
737
745
  uri?: string | null;
738
746
  }
739
747
  /**
740
- * Deprecated and unused. This field will be removed in the near future.
748
+ * Deprecated and unused. This message will be removed in the near future.
741
749
  */
742
750
  export interface Schema$GeminiClusterConfig {
743
751
  /**
@@ -746,7 +754,7 @@ export declare namespace alloydb_v1beta {
746
754
  entitled?: boolean | null;
747
755
  }
748
756
  /**
749
- * Deprecated and unused. This field will be removed in the near future.
757
+ * Deprecated and unused. This message will be removed in the near future.
750
758
  */
751
759
  export interface Schema$GeminiInstanceConfig {
752
760
  /**
@@ -1023,6 +1031,10 @@ export declare namespace alloydb_v1beta {
1023
1031
  * Metadata related to instance-level network configuration.
1024
1032
  */
1025
1033
  export interface Schema$InstanceNetworkConfig {
1034
+ /**
1035
+ * 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])?.
1036
+ */
1037
+ allocatedIpRangeOverride?: string | null;
1026
1038
  /**
1027
1039
  * Optional. A list of external network authorized to access this instance.
1028
1040
  */
@@ -1041,7 +1053,7 @@ export declare namespace alloydb_v1beta {
1041
1053
  network?: string | null;
1042
1054
  }
1043
1055
  /**
1044
- * Details regarding the upgrade of instaces associated with a cluster.
1056
+ * Details regarding the upgrade of instances associated with a cluster.
1045
1057
  */
1046
1058
  export interface Schema$InstanceUpgradeDetails {
1047
1059
  /**
@@ -1295,6 +1307,10 @@ export declare namespace alloydb_v1beta {
1295
1307
  * Track actively running queries on the instance. If not set, this flag is "off" by default.
1296
1308
  */
1297
1309
  trackActiveQueries?: boolean | null;
1310
+ /**
1311
+ * Track client address for an instance. If not set, default value is "off".
1312
+ */
1313
+ trackClientAddress?: boolean | null;
1298
1314
  /**
1299
1315
  * Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on.
1300
1316
  */
@@ -1791,7 +1807,7 @@ export declare namespace alloydb_v1beta {
1791
1807
  internalResourceMetadata?: Schema$StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata[];
1792
1808
  }
1793
1809
  /**
1794
- * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform.
1810
+ * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 8
1795
1811
  */
1796
1812
  export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed {
1797
1813
  /**
@@ -1837,6 +1853,10 @@ export declare namespace alloydb_v1beta {
1837
1853
  * 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.
1838
1854
  */
1839
1855
  externalUri?: string | null;
1856
+ /**
1857
+ * This is used to identify the location of the resource. Example: "us-central1"
1858
+ */
1859
+ location?: string | null;
1840
1860
  /**
1841
1861
  * Required. The name of the signal, ex: PUBLIC_SQL_INSTANCE, SQL_LOG_ERROR_VERBOSITY etc.
1842
1862
  */
@@ -1884,7 +1904,7 @@ export declare namespace alloydb_v1beta {
1884
1904
  */
1885
1905
  providerDescription?: string | null;
1886
1906
  /**
1887
- * 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
1907
+ * 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
1888
1908
  */
1889
1909
  resourceType?: string | null;
1890
1910
  /**
@@ -2438,6 +2458,56 @@ export declare namespace alloydb_v1beta {
2438
2458
  constructor(context: APIRequestContext);
2439
2459
  /**
2440
2460
  * Gets information about a location.
2461
+ * @example
2462
+ * ```js
2463
+ * // Before running the sample:
2464
+ * // - Enable the API at:
2465
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
2466
+ * // - Login into gcloud by running:
2467
+ * // ```sh
2468
+ * // $ gcloud auth application-default login
2469
+ * // ```
2470
+ * // - Install the npm module by running:
2471
+ * // ```sh
2472
+ * // $ npm install googleapis
2473
+ * // ```
2474
+ *
2475
+ * const {google} = require('googleapis');
2476
+ * const alloydb = google.alloydb('v1beta');
2477
+ *
2478
+ * async function main() {
2479
+ * const auth = new google.auth.GoogleAuth({
2480
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2481
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2482
+ * });
2483
+ *
2484
+ * // Acquire an auth client, and bind it to all future calls
2485
+ * const authClient = await auth.getClient();
2486
+ * google.options({auth: authClient});
2487
+ *
2488
+ * // Do the magic
2489
+ * const res = await alloydb.projects.locations.get({
2490
+ * // Resource name for the location.
2491
+ * name: 'projects/my-project/locations/my-location',
2492
+ * });
2493
+ * console.log(res.data);
2494
+ *
2495
+ * // Example response
2496
+ * // {
2497
+ * // "displayName": "my_displayName",
2498
+ * // "labels": {},
2499
+ * // "locationId": "my_locationId",
2500
+ * // "metadata": {},
2501
+ * // "name": "my_name"
2502
+ * // }
2503
+ * }
2504
+ *
2505
+ * main().catch(e => {
2506
+ * console.error(e);
2507
+ * throw e;
2508
+ * });
2509
+ *
2510
+ * ```
2441
2511
  *
2442
2512
  * @param params - Parameters for request
2443
2513
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2452,6 +2522,61 @@ export declare namespace alloydb_v1beta {
2452
2522
  get(callback: BodyResponseCallback<Schema$GoogleCloudLocationLocation>): void;
2453
2523
  /**
2454
2524
  * Lists information about the supported locations for this service.
2525
+ * @example
2526
+ * ```js
2527
+ * // Before running the sample:
2528
+ * // - Enable the API at:
2529
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
2530
+ * // - Login into gcloud by running:
2531
+ * // ```sh
2532
+ * // $ gcloud auth application-default login
2533
+ * // ```
2534
+ * // - Install the npm module by running:
2535
+ * // ```sh
2536
+ * // $ npm install googleapis
2537
+ * // ```
2538
+ *
2539
+ * const {google} = require('googleapis');
2540
+ * const alloydb = google.alloydb('v1beta');
2541
+ *
2542
+ * async function main() {
2543
+ * const auth = new google.auth.GoogleAuth({
2544
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2545
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2546
+ * });
2547
+ *
2548
+ * // Acquire an auth client, and bind it to all future calls
2549
+ * const authClient = await auth.getClient();
2550
+ * google.options({auth: authClient});
2551
+ *
2552
+ * // Do the magic
2553
+ * const res = await alloydb.projects.locations.list({
2554
+ * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.
2555
+ * extraLocationTypes: 'placeholder-value',
2556
+ * // 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).
2557
+ * filter: 'placeholder-value',
2558
+ * // The resource that owns the locations collection, if applicable.
2559
+ * name: 'projects/my-project',
2560
+ * // The maximum number of results to return. If not set, the service selects a default.
2561
+ * pageSize: 'placeholder-value',
2562
+ * // A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
2563
+ * pageToken: 'placeholder-value',
2564
+ * });
2565
+ * console.log(res.data);
2566
+ *
2567
+ * // Example response
2568
+ * // {
2569
+ * // "locations": [],
2570
+ * // "nextPageToken": "my_nextPageToken"
2571
+ * // }
2572
+ * }
2573
+ *
2574
+ * main().catch(e => {
2575
+ * console.error(e);
2576
+ * throw e;
2577
+ * });
2578
+ *
2579
+ * ```
2455
2580
  *
2456
2581
  * @param params - Parameters for request
2457
2582
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2498,6 +2623,93 @@ export declare namespace alloydb_v1beta {
2498
2623
  constructor(context: APIRequestContext);
2499
2624
  /**
2500
2625
  * Creates a new Backup in a given project and location.
2626
+ * @example
2627
+ * ```js
2628
+ * // Before running the sample:
2629
+ * // - Enable the API at:
2630
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
2631
+ * // - Login into gcloud by running:
2632
+ * // ```sh
2633
+ * // $ gcloud auth application-default login
2634
+ * // ```
2635
+ * // - Install the npm module by running:
2636
+ * // ```sh
2637
+ * // $ npm install googleapis
2638
+ * // ```
2639
+ *
2640
+ * const {google} = require('googleapis');
2641
+ * const alloydb = google.alloydb('v1beta');
2642
+ *
2643
+ * async function main() {
2644
+ * const auth = new google.auth.GoogleAuth({
2645
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2646
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2647
+ * });
2648
+ *
2649
+ * // Acquire an auth client, and bind it to all future calls
2650
+ * const authClient = await auth.getClient();
2651
+ * google.options({auth: authClient});
2652
+ *
2653
+ * // Do the magic
2654
+ * const res = await alloydb.projects.locations.backups.create({
2655
+ * // Required. ID of the requesting object.
2656
+ * backupId: 'placeholder-value',
2657
+ * // Required. Value for parent.
2658
+ * parent: 'projects/my-project/locations/my-location',
2659
+ * // 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).
2660
+ * requestId: 'placeholder-value',
2661
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
2662
+ * validateOnly: 'placeholder-value',
2663
+ *
2664
+ * // Request body metadata
2665
+ * requestBody: {
2666
+ * // request body parameters
2667
+ * // {
2668
+ * // "annotations": {},
2669
+ * // "clusterName": "my_clusterName",
2670
+ * // "clusterUid": "my_clusterUid",
2671
+ * // "createCompletionTime": "my_createCompletionTime",
2672
+ * // "createTime": "my_createTime",
2673
+ * // "databaseVersion": "my_databaseVersion",
2674
+ * // "deleteTime": "my_deleteTime",
2675
+ * // "description": "my_description",
2676
+ * // "displayName": "my_displayName",
2677
+ * // "encryptionConfig": {},
2678
+ * // "encryptionInfo": {},
2679
+ * // "etag": "my_etag",
2680
+ * // "expiryQuantity": {},
2681
+ * // "expiryTime": "my_expiryTime",
2682
+ * // "labels": {},
2683
+ * // "name": "my_name",
2684
+ * // "reconciling": false,
2685
+ * // "satisfiesPzs": false,
2686
+ * // "sizeBytes": "my_sizeBytes",
2687
+ * // "state": "my_state",
2688
+ * // "tags": {},
2689
+ * // "type": "my_type",
2690
+ * // "uid": "my_uid",
2691
+ * // "updateTime": "my_updateTime"
2692
+ * // }
2693
+ * },
2694
+ * });
2695
+ * console.log(res.data);
2696
+ *
2697
+ * // Example response
2698
+ * // {
2699
+ * // "done": false,
2700
+ * // "error": {},
2701
+ * // "metadata": {},
2702
+ * // "name": "my_name",
2703
+ * // "response": {}
2704
+ * // }
2705
+ * }
2706
+ *
2707
+ * main().catch(e => {
2708
+ * console.error(e);
2709
+ * throw e;
2710
+ * });
2711
+ *
2712
+ * ```
2501
2713
  *
2502
2714
  * @param params - Parameters for request
2503
2715
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2512,6 +2724,62 @@ export declare namespace alloydb_v1beta {
2512
2724
  create(callback: BodyResponseCallback<Schema$Operation>): void;
2513
2725
  /**
2514
2726
  * Deletes a single Backup.
2727
+ * @example
2728
+ * ```js
2729
+ * // Before running the sample:
2730
+ * // - Enable the API at:
2731
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
2732
+ * // - Login into gcloud by running:
2733
+ * // ```sh
2734
+ * // $ gcloud auth application-default login
2735
+ * // ```
2736
+ * // - Install the npm module by running:
2737
+ * // ```sh
2738
+ * // $ npm install googleapis
2739
+ * // ```
2740
+ *
2741
+ * const {google} = require('googleapis');
2742
+ * const alloydb = google.alloydb('v1beta');
2743
+ *
2744
+ * async function main() {
2745
+ * const auth = new google.auth.GoogleAuth({
2746
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2747
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2748
+ * });
2749
+ *
2750
+ * // Acquire an auth client, and bind it to all future calls
2751
+ * const authClient = await auth.getClient();
2752
+ * google.options({auth: authClient});
2753
+ *
2754
+ * // Do the magic
2755
+ * const res = await alloydb.projects.locations.backups.delete({
2756
+ * // 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.
2757
+ * etag: 'placeholder-value',
2758
+ * // Required. Name of the resource. For the required format, see the comment on the Backup.name field.
2759
+ * name: 'projects/my-project/locations/my-location/backups/my-backup',
2760
+ * // 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).
2761
+ * requestId: 'placeholder-value',
2762
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
2763
+ * validateOnly: 'placeholder-value',
2764
+ * });
2765
+ * console.log(res.data);
2766
+ *
2767
+ * // Example response
2768
+ * // {
2769
+ * // "done": false,
2770
+ * // "error": {},
2771
+ * // "metadata": {},
2772
+ * // "name": "my_name",
2773
+ * // "response": {}
2774
+ * // }
2775
+ * }
2776
+ *
2777
+ * main().catch(e => {
2778
+ * console.error(e);
2779
+ * throw e;
2780
+ * });
2781
+ *
2782
+ * ```
2515
2783
  *
2516
2784
  * @param params - Parameters for request
2517
2785
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2526,6 +2794,75 @@ export declare namespace alloydb_v1beta {
2526
2794
  delete(callback: BodyResponseCallback<Schema$Operation>): void;
2527
2795
  /**
2528
2796
  * Gets details of a single Backup.
2797
+ * @example
2798
+ * ```js
2799
+ * // Before running the sample:
2800
+ * // - Enable the API at:
2801
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
2802
+ * // - Login into gcloud by running:
2803
+ * // ```sh
2804
+ * // $ gcloud auth application-default login
2805
+ * // ```
2806
+ * // - Install the npm module by running:
2807
+ * // ```sh
2808
+ * // $ npm install googleapis
2809
+ * // ```
2810
+ *
2811
+ * const {google} = require('googleapis');
2812
+ * const alloydb = google.alloydb('v1beta');
2813
+ *
2814
+ * async function main() {
2815
+ * const auth = new google.auth.GoogleAuth({
2816
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2817
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2818
+ * });
2819
+ *
2820
+ * // Acquire an auth client, and bind it to all future calls
2821
+ * const authClient = await auth.getClient();
2822
+ * google.options({auth: authClient});
2823
+ *
2824
+ * // Do the magic
2825
+ * const res = await alloydb.projects.locations.backups.get({
2826
+ * // Required. Name of the resource
2827
+ * name: 'projects/my-project/locations/my-location/backups/my-backup',
2828
+ * });
2829
+ * console.log(res.data);
2830
+ *
2831
+ * // Example response
2832
+ * // {
2833
+ * // "annotations": {},
2834
+ * // "clusterName": "my_clusterName",
2835
+ * // "clusterUid": "my_clusterUid",
2836
+ * // "createCompletionTime": "my_createCompletionTime",
2837
+ * // "createTime": "my_createTime",
2838
+ * // "databaseVersion": "my_databaseVersion",
2839
+ * // "deleteTime": "my_deleteTime",
2840
+ * // "description": "my_description",
2841
+ * // "displayName": "my_displayName",
2842
+ * // "encryptionConfig": {},
2843
+ * // "encryptionInfo": {},
2844
+ * // "etag": "my_etag",
2845
+ * // "expiryQuantity": {},
2846
+ * // "expiryTime": "my_expiryTime",
2847
+ * // "labels": {},
2848
+ * // "name": "my_name",
2849
+ * // "reconciling": false,
2850
+ * // "satisfiesPzs": false,
2851
+ * // "sizeBytes": "my_sizeBytes",
2852
+ * // "state": "my_state",
2853
+ * // "tags": {},
2854
+ * // "type": "my_type",
2855
+ * // "uid": "my_uid",
2856
+ * // "updateTime": "my_updateTime"
2857
+ * // }
2858
+ * }
2859
+ *
2860
+ * main().catch(e => {
2861
+ * console.error(e);
2862
+ * throw e;
2863
+ * });
2864
+ *
2865
+ * ```
2529
2866
  *
2530
2867
  * @param params - Parameters for request
2531
2868
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2540,6 +2877,62 @@ export declare namespace alloydb_v1beta {
2540
2877
  get(callback: BodyResponseCallback<Schema$Backup>): void;
2541
2878
  /**
2542
2879
  * Lists Backups in a given project and location.
2880
+ * @example
2881
+ * ```js
2882
+ * // Before running the sample:
2883
+ * // - Enable the API at:
2884
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
2885
+ * // - Login into gcloud by running:
2886
+ * // ```sh
2887
+ * // $ gcloud auth application-default login
2888
+ * // ```
2889
+ * // - Install the npm module by running:
2890
+ * // ```sh
2891
+ * // $ npm install googleapis
2892
+ * // ```
2893
+ *
2894
+ * const {google} = require('googleapis');
2895
+ * const alloydb = google.alloydb('v1beta');
2896
+ *
2897
+ * async function main() {
2898
+ * const auth = new google.auth.GoogleAuth({
2899
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2900
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2901
+ * });
2902
+ *
2903
+ * // Acquire an auth client, and bind it to all future calls
2904
+ * const authClient = await auth.getClient();
2905
+ * google.options({auth: authClient});
2906
+ *
2907
+ * // Do the magic
2908
+ * const res = await alloydb.projects.locations.backups.list({
2909
+ * // Filtering results
2910
+ * filter: 'placeholder-value',
2911
+ * // Hint for how to order the results
2912
+ * orderBy: 'placeholder-value',
2913
+ * // Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
2914
+ * pageSize: 'placeholder-value',
2915
+ * // A token identifying a page of results the server should return.
2916
+ * pageToken: 'placeholder-value',
2917
+ * // Required. Parent value for ListBackupsRequest
2918
+ * parent: 'projects/my-project/locations/my-location',
2919
+ * });
2920
+ * console.log(res.data);
2921
+ *
2922
+ * // Example response
2923
+ * // {
2924
+ * // "backups": [],
2925
+ * // "nextPageToken": "my_nextPageToken",
2926
+ * // "unreachable": []
2927
+ * // }
2928
+ * }
2929
+ *
2930
+ * main().catch(e => {
2931
+ * console.error(e);
2932
+ * throw e;
2933
+ * });
2934
+ *
2935
+ * ```
2543
2936
  *
2544
2937
  * @param params - Parameters for request
2545
2938
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2554,6 +2947,95 @@ export declare namespace alloydb_v1beta {
2554
2947
  list(callback: BodyResponseCallback<Schema$ListBackupsResponse>): void;
2555
2948
  /**
2556
2949
  * Updates the parameters of a single Backup.
2950
+ * @example
2951
+ * ```js
2952
+ * // Before running the sample:
2953
+ * // - Enable the API at:
2954
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
2955
+ * // - Login into gcloud by running:
2956
+ * // ```sh
2957
+ * // $ gcloud auth application-default login
2958
+ * // ```
2959
+ * // - Install the npm module by running:
2960
+ * // ```sh
2961
+ * // $ npm install googleapis
2962
+ * // ```
2963
+ *
2964
+ * const {google} = require('googleapis');
2965
+ * const alloydb = google.alloydb('v1beta');
2966
+ *
2967
+ * async function main() {
2968
+ * const auth = new google.auth.GoogleAuth({
2969
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2970
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2971
+ * });
2972
+ *
2973
+ * // Acquire an auth client, and bind it to all future calls
2974
+ * const authClient = await auth.getClient();
2975
+ * google.options({auth: authClient});
2976
+ *
2977
+ * // Do the magic
2978
+ * const res = await alloydb.projects.locations.backups.patch({
2979
+ * // 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.
2980
+ * allowMissing: 'placeholder-value',
2981
+ * // 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\}
2982
+ * name: 'projects/my-project/locations/my-location/backups/my-backup',
2983
+ * // 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).
2984
+ * requestId: 'placeholder-value',
2985
+ * // 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.
2986
+ * updateMask: 'placeholder-value',
2987
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
2988
+ * validateOnly: 'placeholder-value',
2989
+ *
2990
+ * // Request body metadata
2991
+ * requestBody: {
2992
+ * // request body parameters
2993
+ * // {
2994
+ * // "annotations": {},
2995
+ * // "clusterName": "my_clusterName",
2996
+ * // "clusterUid": "my_clusterUid",
2997
+ * // "createCompletionTime": "my_createCompletionTime",
2998
+ * // "createTime": "my_createTime",
2999
+ * // "databaseVersion": "my_databaseVersion",
3000
+ * // "deleteTime": "my_deleteTime",
3001
+ * // "description": "my_description",
3002
+ * // "displayName": "my_displayName",
3003
+ * // "encryptionConfig": {},
3004
+ * // "encryptionInfo": {},
3005
+ * // "etag": "my_etag",
3006
+ * // "expiryQuantity": {},
3007
+ * // "expiryTime": "my_expiryTime",
3008
+ * // "labels": {},
3009
+ * // "name": "my_name",
3010
+ * // "reconciling": false,
3011
+ * // "satisfiesPzs": false,
3012
+ * // "sizeBytes": "my_sizeBytes",
3013
+ * // "state": "my_state",
3014
+ * // "tags": {},
3015
+ * // "type": "my_type",
3016
+ * // "uid": "my_uid",
3017
+ * // "updateTime": "my_updateTime"
3018
+ * // }
3019
+ * },
3020
+ * });
3021
+ * console.log(res.data);
3022
+ *
3023
+ * // Example response
3024
+ * // {
3025
+ * // "done": false,
3026
+ * // "error": {},
3027
+ * // "metadata": {},
3028
+ * // "name": "my_name",
3029
+ * // "response": {}
3030
+ * // }
3031
+ * }
3032
+ *
3033
+ * main().catch(e => {
3034
+ * console.error(e);
3035
+ * throw e;
3036
+ * });
3037
+ *
3038
+ * ```
2557
3039
  *
2558
3040
  * @param params - Parameters for request
2559
3041
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2668,6 +3150,105 @@ export declare namespace alloydb_v1beta {
2668
3150
  constructor(context: APIRequestContext);
2669
3151
  /**
2670
3152
  * Creates a new Cluster in a given project and location.
3153
+ * @example
3154
+ * ```js
3155
+ * // Before running the sample:
3156
+ * // - Enable the API at:
3157
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3158
+ * // - Login into gcloud by running:
3159
+ * // ```sh
3160
+ * // $ gcloud auth application-default login
3161
+ * // ```
3162
+ * // - Install the npm module by running:
3163
+ * // ```sh
3164
+ * // $ npm install googleapis
3165
+ * // ```
3166
+ *
3167
+ * const {google} = require('googleapis');
3168
+ * const alloydb = google.alloydb('v1beta');
3169
+ *
3170
+ * async function main() {
3171
+ * const auth = new google.auth.GoogleAuth({
3172
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3173
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3174
+ * });
3175
+ *
3176
+ * // Acquire an auth client, and bind it to all future calls
3177
+ * const authClient = await auth.getClient();
3178
+ * google.options({auth: authClient});
3179
+ *
3180
+ * // Do the magic
3181
+ * const res = await alloydb.projects.locations.clusters.create({
3182
+ * // Required. ID of the requesting object.
3183
+ * clusterId: 'placeholder-value',
3184
+ * // Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field.
3185
+ * parent: 'projects/my-project/locations/my-location',
3186
+ * // 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).
3187
+ * requestId: 'placeholder-value',
3188
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
3189
+ * validateOnly: 'placeholder-value',
3190
+ *
3191
+ * // Request body metadata
3192
+ * requestBody: {
3193
+ * // request body parameters
3194
+ * // {
3195
+ * // "annotations": {},
3196
+ * // "automatedBackupPolicy": {},
3197
+ * // "backupSource": {},
3198
+ * // "cloudsqlBackupRunSource": {},
3199
+ * // "clusterType": "my_clusterType",
3200
+ * // "continuousBackupConfig": {},
3201
+ * // "continuousBackupInfo": {},
3202
+ * // "createTime": "my_createTime",
3203
+ * // "databaseVersion": "my_databaseVersion",
3204
+ * // "deleteTime": "my_deleteTime",
3205
+ * // "displayName": "my_displayName",
3206
+ * // "encryptionConfig": {},
3207
+ * // "encryptionInfo": {},
3208
+ * // "etag": "my_etag",
3209
+ * // "geminiConfig": {},
3210
+ * // "initialUser": {},
3211
+ * // "labels": {},
3212
+ * // "maintenanceSchedule": {},
3213
+ * // "maintenanceUpdatePolicy": {},
3214
+ * // "migrationSource": {},
3215
+ * // "name": "my_name",
3216
+ * // "network": "my_network",
3217
+ * // "networkConfig": {},
3218
+ * // "primaryConfig": {},
3219
+ * // "pscConfig": {},
3220
+ * // "reconciling": false,
3221
+ * // "satisfiesPzs": false,
3222
+ * // "secondaryConfig": {},
3223
+ * // "serviceAccountEmail": "my_serviceAccountEmail",
3224
+ * // "sslConfig": {},
3225
+ * // "state": "my_state",
3226
+ * // "subscriptionType": "my_subscriptionType",
3227
+ * // "tags": {},
3228
+ * // "trialMetadata": {},
3229
+ * // "uid": "my_uid",
3230
+ * // "updateTime": "my_updateTime"
3231
+ * // }
3232
+ * },
3233
+ * });
3234
+ * console.log(res.data);
3235
+ *
3236
+ * // Example response
3237
+ * // {
3238
+ * // "done": false,
3239
+ * // "error": {},
3240
+ * // "metadata": {},
3241
+ * // "name": "my_name",
3242
+ * // "response": {}
3243
+ * // }
3244
+ * }
3245
+ *
3246
+ * main().catch(e => {
3247
+ * console.error(e);
3248
+ * throw e;
3249
+ * });
3250
+ *
3251
+ * ```
2671
3252
  *
2672
3253
  * @param params - Parameters for request
2673
3254
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2682,6 +3263,105 @@ export declare namespace alloydb_v1beta {
2682
3263
  create(callback: BodyResponseCallback<Schema$Operation>): void;
2683
3264
  /**
2684
3265
  * Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.
3266
+ * @example
3267
+ * ```js
3268
+ * // Before running the sample:
3269
+ * // - Enable the API at:
3270
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3271
+ * // - Login into gcloud by running:
3272
+ * // ```sh
3273
+ * // $ gcloud auth application-default login
3274
+ * // ```
3275
+ * // - Install the npm module by running:
3276
+ * // ```sh
3277
+ * // $ npm install googleapis
3278
+ * // ```
3279
+ *
3280
+ * const {google} = require('googleapis');
3281
+ * const alloydb = google.alloydb('v1beta');
3282
+ *
3283
+ * async function main() {
3284
+ * const auth = new google.auth.GoogleAuth({
3285
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3286
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3287
+ * });
3288
+ *
3289
+ * // Acquire an auth client, and bind it to all future calls
3290
+ * const authClient = await auth.getClient();
3291
+ * google.options({auth: authClient});
3292
+ *
3293
+ * // Do the magic
3294
+ * const res = await alloydb.projects.locations.clusters.createsecondary({
3295
+ * // Required. ID of the requesting object (the secondary cluster).
3296
+ * clusterId: 'placeholder-value',
3297
+ * // Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field.
3298
+ * parent: 'projects/my-project/locations/my-location',
3299
+ * // 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).
3300
+ * requestId: 'placeholder-value',
3301
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
3302
+ * validateOnly: 'placeholder-value',
3303
+ *
3304
+ * // Request body metadata
3305
+ * requestBody: {
3306
+ * // request body parameters
3307
+ * // {
3308
+ * // "annotations": {},
3309
+ * // "automatedBackupPolicy": {},
3310
+ * // "backupSource": {},
3311
+ * // "cloudsqlBackupRunSource": {},
3312
+ * // "clusterType": "my_clusterType",
3313
+ * // "continuousBackupConfig": {},
3314
+ * // "continuousBackupInfo": {},
3315
+ * // "createTime": "my_createTime",
3316
+ * // "databaseVersion": "my_databaseVersion",
3317
+ * // "deleteTime": "my_deleteTime",
3318
+ * // "displayName": "my_displayName",
3319
+ * // "encryptionConfig": {},
3320
+ * // "encryptionInfo": {},
3321
+ * // "etag": "my_etag",
3322
+ * // "geminiConfig": {},
3323
+ * // "initialUser": {},
3324
+ * // "labels": {},
3325
+ * // "maintenanceSchedule": {},
3326
+ * // "maintenanceUpdatePolicy": {},
3327
+ * // "migrationSource": {},
3328
+ * // "name": "my_name",
3329
+ * // "network": "my_network",
3330
+ * // "networkConfig": {},
3331
+ * // "primaryConfig": {},
3332
+ * // "pscConfig": {},
3333
+ * // "reconciling": false,
3334
+ * // "satisfiesPzs": false,
3335
+ * // "secondaryConfig": {},
3336
+ * // "serviceAccountEmail": "my_serviceAccountEmail",
3337
+ * // "sslConfig": {},
3338
+ * // "state": "my_state",
3339
+ * // "subscriptionType": "my_subscriptionType",
3340
+ * // "tags": {},
3341
+ * // "trialMetadata": {},
3342
+ * // "uid": "my_uid",
3343
+ * // "updateTime": "my_updateTime"
3344
+ * // }
3345
+ * },
3346
+ * });
3347
+ * console.log(res.data);
3348
+ *
3349
+ * // Example response
3350
+ * // {
3351
+ * // "done": false,
3352
+ * // "error": {},
3353
+ * // "metadata": {},
3354
+ * // "name": "my_name",
3355
+ * // "response": {}
3356
+ * // }
3357
+ * }
3358
+ *
3359
+ * main().catch(e => {
3360
+ * console.error(e);
3361
+ * throw e;
3362
+ * });
3363
+ *
3364
+ * ```
2685
3365
  *
2686
3366
  * @param params - Parameters for request
2687
3367
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2696,6 +3376,64 @@ export declare namespace alloydb_v1beta {
2696
3376
  createsecondary(callback: BodyResponseCallback<Schema$Operation>): void;
2697
3377
  /**
2698
3378
  * Deletes a single Cluster.
3379
+ * @example
3380
+ * ```js
3381
+ * // Before running the sample:
3382
+ * // - Enable the API at:
3383
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3384
+ * // - Login into gcloud by running:
3385
+ * // ```sh
3386
+ * // $ gcloud auth application-default login
3387
+ * // ```
3388
+ * // - Install the npm module by running:
3389
+ * // ```sh
3390
+ * // $ npm install googleapis
3391
+ * // ```
3392
+ *
3393
+ * const {google} = require('googleapis');
3394
+ * const alloydb = google.alloydb('v1beta');
3395
+ *
3396
+ * async function main() {
3397
+ * const auth = new google.auth.GoogleAuth({
3398
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3399
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3400
+ * });
3401
+ *
3402
+ * // Acquire an auth client, and bind it to all future calls
3403
+ * const authClient = await auth.getClient();
3404
+ * google.options({auth: authClient});
3405
+ *
3406
+ * // Do the magic
3407
+ * const res = await alloydb.projects.locations.clusters.delete({
3408
+ * // 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.
3409
+ * etag: 'placeholder-value',
3410
+ * // Optional. Whether to cascade delete child instances for given cluster.
3411
+ * force: 'placeholder-value',
3412
+ * // Required. The name of the resource. For the required format, see the comment on the Cluster.name field.
3413
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
3414
+ * // 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).
3415
+ * requestId: 'placeholder-value',
3416
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
3417
+ * validateOnly: 'placeholder-value',
3418
+ * });
3419
+ * console.log(res.data);
3420
+ *
3421
+ * // Example response
3422
+ * // {
3423
+ * // "done": false,
3424
+ * // "error": {},
3425
+ * // "metadata": {},
3426
+ * // "name": "my_name",
3427
+ * // "response": {}
3428
+ * // }
3429
+ * }
3430
+ *
3431
+ * main().catch(e => {
3432
+ * console.error(e);
3433
+ * throw e;
3434
+ * });
3435
+ *
3436
+ * ```
2699
3437
  *
2700
3438
  * @param params - Parameters for request
2701
3439
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2710,6 +3448,67 @@ export declare namespace alloydb_v1beta {
2710
3448
  delete(callback: BodyResponseCallback<Schema$Operation>): void;
2711
3449
  /**
2712
3450
  * Exports data from the cluster. Imperative only.
3451
+ * @example
3452
+ * ```js
3453
+ * // Before running the sample:
3454
+ * // - Enable the API at:
3455
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3456
+ * // - Login into gcloud by running:
3457
+ * // ```sh
3458
+ * // $ gcloud auth application-default login
3459
+ * // ```
3460
+ * // - Install the npm module by running:
3461
+ * // ```sh
3462
+ * // $ npm install googleapis
3463
+ * // ```
3464
+ *
3465
+ * const {google} = require('googleapis');
3466
+ * const alloydb = google.alloydb('v1beta');
3467
+ *
3468
+ * async function main() {
3469
+ * const auth = new google.auth.GoogleAuth({
3470
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3471
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3472
+ * });
3473
+ *
3474
+ * // Acquire an auth client, and bind it to all future calls
3475
+ * const authClient = await auth.getClient();
3476
+ * google.options({auth: authClient});
3477
+ *
3478
+ * // Do the magic
3479
+ * const res = await alloydb.projects.locations.clusters.export({
3480
+ * // Required. The resource name of the cluster.
3481
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
3482
+ *
3483
+ * // Request body metadata
3484
+ * requestBody: {
3485
+ * // request body parameters
3486
+ * // {
3487
+ * // "csvExportOptions": {},
3488
+ * // "database": "my_database",
3489
+ * // "gcsDestination": {},
3490
+ * // "sqlExportOptions": {}
3491
+ * // }
3492
+ * },
3493
+ * });
3494
+ * console.log(res.data);
3495
+ *
3496
+ * // Example response
3497
+ * // {
3498
+ * // "done": false,
3499
+ * // "error": {},
3500
+ * // "metadata": {},
3501
+ * // "name": "my_name",
3502
+ * // "response": {}
3503
+ * // }
3504
+ * }
3505
+ *
3506
+ * main().catch(e => {
3507
+ * console.error(e);
3508
+ * throw e;
3509
+ * });
3510
+ *
3511
+ * ```
2713
3512
  *
2714
3513
  * @param params - Parameters for request
2715
3514
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2724,6 +3523,89 @@ export declare namespace alloydb_v1beta {
2724
3523
  export(callback: BodyResponseCallback<Schema$Operation>): void;
2725
3524
  /**
2726
3525
  * Gets details of a single Cluster.
3526
+ * @example
3527
+ * ```js
3528
+ * // Before running the sample:
3529
+ * // - Enable the API at:
3530
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3531
+ * // - Login into gcloud by running:
3532
+ * // ```sh
3533
+ * // $ gcloud auth application-default login
3534
+ * // ```
3535
+ * // - Install the npm module by running:
3536
+ * // ```sh
3537
+ * // $ npm install googleapis
3538
+ * // ```
3539
+ *
3540
+ * const {google} = require('googleapis');
3541
+ * const alloydb = google.alloydb('v1beta');
3542
+ *
3543
+ * async function main() {
3544
+ * const auth = new google.auth.GoogleAuth({
3545
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3546
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3547
+ * });
3548
+ *
3549
+ * // Acquire an auth client, and bind it to all future calls
3550
+ * const authClient = await auth.getClient();
3551
+ * google.options({auth: authClient});
3552
+ *
3553
+ * // Do the magic
3554
+ * const res = await alloydb.projects.locations.clusters.get({
3555
+ * // Required. The name of the resource. For the required format, see the comment on the Cluster.name field.
3556
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
3557
+ * // Optional. The view of the cluster to return. Returns all default fields if not set.
3558
+ * view: 'placeholder-value',
3559
+ * });
3560
+ * console.log(res.data);
3561
+ *
3562
+ * // Example response
3563
+ * // {
3564
+ * // "annotations": {},
3565
+ * // "automatedBackupPolicy": {},
3566
+ * // "backupSource": {},
3567
+ * // "cloudsqlBackupRunSource": {},
3568
+ * // "clusterType": "my_clusterType",
3569
+ * // "continuousBackupConfig": {},
3570
+ * // "continuousBackupInfo": {},
3571
+ * // "createTime": "my_createTime",
3572
+ * // "databaseVersion": "my_databaseVersion",
3573
+ * // "deleteTime": "my_deleteTime",
3574
+ * // "displayName": "my_displayName",
3575
+ * // "encryptionConfig": {},
3576
+ * // "encryptionInfo": {},
3577
+ * // "etag": "my_etag",
3578
+ * // "geminiConfig": {},
3579
+ * // "initialUser": {},
3580
+ * // "labels": {},
3581
+ * // "maintenanceSchedule": {},
3582
+ * // "maintenanceUpdatePolicy": {},
3583
+ * // "migrationSource": {},
3584
+ * // "name": "my_name",
3585
+ * // "network": "my_network",
3586
+ * // "networkConfig": {},
3587
+ * // "primaryConfig": {},
3588
+ * // "pscConfig": {},
3589
+ * // "reconciling": false,
3590
+ * // "satisfiesPzs": false,
3591
+ * // "secondaryConfig": {},
3592
+ * // "serviceAccountEmail": "my_serviceAccountEmail",
3593
+ * // "sslConfig": {},
3594
+ * // "state": "my_state",
3595
+ * // "subscriptionType": "my_subscriptionType",
3596
+ * // "tags": {},
3597
+ * // "trialMetadata": {},
3598
+ * // "uid": "my_uid",
3599
+ * // "updateTime": "my_updateTime"
3600
+ * // }
3601
+ * }
3602
+ *
3603
+ * main().catch(e => {
3604
+ * console.error(e);
3605
+ * throw e;
3606
+ * });
3607
+ *
3608
+ * ```
2727
3609
  *
2728
3610
  * @param params - Parameters for request
2729
3611
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2738,6 +3620,68 @@ export declare namespace alloydb_v1beta {
2738
3620
  get(callback: BodyResponseCallback<Schema$Cluster>): void;
2739
3621
  /**
2740
3622
  * Imports data to the cluster. Imperative only.
3623
+ * @example
3624
+ * ```js
3625
+ * // Before running the sample:
3626
+ * // - Enable the API at:
3627
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3628
+ * // - Login into gcloud by running:
3629
+ * // ```sh
3630
+ * // $ gcloud auth application-default login
3631
+ * // ```
3632
+ * // - Install the npm module by running:
3633
+ * // ```sh
3634
+ * // $ npm install googleapis
3635
+ * // ```
3636
+ *
3637
+ * const {google} = require('googleapis');
3638
+ * const alloydb = google.alloydb('v1beta');
3639
+ *
3640
+ * async function main() {
3641
+ * const auth = new google.auth.GoogleAuth({
3642
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3643
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3644
+ * });
3645
+ *
3646
+ * // Acquire an auth client, and bind it to all future calls
3647
+ * const authClient = await auth.getClient();
3648
+ * google.options({auth: authClient});
3649
+ *
3650
+ * // Do the magic
3651
+ * const res = await alloydb.projects.locations.clusters.import({
3652
+ * // Required. The resource name of the cluster.
3653
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
3654
+ *
3655
+ * // Request body metadata
3656
+ * requestBody: {
3657
+ * // request body parameters
3658
+ * // {
3659
+ * // "csvImportOptions": {},
3660
+ * // "database": "my_database",
3661
+ * // "gcsUri": "my_gcsUri",
3662
+ * // "sqlImportOptions": {},
3663
+ * // "user": "my_user"
3664
+ * // }
3665
+ * },
3666
+ * });
3667
+ * console.log(res.data);
3668
+ *
3669
+ * // Example response
3670
+ * // {
3671
+ * // "done": false,
3672
+ * // "error": {},
3673
+ * // "metadata": {},
3674
+ * // "name": "my_name",
3675
+ * // "response": {}
3676
+ * // }
3677
+ * }
3678
+ *
3679
+ * main().catch(e => {
3680
+ * console.error(e);
3681
+ * throw e;
3682
+ * });
3683
+ *
3684
+ * ```
2741
3685
  *
2742
3686
  * @param params - Parameters for request
2743
3687
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2752,6 +3696,62 @@ export declare namespace alloydb_v1beta {
2752
3696
  import(callback: BodyResponseCallback<Schema$Operation>): void;
2753
3697
  /**
2754
3698
  * Lists Clusters in a given project and location.
3699
+ * @example
3700
+ * ```js
3701
+ * // Before running the sample:
3702
+ * // - Enable the API at:
3703
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3704
+ * // - Login into gcloud by running:
3705
+ * // ```sh
3706
+ * // $ gcloud auth application-default login
3707
+ * // ```
3708
+ * // - Install the npm module by running:
3709
+ * // ```sh
3710
+ * // $ npm install googleapis
3711
+ * // ```
3712
+ *
3713
+ * const {google} = require('googleapis');
3714
+ * const alloydb = google.alloydb('v1beta');
3715
+ *
3716
+ * async function main() {
3717
+ * const auth = new google.auth.GoogleAuth({
3718
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3719
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3720
+ * });
3721
+ *
3722
+ * // Acquire an auth client, and bind it to all future calls
3723
+ * const authClient = await auth.getClient();
3724
+ * google.options({auth: authClient});
3725
+ *
3726
+ * // Do the magic
3727
+ * const res = await alloydb.projects.locations.clusters.list({
3728
+ * // Optional. Filtering results
3729
+ * filter: 'placeholder-value',
3730
+ * // Optional. Hint for how to order the results
3731
+ * orderBy: 'placeholder-value',
3732
+ * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
3733
+ * pageSize: 'placeholder-value',
3734
+ * // A token identifying a page of results the server should return.
3735
+ * pageToken: 'placeholder-value',
3736
+ * // 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/-
3737
+ * parent: 'projects/my-project/locations/my-location',
3738
+ * });
3739
+ * console.log(res.data);
3740
+ *
3741
+ * // Example response
3742
+ * // {
3743
+ * // "clusters": [],
3744
+ * // "nextPageToken": "my_nextPageToken",
3745
+ * // "unreachable": []
3746
+ * // }
3747
+ * }
3748
+ *
3749
+ * main().catch(e => {
3750
+ * console.error(e);
3751
+ * throw e;
3752
+ * });
3753
+ *
3754
+ * ```
2755
3755
  *
2756
3756
  * @param params - Parameters for request
2757
3757
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2766,6 +3766,107 @@ export declare namespace alloydb_v1beta {
2766
3766
  list(callback: BodyResponseCallback<Schema$ListClustersResponse>): void;
2767
3767
  /**
2768
3768
  * Updates the parameters of a single Cluster.
3769
+ * @example
3770
+ * ```js
3771
+ * // Before running the sample:
3772
+ * // - Enable the API at:
3773
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3774
+ * // - Login into gcloud by running:
3775
+ * // ```sh
3776
+ * // $ gcloud auth application-default login
3777
+ * // ```
3778
+ * // - Install the npm module by running:
3779
+ * // ```sh
3780
+ * // $ npm install googleapis
3781
+ * // ```
3782
+ *
3783
+ * const {google} = require('googleapis');
3784
+ * const alloydb = google.alloydb('v1beta');
3785
+ *
3786
+ * async function main() {
3787
+ * const auth = new google.auth.GoogleAuth({
3788
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3789
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3790
+ * });
3791
+ *
3792
+ * // Acquire an auth client, and bind it to all future calls
3793
+ * const authClient = await auth.getClient();
3794
+ * google.options({auth: authClient});
3795
+ *
3796
+ * // Do the magic
3797
+ * const res = await alloydb.projects.locations.clusters.patch({
3798
+ * // 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.
3799
+ * allowMissing: 'placeholder-value',
3800
+ * // 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\}
3801
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
3802
+ * // 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).
3803
+ * requestId: 'placeholder-value',
3804
+ * // 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.
3805
+ * updateMask: 'placeholder-value',
3806
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
3807
+ * validateOnly: 'placeholder-value',
3808
+ *
3809
+ * // Request body metadata
3810
+ * requestBody: {
3811
+ * // request body parameters
3812
+ * // {
3813
+ * // "annotations": {},
3814
+ * // "automatedBackupPolicy": {},
3815
+ * // "backupSource": {},
3816
+ * // "cloudsqlBackupRunSource": {},
3817
+ * // "clusterType": "my_clusterType",
3818
+ * // "continuousBackupConfig": {},
3819
+ * // "continuousBackupInfo": {},
3820
+ * // "createTime": "my_createTime",
3821
+ * // "databaseVersion": "my_databaseVersion",
3822
+ * // "deleteTime": "my_deleteTime",
3823
+ * // "displayName": "my_displayName",
3824
+ * // "encryptionConfig": {},
3825
+ * // "encryptionInfo": {},
3826
+ * // "etag": "my_etag",
3827
+ * // "geminiConfig": {},
3828
+ * // "initialUser": {},
3829
+ * // "labels": {},
3830
+ * // "maintenanceSchedule": {},
3831
+ * // "maintenanceUpdatePolicy": {},
3832
+ * // "migrationSource": {},
3833
+ * // "name": "my_name",
3834
+ * // "network": "my_network",
3835
+ * // "networkConfig": {},
3836
+ * // "primaryConfig": {},
3837
+ * // "pscConfig": {},
3838
+ * // "reconciling": false,
3839
+ * // "satisfiesPzs": false,
3840
+ * // "secondaryConfig": {},
3841
+ * // "serviceAccountEmail": "my_serviceAccountEmail",
3842
+ * // "sslConfig": {},
3843
+ * // "state": "my_state",
3844
+ * // "subscriptionType": "my_subscriptionType",
3845
+ * // "tags": {},
3846
+ * // "trialMetadata": {},
3847
+ * // "uid": "my_uid",
3848
+ * // "updateTime": "my_updateTime"
3849
+ * // }
3850
+ * },
3851
+ * });
3852
+ * console.log(res.data);
3853
+ *
3854
+ * // Example response
3855
+ * // {
3856
+ * // "done": false,
3857
+ * // "error": {},
3858
+ * // "metadata": {},
3859
+ * // "name": "my_name",
3860
+ * // "response": {}
3861
+ * // }
3862
+ * }
3863
+ *
3864
+ * main().catch(e => {
3865
+ * console.error(e);
3866
+ * throw e;
3867
+ * });
3868
+ *
3869
+ * ```
2769
3870
  *
2770
3871
  * @param params - Parameters for request
2771
3872
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2780,6 +3881,66 @@ export declare namespace alloydb_v1beta {
2780
3881
  patch(callback: BodyResponseCallback<Schema$Operation>): void;
2781
3882
  /**
2782
3883
  * Promotes a SECONDARY cluster. This turns down replication from the PRIMARY cluster and promotes a secondary cluster into its own standalone cluster. Imperative only.
3884
+ * @example
3885
+ * ```js
3886
+ * // Before running the sample:
3887
+ * // - Enable the API at:
3888
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3889
+ * // - Login into gcloud by running:
3890
+ * // ```sh
3891
+ * // $ gcloud auth application-default login
3892
+ * // ```
3893
+ * // - Install the npm module by running:
3894
+ * // ```sh
3895
+ * // $ npm install googleapis
3896
+ * // ```
3897
+ *
3898
+ * const {google} = require('googleapis');
3899
+ * const alloydb = google.alloydb('v1beta');
3900
+ *
3901
+ * async function main() {
3902
+ * const auth = new google.auth.GoogleAuth({
3903
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3904
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3905
+ * });
3906
+ *
3907
+ * // Acquire an auth client, and bind it to all future calls
3908
+ * const authClient = await auth.getClient();
3909
+ * google.options({auth: authClient});
3910
+ *
3911
+ * // Do the magic
3912
+ * const res = await alloydb.projects.locations.clusters.promote({
3913
+ * // Required. The name of the resource. For the required format, see the comment on the Cluster.name field
3914
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
3915
+ *
3916
+ * // Request body metadata
3917
+ * requestBody: {
3918
+ * // request body parameters
3919
+ * // {
3920
+ * // "etag": "my_etag",
3921
+ * // "requestId": "my_requestId",
3922
+ * // "validateOnly": false
3923
+ * // }
3924
+ * },
3925
+ * });
3926
+ * console.log(res.data);
3927
+ *
3928
+ * // Example response
3929
+ * // {
3930
+ * // "done": false,
3931
+ * // "error": {},
3932
+ * // "metadata": {},
3933
+ * // "name": "my_name",
3934
+ * // "response": {}
3935
+ * // }
3936
+ * }
3937
+ *
3938
+ * main().catch(e => {
3939
+ * console.error(e);
3940
+ * throw e;
3941
+ * });
3942
+ *
3943
+ * ```
2783
3944
  *
2784
3945
  * @param params - Parameters for request
2785
3946
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2794,6 +3955,69 @@ export declare namespace alloydb_v1beta {
2794
3955
  promote(callback: BodyResponseCallback<Schema$Operation>): void;
2795
3956
  /**
2796
3957
  * 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.
3958
+ * @example
3959
+ * ```js
3960
+ * // Before running the sample:
3961
+ * // - Enable the API at:
3962
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3963
+ * // - Login into gcloud by running:
3964
+ * // ```sh
3965
+ * // $ gcloud auth application-default login
3966
+ * // ```
3967
+ * // - Install the npm module by running:
3968
+ * // ```sh
3969
+ * // $ npm install googleapis
3970
+ * // ```
3971
+ *
3972
+ * const {google} = require('googleapis');
3973
+ * const alloydb = google.alloydb('v1beta');
3974
+ *
3975
+ * async function main() {
3976
+ * const auth = new google.auth.GoogleAuth({
3977
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3978
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3979
+ * });
3980
+ *
3981
+ * // Acquire an auth client, and bind it to all future calls
3982
+ * const authClient = await auth.getClient();
3983
+ * google.options({auth: authClient});
3984
+ *
3985
+ * // Do the magic
3986
+ * const res = await alloydb.projects.locations.clusters.restore({
3987
+ * // Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field.
3988
+ * parent: 'projects/my-project/locations/my-location',
3989
+ *
3990
+ * // Request body metadata
3991
+ * requestBody: {
3992
+ * // request body parameters
3993
+ * // {
3994
+ * // "backupSource": {},
3995
+ * // "cluster": {},
3996
+ * // "clusterId": "my_clusterId",
3997
+ * // "continuousBackupSource": {},
3998
+ * // "requestId": "my_requestId",
3999
+ * // "validateOnly": false
4000
+ * // }
4001
+ * },
4002
+ * });
4003
+ * console.log(res.data);
4004
+ *
4005
+ * // Example response
4006
+ * // {
4007
+ * // "done": false,
4008
+ * // "error": {},
4009
+ * // "metadata": {},
4010
+ * // "name": "my_name",
4011
+ * // "response": {}
4012
+ * // }
4013
+ * }
4014
+ *
4015
+ * main().catch(e => {
4016
+ * console.error(e);
4017
+ * throw e;
4018
+ * });
4019
+ *
4020
+ * ```
2797
4021
  *
2798
4022
  * @param params - Parameters for request
2799
4023
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2808,6 +4032,66 @@ export declare namespace alloydb_v1beta {
2808
4032
  restore(callback: BodyResponseCallback<Schema$Operation>): void;
2809
4033
  /**
2810
4034
  * Restores an AlloyDB cluster from a CloudSQL resource.
4035
+ * @example
4036
+ * ```js
4037
+ * // Before running the sample:
4038
+ * // - Enable the API at:
4039
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4040
+ * // - Login into gcloud by running:
4041
+ * // ```sh
4042
+ * // $ gcloud auth application-default login
4043
+ * // ```
4044
+ * // - Install the npm module by running:
4045
+ * // ```sh
4046
+ * // $ npm install googleapis
4047
+ * // ```
4048
+ *
4049
+ * const {google} = require('googleapis');
4050
+ * const alloydb = google.alloydb('v1beta');
4051
+ *
4052
+ * async function main() {
4053
+ * const auth = new google.auth.GoogleAuth({
4054
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4055
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4056
+ * });
4057
+ *
4058
+ * // Acquire an auth client, and bind it to all future calls
4059
+ * const authClient = await auth.getClient();
4060
+ * google.options({auth: authClient});
4061
+ *
4062
+ * // Do the magic
4063
+ * const res = await alloydb.projects.locations.clusters.restoreFromCloudSQL({
4064
+ * // Required. The location of the new cluster. For the required format, see the comment on Cluster.name field.
4065
+ * parent: 'projects/my-project/locations/my-location',
4066
+ *
4067
+ * // Request body metadata
4068
+ * requestBody: {
4069
+ * // request body parameters
4070
+ * // {
4071
+ * // "cloudsqlBackupRunSource": {},
4072
+ * // "cluster": {},
4073
+ * // "clusterId": "my_clusterId"
4074
+ * // }
4075
+ * },
4076
+ * });
4077
+ * console.log(res.data);
4078
+ *
4079
+ * // Example response
4080
+ * // {
4081
+ * // "done": false,
4082
+ * // "error": {},
4083
+ * // "metadata": {},
4084
+ * // "name": "my_name",
4085
+ * // "response": {}
4086
+ * // }
4087
+ * }
4088
+ *
4089
+ * main().catch(e => {
4090
+ * console.error(e);
4091
+ * throw e;
4092
+ * });
4093
+ *
4094
+ * ```
2811
4095
  *
2812
4096
  * @param params - Parameters for request
2813
4097
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2822,6 +4106,65 @@ export declare namespace alloydb_v1beta {
2822
4106
  restoreFromCloudSQL(callback: BodyResponseCallback<Schema$Operation>): void;
2823
4107
  /**
2824
4108
  * 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.
4109
+ * @example
4110
+ * ```js
4111
+ * // Before running the sample:
4112
+ * // - Enable the API at:
4113
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4114
+ * // - Login into gcloud by running:
4115
+ * // ```sh
4116
+ * // $ gcloud auth application-default login
4117
+ * // ```
4118
+ * // - Install the npm module by running:
4119
+ * // ```sh
4120
+ * // $ npm install googleapis
4121
+ * // ```
4122
+ *
4123
+ * const {google} = require('googleapis');
4124
+ * const alloydb = google.alloydb('v1beta');
4125
+ *
4126
+ * async function main() {
4127
+ * const auth = new google.auth.GoogleAuth({
4128
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4129
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4130
+ * });
4131
+ *
4132
+ * // Acquire an auth client, and bind it to all future calls
4133
+ * const authClient = await auth.getClient();
4134
+ * google.options({auth: authClient});
4135
+ *
4136
+ * // Do the magic
4137
+ * const res = await alloydb.projects.locations.clusters.switchover({
4138
+ * // Required. The name of the resource. For the required format, see the comment on the Cluster.name field
4139
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
4140
+ *
4141
+ * // Request body metadata
4142
+ * requestBody: {
4143
+ * // request body parameters
4144
+ * // {
4145
+ * // "requestId": "my_requestId",
4146
+ * // "validateOnly": false
4147
+ * // }
4148
+ * },
4149
+ * });
4150
+ * console.log(res.data);
4151
+ *
4152
+ * // Example response
4153
+ * // {
4154
+ * // "done": false,
4155
+ * // "error": {},
4156
+ * // "metadata": {},
4157
+ * // "name": "my_name",
4158
+ * // "response": {}
4159
+ * // }
4160
+ * }
4161
+ *
4162
+ * main().catch(e => {
4163
+ * console.error(e);
4164
+ * throw e;
4165
+ * });
4166
+ *
4167
+ * ```
2825
4168
  *
2826
4169
  * @param params - Parameters for request
2827
4170
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2836,6 +4179,67 @@ export declare namespace alloydb_v1beta {
2836
4179
  switchover(callback: BodyResponseCallback<Schema$Operation>): void;
2837
4180
  /**
2838
4181
  * Upgrades a single Cluster. Imperative only.
4182
+ * @example
4183
+ * ```js
4184
+ * // Before running the sample:
4185
+ * // - Enable the API at:
4186
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4187
+ * // - Login into gcloud by running:
4188
+ * // ```sh
4189
+ * // $ gcloud auth application-default login
4190
+ * // ```
4191
+ * // - Install the npm module by running:
4192
+ * // ```sh
4193
+ * // $ npm install googleapis
4194
+ * // ```
4195
+ *
4196
+ * const {google} = require('googleapis');
4197
+ * const alloydb = google.alloydb('v1beta');
4198
+ *
4199
+ * async function main() {
4200
+ * const auth = new google.auth.GoogleAuth({
4201
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4202
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4203
+ * });
4204
+ *
4205
+ * // Acquire an auth client, and bind it to all future calls
4206
+ * const authClient = await auth.getClient();
4207
+ * google.options({auth: authClient});
4208
+ *
4209
+ * // Do the magic
4210
+ * const res = await alloydb.projects.locations.clusters.upgrade({
4211
+ * // Required. The resource name of the cluster.
4212
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
4213
+ *
4214
+ * // Request body metadata
4215
+ * requestBody: {
4216
+ * // request body parameters
4217
+ * // {
4218
+ * // "etag": "my_etag",
4219
+ * // "requestId": "my_requestId",
4220
+ * // "validateOnly": false,
4221
+ * // "version": "my_version"
4222
+ * // }
4223
+ * },
4224
+ * });
4225
+ * console.log(res.data);
4226
+ *
4227
+ * // Example response
4228
+ * // {
4229
+ * // "done": false,
4230
+ * // "error": {},
4231
+ * // "metadata": {},
4232
+ * // "name": "my_name",
4233
+ * // "response": {}
4234
+ * // }
4235
+ * }
4236
+ *
4237
+ * main().catch(e => {
4238
+ * console.error(e);
4239
+ * throw e;
4240
+ * });
4241
+ *
4242
+ * ```
2839
4243
  *
2840
4244
  * @param params - Parameters for request
2841
4245
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3048,6 +4452,102 @@ export declare namespace alloydb_v1beta {
3048
4452
  constructor(context: APIRequestContext);
3049
4453
  /**
3050
4454
  * Creates a new Instance in a given project and location.
4455
+ * @example
4456
+ * ```js
4457
+ * // Before running the sample:
4458
+ * // - Enable the API at:
4459
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4460
+ * // - Login into gcloud by running:
4461
+ * // ```sh
4462
+ * // $ gcloud auth application-default login
4463
+ * // ```
4464
+ * // - Install the npm module by running:
4465
+ * // ```sh
4466
+ * // $ npm install googleapis
4467
+ * // ```
4468
+ *
4469
+ * const {google} = require('googleapis');
4470
+ * const alloydb = google.alloydb('v1beta');
4471
+ *
4472
+ * async function main() {
4473
+ * const auth = new google.auth.GoogleAuth({
4474
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4475
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4476
+ * });
4477
+ *
4478
+ * // Acquire an auth client, and bind it to all future calls
4479
+ * const authClient = await auth.getClient();
4480
+ * google.options({auth: authClient});
4481
+ *
4482
+ * // Do the magic
4483
+ * const res = await alloydb.projects.locations.clusters.instances.create({
4484
+ * // Required. ID of the requesting object.
4485
+ * instanceId: 'placeholder-value',
4486
+ * // Required. The name of the parent resource. For the required format, see the comment on the Instance.name field.
4487
+ * parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
4488
+ * // 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).
4489
+ * requestId: 'placeholder-value',
4490
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
4491
+ * validateOnly: 'placeholder-value',
4492
+ *
4493
+ * // Request body metadata
4494
+ * requestBody: {
4495
+ * // request body parameters
4496
+ * // {
4497
+ * // "activationPolicy": "my_activationPolicy",
4498
+ * // "annotations": {},
4499
+ * // "availabilityType": "my_availabilityType",
4500
+ * // "clientConnectionConfig": {},
4501
+ * // "connectionPoolConfig": {},
4502
+ * // "createTime": "my_createTime",
4503
+ * // "databaseFlags": {},
4504
+ * // "deleteTime": "my_deleteTime",
4505
+ * // "displayName": "my_displayName",
4506
+ * // "etag": "my_etag",
4507
+ * // "gcaConfig": {},
4508
+ * // "gceZone": "my_gceZone",
4509
+ * // "geminiConfig": {},
4510
+ * // "instanceType": "my_instanceType",
4511
+ * // "ipAddress": "my_ipAddress",
4512
+ * // "labels": {},
4513
+ * // "machineConfig": {},
4514
+ * // "name": "my_name",
4515
+ * // "networkConfig": {},
4516
+ * // "nodes": [],
4517
+ * // "observabilityConfig": {},
4518
+ * // "outboundPublicIpAddresses": [],
4519
+ * // "pscInstanceConfig": {},
4520
+ * // "publicIpAddress": "my_publicIpAddress",
4521
+ * // "queryInsightsConfig": {},
4522
+ * // "readPoolConfig": {},
4523
+ * // "reconciling": false,
4524
+ * // "satisfiesPzs": false,
4525
+ * // "state": "my_state",
4526
+ * // "uid": "my_uid",
4527
+ * // "updatePolicy": {},
4528
+ * // "updateTime": "my_updateTime",
4529
+ * // "writableNode": {}
4530
+ * // }
4531
+ * },
4532
+ * });
4533
+ * console.log(res.data);
4534
+ *
4535
+ * // Example response
4536
+ * // {
4537
+ * // "done": false,
4538
+ * // "error": {},
4539
+ * // "metadata": {},
4540
+ * // "name": "my_name",
4541
+ * // "response": {}
4542
+ * // }
4543
+ * }
4544
+ *
4545
+ * main().catch(e => {
4546
+ * console.error(e);
4547
+ * throw e;
4548
+ * });
4549
+ *
4550
+ * ```
3051
4551
  *
3052
4552
  * @param params - Parameters for request
3053
4553
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3062,6 +4562,103 @@ export declare namespace alloydb_v1beta {
3062
4562
  create(callback: BodyResponseCallback<Schema$Operation>): void;
3063
4563
  /**
3064
4564
  * Creates a new SECONDARY Instance in a given project and location.
4565
+ * @example
4566
+ * ```js
4567
+ * // Before running the sample:
4568
+ * // - Enable the API at:
4569
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4570
+ * // - Login into gcloud by running:
4571
+ * // ```sh
4572
+ * // $ gcloud auth application-default login
4573
+ * // ```
4574
+ * // - Install the npm module by running:
4575
+ * // ```sh
4576
+ * // $ npm install googleapis
4577
+ * // ```
4578
+ *
4579
+ * const {google} = require('googleapis');
4580
+ * const alloydb = google.alloydb('v1beta');
4581
+ *
4582
+ * async function main() {
4583
+ * const auth = new google.auth.GoogleAuth({
4584
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4585
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4586
+ * });
4587
+ *
4588
+ * // Acquire an auth client, and bind it to all future calls
4589
+ * const authClient = await auth.getClient();
4590
+ * google.options({auth: authClient});
4591
+ *
4592
+ * // Do the magic
4593
+ * const res =
4594
+ * await alloydb.projects.locations.clusters.instances.createsecondary({
4595
+ * // Required. ID of the requesting object.
4596
+ * instanceId: 'placeholder-value',
4597
+ * // Required. The name of the parent resource. For the required format, see the comment on the Instance.name field.
4598
+ * parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
4599
+ * // 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).
4600
+ * requestId: 'placeholder-value',
4601
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
4602
+ * validateOnly: 'placeholder-value',
4603
+ *
4604
+ * // Request body metadata
4605
+ * requestBody: {
4606
+ * // request body parameters
4607
+ * // {
4608
+ * // "activationPolicy": "my_activationPolicy",
4609
+ * // "annotations": {},
4610
+ * // "availabilityType": "my_availabilityType",
4611
+ * // "clientConnectionConfig": {},
4612
+ * // "connectionPoolConfig": {},
4613
+ * // "createTime": "my_createTime",
4614
+ * // "databaseFlags": {},
4615
+ * // "deleteTime": "my_deleteTime",
4616
+ * // "displayName": "my_displayName",
4617
+ * // "etag": "my_etag",
4618
+ * // "gcaConfig": {},
4619
+ * // "gceZone": "my_gceZone",
4620
+ * // "geminiConfig": {},
4621
+ * // "instanceType": "my_instanceType",
4622
+ * // "ipAddress": "my_ipAddress",
4623
+ * // "labels": {},
4624
+ * // "machineConfig": {},
4625
+ * // "name": "my_name",
4626
+ * // "networkConfig": {},
4627
+ * // "nodes": [],
4628
+ * // "observabilityConfig": {},
4629
+ * // "outboundPublicIpAddresses": [],
4630
+ * // "pscInstanceConfig": {},
4631
+ * // "publicIpAddress": "my_publicIpAddress",
4632
+ * // "queryInsightsConfig": {},
4633
+ * // "readPoolConfig": {},
4634
+ * // "reconciling": false,
4635
+ * // "satisfiesPzs": false,
4636
+ * // "state": "my_state",
4637
+ * // "uid": "my_uid",
4638
+ * // "updatePolicy": {},
4639
+ * // "updateTime": "my_updateTime",
4640
+ * // "writableNode": {}
4641
+ * // }
4642
+ * },
4643
+ * });
4644
+ * console.log(res.data);
4645
+ *
4646
+ * // Example response
4647
+ * // {
4648
+ * // "done": false,
4649
+ * // "error": {},
4650
+ * // "metadata": {},
4651
+ * // "name": "my_name",
4652
+ * // "response": {}
4653
+ * // }
4654
+ * }
4655
+ *
4656
+ * main().catch(e => {
4657
+ * console.error(e);
4658
+ * throw e;
4659
+ * });
4660
+ *
4661
+ * ```
3065
4662
  *
3066
4663
  * @param params - Parameters for request
3067
4664
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3076,6 +4673,62 @@ export declare namespace alloydb_v1beta {
3076
4673
  createsecondary(callback: BodyResponseCallback<Schema$Operation>): void;
3077
4674
  /**
3078
4675
  * Deletes a single Instance.
4676
+ * @example
4677
+ * ```js
4678
+ * // Before running the sample:
4679
+ * // - Enable the API at:
4680
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4681
+ * // - Login into gcloud by running:
4682
+ * // ```sh
4683
+ * // $ gcloud auth application-default login
4684
+ * // ```
4685
+ * // - Install the npm module by running:
4686
+ * // ```sh
4687
+ * // $ npm install googleapis
4688
+ * // ```
4689
+ *
4690
+ * const {google} = require('googleapis');
4691
+ * const alloydb = google.alloydb('v1beta');
4692
+ *
4693
+ * async function main() {
4694
+ * const auth = new google.auth.GoogleAuth({
4695
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4696
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4697
+ * });
4698
+ *
4699
+ * // Acquire an auth client, and bind it to all future calls
4700
+ * const authClient = await auth.getClient();
4701
+ * google.options({auth: authClient});
4702
+ *
4703
+ * // Do the magic
4704
+ * const res = await alloydb.projects.locations.clusters.instances.delete({
4705
+ * // 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.
4706
+ * etag: 'placeholder-value',
4707
+ * // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
4708
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
4709
+ * // 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).
4710
+ * requestId: 'placeholder-value',
4711
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
4712
+ * validateOnly: 'placeholder-value',
4713
+ * });
4714
+ * console.log(res.data);
4715
+ *
4716
+ * // Example response
4717
+ * // {
4718
+ * // "done": false,
4719
+ * // "error": {},
4720
+ * // "metadata": {},
4721
+ * // "name": "my_name",
4722
+ * // "response": {}
4723
+ * // }
4724
+ * }
4725
+ *
4726
+ * main().catch(e => {
4727
+ * console.error(e);
4728
+ * throw e;
4729
+ * });
4730
+ *
4731
+ * ```
3079
4732
  *
3080
4733
  * @param params - Parameters for request
3081
4734
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3090,6 +4743,65 @@ export declare namespace alloydb_v1beta {
3090
4743
  delete(callback: BodyResponseCallback<Schema$Operation>): void;
3091
4744
  /**
3092
4745
  * Forces a Failover for a highly available instance. Failover promotes the HA standby instance as the new primary. Imperative only.
4746
+ * @example
4747
+ * ```js
4748
+ * // Before running the sample:
4749
+ * // - Enable the API at:
4750
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4751
+ * // - Login into gcloud by running:
4752
+ * // ```sh
4753
+ * // $ gcloud auth application-default login
4754
+ * // ```
4755
+ * // - Install the npm module by running:
4756
+ * // ```sh
4757
+ * // $ npm install googleapis
4758
+ * // ```
4759
+ *
4760
+ * const {google} = require('googleapis');
4761
+ * const alloydb = google.alloydb('v1beta');
4762
+ *
4763
+ * async function main() {
4764
+ * const auth = new google.auth.GoogleAuth({
4765
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4766
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4767
+ * });
4768
+ *
4769
+ * // Acquire an auth client, and bind it to all future calls
4770
+ * const authClient = await auth.getClient();
4771
+ * google.options({auth: authClient});
4772
+ *
4773
+ * // Do the magic
4774
+ * const res = await alloydb.projects.locations.clusters.instances.failover({
4775
+ * // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
4776
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
4777
+ *
4778
+ * // Request body metadata
4779
+ * requestBody: {
4780
+ * // request body parameters
4781
+ * // {
4782
+ * // "requestId": "my_requestId",
4783
+ * // "validateOnly": false
4784
+ * // }
4785
+ * },
4786
+ * });
4787
+ * console.log(res.data);
4788
+ *
4789
+ * // Example response
4790
+ * // {
4791
+ * // "done": false,
4792
+ * // "error": {},
4793
+ * // "metadata": {},
4794
+ * // "name": "my_name",
4795
+ * // "response": {}
4796
+ * // }
4797
+ * }
4798
+ *
4799
+ * main().catch(e => {
4800
+ * console.error(e);
4801
+ * throw e;
4802
+ * });
4803
+ *
4804
+ * ```
3093
4805
  *
3094
4806
  * @param params - Parameters for request
3095
4807
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3104,6 +4816,86 @@ export declare namespace alloydb_v1beta {
3104
4816
  failover(callback: BodyResponseCallback<Schema$Operation>): void;
3105
4817
  /**
3106
4818
  * Gets details of a single Instance.
4819
+ * @example
4820
+ * ```js
4821
+ * // Before running the sample:
4822
+ * // - Enable the API at:
4823
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4824
+ * // - Login into gcloud by running:
4825
+ * // ```sh
4826
+ * // $ gcloud auth application-default login
4827
+ * // ```
4828
+ * // - Install the npm module by running:
4829
+ * // ```sh
4830
+ * // $ npm install googleapis
4831
+ * // ```
4832
+ *
4833
+ * const {google} = require('googleapis');
4834
+ * const alloydb = google.alloydb('v1beta');
4835
+ *
4836
+ * async function main() {
4837
+ * const auth = new google.auth.GoogleAuth({
4838
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4839
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4840
+ * });
4841
+ *
4842
+ * // Acquire an auth client, and bind it to all future calls
4843
+ * const authClient = await auth.getClient();
4844
+ * google.options({auth: authClient});
4845
+ *
4846
+ * // Do the magic
4847
+ * const res = await alloydb.projects.locations.clusters.instances.get({
4848
+ * // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
4849
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
4850
+ * // The view of the instance to return.
4851
+ * view: 'placeholder-value',
4852
+ * });
4853
+ * console.log(res.data);
4854
+ *
4855
+ * // Example response
4856
+ * // {
4857
+ * // "activationPolicy": "my_activationPolicy",
4858
+ * // "annotations": {},
4859
+ * // "availabilityType": "my_availabilityType",
4860
+ * // "clientConnectionConfig": {},
4861
+ * // "connectionPoolConfig": {},
4862
+ * // "createTime": "my_createTime",
4863
+ * // "databaseFlags": {},
4864
+ * // "deleteTime": "my_deleteTime",
4865
+ * // "displayName": "my_displayName",
4866
+ * // "etag": "my_etag",
4867
+ * // "gcaConfig": {},
4868
+ * // "gceZone": "my_gceZone",
4869
+ * // "geminiConfig": {},
4870
+ * // "instanceType": "my_instanceType",
4871
+ * // "ipAddress": "my_ipAddress",
4872
+ * // "labels": {},
4873
+ * // "machineConfig": {},
4874
+ * // "name": "my_name",
4875
+ * // "networkConfig": {},
4876
+ * // "nodes": [],
4877
+ * // "observabilityConfig": {},
4878
+ * // "outboundPublicIpAddresses": [],
4879
+ * // "pscInstanceConfig": {},
4880
+ * // "publicIpAddress": "my_publicIpAddress",
4881
+ * // "queryInsightsConfig": {},
4882
+ * // "readPoolConfig": {},
4883
+ * // "reconciling": false,
4884
+ * // "satisfiesPzs": false,
4885
+ * // "state": "my_state",
4886
+ * // "uid": "my_uid",
4887
+ * // "updatePolicy": {},
4888
+ * // "updateTime": "my_updateTime",
4889
+ * // "writableNode": {}
4890
+ * // }
4891
+ * }
4892
+ *
4893
+ * main().catch(e => {
4894
+ * console.error(e);
4895
+ * throw e;
4896
+ * });
4897
+ *
4898
+ * ```
3107
4899
  *
3108
4900
  * @param params - Parameters for request
3109
4901
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3118,6 +4910,61 @@ export declare namespace alloydb_v1beta {
3118
4910
  get(callback: BodyResponseCallback<Schema$Instance>): void;
3119
4911
  /**
3120
4912
  * Get instance metadata used for a connection.
4913
+ * @example
4914
+ * ```js
4915
+ * // Before running the sample:
4916
+ * // - Enable the API at:
4917
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4918
+ * // - Login into gcloud by running:
4919
+ * // ```sh
4920
+ * // $ gcloud auth application-default login
4921
+ * // ```
4922
+ * // - Install the npm module by running:
4923
+ * // ```sh
4924
+ * // $ npm install googleapis
4925
+ * // ```
4926
+ *
4927
+ * const {google} = require('googleapis');
4928
+ * const alloydb = google.alloydb('v1beta');
4929
+ *
4930
+ * async function main() {
4931
+ * const auth = new google.auth.GoogleAuth({
4932
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4933
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4934
+ * });
4935
+ *
4936
+ * // Acquire an auth client, and bind it to all future calls
4937
+ * const authClient = await auth.getClient();
4938
+ * google.options({auth: authClient});
4939
+ *
4940
+ * // Do the magic
4941
+ * const res =
4942
+ * await alloydb.projects.locations.clusters.instances.getConnectionInfo({
4943
+ * // Required. The name of the parent resource. The required format is: projects/{project\}/locations/{location\}/clusters/{cluster\}/instances/{instance\}
4944
+ * parent:
4945
+ * 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
4946
+ * // 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).
4947
+ * requestId: 'placeholder-value',
4948
+ * });
4949
+ * console.log(res.data);
4950
+ *
4951
+ * // Example response
4952
+ * // {
4953
+ * // "instanceUid": "my_instanceUid",
4954
+ * // "ipAddress": "my_ipAddress",
4955
+ * // "name": "my_name",
4956
+ * // "pemCertificateChain": [],
4957
+ * // "pscDnsName": "my_pscDnsName",
4958
+ * // "publicIpAddress": "my_publicIpAddress"
4959
+ * // }
4960
+ * }
4961
+ *
4962
+ * main().catch(e => {
4963
+ * console.error(e);
4964
+ * throw e;
4965
+ * });
4966
+ *
4967
+ * ```
3121
4968
  *
3122
4969
  * @param params - Parameters for request
3123
4970
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3132,6 +4979,66 @@ export declare namespace alloydb_v1beta {
3132
4979
  getConnectionInfo(callback: BodyResponseCallback<Schema$ConnectionInfo>): void;
3133
4980
  /**
3134
4981
  * Injects fault in an instance. Imperative only.
4982
+ * @example
4983
+ * ```js
4984
+ * // Before running the sample:
4985
+ * // - Enable the API at:
4986
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4987
+ * // - Login into gcloud by running:
4988
+ * // ```sh
4989
+ * // $ gcloud auth application-default login
4990
+ * // ```
4991
+ * // - Install the npm module by running:
4992
+ * // ```sh
4993
+ * // $ npm install googleapis
4994
+ * // ```
4995
+ *
4996
+ * const {google} = require('googleapis');
4997
+ * const alloydb = google.alloydb('v1beta');
4998
+ *
4999
+ * async function main() {
5000
+ * const auth = new google.auth.GoogleAuth({
5001
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5002
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5003
+ * });
5004
+ *
5005
+ * // Acquire an auth client, and bind it to all future calls
5006
+ * const authClient = await auth.getClient();
5007
+ * google.options({auth: authClient});
5008
+ *
5009
+ * // Do the magic
5010
+ * const res = await alloydb.projects.locations.clusters.instances.injectFault({
5011
+ * // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
5012
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
5013
+ *
5014
+ * // Request body metadata
5015
+ * requestBody: {
5016
+ * // request body parameters
5017
+ * // {
5018
+ * // "faultType": "my_faultType",
5019
+ * // "requestId": "my_requestId",
5020
+ * // "validateOnly": false
5021
+ * // }
5022
+ * },
5023
+ * });
5024
+ * console.log(res.data);
5025
+ *
5026
+ * // Example response
5027
+ * // {
5028
+ * // "done": false,
5029
+ * // "error": {},
5030
+ * // "metadata": {},
5031
+ * // "name": "my_name",
5032
+ * // "response": {}
5033
+ * // }
5034
+ * }
5035
+ *
5036
+ * main().catch(e => {
5037
+ * console.error(e);
5038
+ * throw e;
5039
+ * });
5040
+ *
5041
+ * ```
3135
5042
  *
3136
5043
  * @param params - Parameters for request
3137
5044
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3146,6 +5053,62 @@ export declare namespace alloydb_v1beta {
3146
5053
  injectFault(callback: BodyResponseCallback<Schema$Operation>): void;
3147
5054
  /**
3148
5055
  * Lists Instances in a given project and location.
5056
+ * @example
5057
+ * ```js
5058
+ * // Before running the sample:
5059
+ * // - Enable the API at:
5060
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5061
+ * // - Login into gcloud by running:
5062
+ * // ```sh
5063
+ * // $ gcloud auth application-default login
5064
+ * // ```
5065
+ * // - Install the npm module by running:
5066
+ * // ```sh
5067
+ * // $ npm install googleapis
5068
+ * // ```
5069
+ *
5070
+ * const {google} = require('googleapis');
5071
+ * const alloydb = google.alloydb('v1beta');
5072
+ *
5073
+ * async function main() {
5074
+ * const auth = new google.auth.GoogleAuth({
5075
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5076
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5077
+ * });
5078
+ *
5079
+ * // Acquire an auth client, and bind it to all future calls
5080
+ * const authClient = await auth.getClient();
5081
+ * google.options({auth: authClient});
5082
+ *
5083
+ * // Do the magic
5084
+ * const res = await alloydb.projects.locations.clusters.instances.list({
5085
+ * // Optional. Filtering results
5086
+ * filter: 'placeholder-value',
5087
+ * // Optional. Hint for how to order the results
5088
+ * orderBy: 'placeholder-value',
5089
+ * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
5090
+ * pageSize: 'placeholder-value',
5091
+ * // A token identifying a page of results the server should return.
5092
+ * pageToken: 'placeholder-value',
5093
+ * // 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/-
5094
+ * parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
5095
+ * });
5096
+ * console.log(res.data);
5097
+ *
5098
+ * // Example response
5099
+ * // {
5100
+ * // "instances": [],
5101
+ * // "nextPageToken": "my_nextPageToken",
5102
+ * // "unreachable": []
5103
+ * // }
5104
+ * }
5105
+ *
5106
+ * main().catch(e => {
5107
+ * console.error(e);
5108
+ * throw e;
5109
+ * });
5110
+ *
5111
+ * ```
3149
5112
  *
3150
5113
  * @param params - Parameters for request
3151
5114
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3160,6 +5123,104 @@ export declare namespace alloydb_v1beta {
3160
5123
  list(callback: BodyResponseCallback<Schema$ListInstancesResponse>): void;
3161
5124
  /**
3162
5125
  * Updates the parameters of a single Instance.
5126
+ * @example
5127
+ * ```js
5128
+ * // Before running the sample:
5129
+ * // - Enable the API at:
5130
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5131
+ * // - Login into gcloud by running:
5132
+ * // ```sh
5133
+ * // $ gcloud auth application-default login
5134
+ * // ```
5135
+ * // - Install the npm module by running:
5136
+ * // ```sh
5137
+ * // $ npm install googleapis
5138
+ * // ```
5139
+ *
5140
+ * const {google} = require('googleapis');
5141
+ * const alloydb = google.alloydb('v1beta');
5142
+ *
5143
+ * async function main() {
5144
+ * const auth = new google.auth.GoogleAuth({
5145
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5146
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5147
+ * });
5148
+ *
5149
+ * // Acquire an auth client, and bind it to all future calls
5150
+ * const authClient = await auth.getClient();
5151
+ * google.options({auth: authClient});
5152
+ *
5153
+ * // Do the magic
5154
+ * const res = await alloydb.projects.locations.clusters.instances.patch({
5155
+ * // 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.
5156
+ * allowMissing: 'placeholder-value',
5157
+ * // 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\}
5158
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
5159
+ * // 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).
5160
+ * requestId: 'placeholder-value',
5161
+ * // 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.
5162
+ * updateMask: 'placeholder-value',
5163
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
5164
+ * validateOnly: 'placeholder-value',
5165
+ *
5166
+ * // Request body metadata
5167
+ * requestBody: {
5168
+ * // request body parameters
5169
+ * // {
5170
+ * // "activationPolicy": "my_activationPolicy",
5171
+ * // "annotations": {},
5172
+ * // "availabilityType": "my_availabilityType",
5173
+ * // "clientConnectionConfig": {},
5174
+ * // "connectionPoolConfig": {},
5175
+ * // "createTime": "my_createTime",
5176
+ * // "databaseFlags": {},
5177
+ * // "deleteTime": "my_deleteTime",
5178
+ * // "displayName": "my_displayName",
5179
+ * // "etag": "my_etag",
5180
+ * // "gcaConfig": {},
5181
+ * // "gceZone": "my_gceZone",
5182
+ * // "geminiConfig": {},
5183
+ * // "instanceType": "my_instanceType",
5184
+ * // "ipAddress": "my_ipAddress",
5185
+ * // "labels": {},
5186
+ * // "machineConfig": {},
5187
+ * // "name": "my_name",
5188
+ * // "networkConfig": {},
5189
+ * // "nodes": [],
5190
+ * // "observabilityConfig": {},
5191
+ * // "outboundPublicIpAddresses": [],
5192
+ * // "pscInstanceConfig": {},
5193
+ * // "publicIpAddress": "my_publicIpAddress",
5194
+ * // "queryInsightsConfig": {},
5195
+ * // "readPoolConfig": {},
5196
+ * // "reconciling": false,
5197
+ * // "satisfiesPzs": false,
5198
+ * // "state": "my_state",
5199
+ * // "uid": "my_uid",
5200
+ * // "updatePolicy": {},
5201
+ * // "updateTime": "my_updateTime",
5202
+ * // "writableNode": {}
5203
+ * // }
5204
+ * },
5205
+ * });
5206
+ * console.log(res.data);
5207
+ *
5208
+ * // Example response
5209
+ * // {
5210
+ * // "done": false,
5211
+ * // "error": {},
5212
+ * // "metadata": {},
5213
+ * // "name": "my_name",
5214
+ * // "response": {}
5215
+ * // }
5216
+ * }
5217
+ *
5218
+ * main().catch(e => {
5219
+ * console.error(e);
5220
+ * throw e;
5221
+ * });
5222
+ *
5223
+ * ```
3163
5224
  *
3164
5225
  * @param params - Parameters for request
3165
5226
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3174,6 +5235,66 @@ export declare namespace alloydb_v1beta {
3174
5235
  patch(callback: BodyResponseCallback<Schema$Operation>): void;
3175
5236
  /**
3176
5237
  * Restart an Instance in a cluster. Imperative only.
5238
+ * @example
5239
+ * ```js
5240
+ * // Before running the sample:
5241
+ * // - Enable the API at:
5242
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5243
+ * // - Login into gcloud by running:
5244
+ * // ```sh
5245
+ * // $ gcloud auth application-default login
5246
+ * // ```
5247
+ * // - Install the npm module by running:
5248
+ * // ```sh
5249
+ * // $ npm install googleapis
5250
+ * // ```
5251
+ *
5252
+ * const {google} = require('googleapis');
5253
+ * const alloydb = google.alloydb('v1beta');
5254
+ *
5255
+ * async function main() {
5256
+ * const auth = new google.auth.GoogleAuth({
5257
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5258
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5259
+ * });
5260
+ *
5261
+ * // Acquire an auth client, and bind it to all future calls
5262
+ * const authClient = await auth.getClient();
5263
+ * google.options({auth: authClient});
5264
+ *
5265
+ * // Do the magic
5266
+ * const res = await alloydb.projects.locations.clusters.instances.restart({
5267
+ * // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
5268
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
5269
+ *
5270
+ * // Request body metadata
5271
+ * requestBody: {
5272
+ * // request body parameters
5273
+ * // {
5274
+ * // "nodeIds": [],
5275
+ * // "requestId": "my_requestId",
5276
+ * // "validateOnly": false
5277
+ * // }
5278
+ * },
5279
+ * });
5280
+ * console.log(res.data);
5281
+ *
5282
+ * // Example response
5283
+ * // {
5284
+ * // "done": false,
5285
+ * // "error": {},
5286
+ * // "metadata": {},
5287
+ * // "name": "my_name",
5288
+ * // "response": {}
5289
+ * // }
5290
+ * }
5291
+ *
5292
+ * main().catch(e => {
5293
+ * console.error(e);
5294
+ * throw e;
5295
+ * });
5296
+ *
5297
+ * ```
3177
5298
  *
3178
5299
  * @param params - Parameters for request
3179
5300
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3352,6 +5473,74 @@ export declare namespace alloydb_v1beta {
3352
5473
  constructor(context: APIRequestContext);
3353
5474
  /**
3354
5475
  * Creates a new User in a given project, location, and cluster.
5476
+ * @example
5477
+ * ```js
5478
+ * // Before running the sample:
5479
+ * // - Enable the API at:
5480
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5481
+ * // - Login into gcloud by running:
5482
+ * // ```sh
5483
+ * // $ gcloud auth application-default login
5484
+ * // ```
5485
+ * // - Install the npm module by running:
5486
+ * // ```sh
5487
+ * // $ npm install googleapis
5488
+ * // ```
5489
+ *
5490
+ * const {google} = require('googleapis');
5491
+ * const alloydb = google.alloydb('v1beta');
5492
+ *
5493
+ * async function main() {
5494
+ * const auth = new google.auth.GoogleAuth({
5495
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5496
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5497
+ * });
5498
+ *
5499
+ * // Acquire an auth client, and bind it to all future calls
5500
+ * const authClient = await auth.getClient();
5501
+ * google.options({auth: authClient});
5502
+ *
5503
+ * // Do the magic
5504
+ * const res = await alloydb.projects.locations.clusters.users.create({
5505
+ * // Required. Value for parent.
5506
+ * parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
5507
+ * // 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).
5508
+ * requestId: 'placeholder-value',
5509
+ * // Required. ID of the requesting object.
5510
+ * userId: 'placeholder-value',
5511
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
5512
+ * validateOnly: 'placeholder-value',
5513
+ *
5514
+ * // Request body metadata
5515
+ * requestBody: {
5516
+ * // request body parameters
5517
+ * // {
5518
+ * // "databaseRoles": [],
5519
+ * // "keepExtraRoles": false,
5520
+ * // "name": "my_name",
5521
+ * // "password": "my_password",
5522
+ * // "userType": "my_userType"
5523
+ * // }
5524
+ * },
5525
+ * });
5526
+ * console.log(res.data);
5527
+ *
5528
+ * // Example response
5529
+ * // {
5530
+ * // "databaseRoles": [],
5531
+ * // "keepExtraRoles": false,
5532
+ * // "name": "my_name",
5533
+ * // "password": "my_password",
5534
+ * // "userType": "my_userType"
5535
+ * // }
5536
+ * }
5537
+ *
5538
+ * main().catch(e => {
5539
+ * console.error(e);
5540
+ * throw e;
5541
+ * });
5542
+ *
5543
+ * ```
3355
5544
  *
3356
5545
  * @param params - Parameters for request
3357
5546
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3366,6 +5555,54 @@ export declare namespace alloydb_v1beta {
3366
5555
  create(callback: BodyResponseCallback<Schema$User>): void;
3367
5556
  /**
3368
5557
  * Deletes a single User.
5558
+ * @example
5559
+ * ```js
5560
+ * // Before running the sample:
5561
+ * // - Enable the API at:
5562
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5563
+ * // - Login into gcloud by running:
5564
+ * // ```sh
5565
+ * // $ gcloud auth application-default login
5566
+ * // ```
5567
+ * // - Install the npm module by running:
5568
+ * // ```sh
5569
+ * // $ npm install googleapis
5570
+ * // ```
5571
+ *
5572
+ * const {google} = require('googleapis');
5573
+ * const alloydb = google.alloydb('v1beta');
5574
+ *
5575
+ * async function main() {
5576
+ * const auth = new google.auth.GoogleAuth({
5577
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5578
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5579
+ * });
5580
+ *
5581
+ * // Acquire an auth client, and bind it to all future calls
5582
+ * const authClient = await auth.getClient();
5583
+ * google.options({auth: authClient});
5584
+ *
5585
+ * // Do the magic
5586
+ * const res = await alloydb.projects.locations.clusters.users.delete({
5587
+ * // Required. The name of the resource. For the required format, see the comment on the User.name field.
5588
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/users/my-user',
5589
+ * // 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).
5590
+ * requestId: 'placeholder-value',
5591
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
5592
+ * validateOnly: 'placeholder-value',
5593
+ * });
5594
+ * console.log(res.data);
5595
+ *
5596
+ * // Example response
5597
+ * // {}
5598
+ * }
5599
+ *
5600
+ * main().catch(e => {
5601
+ * console.error(e);
5602
+ * throw e;
5603
+ * });
5604
+ *
5605
+ * ```
3369
5606
  *
3370
5607
  * @param params - Parameters for request
3371
5608
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3380,6 +5617,56 @@ export declare namespace alloydb_v1beta {
3380
5617
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
3381
5618
  /**
3382
5619
  * Gets details of a single User.
5620
+ * @example
5621
+ * ```js
5622
+ * // Before running the sample:
5623
+ * // - Enable the API at:
5624
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5625
+ * // - Login into gcloud by running:
5626
+ * // ```sh
5627
+ * // $ gcloud auth application-default login
5628
+ * // ```
5629
+ * // - Install the npm module by running:
5630
+ * // ```sh
5631
+ * // $ npm install googleapis
5632
+ * // ```
5633
+ *
5634
+ * const {google} = require('googleapis');
5635
+ * const alloydb = google.alloydb('v1beta');
5636
+ *
5637
+ * async function main() {
5638
+ * const auth = new google.auth.GoogleAuth({
5639
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5640
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5641
+ * });
5642
+ *
5643
+ * // Acquire an auth client, and bind it to all future calls
5644
+ * const authClient = await auth.getClient();
5645
+ * google.options({auth: authClient});
5646
+ *
5647
+ * // Do the magic
5648
+ * const res = await alloydb.projects.locations.clusters.users.get({
5649
+ * // Required. The name of the resource. For the required format, see the comment on the User.name field.
5650
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/users/my-user',
5651
+ * });
5652
+ * console.log(res.data);
5653
+ *
5654
+ * // Example response
5655
+ * // {
5656
+ * // "databaseRoles": [],
5657
+ * // "keepExtraRoles": false,
5658
+ * // "name": "my_name",
5659
+ * // "password": "my_password",
5660
+ * // "userType": "my_userType"
5661
+ * // }
5662
+ * }
5663
+ *
5664
+ * main().catch(e => {
5665
+ * console.error(e);
5666
+ * throw e;
5667
+ * });
5668
+ *
5669
+ * ```
3383
5670
  *
3384
5671
  * @param params - Parameters for request
3385
5672
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3394,6 +5681,62 @@ export declare namespace alloydb_v1beta {
3394
5681
  get(callback: BodyResponseCallback<Schema$User>): void;
3395
5682
  /**
3396
5683
  * Lists Users in a given project and location.
5684
+ * @example
5685
+ * ```js
5686
+ * // Before running the sample:
5687
+ * // - Enable the API at:
5688
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5689
+ * // - Login into gcloud by running:
5690
+ * // ```sh
5691
+ * // $ gcloud auth application-default login
5692
+ * // ```
5693
+ * // - Install the npm module by running:
5694
+ * // ```sh
5695
+ * // $ npm install googleapis
5696
+ * // ```
5697
+ *
5698
+ * const {google} = require('googleapis');
5699
+ * const alloydb = google.alloydb('v1beta');
5700
+ *
5701
+ * async function main() {
5702
+ * const auth = new google.auth.GoogleAuth({
5703
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5704
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5705
+ * });
5706
+ *
5707
+ * // Acquire an auth client, and bind it to all future calls
5708
+ * const authClient = await auth.getClient();
5709
+ * google.options({auth: authClient});
5710
+ *
5711
+ * // Do the magic
5712
+ * const res = await alloydb.projects.locations.clusters.users.list({
5713
+ * // Optional. Filtering results
5714
+ * filter: 'placeholder-value',
5715
+ * // Optional. Hint for how to order the results
5716
+ * orderBy: 'placeholder-value',
5717
+ * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
5718
+ * pageSize: 'placeholder-value',
5719
+ * // Optional. A token identifying a page of results the server should return.
5720
+ * pageToken: 'placeholder-value',
5721
+ * // Required. Parent value for ListUsersRequest
5722
+ * parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
5723
+ * });
5724
+ * console.log(res.data);
5725
+ *
5726
+ * // Example response
5727
+ * // {
5728
+ * // "nextPageToken": "my_nextPageToken",
5729
+ * // "unreachable": [],
5730
+ * // "users": []
5731
+ * // }
5732
+ * }
5733
+ *
5734
+ * main().catch(e => {
5735
+ * console.error(e);
5736
+ * throw e;
5737
+ * });
5738
+ *
5739
+ * ```
3397
5740
  *
3398
5741
  * @param params - Parameters for request
3399
5742
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3408,6 +5751,76 @@ export declare namespace alloydb_v1beta {
3408
5751
  list(callback: BodyResponseCallback<Schema$ListUsersResponse>): void;
3409
5752
  /**
3410
5753
  * Updates the parameters of a single User.
5754
+ * @example
5755
+ * ```js
5756
+ * // Before running the sample:
5757
+ * // - Enable the API at:
5758
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5759
+ * // - Login into gcloud by running:
5760
+ * // ```sh
5761
+ * // $ gcloud auth application-default login
5762
+ * // ```
5763
+ * // - Install the npm module by running:
5764
+ * // ```sh
5765
+ * // $ npm install googleapis
5766
+ * // ```
5767
+ *
5768
+ * const {google} = require('googleapis');
5769
+ * const alloydb = google.alloydb('v1beta');
5770
+ *
5771
+ * async function main() {
5772
+ * const auth = new google.auth.GoogleAuth({
5773
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5774
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5775
+ * });
5776
+ *
5777
+ * // Acquire an auth client, and bind it to all future calls
5778
+ * const authClient = await auth.getClient();
5779
+ * google.options({auth: authClient});
5780
+ *
5781
+ * // Do the magic
5782
+ * const res = await alloydb.projects.locations.clusters.users.patch({
5783
+ * // Optional. Allow missing fields in the update mask.
5784
+ * allowMissing: 'placeholder-value',
5785
+ * // Output only. Name of the resource in the form of projects/{project\}/locations/{location\}/cluster/{cluster\}/users/{user\}.
5786
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/users/my-user',
5787
+ * // 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).
5788
+ * requestId: 'placeholder-value',
5789
+ * // 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.
5790
+ * updateMask: 'placeholder-value',
5791
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
5792
+ * validateOnly: 'placeholder-value',
5793
+ *
5794
+ * // Request body metadata
5795
+ * requestBody: {
5796
+ * // request body parameters
5797
+ * // {
5798
+ * // "databaseRoles": [],
5799
+ * // "keepExtraRoles": false,
5800
+ * // "name": "my_name",
5801
+ * // "password": "my_password",
5802
+ * // "userType": "my_userType"
5803
+ * // }
5804
+ * },
5805
+ * });
5806
+ * console.log(res.data);
5807
+ *
5808
+ * // Example response
5809
+ * // {
5810
+ * // "databaseRoles": [],
5811
+ * // "keepExtraRoles": false,
5812
+ * // "name": "my_name",
5813
+ * // "password": "my_password",
5814
+ * // "userType": "my_userType"
5815
+ * // }
5816
+ * }
5817
+ *
5818
+ * main().catch(e => {
5819
+ * console.error(e);
5820
+ * throw e;
5821
+ * });
5822
+ *
5823
+ * ```
3411
5824
  *
3412
5825
  * @param params - Parameters for request
3413
5826
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3516,6 +5929,50 @@ export declare namespace alloydb_v1beta {
3516
5929
  constructor(context: APIRequestContext);
3517
5930
  /**
3518
5931
  * 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`.
5932
+ * @example
5933
+ * ```js
5934
+ * // Before running the sample:
5935
+ * // - Enable the API at:
5936
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5937
+ * // - Login into gcloud by running:
5938
+ * // ```sh
5939
+ * // $ gcloud auth application-default login
5940
+ * // ```
5941
+ * // - Install the npm module by running:
5942
+ * // ```sh
5943
+ * // $ npm install googleapis
5944
+ * // ```
5945
+ *
5946
+ * const {google} = require('googleapis');
5947
+ * const alloydb = google.alloydb('v1beta');
5948
+ *
5949
+ * async function main() {
5950
+ * const auth = new google.auth.GoogleAuth({
5951
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5952
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5953
+ * });
5954
+ *
5955
+ * // Acquire an auth client, and bind it to all future calls
5956
+ * const authClient = await auth.getClient();
5957
+ * google.options({auth: authClient});
5958
+ *
5959
+ * // Do the magic
5960
+ * const res = await alloydb.projects.locations.operations.cancel({
5961
+ * // The name of the operation resource to be cancelled.
5962
+ * name: 'projects/my-project/locations/my-location/operations/my-operation',
5963
+ * });
5964
+ * console.log(res.data);
5965
+ *
5966
+ * // Example response
5967
+ * // {}
5968
+ * }
5969
+ *
5970
+ * main().catch(e => {
5971
+ * console.error(e);
5972
+ * throw e;
5973
+ * });
5974
+ *
5975
+ * ```
3519
5976
  *
3520
5977
  * @param params - Parameters for request
3521
5978
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3530,6 +5987,50 @@ export declare namespace alloydb_v1beta {
3530
5987
  cancel(callback: BodyResponseCallback<Schema$Empty>): void;
3531
5988
  /**
3532
5989
  * 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`.
5990
+ * @example
5991
+ * ```js
5992
+ * // Before running the sample:
5993
+ * // - Enable the API at:
5994
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5995
+ * // - Login into gcloud by running:
5996
+ * // ```sh
5997
+ * // $ gcloud auth application-default login
5998
+ * // ```
5999
+ * // - Install the npm module by running:
6000
+ * // ```sh
6001
+ * // $ npm install googleapis
6002
+ * // ```
6003
+ *
6004
+ * const {google} = require('googleapis');
6005
+ * const alloydb = google.alloydb('v1beta');
6006
+ *
6007
+ * async function main() {
6008
+ * const auth = new google.auth.GoogleAuth({
6009
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6010
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
6011
+ * });
6012
+ *
6013
+ * // Acquire an auth client, and bind it to all future calls
6014
+ * const authClient = await auth.getClient();
6015
+ * google.options({auth: authClient});
6016
+ *
6017
+ * // Do the magic
6018
+ * const res = await alloydb.projects.locations.operations.delete({
6019
+ * // The name of the operation resource to be deleted.
6020
+ * name: 'projects/my-project/locations/my-location/operations/my-operation',
6021
+ * });
6022
+ * console.log(res.data);
6023
+ *
6024
+ * // Example response
6025
+ * // {}
6026
+ * }
6027
+ *
6028
+ * main().catch(e => {
6029
+ * console.error(e);
6030
+ * throw e;
6031
+ * });
6032
+ *
6033
+ * ```
3533
6034
  *
3534
6035
  * @param params - Parameters for request
3535
6036
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3544,6 +6045,56 @@ export declare namespace alloydb_v1beta {
3544
6045
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
3545
6046
  /**
3546
6047
  * 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.
6048
+ * @example
6049
+ * ```js
6050
+ * // Before running the sample:
6051
+ * // - Enable the API at:
6052
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
6053
+ * // - Login into gcloud by running:
6054
+ * // ```sh
6055
+ * // $ gcloud auth application-default login
6056
+ * // ```
6057
+ * // - Install the npm module by running:
6058
+ * // ```sh
6059
+ * // $ npm install googleapis
6060
+ * // ```
6061
+ *
6062
+ * const {google} = require('googleapis');
6063
+ * const alloydb = google.alloydb('v1beta');
6064
+ *
6065
+ * async function main() {
6066
+ * const auth = new google.auth.GoogleAuth({
6067
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6068
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
6069
+ * });
6070
+ *
6071
+ * // Acquire an auth client, and bind it to all future calls
6072
+ * const authClient = await auth.getClient();
6073
+ * google.options({auth: authClient});
6074
+ *
6075
+ * // Do the magic
6076
+ * const res = await alloydb.projects.locations.operations.get({
6077
+ * // The name of the operation resource.
6078
+ * name: 'projects/my-project/locations/my-location/operations/my-operation',
6079
+ * });
6080
+ * console.log(res.data);
6081
+ *
6082
+ * // Example response
6083
+ * // {
6084
+ * // "done": false,
6085
+ * // "error": {},
6086
+ * // "metadata": {},
6087
+ * // "name": "my_name",
6088
+ * // "response": {}
6089
+ * // }
6090
+ * }
6091
+ *
6092
+ * main().catch(e => {
6093
+ * console.error(e);
6094
+ * throw e;
6095
+ * });
6096
+ *
6097
+ * ```
3547
6098
  *
3548
6099
  * @param params - Parameters for request
3549
6100
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3558,6 +6109,59 @@ export declare namespace alloydb_v1beta {
3558
6109
  get(callback: BodyResponseCallback<Schema$Operation>): void;
3559
6110
  /**
3560
6111
  * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
6112
+ * @example
6113
+ * ```js
6114
+ * // Before running the sample:
6115
+ * // - Enable the API at:
6116
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
6117
+ * // - Login into gcloud by running:
6118
+ * // ```sh
6119
+ * // $ gcloud auth application-default login
6120
+ * // ```
6121
+ * // - Install the npm module by running:
6122
+ * // ```sh
6123
+ * // $ npm install googleapis
6124
+ * // ```
6125
+ *
6126
+ * const {google} = require('googleapis');
6127
+ * const alloydb = google.alloydb('v1beta');
6128
+ *
6129
+ * async function main() {
6130
+ * const auth = new google.auth.GoogleAuth({
6131
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6132
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
6133
+ * });
6134
+ *
6135
+ * // Acquire an auth client, and bind it to all future calls
6136
+ * const authClient = await auth.getClient();
6137
+ * google.options({auth: authClient});
6138
+ *
6139
+ * // Do the magic
6140
+ * const res = await alloydb.projects.locations.operations.list({
6141
+ * // The standard list filter.
6142
+ * filter: 'placeholder-value',
6143
+ * // The name of the operation's parent resource.
6144
+ * name: 'projects/my-project/locations/my-location',
6145
+ * // The standard list page size.
6146
+ * pageSize: 'placeholder-value',
6147
+ * // The standard list page token.
6148
+ * pageToken: 'placeholder-value',
6149
+ * });
6150
+ * console.log(res.data);
6151
+ *
6152
+ * // Example response
6153
+ * // {
6154
+ * // "nextPageToken": "my_nextPageToken",
6155
+ * // "operations": []
6156
+ * // }
6157
+ * }
6158
+ *
6159
+ * main().catch(e => {
6160
+ * console.error(e);
6161
+ * throw e;
6162
+ * });
6163
+ *
6164
+ * ```
3561
6165
  *
3562
6166
  * @param params - Parameters for request
3563
6167
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3612,6 +6216,59 @@ export declare namespace alloydb_v1beta {
3612
6216
  constructor(context: APIRequestContext);
3613
6217
  /**
3614
6218
  * Lists SupportedDatabaseFlags for a given project and location.
6219
+ * @example
6220
+ * ```js
6221
+ * // Before running the sample:
6222
+ * // - Enable the API at:
6223
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
6224
+ * // - Login into gcloud by running:
6225
+ * // ```sh
6226
+ * // $ gcloud auth application-default login
6227
+ * // ```
6228
+ * // - Install the npm module by running:
6229
+ * // ```sh
6230
+ * // $ npm install googleapis
6231
+ * // ```
6232
+ *
6233
+ * const {google} = require('googleapis');
6234
+ * const alloydb = google.alloydb('v1beta');
6235
+ *
6236
+ * async function main() {
6237
+ * const auth = new google.auth.GoogleAuth({
6238
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6239
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
6240
+ * });
6241
+ *
6242
+ * // Acquire an auth client, and bind it to all future calls
6243
+ * const authClient = await auth.getClient();
6244
+ * google.options({auth: authClient});
6245
+ *
6246
+ * // Do the magic
6247
+ * const res = await alloydb.projects.locations.supportedDatabaseFlags.list({
6248
+ * // Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
6249
+ * pageSize: 'placeholder-value',
6250
+ * // A token identifying a page of results the server should return.
6251
+ * pageToken: 'placeholder-value',
6252
+ * // 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.
6253
+ * parent: 'projects/my-project/locations/my-location',
6254
+ * // Optional. The scope for which supported flags are requested. If not specified, default is DATABASE.
6255
+ * scope: 'placeholder-value',
6256
+ * });
6257
+ * console.log(res.data);
6258
+ *
6259
+ * // Example response
6260
+ * // {
6261
+ * // "nextPageToken": "my_nextPageToken",
6262
+ * // "supportedDatabaseFlags": []
6263
+ * // }
6264
+ * }
6265
+ *
6266
+ * main().catch(e => {
6267
+ * console.error(e);
6268
+ * throw e;
6269
+ * });
6270
+ *
6271
+ * ```
3615
6272
  *
3616
6273
  * @param params - Parameters for request
3617
6274
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.