@googleapis/alloydb 13.0.1 → 14.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/build/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
  */
@@ -1654,6 +1670,27 @@ export declare namespace alloydb_v1beta {
1654
1670
  */
1655
1671
  status?: string | null;
1656
1672
  }
1673
+ /**
1674
+ * Timing information for the stage execution.
1675
+ */
1676
+ export interface Schema$StageSchedule {
1677
+ /**
1678
+ * Actual end time of the stage. Set only if the stage has completed.
1679
+ */
1680
+ actualEndTime?: string | null;
1681
+ /**
1682
+ * Actual start time of the stage. Set only if the stage has started.
1683
+ */
1684
+ actualStartTime?: string | null;
1685
+ /**
1686
+ * When the stage is expected to end. Set only if the stage has not completed yet.
1687
+ */
1688
+ estimatedEndTime?: string | null;
1689
+ /**
1690
+ * When the stage is expected to start. Set only if the stage has not started yet.
1691
+ */
1692
+ estimatedStartTime?: string | null;
1693
+ }
1657
1694
  /**
1658
1695
  * Status of an upgrade stage.
1659
1696
  */
@@ -1662,6 +1699,10 @@ export declare namespace alloydb_v1beta {
1662
1699
  * Read pool instances upgrade metadata.
1663
1700
  */
1664
1701
  readPoolInstancesUpgrade?: Schema$ReadPoolInstancesUpgradeStageStatus;
1702
+ /**
1703
+ * Output only. Timing information for the stage execution.
1704
+ */
1705
+ schedule?: Schema$StageSchedule;
1665
1706
  /**
1666
1707
  * Upgrade stage.
1667
1708
  */
@@ -1747,6 +1788,15 @@ export declare namespace alloydb_v1beta {
1747
1788
  */
1748
1789
  pointInTimeRecoveryEnabled?: boolean | null;
1749
1790
  }
1791
+ /**
1792
+ * BackupDRConfiguration to capture the backup and disaster recovery details of database resource.
1793
+ */
1794
+ export interface Schema$StorageDatabasecenterPartnerapiV1mainBackupDRConfiguration {
1795
+ /**
1796
+ * Indicates if the resource is managed by BackupDR.
1797
+ */
1798
+ backupdrManaged?: boolean | null;
1799
+ }
1750
1800
  /**
1751
1801
  * A backup run.
1752
1802
  */
@@ -1781,6 +1831,31 @@ export declare namespace alloydb_v1beta {
1781
1831
  */
1782
1832
  version?: string | null;
1783
1833
  }
1834
+ /**
1835
+ * Config based signal data. This is used to send signals to Condor which are based on the DB level configurations. These will be used to send signals for self managed databases.
1836
+ */
1837
+ export interface Schema$StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData {
1838
+ /**
1839
+ * Required. Full Resource name of the source resource.
1840
+ */
1841
+ fullResourceName?: string | null;
1842
+ /**
1843
+ * Required. Last time signal was refreshed
1844
+ */
1845
+ lastRefreshTime?: string | null;
1846
+ /**
1847
+ * Database resource id.
1848
+ */
1849
+ resourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId;
1850
+ /**
1851
+ * Signal data for boolean signals.
1852
+ */
1853
+ signalBoolValue?: boolean | null;
1854
+ /**
1855
+ * Required. Signal type of the signal
1856
+ */
1857
+ signalType?: string | null;
1858
+ }
1784
1859
  /**
1785
1860
  * Any custom metadata associated with the resource. e.g. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data
1786
1861
  */
@@ -1791,9 +1866,13 @@ export declare namespace alloydb_v1beta {
1791
1866
  internalResourceMetadata?: Schema$StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata[];
1792
1867
  }
1793
1868
  /**
1794
- * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform.
1869
+ * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 9
1795
1870
  */
1796
1871
  export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed {
1872
+ /**
1873
+ * Config based signal data is used to ingest signals that are generated based on the configuration of the database resource.
1874
+ */
1875
+ configBasedSignalData?: Schema$StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData;
1797
1876
  /**
1798
1877
  * Required. Timestamp when feed is generated.
1799
1878
  */
@@ -1837,6 +1916,10 @@ export declare namespace alloydb_v1beta {
1837
1916
  * 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
1917
  */
1839
1918
  externalUri?: string | null;
1919
+ /**
1920
+ * This is used to identify the location of the resource. Example: "us-central1"
1921
+ */
1922
+ location?: string | null;
1840
1923
  /**
1841
1924
  * Required. The name of the signal, ex: PUBLIC_SQL_INSTANCE, SQL_LOG_ERROR_VERBOSITY etc.
1842
1925
  */
@@ -1884,7 +1967,7 @@ export declare namespace alloydb_v1beta {
1884
1967
  */
1885
1968
  providerDescription?: string | null;
1886
1969
  /**
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
1970
+ * 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
1971
  */
1889
1972
  resourceType?: string | null;
1890
1973
  /**
@@ -1893,7 +1976,7 @@ export declare namespace alloydb_v1beta {
1893
1976
  uniqueId?: string | null;
1894
1977
  }
1895
1978
  /**
1896
- * Common model for database resource instance metadata. Next ID: 25
1979
+ * Common model for database resource instance metadata. Next ID: 26
1897
1980
  */
1898
1981
  export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata {
1899
1982
  /**
@@ -1904,6 +1987,10 @@ export declare namespace alloydb_v1beta {
1904
1987
  * Backup configuration for this instance
1905
1988
  */
1906
1989
  backupConfiguration?: Schema$StorageDatabasecenterPartnerapiV1mainBackupConfiguration;
1990
+ /**
1991
+ * Optional. BackupDR Configuration for the resource.
1992
+ */
1993
+ backupdrConfiguration?: Schema$StorageDatabasecenterPartnerapiV1mainBackupDRConfiguration;
1907
1994
  /**
1908
1995
  * Latest backup run information for this instance
1909
1996
  */
@@ -2173,6 +2260,10 @@ export declare namespace alloydb_v1beta {
2173
2260
  * The specific engine that the underlying database is running.
2174
2261
  */
2175
2262
  engine?: string | null;
2263
+ /**
2264
+ * Minor version of the underlying database engine. Example values: For MySQL, it could be "8.0.32", "5.7.32" etc.. For Postgres, it could be "14.3", "15.3" etc..
2265
+ */
2266
+ minorVersion?: string | null;
2176
2267
  /**
2177
2268
  * Type of specific database product. It could be CloudSQL, AlloyDB etc..
2178
2269
  */
@@ -2438,6 +2529,56 @@ export declare namespace alloydb_v1beta {
2438
2529
  constructor(context: APIRequestContext);
2439
2530
  /**
2440
2531
  * Gets information about a location.
2532
+ * @example
2533
+ * ```js
2534
+ * // Before running the sample:
2535
+ * // - Enable the API at:
2536
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
2537
+ * // - Login into gcloud by running:
2538
+ * // ```sh
2539
+ * // $ gcloud auth application-default login
2540
+ * // ```
2541
+ * // - Install the npm module by running:
2542
+ * // ```sh
2543
+ * // $ npm install googleapis
2544
+ * // ```
2545
+ *
2546
+ * const {google} = require('googleapis');
2547
+ * const alloydb = google.alloydb('v1beta');
2548
+ *
2549
+ * async function main() {
2550
+ * const auth = new google.auth.GoogleAuth({
2551
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2552
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2553
+ * });
2554
+ *
2555
+ * // Acquire an auth client, and bind it to all future calls
2556
+ * const authClient = await auth.getClient();
2557
+ * google.options({auth: authClient});
2558
+ *
2559
+ * // Do the magic
2560
+ * const res = await alloydb.projects.locations.get({
2561
+ * // Resource name for the location.
2562
+ * name: 'projects/my-project/locations/my-location',
2563
+ * });
2564
+ * console.log(res.data);
2565
+ *
2566
+ * // Example response
2567
+ * // {
2568
+ * // "displayName": "my_displayName",
2569
+ * // "labels": {},
2570
+ * // "locationId": "my_locationId",
2571
+ * // "metadata": {},
2572
+ * // "name": "my_name"
2573
+ * // }
2574
+ * }
2575
+ *
2576
+ * main().catch(e => {
2577
+ * console.error(e);
2578
+ * throw e;
2579
+ * });
2580
+ *
2581
+ * ```
2441
2582
  *
2442
2583
  * @param params - Parameters for request
2443
2584
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2452,6 +2593,61 @@ export declare namespace alloydb_v1beta {
2452
2593
  get(callback: BodyResponseCallback<Schema$GoogleCloudLocationLocation>): void;
2453
2594
  /**
2454
2595
  * Lists information about the supported locations for this service.
2596
+ * @example
2597
+ * ```js
2598
+ * // Before running the sample:
2599
+ * // - Enable the API at:
2600
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
2601
+ * // - Login into gcloud by running:
2602
+ * // ```sh
2603
+ * // $ gcloud auth application-default login
2604
+ * // ```
2605
+ * // - Install the npm module by running:
2606
+ * // ```sh
2607
+ * // $ npm install googleapis
2608
+ * // ```
2609
+ *
2610
+ * const {google} = require('googleapis');
2611
+ * const alloydb = google.alloydb('v1beta');
2612
+ *
2613
+ * async function main() {
2614
+ * const auth = new google.auth.GoogleAuth({
2615
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2616
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2617
+ * });
2618
+ *
2619
+ * // Acquire an auth client, and bind it to all future calls
2620
+ * const authClient = await auth.getClient();
2621
+ * google.options({auth: authClient});
2622
+ *
2623
+ * // Do the magic
2624
+ * const res = await alloydb.projects.locations.list({
2625
+ * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.
2626
+ * extraLocationTypes: 'placeholder-value',
2627
+ * // 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).
2628
+ * filter: 'placeholder-value',
2629
+ * // The resource that owns the locations collection, if applicable.
2630
+ * name: 'projects/my-project',
2631
+ * // The maximum number of results to return. If not set, the service selects a default.
2632
+ * pageSize: 'placeholder-value',
2633
+ * // A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
2634
+ * pageToken: 'placeholder-value',
2635
+ * });
2636
+ * console.log(res.data);
2637
+ *
2638
+ * // Example response
2639
+ * // {
2640
+ * // "locations": [],
2641
+ * // "nextPageToken": "my_nextPageToken"
2642
+ * // }
2643
+ * }
2644
+ *
2645
+ * main().catch(e => {
2646
+ * console.error(e);
2647
+ * throw e;
2648
+ * });
2649
+ *
2650
+ * ```
2455
2651
  *
2456
2652
  * @param params - Parameters for request
2457
2653
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2498,6 +2694,93 @@ export declare namespace alloydb_v1beta {
2498
2694
  constructor(context: APIRequestContext);
2499
2695
  /**
2500
2696
  * Creates a new Backup in a given project and location.
2697
+ * @example
2698
+ * ```js
2699
+ * // Before running the sample:
2700
+ * // - Enable the API at:
2701
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
2702
+ * // - Login into gcloud by running:
2703
+ * // ```sh
2704
+ * // $ gcloud auth application-default login
2705
+ * // ```
2706
+ * // - Install the npm module by running:
2707
+ * // ```sh
2708
+ * // $ npm install googleapis
2709
+ * // ```
2710
+ *
2711
+ * const {google} = require('googleapis');
2712
+ * const alloydb = google.alloydb('v1beta');
2713
+ *
2714
+ * async function main() {
2715
+ * const auth = new google.auth.GoogleAuth({
2716
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2717
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2718
+ * });
2719
+ *
2720
+ * // Acquire an auth client, and bind it to all future calls
2721
+ * const authClient = await auth.getClient();
2722
+ * google.options({auth: authClient});
2723
+ *
2724
+ * // Do the magic
2725
+ * const res = await alloydb.projects.locations.backups.create({
2726
+ * // Required. ID of the requesting object.
2727
+ * backupId: 'placeholder-value',
2728
+ * // Required. Value for parent.
2729
+ * parent: 'projects/my-project/locations/my-location',
2730
+ * // 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).
2731
+ * requestId: 'placeholder-value',
2732
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
2733
+ * validateOnly: 'placeholder-value',
2734
+ *
2735
+ * // Request body metadata
2736
+ * requestBody: {
2737
+ * // request body parameters
2738
+ * // {
2739
+ * // "annotations": {},
2740
+ * // "clusterName": "my_clusterName",
2741
+ * // "clusterUid": "my_clusterUid",
2742
+ * // "createCompletionTime": "my_createCompletionTime",
2743
+ * // "createTime": "my_createTime",
2744
+ * // "databaseVersion": "my_databaseVersion",
2745
+ * // "deleteTime": "my_deleteTime",
2746
+ * // "description": "my_description",
2747
+ * // "displayName": "my_displayName",
2748
+ * // "encryptionConfig": {},
2749
+ * // "encryptionInfo": {},
2750
+ * // "etag": "my_etag",
2751
+ * // "expiryQuantity": {},
2752
+ * // "expiryTime": "my_expiryTime",
2753
+ * // "labels": {},
2754
+ * // "name": "my_name",
2755
+ * // "reconciling": false,
2756
+ * // "satisfiesPzs": false,
2757
+ * // "sizeBytes": "my_sizeBytes",
2758
+ * // "state": "my_state",
2759
+ * // "tags": {},
2760
+ * // "type": "my_type",
2761
+ * // "uid": "my_uid",
2762
+ * // "updateTime": "my_updateTime"
2763
+ * // }
2764
+ * },
2765
+ * });
2766
+ * console.log(res.data);
2767
+ *
2768
+ * // Example response
2769
+ * // {
2770
+ * // "done": false,
2771
+ * // "error": {},
2772
+ * // "metadata": {},
2773
+ * // "name": "my_name",
2774
+ * // "response": {}
2775
+ * // }
2776
+ * }
2777
+ *
2778
+ * main().catch(e => {
2779
+ * console.error(e);
2780
+ * throw e;
2781
+ * });
2782
+ *
2783
+ * ```
2501
2784
  *
2502
2785
  * @param params - Parameters for request
2503
2786
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2512,6 +2795,62 @@ export declare namespace alloydb_v1beta {
2512
2795
  create(callback: BodyResponseCallback<Schema$Operation>): void;
2513
2796
  /**
2514
2797
  * Deletes a single Backup.
2798
+ * @example
2799
+ * ```js
2800
+ * // Before running the sample:
2801
+ * // - Enable the API at:
2802
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
2803
+ * // - Login into gcloud by running:
2804
+ * // ```sh
2805
+ * // $ gcloud auth application-default login
2806
+ * // ```
2807
+ * // - Install the npm module by running:
2808
+ * // ```sh
2809
+ * // $ npm install googleapis
2810
+ * // ```
2811
+ *
2812
+ * const {google} = require('googleapis');
2813
+ * const alloydb = google.alloydb('v1beta');
2814
+ *
2815
+ * async function main() {
2816
+ * const auth = new google.auth.GoogleAuth({
2817
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2818
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2819
+ * });
2820
+ *
2821
+ * // Acquire an auth client, and bind it to all future calls
2822
+ * const authClient = await auth.getClient();
2823
+ * google.options({auth: authClient});
2824
+ *
2825
+ * // Do the magic
2826
+ * const res = await alloydb.projects.locations.backups.delete({
2827
+ * // 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.
2828
+ * etag: 'placeholder-value',
2829
+ * // Required. Name of the resource. For the required format, see the comment on the Backup.name field.
2830
+ * name: 'projects/my-project/locations/my-location/backups/my-backup',
2831
+ * // 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).
2832
+ * requestId: 'placeholder-value',
2833
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
2834
+ * validateOnly: 'placeholder-value',
2835
+ * });
2836
+ * console.log(res.data);
2837
+ *
2838
+ * // Example response
2839
+ * // {
2840
+ * // "done": false,
2841
+ * // "error": {},
2842
+ * // "metadata": {},
2843
+ * // "name": "my_name",
2844
+ * // "response": {}
2845
+ * // }
2846
+ * }
2847
+ *
2848
+ * main().catch(e => {
2849
+ * console.error(e);
2850
+ * throw e;
2851
+ * });
2852
+ *
2853
+ * ```
2515
2854
  *
2516
2855
  * @param params - Parameters for request
2517
2856
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2526,6 +2865,75 @@ export declare namespace alloydb_v1beta {
2526
2865
  delete(callback: BodyResponseCallback<Schema$Operation>): void;
2527
2866
  /**
2528
2867
  * Gets details of a single Backup.
2868
+ * @example
2869
+ * ```js
2870
+ * // Before running the sample:
2871
+ * // - Enable the API at:
2872
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
2873
+ * // - Login into gcloud by running:
2874
+ * // ```sh
2875
+ * // $ gcloud auth application-default login
2876
+ * // ```
2877
+ * // - Install the npm module by running:
2878
+ * // ```sh
2879
+ * // $ npm install googleapis
2880
+ * // ```
2881
+ *
2882
+ * const {google} = require('googleapis');
2883
+ * const alloydb = google.alloydb('v1beta');
2884
+ *
2885
+ * async function main() {
2886
+ * const auth = new google.auth.GoogleAuth({
2887
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2888
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2889
+ * });
2890
+ *
2891
+ * // Acquire an auth client, and bind it to all future calls
2892
+ * const authClient = await auth.getClient();
2893
+ * google.options({auth: authClient});
2894
+ *
2895
+ * // Do the magic
2896
+ * const res = await alloydb.projects.locations.backups.get({
2897
+ * // Required. Name of the resource
2898
+ * name: 'projects/my-project/locations/my-location/backups/my-backup',
2899
+ * });
2900
+ * console.log(res.data);
2901
+ *
2902
+ * // Example response
2903
+ * // {
2904
+ * // "annotations": {},
2905
+ * // "clusterName": "my_clusterName",
2906
+ * // "clusterUid": "my_clusterUid",
2907
+ * // "createCompletionTime": "my_createCompletionTime",
2908
+ * // "createTime": "my_createTime",
2909
+ * // "databaseVersion": "my_databaseVersion",
2910
+ * // "deleteTime": "my_deleteTime",
2911
+ * // "description": "my_description",
2912
+ * // "displayName": "my_displayName",
2913
+ * // "encryptionConfig": {},
2914
+ * // "encryptionInfo": {},
2915
+ * // "etag": "my_etag",
2916
+ * // "expiryQuantity": {},
2917
+ * // "expiryTime": "my_expiryTime",
2918
+ * // "labels": {},
2919
+ * // "name": "my_name",
2920
+ * // "reconciling": false,
2921
+ * // "satisfiesPzs": false,
2922
+ * // "sizeBytes": "my_sizeBytes",
2923
+ * // "state": "my_state",
2924
+ * // "tags": {},
2925
+ * // "type": "my_type",
2926
+ * // "uid": "my_uid",
2927
+ * // "updateTime": "my_updateTime"
2928
+ * // }
2929
+ * }
2930
+ *
2931
+ * main().catch(e => {
2932
+ * console.error(e);
2933
+ * throw e;
2934
+ * });
2935
+ *
2936
+ * ```
2529
2937
  *
2530
2938
  * @param params - Parameters for request
2531
2939
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2540,6 +2948,62 @@ export declare namespace alloydb_v1beta {
2540
2948
  get(callback: BodyResponseCallback<Schema$Backup>): void;
2541
2949
  /**
2542
2950
  * Lists Backups in a given project and location.
2951
+ * @example
2952
+ * ```js
2953
+ * // Before running the sample:
2954
+ * // - Enable the API at:
2955
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
2956
+ * // - Login into gcloud by running:
2957
+ * // ```sh
2958
+ * // $ gcloud auth application-default login
2959
+ * // ```
2960
+ * // - Install the npm module by running:
2961
+ * // ```sh
2962
+ * // $ npm install googleapis
2963
+ * // ```
2964
+ *
2965
+ * const {google} = require('googleapis');
2966
+ * const alloydb = google.alloydb('v1beta');
2967
+ *
2968
+ * async function main() {
2969
+ * const auth = new google.auth.GoogleAuth({
2970
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2971
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2972
+ * });
2973
+ *
2974
+ * // Acquire an auth client, and bind it to all future calls
2975
+ * const authClient = await auth.getClient();
2976
+ * google.options({auth: authClient});
2977
+ *
2978
+ * // Do the magic
2979
+ * const res = await alloydb.projects.locations.backups.list({
2980
+ * // Filtering results
2981
+ * filter: 'placeholder-value',
2982
+ * // Hint for how to order the results
2983
+ * orderBy: 'placeholder-value',
2984
+ * // Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
2985
+ * pageSize: 'placeholder-value',
2986
+ * // A token identifying a page of results the server should return.
2987
+ * pageToken: 'placeholder-value',
2988
+ * // Required. Parent value for ListBackupsRequest
2989
+ * parent: 'projects/my-project/locations/my-location',
2990
+ * });
2991
+ * console.log(res.data);
2992
+ *
2993
+ * // Example response
2994
+ * // {
2995
+ * // "backups": [],
2996
+ * // "nextPageToken": "my_nextPageToken",
2997
+ * // "unreachable": []
2998
+ * // }
2999
+ * }
3000
+ *
3001
+ * main().catch(e => {
3002
+ * console.error(e);
3003
+ * throw e;
3004
+ * });
3005
+ *
3006
+ * ```
2543
3007
  *
2544
3008
  * @param params - Parameters for request
2545
3009
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2554,6 +3018,95 @@ export declare namespace alloydb_v1beta {
2554
3018
  list(callback: BodyResponseCallback<Schema$ListBackupsResponse>): void;
2555
3019
  /**
2556
3020
  * Updates the parameters of a single Backup.
3021
+ * @example
3022
+ * ```js
3023
+ * // Before running the sample:
3024
+ * // - Enable the API at:
3025
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3026
+ * // - Login into gcloud by running:
3027
+ * // ```sh
3028
+ * // $ gcloud auth application-default login
3029
+ * // ```
3030
+ * // - Install the npm module by running:
3031
+ * // ```sh
3032
+ * // $ npm install googleapis
3033
+ * // ```
3034
+ *
3035
+ * const {google} = require('googleapis');
3036
+ * const alloydb = google.alloydb('v1beta');
3037
+ *
3038
+ * async function main() {
3039
+ * const auth = new google.auth.GoogleAuth({
3040
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3041
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3042
+ * });
3043
+ *
3044
+ * // Acquire an auth client, and bind it to all future calls
3045
+ * const authClient = await auth.getClient();
3046
+ * google.options({auth: authClient});
3047
+ *
3048
+ * // Do the magic
3049
+ * const res = await alloydb.projects.locations.backups.patch({
3050
+ * // 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.
3051
+ * allowMissing: 'placeholder-value',
3052
+ * // 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\}
3053
+ * name: 'projects/my-project/locations/my-location/backups/my-backup',
3054
+ * // 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).
3055
+ * requestId: 'placeholder-value',
3056
+ * // 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.
3057
+ * updateMask: 'placeholder-value',
3058
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
3059
+ * validateOnly: 'placeholder-value',
3060
+ *
3061
+ * // Request body metadata
3062
+ * requestBody: {
3063
+ * // request body parameters
3064
+ * // {
3065
+ * // "annotations": {},
3066
+ * // "clusterName": "my_clusterName",
3067
+ * // "clusterUid": "my_clusterUid",
3068
+ * // "createCompletionTime": "my_createCompletionTime",
3069
+ * // "createTime": "my_createTime",
3070
+ * // "databaseVersion": "my_databaseVersion",
3071
+ * // "deleteTime": "my_deleteTime",
3072
+ * // "description": "my_description",
3073
+ * // "displayName": "my_displayName",
3074
+ * // "encryptionConfig": {},
3075
+ * // "encryptionInfo": {},
3076
+ * // "etag": "my_etag",
3077
+ * // "expiryQuantity": {},
3078
+ * // "expiryTime": "my_expiryTime",
3079
+ * // "labels": {},
3080
+ * // "name": "my_name",
3081
+ * // "reconciling": false,
3082
+ * // "satisfiesPzs": false,
3083
+ * // "sizeBytes": "my_sizeBytes",
3084
+ * // "state": "my_state",
3085
+ * // "tags": {},
3086
+ * // "type": "my_type",
3087
+ * // "uid": "my_uid",
3088
+ * // "updateTime": "my_updateTime"
3089
+ * // }
3090
+ * },
3091
+ * });
3092
+ * console.log(res.data);
3093
+ *
3094
+ * // Example response
3095
+ * // {
3096
+ * // "done": false,
3097
+ * // "error": {},
3098
+ * // "metadata": {},
3099
+ * // "name": "my_name",
3100
+ * // "response": {}
3101
+ * // }
3102
+ * }
3103
+ *
3104
+ * main().catch(e => {
3105
+ * console.error(e);
3106
+ * throw e;
3107
+ * });
3108
+ *
3109
+ * ```
2557
3110
  *
2558
3111
  * @param params - Parameters for request
2559
3112
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2668,6 +3221,105 @@ export declare namespace alloydb_v1beta {
2668
3221
  constructor(context: APIRequestContext);
2669
3222
  /**
2670
3223
  * Creates a new Cluster in a given project and location.
3224
+ * @example
3225
+ * ```js
3226
+ * // Before running the sample:
3227
+ * // - Enable the API at:
3228
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3229
+ * // - Login into gcloud by running:
3230
+ * // ```sh
3231
+ * // $ gcloud auth application-default login
3232
+ * // ```
3233
+ * // - Install the npm module by running:
3234
+ * // ```sh
3235
+ * // $ npm install googleapis
3236
+ * // ```
3237
+ *
3238
+ * const {google} = require('googleapis');
3239
+ * const alloydb = google.alloydb('v1beta');
3240
+ *
3241
+ * async function main() {
3242
+ * const auth = new google.auth.GoogleAuth({
3243
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3244
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3245
+ * });
3246
+ *
3247
+ * // Acquire an auth client, and bind it to all future calls
3248
+ * const authClient = await auth.getClient();
3249
+ * google.options({auth: authClient});
3250
+ *
3251
+ * // Do the magic
3252
+ * const res = await alloydb.projects.locations.clusters.create({
3253
+ * // Required. ID of the requesting object.
3254
+ * clusterId: 'placeholder-value',
3255
+ * // Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field.
3256
+ * parent: 'projects/my-project/locations/my-location',
3257
+ * // 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).
3258
+ * requestId: 'placeholder-value',
3259
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
3260
+ * validateOnly: 'placeholder-value',
3261
+ *
3262
+ * // Request body metadata
3263
+ * requestBody: {
3264
+ * // request body parameters
3265
+ * // {
3266
+ * // "annotations": {},
3267
+ * // "automatedBackupPolicy": {},
3268
+ * // "backupSource": {},
3269
+ * // "cloudsqlBackupRunSource": {},
3270
+ * // "clusterType": "my_clusterType",
3271
+ * // "continuousBackupConfig": {},
3272
+ * // "continuousBackupInfo": {},
3273
+ * // "createTime": "my_createTime",
3274
+ * // "databaseVersion": "my_databaseVersion",
3275
+ * // "deleteTime": "my_deleteTime",
3276
+ * // "displayName": "my_displayName",
3277
+ * // "encryptionConfig": {},
3278
+ * // "encryptionInfo": {},
3279
+ * // "etag": "my_etag",
3280
+ * // "geminiConfig": {},
3281
+ * // "initialUser": {},
3282
+ * // "labels": {},
3283
+ * // "maintenanceSchedule": {},
3284
+ * // "maintenanceUpdatePolicy": {},
3285
+ * // "migrationSource": {},
3286
+ * // "name": "my_name",
3287
+ * // "network": "my_network",
3288
+ * // "networkConfig": {},
3289
+ * // "primaryConfig": {},
3290
+ * // "pscConfig": {},
3291
+ * // "reconciling": false,
3292
+ * // "satisfiesPzs": false,
3293
+ * // "secondaryConfig": {},
3294
+ * // "serviceAccountEmail": "my_serviceAccountEmail",
3295
+ * // "sslConfig": {},
3296
+ * // "state": "my_state",
3297
+ * // "subscriptionType": "my_subscriptionType",
3298
+ * // "tags": {},
3299
+ * // "trialMetadata": {},
3300
+ * // "uid": "my_uid",
3301
+ * // "updateTime": "my_updateTime"
3302
+ * // }
3303
+ * },
3304
+ * });
3305
+ * console.log(res.data);
3306
+ *
3307
+ * // Example response
3308
+ * // {
3309
+ * // "done": false,
3310
+ * // "error": {},
3311
+ * // "metadata": {},
3312
+ * // "name": "my_name",
3313
+ * // "response": {}
3314
+ * // }
3315
+ * }
3316
+ *
3317
+ * main().catch(e => {
3318
+ * console.error(e);
3319
+ * throw e;
3320
+ * });
3321
+ *
3322
+ * ```
2671
3323
  *
2672
3324
  * @param params - Parameters for request
2673
3325
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2682,6 +3334,105 @@ export declare namespace alloydb_v1beta {
2682
3334
  create(callback: BodyResponseCallback<Schema$Operation>): void;
2683
3335
  /**
2684
3336
  * Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.
3337
+ * @example
3338
+ * ```js
3339
+ * // Before running the sample:
3340
+ * // - Enable the API at:
3341
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3342
+ * // - Login into gcloud by running:
3343
+ * // ```sh
3344
+ * // $ gcloud auth application-default login
3345
+ * // ```
3346
+ * // - Install the npm module by running:
3347
+ * // ```sh
3348
+ * // $ npm install googleapis
3349
+ * // ```
3350
+ *
3351
+ * const {google} = require('googleapis');
3352
+ * const alloydb = google.alloydb('v1beta');
3353
+ *
3354
+ * async function main() {
3355
+ * const auth = new google.auth.GoogleAuth({
3356
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3357
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3358
+ * });
3359
+ *
3360
+ * // Acquire an auth client, and bind it to all future calls
3361
+ * const authClient = await auth.getClient();
3362
+ * google.options({auth: authClient});
3363
+ *
3364
+ * // Do the magic
3365
+ * const res = await alloydb.projects.locations.clusters.createsecondary({
3366
+ * // Required. ID of the requesting object (the secondary cluster).
3367
+ * clusterId: 'placeholder-value',
3368
+ * // Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field.
3369
+ * parent: 'projects/my-project/locations/my-location',
3370
+ * // 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).
3371
+ * requestId: 'placeholder-value',
3372
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
3373
+ * validateOnly: 'placeholder-value',
3374
+ *
3375
+ * // Request body metadata
3376
+ * requestBody: {
3377
+ * // request body parameters
3378
+ * // {
3379
+ * // "annotations": {},
3380
+ * // "automatedBackupPolicy": {},
3381
+ * // "backupSource": {},
3382
+ * // "cloudsqlBackupRunSource": {},
3383
+ * // "clusterType": "my_clusterType",
3384
+ * // "continuousBackupConfig": {},
3385
+ * // "continuousBackupInfo": {},
3386
+ * // "createTime": "my_createTime",
3387
+ * // "databaseVersion": "my_databaseVersion",
3388
+ * // "deleteTime": "my_deleteTime",
3389
+ * // "displayName": "my_displayName",
3390
+ * // "encryptionConfig": {},
3391
+ * // "encryptionInfo": {},
3392
+ * // "etag": "my_etag",
3393
+ * // "geminiConfig": {},
3394
+ * // "initialUser": {},
3395
+ * // "labels": {},
3396
+ * // "maintenanceSchedule": {},
3397
+ * // "maintenanceUpdatePolicy": {},
3398
+ * // "migrationSource": {},
3399
+ * // "name": "my_name",
3400
+ * // "network": "my_network",
3401
+ * // "networkConfig": {},
3402
+ * // "primaryConfig": {},
3403
+ * // "pscConfig": {},
3404
+ * // "reconciling": false,
3405
+ * // "satisfiesPzs": false,
3406
+ * // "secondaryConfig": {},
3407
+ * // "serviceAccountEmail": "my_serviceAccountEmail",
3408
+ * // "sslConfig": {},
3409
+ * // "state": "my_state",
3410
+ * // "subscriptionType": "my_subscriptionType",
3411
+ * // "tags": {},
3412
+ * // "trialMetadata": {},
3413
+ * // "uid": "my_uid",
3414
+ * // "updateTime": "my_updateTime"
3415
+ * // }
3416
+ * },
3417
+ * });
3418
+ * console.log(res.data);
3419
+ *
3420
+ * // Example response
3421
+ * // {
3422
+ * // "done": false,
3423
+ * // "error": {},
3424
+ * // "metadata": {},
3425
+ * // "name": "my_name",
3426
+ * // "response": {}
3427
+ * // }
3428
+ * }
3429
+ *
3430
+ * main().catch(e => {
3431
+ * console.error(e);
3432
+ * throw e;
3433
+ * });
3434
+ *
3435
+ * ```
2685
3436
  *
2686
3437
  * @param params - Parameters for request
2687
3438
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2696,6 +3447,64 @@ export declare namespace alloydb_v1beta {
2696
3447
  createsecondary(callback: BodyResponseCallback<Schema$Operation>): void;
2697
3448
  /**
2698
3449
  * Deletes a single Cluster.
3450
+ * @example
3451
+ * ```js
3452
+ * // Before running the sample:
3453
+ * // - Enable the API at:
3454
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3455
+ * // - Login into gcloud by running:
3456
+ * // ```sh
3457
+ * // $ gcloud auth application-default login
3458
+ * // ```
3459
+ * // - Install the npm module by running:
3460
+ * // ```sh
3461
+ * // $ npm install googleapis
3462
+ * // ```
3463
+ *
3464
+ * const {google} = require('googleapis');
3465
+ * const alloydb = google.alloydb('v1beta');
3466
+ *
3467
+ * async function main() {
3468
+ * const auth = new google.auth.GoogleAuth({
3469
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3470
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3471
+ * });
3472
+ *
3473
+ * // Acquire an auth client, and bind it to all future calls
3474
+ * const authClient = await auth.getClient();
3475
+ * google.options({auth: authClient});
3476
+ *
3477
+ * // Do the magic
3478
+ * const res = await alloydb.projects.locations.clusters.delete({
3479
+ * // 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.
3480
+ * etag: 'placeholder-value',
3481
+ * // Optional. Whether to cascade delete child instances for given cluster.
3482
+ * force: 'placeholder-value',
3483
+ * // Required. The name of the resource. For the required format, see the comment on the Cluster.name field.
3484
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
3485
+ * // 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).
3486
+ * requestId: 'placeholder-value',
3487
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
3488
+ * validateOnly: 'placeholder-value',
3489
+ * });
3490
+ * console.log(res.data);
3491
+ *
3492
+ * // Example response
3493
+ * // {
3494
+ * // "done": false,
3495
+ * // "error": {},
3496
+ * // "metadata": {},
3497
+ * // "name": "my_name",
3498
+ * // "response": {}
3499
+ * // }
3500
+ * }
3501
+ *
3502
+ * main().catch(e => {
3503
+ * console.error(e);
3504
+ * throw e;
3505
+ * });
3506
+ *
3507
+ * ```
2699
3508
  *
2700
3509
  * @param params - Parameters for request
2701
3510
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2710,6 +3519,67 @@ export declare namespace alloydb_v1beta {
2710
3519
  delete(callback: BodyResponseCallback<Schema$Operation>): void;
2711
3520
  /**
2712
3521
  * Exports data from the cluster. Imperative only.
3522
+ * @example
3523
+ * ```js
3524
+ * // Before running the sample:
3525
+ * // - Enable the API at:
3526
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3527
+ * // - Login into gcloud by running:
3528
+ * // ```sh
3529
+ * // $ gcloud auth application-default login
3530
+ * // ```
3531
+ * // - Install the npm module by running:
3532
+ * // ```sh
3533
+ * // $ npm install googleapis
3534
+ * // ```
3535
+ *
3536
+ * const {google} = require('googleapis');
3537
+ * const alloydb = google.alloydb('v1beta');
3538
+ *
3539
+ * async function main() {
3540
+ * const auth = new google.auth.GoogleAuth({
3541
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3542
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3543
+ * });
3544
+ *
3545
+ * // Acquire an auth client, and bind it to all future calls
3546
+ * const authClient = await auth.getClient();
3547
+ * google.options({auth: authClient});
3548
+ *
3549
+ * // Do the magic
3550
+ * const res = await alloydb.projects.locations.clusters.export({
3551
+ * // Required. The resource name of the cluster.
3552
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
3553
+ *
3554
+ * // Request body metadata
3555
+ * requestBody: {
3556
+ * // request body parameters
3557
+ * // {
3558
+ * // "csvExportOptions": {},
3559
+ * // "database": "my_database",
3560
+ * // "gcsDestination": {},
3561
+ * // "sqlExportOptions": {}
3562
+ * // }
3563
+ * },
3564
+ * });
3565
+ * console.log(res.data);
3566
+ *
3567
+ * // Example response
3568
+ * // {
3569
+ * // "done": false,
3570
+ * // "error": {},
3571
+ * // "metadata": {},
3572
+ * // "name": "my_name",
3573
+ * // "response": {}
3574
+ * // }
3575
+ * }
3576
+ *
3577
+ * main().catch(e => {
3578
+ * console.error(e);
3579
+ * throw e;
3580
+ * });
3581
+ *
3582
+ * ```
2713
3583
  *
2714
3584
  * @param params - Parameters for request
2715
3585
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2724,6 +3594,89 @@ export declare namespace alloydb_v1beta {
2724
3594
  export(callback: BodyResponseCallback<Schema$Operation>): void;
2725
3595
  /**
2726
3596
  * Gets details of a single Cluster.
3597
+ * @example
3598
+ * ```js
3599
+ * // Before running the sample:
3600
+ * // - Enable the API at:
3601
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3602
+ * // - Login into gcloud by running:
3603
+ * // ```sh
3604
+ * // $ gcloud auth application-default login
3605
+ * // ```
3606
+ * // - Install the npm module by running:
3607
+ * // ```sh
3608
+ * // $ npm install googleapis
3609
+ * // ```
3610
+ *
3611
+ * const {google} = require('googleapis');
3612
+ * const alloydb = google.alloydb('v1beta');
3613
+ *
3614
+ * async function main() {
3615
+ * const auth = new google.auth.GoogleAuth({
3616
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3617
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3618
+ * });
3619
+ *
3620
+ * // Acquire an auth client, and bind it to all future calls
3621
+ * const authClient = await auth.getClient();
3622
+ * google.options({auth: authClient});
3623
+ *
3624
+ * // Do the magic
3625
+ * const res = await alloydb.projects.locations.clusters.get({
3626
+ * // Required. The name of the resource. For the required format, see the comment on the Cluster.name field.
3627
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
3628
+ * // Optional. The view of the cluster to return. Returns all default fields if not set.
3629
+ * view: 'placeholder-value',
3630
+ * });
3631
+ * console.log(res.data);
3632
+ *
3633
+ * // Example response
3634
+ * // {
3635
+ * // "annotations": {},
3636
+ * // "automatedBackupPolicy": {},
3637
+ * // "backupSource": {},
3638
+ * // "cloudsqlBackupRunSource": {},
3639
+ * // "clusterType": "my_clusterType",
3640
+ * // "continuousBackupConfig": {},
3641
+ * // "continuousBackupInfo": {},
3642
+ * // "createTime": "my_createTime",
3643
+ * // "databaseVersion": "my_databaseVersion",
3644
+ * // "deleteTime": "my_deleteTime",
3645
+ * // "displayName": "my_displayName",
3646
+ * // "encryptionConfig": {},
3647
+ * // "encryptionInfo": {},
3648
+ * // "etag": "my_etag",
3649
+ * // "geminiConfig": {},
3650
+ * // "initialUser": {},
3651
+ * // "labels": {},
3652
+ * // "maintenanceSchedule": {},
3653
+ * // "maintenanceUpdatePolicy": {},
3654
+ * // "migrationSource": {},
3655
+ * // "name": "my_name",
3656
+ * // "network": "my_network",
3657
+ * // "networkConfig": {},
3658
+ * // "primaryConfig": {},
3659
+ * // "pscConfig": {},
3660
+ * // "reconciling": false,
3661
+ * // "satisfiesPzs": false,
3662
+ * // "secondaryConfig": {},
3663
+ * // "serviceAccountEmail": "my_serviceAccountEmail",
3664
+ * // "sslConfig": {},
3665
+ * // "state": "my_state",
3666
+ * // "subscriptionType": "my_subscriptionType",
3667
+ * // "tags": {},
3668
+ * // "trialMetadata": {},
3669
+ * // "uid": "my_uid",
3670
+ * // "updateTime": "my_updateTime"
3671
+ * // }
3672
+ * }
3673
+ *
3674
+ * main().catch(e => {
3675
+ * console.error(e);
3676
+ * throw e;
3677
+ * });
3678
+ *
3679
+ * ```
2727
3680
  *
2728
3681
  * @param params - Parameters for request
2729
3682
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2738,6 +3691,68 @@ export declare namespace alloydb_v1beta {
2738
3691
  get(callback: BodyResponseCallback<Schema$Cluster>): void;
2739
3692
  /**
2740
3693
  * Imports data to the cluster. Imperative only.
3694
+ * @example
3695
+ * ```js
3696
+ * // Before running the sample:
3697
+ * // - Enable the API at:
3698
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3699
+ * // - Login into gcloud by running:
3700
+ * // ```sh
3701
+ * // $ gcloud auth application-default login
3702
+ * // ```
3703
+ * // - Install the npm module by running:
3704
+ * // ```sh
3705
+ * // $ npm install googleapis
3706
+ * // ```
3707
+ *
3708
+ * const {google} = require('googleapis');
3709
+ * const alloydb = google.alloydb('v1beta');
3710
+ *
3711
+ * async function main() {
3712
+ * const auth = new google.auth.GoogleAuth({
3713
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3714
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3715
+ * });
3716
+ *
3717
+ * // Acquire an auth client, and bind it to all future calls
3718
+ * const authClient = await auth.getClient();
3719
+ * google.options({auth: authClient});
3720
+ *
3721
+ * // Do the magic
3722
+ * const res = await alloydb.projects.locations.clusters.import({
3723
+ * // Required. The resource name of the cluster.
3724
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
3725
+ *
3726
+ * // Request body metadata
3727
+ * requestBody: {
3728
+ * // request body parameters
3729
+ * // {
3730
+ * // "csvImportOptions": {},
3731
+ * // "database": "my_database",
3732
+ * // "gcsUri": "my_gcsUri",
3733
+ * // "sqlImportOptions": {},
3734
+ * // "user": "my_user"
3735
+ * // }
3736
+ * },
3737
+ * });
3738
+ * console.log(res.data);
3739
+ *
3740
+ * // Example response
3741
+ * // {
3742
+ * // "done": false,
3743
+ * // "error": {},
3744
+ * // "metadata": {},
3745
+ * // "name": "my_name",
3746
+ * // "response": {}
3747
+ * // }
3748
+ * }
3749
+ *
3750
+ * main().catch(e => {
3751
+ * console.error(e);
3752
+ * throw e;
3753
+ * });
3754
+ *
3755
+ * ```
2741
3756
  *
2742
3757
  * @param params - Parameters for request
2743
3758
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2752,6 +3767,62 @@ export declare namespace alloydb_v1beta {
2752
3767
  import(callback: BodyResponseCallback<Schema$Operation>): void;
2753
3768
  /**
2754
3769
  * Lists Clusters in a given project and location.
3770
+ * @example
3771
+ * ```js
3772
+ * // Before running the sample:
3773
+ * // - Enable the API at:
3774
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3775
+ * // - Login into gcloud by running:
3776
+ * // ```sh
3777
+ * // $ gcloud auth application-default login
3778
+ * // ```
3779
+ * // - Install the npm module by running:
3780
+ * // ```sh
3781
+ * // $ npm install googleapis
3782
+ * // ```
3783
+ *
3784
+ * const {google} = require('googleapis');
3785
+ * const alloydb = google.alloydb('v1beta');
3786
+ *
3787
+ * async function main() {
3788
+ * const auth = new google.auth.GoogleAuth({
3789
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3790
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3791
+ * });
3792
+ *
3793
+ * // Acquire an auth client, and bind it to all future calls
3794
+ * const authClient = await auth.getClient();
3795
+ * google.options({auth: authClient});
3796
+ *
3797
+ * // Do the magic
3798
+ * const res = await alloydb.projects.locations.clusters.list({
3799
+ * // Optional. Filtering results
3800
+ * filter: 'placeholder-value',
3801
+ * // Optional. Hint for how to order the results
3802
+ * orderBy: 'placeholder-value',
3803
+ * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
3804
+ * pageSize: 'placeholder-value',
3805
+ * // A token identifying a page of results the server should return.
3806
+ * pageToken: 'placeholder-value',
3807
+ * // 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/-
3808
+ * parent: 'projects/my-project/locations/my-location',
3809
+ * });
3810
+ * console.log(res.data);
3811
+ *
3812
+ * // Example response
3813
+ * // {
3814
+ * // "clusters": [],
3815
+ * // "nextPageToken": "my_nextPageToken",
3816
+ * // "unreachable": []
3817
+ * // }
3818
+ * }
3819
+ *
3820
+ * main().catch(e => {
3821
+ * console.error(e);
3822
+ * throw e;
3823
+ * });
3824
+ *
3825
+ * ```
2755
3826
  *
2756
3827
  * @param params - Parameters for request
2757
3828
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2766,6 +3837,107 @@ export declare namespace alloydb_v1beta {
2766
3837
  list(callback: BodyResponseCallback<Schema$ListClustersResponse>): void;
2767
3838
  /**
2768
3839
  * Updates the parameters of a single Cluster.
3840
+ * @example
3841
+ * ```js
3842
+ * // Before running the sample:
3843
+ * // - Enable the API at:
3844
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3845
+ * // - Login into gcloud by running:
3846
+ * // ```sh
3847
+ * // $ gcloud auth application-default login
3848
+ * // ```
3849
+ * // - Install the npm module by running:
3850
+ * // ```sh
3851
+ * // $ npm install googleapis
3852
+ * // ```
3853
+ *
3854
+ * const {google} = require('googleapis');
3855
+ * const alloydb = google.alloydb('v1beta');
3856
+ *
3857
+ * async function main() {
3858
+ * const auth = new google.auth.GoogleAuth({
3859
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3860
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3861
+ * });
3862
+ *
3863
+ * // Acquire an auth client, and bind it to all future calls
3864
+ * const authClient = await auth.getClient();
3865
+ * google.options({auth: authClient});
3866
+ *
3867
+ * // Do the magic
3868
+ * const res = await alloydb.projects.locations.clusters.patch({
3869
+ * // 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.
3870
+ * allowMissing: 'placeholder-value',
3871
+ * // 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\}
3872
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
3873
+ * // 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).
3874
+ * requestId: 'placeholder-value',
3875
+ * // 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.
3876
+ * updateMask: 'placeholder-value',
3877
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
3878
+ * validateOnly: 'placeholder-value',
3879
+ *
3880
+ * // Request body metadata
3881
+ * requestBody: {
3882
+ * // request body parameters
3883
+ * // {
3884
+ * // "annotations": {},
3885
+ * // "automatedBackupPolicy": {},
3886
+ * // "backupSource": {},
3887
+ * // "cloudsqlBackupRunSource": {},
3888
+ * // "clusterType": "my_clusterType",
3889
+ * // "continuousBackupConfig": {},
3890
+ * // "continuousBackupInfo": {},
3891
+ * // "createTime": "my_createTime",
3892
+ * // "databaseVersion": "my_databaseVersion",
3893
+ * // "deleteTime": "my_deleteTime",
3894
+ * // "displayName": "my_displayName",
3895
+ * // "encryptionConfig": {},
3896
+ * // "encryptionInfo": {},
3897
+ * // "etag": "my_etag",
3898
+ * // "geminiConfig": {},
3899
+ * // "initialUser": {},
3900
+ * // "labels": {},
3901
+ * // "maintenanceSchedule": {},
3902
+ * // "maintenanceUpdatePolicy": {},
3903
+ * // "migrationSource": {},
3904
+ * // "name": "my_name",
3905
+ * // "network": "my_network",
3906
+ * // "networkConfig": {},
3907
+ * // "primaryConfig": {},
3908
+ * // "pscConfig": {},
3909
+ * // "reconciling": false,
3910
+ * // "satisfiesPzs": false,
3911
+ * // "secondaryConfig": {},
3912
+ * // "serviceAccountEmail": "my_serviceAccountEmail",
3913
+ * // "sslConfig": {},
3914
+ * // "state": "my_state",
3915
+ * // "subscriptionType": "my_subscriptionType",
3916
+ * // "tags": {},
3917
+ * // "trialMetadata": {},
3918
+ * // "uid": "my_uid",
3919
+ * // "updateTime": "my_updateTime"
3920
+ * // }
3921
+ * },
3922
+ * });
3923
+ * console.log(res.data);
3924
+ *
3925
+ * // Example response
3926
+ * // {
3927
+ * // "done": false,
3928
+ * // "error": {},
3929
+ * // "metadata": {},
3930
+ * // "name": "my_name",
3931
+ * // "response": {}
3932
+ * // }
3933
+ * }
3934
+ *
3935
+ * main().catch(e => {
3936
+ * console.error(e);
3937
+ * throw e;
3938
+ * });
3939
+ *
3940
+ * ```
2769
3941
  *
2770
3942
  * @param params - Parameters for request
2771
3943
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2780,6 +3952,66 @@ export declare namespace alloydb_v1beta {
2780
3952
  patch(callback: BodyResponseCallback<Schema$Operation>): void;
2781
3953
  /**
2782
3954
  * Promotes a SECONDARY cluster. This turns down replication from the PRIMARY cluster and promotes a secondary cluster into its own standalone cluster. Imperative only.
3955
+ * @example
3956
+ * ```js
3957
+ * // Before running the sample:
3958
+ * // - Enable the API at:
3959
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3960
+ * // - Login into gcloud by running:
3961
+ * // ```sh
3962
+ * // $ gcloud auth application-default login
3963
+ * // ```
3964
+ * // - Install the npm module by running:
3965
+ * // ```sh
3966
+ * // $ npm install googleapis
3967
+ * // ```
3968
+ *
3969
+ * const {google} = require('googleapis');
3970
+ * const alloydb = google.alloydb('v1beta');
3971
+ *
3972
+ * async function main() {
3973
+ * const auth = new google.auth.GoogleAuth({
3974
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3975
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3976
+ * });
3977
+ *
3978
+ * // Acquire an auth client, and bind it to all future calls
3979
+ * const authClient = await auth.getClient();
3980
+ * google.options({auth: authClient});
3981
+ *
3982
+ * // Do the magic
3983
+ * const res = await alloydb.projects.locations.clusters.promote({
3984
+ * // Required. The name of the resource. For the required format, see the comment on the Cluster.name field
3985
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
3986
+ *
3987
+ * // Request body metadata
3988
+ * requestBody: {
3989
+ * // request body parameters
3990
+ * // {
3991
+ * // "etag": "my_etag",
3992
+ * // "requestId": "my_requestId",
3993
+ * // "validateOnly": false
3994
+ * // }
3995
+ * },
3996
+ * });
3997
+ * console.log(res.data);
3998
+ *
3999
+ * // Example response
4000
+ * // {
4001
+ * // "done": false,
4002
+ * // "error": {},
4003
+ * // "metadata": {},
4004
+ * // "name": "my_name",
4005
+ * // "response": {}
4006
+ * // }
4007
+ * }
4008
+ *
4009
+ * main().catch(e => {
4010
+ * console.error(e);
4011
+ * throw e;
4012
+ * });
4013
+ *
4014
+ * ```
2783
4015
  *
2784
4016
  * @param params - Parameters for request
2785
4017
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2794,6 +4026,69 @@ export declare namespace alloydb_v1beta {
2794
4026
  promote(callback: BodyResponseCallback<Schema$Operation>): void;
2795
4027
  /**
2796
4028
  * 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.
4029
+ * @example
4030
+ * ```js
4031
+ * // Before running the sample:
4032
+ * // - Enable the API at:
4033
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4034
+ * // - Login into gcloud by running:
4035
+ * // ```sh
4036
+ * // $ gcloud auth application-default login
4037
+ * // ```
4038
+ * // - Install the npm module by running:
4039
+ * // ```sh
4040
+ * // $ npm install googleapis
4041
+ * // ```
4042
+ *
4043
+ * const {google} = require('googleapis');
4044
+ * const alloydb = google.alloydb('v1beta');
4045
+ *
4046
+ * async function main() {
4047
+ * const auth = new google.auth.GoogleAuth({
4048
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4049
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4050
+ * });
4051
+ *
4052
+ * // Acquire an auth client, and bind it to all future calls
4053
+ * const authClient = await auth.getClient();
4054
+ * google.options({auth: authClient});
4055
+ *
4056
+ * // Do the magic
4057
+ * const res = await alloydb.projects.locations.clusters.restore({
4058
+ * // Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field.
4059
+ * parent: 'projects/my-project/locations/my-location',
4060
+ *
4061
+ * // Request body metadata
4062
+ * requestBody: {
4063
+ * // request body parameters
4064
+ * // {
4065
+ * // "backupSource": {},
4066
+ * // "cluster": {},
4067
+ * // "clusterId": "my_clusterId",
4068
+ * // "continuousBackupSource": {},
4069
+ * // "requestId": "my_requestId",
4070
+ * // "validateOnly": false
4071
+ * // }
4072
+ * },
4073
+ * });
4074
+ * console.log(res.data);
4075
+ *
4076
+ * // Example response
4077
+ * // {
4078
+ * // "done": false,
4079
+ * // "error": {},
4080
+ * // "metadata": {},
4081
+ * // "name": "my_name",
4082
+ * // "response": {}
4083
+ * // }
4084
+ * }
4085
+ *
4086
+ * main().catch(e => {
4087
+ * console.error(e);
4088
+ * throw e;
4089
+ * });
4090
+ *
4091
+ * ```
2797
4092
  *
2798
4093
  * @param params - Parameters for request
2799
4094
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2808,6 +4103,66 @@ export declare namespace alloydb_v1beta {
2808
4103
  restore(callback: BodyResponseCallback<Schema$Operation>): void;
2809
4104
  /**
2810
4105
  * Restores an AlloyDB cluster from a CloudSQL resource.
4106
+ * @example
4107
+ * ```js
4108
+ * // Before running the sample:
4109
+ * // - Enable the API at:
4110
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4111
+ * // - Login into gcloud by running:
4112
+ * // ```sh
4113
+ * // $ gcloud auth application-default login
4114
+ * // ```
4115
+ * // - Install the npm module by running:
4116
+ * // ```sh
4117
+ * // $ npm install googleapis
4118
+ * // ```
4119
+ *
4120
+ * const {google} = require('googleapis');
4121
+ * const alloydb = google.alloydb('v1beta');
4122
+ *
4123
+ * async function main() {
4124
+ * const auth = new google.auth.GoogleAuth({
4125
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4126
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4127
+ * });
4128
+ *
4129
+ * // Acquire an auth client, and bind it to all future calls
4130
+ * const authClient = await auth.getClient();
4131
+ * google.options({auth: authClient});
4132
+ *
4133
+ * // Do the magic
4134
+ * const res = await alloydb.projects.locations.clusters.restoreFromCloudSQL({
4135
+ * // Required. The location of the new cluster. For the required format, see the comment on Cluster.name field.
4136
+ * parent: 'projects/my-project/locations/my-location',
4137
+ *
4138
+ * // Request body metadata
4139
+ * requestBody: {
4140
+ * // request body parameters
4141
+ * // {
4142
+ * // "cloudsqlBackupRunSource": {},
4143
+ * // "cluster": {},
4144
+ * // "clusterId": "my_clusterId"
4145
+ * // }
4146
+ * },
4147
+ * });
4148
+ * console.log(res.data);
4149
+ *
4150
+ * // Example response
4151
+ * // {
4152
+ * // "done": false,
4153
+ * // "error": {},
4154
+ * // "metadata": {},
4155
+ * // "name": "my_name",
4156
+ * // "response": {}
4157
+ * // }
4158
+ * }
4159
+ *
4160
+ * main().catch(e => {
4161
+ * console.error(e);
4162
+ * throw e;
4163
+ * });
4164
+ *
4165
+ * ```
2811
4166
  *
2812
4167
  * @param params - Parameters for request
2813
4168
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2822,6 +4177,65 @@ export declare namespace alloydb_v1beta {
2822
4177
  restoreFromCloudSQL(callback: BodyResponseCallback<Schema$Operation>): void;
2823
4178
  /**
2824
4179
  * 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.
4180
+ * @example
4181
+ * ```js
4182
+ * // Before running the sample:
4183
+ * // - Enable the API at:
4184
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4185
+ * // - Login into gcloud by running:
4186
+ * // ```sh
4187
+ * // $ gcloud auth application-default login
4188
+ * // ```
4189
+ * // - Install the npm module by running:
4190
+ * // ```sh
4191
+ * // $ npm install googleapis
4192
+ * // ```
4193
+ *
4194
+ * const {google} = require('googleapis');
4195
+ * const alloydb = google.alloydb('v1beta');
4196
+ *
4197
+ * async function main() {
4198
+ * const auth = new google.auth.GoogleAuth({
4199
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4200
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4201
+ * });
4202
+ *
4203
+ * // Acquire an auth client, and bind it to all future calls
4204
+ * const authClient = await auth.getClient();
4205
+ * google.options({auth: authClient});
4206
+ *
4207
+ * // Do the magic
4208
+ * const res = await alloydb.projects.locations.clusters.switchover({
4209
+ * // Required. The name of the resource. For the required format, see the comment on the Cluster.name field
4210
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
4211
+ *
4212
+ * // Request body metadata
4213
+ * requestBody: {
4214
+ * // request body parameters
4215
+ * // {
4216
+ * // "requestId": "my_requestId",
4217
+ * // "validateOnly": false
4218
+ * // }
4219
+ * },
4220
+ * });
4221
+ * console.log(res.data);
4222
+ *
4223
+ * // Example response
4224
+ * // {
4225
+ * // "done": false,
4226
+ * // "error": {},
4227
+ * // "metadata": {},
4228
+ * // "name": "my_name",
4229
+ * // "response": {}
4230
+ * // }
4231
+ * }
4232
+ *
4233
+ * main().catch(e => {
4234
+ * console.error(e);
4235
+ * throw e;
4236
+ * });
4237
+ *
4238
+ * ```
2825
4239
  *
2826
4240
  * @param params - Parameters for request
2827
4241
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2836,6 +4250,67 @@ export declare namespace alloydb_v1beta {
2836
4250
  switchover(callback: BodyResponseCallback<Schema$Operation>): void;
2837
4251
  /**
2838
4252
  * Upgrades a single Cluster. Imperative only.
4253
+ * @example
4254
+ * ```js
4255
+ * // Before running the sample:
4256
+ * // - Enable the API at:
4257
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4258
+ * // - Login into gcloud by running:
4259
+ * // ```sh
4260
+ * // $ gcloud auth application-default login
4261
+ * // ```
4262
+ * // - Install the npm module by running:
4263
+ * // ```sh
4264
+ * // $ npm install googleapis
4265
+ * // ```
4266
+ *
4267
+ * const {google} = require('googleapis');
4268
+ * const alloydb = google.alloydb('v1beta');
4269
+ *
4270
+ * async function main() {
4271
+ * const auth = new google.auth.GoogleAuth({
4272
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4273
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4274
+ * });
4275
+ *
4276
+ * // Acquire an auth client, and bind it to all future calls
4277
+ * const authClient = await auth.getClient();
4278
+ * google.options({auth: authClient});
4279
+ *
4280
+ * // Do the magic
4281
+ * const res = await alloydb.projects.locations.clusters.upgrade({
4282
+ * // Required. The resource name of the cluster.
4283
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
4284
+ *
4285
+ * // Request body metadata
4286
+ * requestBody: {
4287
+ * // request body parameters
4288
+ * // {
4289
+ * // "etag": "my_etag",
4290
+ * // "requestId": "my_requestId",
4291
+ * // "validateOnly": false,
4292
+ * // "version": "my_version"
4293
+ * // }
4294
+ * },
4295
+ * });
4296
+ * console.log(res.data);
4297
+ *
4298
+ * // Example response
4299
+ * // {
4300
+ * // "done": false,
4301
+ * // "error": {},
4302
+ * // "metadata": {},
4303
+ * // "name": "my_name",
4304
+ * // "response": {}
4305
+ * // }
4306
+ * }
4307
+ *
4308
+ * main().catch(e => {
4309
+ * console.error(e);
4310
+ * throw e;
4311
+ * });
4312
+ *
4313
+ * ```
2839
4314
  *
2840
4315
  * @param params - Parameters for request
2841
4316
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3048,6 +4523,102 @@ export declare namespace alloydb_v1beta {
3048
4523
  constructor(context: APIRequestContext);
3049
4524
  /**
3050
4525
  * Creates a new Instance in a given project and location.
4526
+ * @example
4527
+ * ```js
4528
+ * // Before running the sample:
4529
+ * // - Enable the API at:
4530
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4531
+ * // - Login into gcloud by running:
4532
+ * // ```sh
4533
+ * // $ gcloud auth application-default login
4534
+ * // ```
4535
+ * // - Install the npm module by running:
4536
+ * // ```sh
4537
+ * // $ npm install googleapis
4538
+ * // ```
4539
+ *
4540
+ * const {google} = require('googleapis');
4541
+ * const alloydb = google.alloydb('v1beta');
4542
+ *
4543
+ * async function main() {
4544
+ * const auth = new google.auth.GoogleAuth({
4545
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4546
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4547
+ * });
4548
+ *
4549
+ * // Acquire an auth client, and bind it to all future calls
4550
+ * const authClient = await auth.getClient();
4551
+ * google.options({auth: authClient});
4552
+ *
4553
+ * // Do the magic
4554
+ * const res = await alloydb.projects.locations.clusters.instances.create({
4555
+ * // Required. ID of the requesting object.
4556
+ * instanceId: 'placeholder-value',
4557
+ * // Required. The name of the parent resource. For the required format, see the comment on the Instance.name field.
4558
+ * parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
4559
+ * // 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).
4560
+ * requestId: 'placeholder-value',
4561
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
4562
+ * validateOnly: 'placeholder-value',
4563
+ *
4564
+ * // Request body metadata
4565
+ * requestBody: {
4566
+ * // request body parameters
4567
+ * // {
4568
+ * // "activationPolicy": "my_activationPolicy",
4569
+ * // "annotations": {},
4570
+ * // "availabilityType": "my_availabilityType",
4571
+ * // "clientConnectionConfig": {},
4572
+ * // "connectionPoolConfig": {},
4573
+ * // "createTime": "my_createTime",
4574
+ * // "databaseFlags": {},
4575
+ * // "deleteTime": "my_deleteTime",
4576
+ * // "displayName": "my_displayName",
4577
+ * // "etag": "my_etag",
4578
+ * // "gcaConfig": {},
4579
+ * // "gceZone": "my_gceZone",
4580
+ * // "geminiConfig": {},
4581
+ * // "instanceType": "my_instanceType",
4582
+ * // "ipAddress": "my_ipAddress",
4583
+ * // "labels": {},
4584
+ * // "machineConfig": {},
4585
+ * // "name": "my_name",
4586
+ * // "networkConfig": {},
4587
+ * // "nodes": [],
4588
+ * // "observabilityConfig": {},
4589
+ * // "outboundPublicIpAddresses": [],
4590
+ * // "pscInstanceConfig": {},
4591
+ * // "publicIpAddress": "my_publicIpAddress",
4592
+ * // "queryInsightsConfig": {},
4593
+ * // "readPoolConfig": {},
4594
+ * // "reconciling": false,
4595
+ * // "satisfiesPzs": false,
4596
+ * // "state": "my_state",
4597
+ * // "uid": "my_uid",
4598
+ * // "updatePolicy": {},
4599
+ * // "updateTime": "my_updateTime",
4600
+ * // "writableNode": {}
4601
+ * // }
4602
+ * },
4603
+ * });
4604
+ * console.log(res.data);
4605
+ *
4606
+ * // Example response
4607
+ * // {
4608
+ * // "done": false,
4609
+ * // "error": {},
4610
+ * // "metadata": {},
4611
+ * // "name": "my_name",
4612
+ * // "response": {}
4613
+ * // }
4614
+ * }
4615
+ *
4616
+ * main().catch(e => {
4617
+ * console.error(e);
4618
+ * throw e;
4619
+ * });
4620
+ *
4621
+ * ```
3051
4622
  *
3052
4623
  * @param params - Parameters for request
3053
4624
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3062,6 +4633,103 @@ export declare namespace alloydb_v1beta {
3062
4633
  create(callback: BodyResponseCallback<Schema$Operation>): void;
3063
4634
  /**
3064
4635
  * Creates a new SECONDARY Instance in a given project and location.
4636
+ * @example
4637
+ * ```js
4638
+ * // Before running the sample:
4639
+ * // - Enable the API at:
4640
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4641
+ * // - Login into gcloud by running:
4642
+ * // ```sh
4643
+ * // $ gcloud auth application-default login
4644
+ * // ```
4645
+ * // - Install the npm module by running:
4646
+ * // ```sh
4647
+ * // $ npm install googleapis
4648
+ * // ```
4649
+ *
4650
+ * const {google} = require('googleapis');
4651
+ * const alloydb = google.alloydb('v1beta');
4652
+ *
4653
+ * async function main() {
4654
+ * const auth = new google.auth.GoogleAuth({
4655
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4656
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4657
+ * });
4658
+ *
4659
+ * // Acquire an auth client, and bind it to all future calls
4660
+ * const authClient = await auth.getClient();
4661
+ * google.options({auth: authClient});
4662
+ *
4663
+ * // Do the magic
4664
+ * const res =
4665
+ * await alloydb.projects.locations.clusters.instances.createsecondary({
4666
+ * // Required. ID of the requesting object.
4667
+ * instanceId: 'placeholder-value',
4668
+ * // Required. The name of the parent resource. For the required format, see the comment on the Instance.name field.
4669
+ * parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
4670
+ * // 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).
4671
+ * requestId: 'placeholder-value',
4672
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
4673
+ * validateOnly: 'placeholder-value',
4674
+ *
4675
+ * // Request body metadata
4676
+ * requestBody: {
4677
+ * // request body parameters
4678
+ * // {
4679
+ * // "activationPolicy": "my_activationPolicy",
4680
+ * // "annotations": {},
4681
+ * // "availabilityType": "my_availabilityType",
4682
+ * // "clientConnectionConfig": {},
4683
+ * // "connectionPoolConfig": {},
4684
+ * // "createTime": "my_createTime",
4685
+ * // "databaseFlags": {},
4686
+ * // "deleteTime": "my_deleteTime",
4687
+ * // "displayName": "my_displayName",
4688
+ * // "etag": "my_etag",
4689
+ * // "gcaConfig": {},
4690
+ * // "gceZone": "my_gceZone",
4691
+ * // "geminiConfig": {},
4692
+ * // "instanceType": "my_instanceType",
4693
+ * // "ipAddress": "my_ipAddress",
4694
+ * // "labels": {},
4695
+ * // "machineConfig": {},
4696
+ * // "name": "my_name",
4697
+ * // "networkConfig": {},
4698
+ * // "nodes": [],
4699
+ * // "observabilityConfig": {},
4700
+ * // "outboundPublicIpAddresses": [],
4701
+ * // "pscInstanceConfig": {},
4702
+ * // "publicIpAddress": "my_publicIpAddress",
4703
+ * // "queryInsightsConfig": {},
4704
+ * // "readPoolConfig": {},
4705
+ * // "reconciling": false,
4706
+ * // "satisfiesPzs": false,
4707
+ * // "state": "my_state",
4708
+ * // "uid": "my_uid",
4709
+ * // "updatePolicy": {},
4710
+ * // "updateTime": "my_updateTime",
4711
+ * // "writableNode": {}
4712
+ * // }
4713
+ * },
4714
+ * });
4715
+ * console.log(res.data);
4716
+ *
4717
+ * // Example response
4718
+ * // {
4719
+ * // "done": false,
4720
+ * // "error": {},
4721
+ * // "metadata": {},
4722
+ * // "name": "my_name",
4723
+ * // "response": {}
4724
+ * // }
4725
+ * }
4726
+ *
4727
+ * main().catch(e => {
4728
+ * console.error(e);
4729
+ * throw e;
4730
+ * });
4731
+ *
4732
+ * ```
3065
4733
  *
3066
4734
  * @param params - Parameters for request
3067
4735
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3076,6 +4744,62 @@ export declare namespace alloydb_v1beta {
3076
4744
  createsecondary(callback: BodyResponseCallback<Schema$Operation>): void;
3077
4745
  /**
3078
4746
  * Deletes a single Instance.
4747
+ * @example
4748
+ * ```js
4749
+ * // Before running the sample:
4750
+ * // - Enable the API at:
4751
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4752
+ * // - Login into gcloud by running:
4753
+ * // ```sh
4754
+ * // $ gcloud auth application-default login
4755
+ * // ```
4756
+ * // - Install the npm module by running:
4757
+ * // ```sh
4758
+ * // $ npm install googleapis
4759
+ * // ```
4760
+ *
4761
+ * const {google} = require('googleapis');
4762
+ * const alloydb = google.alloydb('v1beta');
4763
+ *
4764
+ * async function main() {
4765
+ * const auth = new google.auth.GoogleAuth({
4766
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4767
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4768
+ * });
4769
+ *
4770
+ * // Acquire an auth client, and bind it to all future calls
4771
+ * const authClient = await auth.getClient();
4772
+ * google.options({auth: authClient});
4773
+ *
4774
+ * // Do the magic
4775
+ * const res = await alloydb.projects.locations.clusters.instances.delete({
4776
+ * // 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.
4777
+ * etag: 'placeholder-value',
4778
+ * // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
4779
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
4780
+ * // 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).
4781
+ * requestId: 'placeholder-value',
4782
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
4783
+ * validateOnly: 'placeholder-value',
4784
+ * });
4785
+ * console.log(res.data);
4786
+ *
4787
+ * // Example response
4788
+ * // {
4789
+ * // "done": false,
4790
+ * // "error": {},
4791
+ * // "metadata": {},
4792
+ * // "name": "my_name",
4793
+ * // "response": {}
4794
+ * // }
4795
+ * }
4796
+ *
4797
+ * main().catch(e => {
4798
+ * console.error(e);
4799
+ * throw e;
4800
+ * });
4801
+ *
4802
+ * ```
3079
4803
  *
3080
4804
  * @param params - Parameters for request
3081
4805
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3090,6 +4814,65 @@ export declare namespace alloydb_v1beta {
3090
4814
  delete(callback: BodyResponseCallback<Schema$Operation>): void;
3091
4815
  /**
3092
4816
  * Forces a Failover for a highly available instance. Failover promotes the HA standby instance as the new primary. Imperative only.
4817
+ * @example
4818
+ * ```js
4819
+ * // Before running the sample:
4820
+ * // - Enable the API at:
4821
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4822
+ * // - Login into gcloud by running:
4823
+ * // ```sh
4824
+ * // $ gcloud auth application-default login
4825
+ * // ```
4826
+ * // - Install the npm module by running:
4827
+ * // ```sh
4828
+ * // $ npm install googleapis
4829
+ * // ```
4830
+ *
4831
+ * const {google} = require('googleapis');
4832
+ * const alloydb = google.alloydb('v1beta');
4833
+ *
4834
+ * async function main() {
4835
+ * const auth = new google.auth.GoogleAuth({
4836
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4837
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4838
+ * });
4839
+ *
4840
+ * // Acquire an auth client, and bind it to all future calls
4841
+ * const authClient = await auth.getClient();
4842
+ * google.options({auth: authClient});
4843
+ *
4844
+ * // Do the magic
4845
+ * const res = await alloydb.projects.locations.clusters.instances.failover({
4846
+ * // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
4847
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
4848
+ *
4849
+ * // Request body metadata
4850
+ * requestBody: {
4851
+ * // request body parameters
4852
+ * // {
4853
+ * // "requestId": "my_requestId",
4854
+ * // "validateOnly": false
4855
+ * // }
4856
+ * },
4857
+ * });
4858
+ * console.log(res.data);
4859
+ *
4860
+ * // Example response
4861
+ * // {
4862
+ * // "done": false,
4863
+ * // "error": {},
4864
+ * // "metadata": {},
4865
+ * // "name": "my_name",
4866
+ * // "response": {}
4867
+ * // }
4868
+ * }
4869
+ *
4870
+ * main().catch(e => {
4871
+ * console.error(e);
4872
+ * throw e;
4873
+ * });
4874
+ *
4875
+ * ```
3093
4876
  *
3094
4877
  * @param params - Parameters for request
3095
4878
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3104,6 +4887,86 @@ export declare namespace alloydb_v1beta {
3104
4887
  failover(callback: BodyResponseCallback<Schema$Operation>): void;
3105
4888
  /**
3106
4889
  * Gets details of a single Instance.
4890
+ * @example
4891
+ * ```js
4892
+ * // Before running the sample:
4893
+ * // - Enable the API at:
4894
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4895
+ * // - Login into gcloud by running:
4896
+ * // ```sh
4897
+ * // $ gcloud auth application-default login
4898
+ * // ```
4899
+ * // - Install the npm module by running:
4900
+ * // ```sh
4901
+ * // $ npm install googleapis
4902
+ * // ```
4903
+ *
4904
+ * const {google} = require('googleapis');
4905
+ * const alloydb = google.alloydb('v1beta');
4906
+ *
4907
+ * async function main() {
4908
+ * const auth = new google.auth.GoogleAuth({
4909
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4910
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4911
+ * });
4912
+ *
4913
+ * // Acquire an auth client, and bind it to all future calls
4914
+ * const authClient = await auth.getClient();
4915
+ * google.options({auth: authClient});
4916
+ *
4917
+ * // Do the magic
4918
+ * const res = await alloydb.projects.locations.clusters.instances.get({
4919
+ * // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
4920
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
4921
+ * // The view of the instance to return.
4922
+ * view: 'placeholder-value',
4923
+ * });
4924
+ * console.log(res.data);
4925
+ *
4926
+ * // Example response
4927
+ * // {
4928
+ * // "activationPolicy": "my_activationPolicy",
4929
+ * // "annotations": {},
4930
+ * // "availabilityType": "my_availabilityType",
4931
+ * // "clientConnectionConfig": {},
4932
+ * // "connectionPoolConfig": {},
4933
+ * // "createTime": "my_createTime",
4934
+ * // "databaseFlags": {},
4935
+ * // "deleteTime": "my_deleteTime",
4936
+ * // "displayName": "my_displayName",
4937
+ * // "etag": "my_etag",
4938
+ * // "gcaConfig": {},
4939
+ * // "gceZone": "my_gceZone",
4940
+ * // "geminiConfig": {},
4941
+ * // "instanceType": "my_instanceType",
4942
+ * // "ipAddress": "my_ipAddress",
4943
+ * // "labels": {},
4944
+ * // "machineConfig": {},
4945
+ * // "name": "my_name",
4946
+ * // "networkConfig": {},
4947
+ * // "nodes": [],
4948
+ * // "observabilityConfig": {},
4949
+ * // "outboundPublicIpAddresses": [],
4950
+ * // "pscInstanceConfig": {},
4951
+ * // "publicIpAddress": "my_publicIpAddress",
4952
+ * // "queryInsightsConfig": {},
4953
+ * // "readPoolConfig": {},
4954
+ * // "reconciling": false,
4955
+ * // "satisfiesPzs": false,
4956
+ * // "state": "my_state",
4957
+ * // "uid": "my_uid",
4958
+ * // "updatePolicy": {},
4959
+ * // "updateTime": "my_updateTime",
4960
+ * // "writableNode": {}
4961
+ * // }
4962
+ * }
4963
+ *
4964
+ * main().catch(e => {
4965
+ * console.error(e);
4966
+ * throw e;
4967
+ * });
4968
+ *
4969
+ * ```
3107
4970
  *
3108
4971
  * @param params - Parameters for request
3109
4972
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3118,6 +4981,61 @@ export declare namespace alloydb_v1beta {
3118
4981
  get(callback: BodyResponseCallback<Schema$Instance>): void;
3119
4982
  /**
3120
4983
  * Get instance metadata used for a connection.
4984
+ * @example
4985
+ * ```js
4986
+ * // Before running the sample:
4987
+ * // - Enable the API at:
4988
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4989
+ * // - Login into gcloud by running:
4990
+ * // ```sh
4991
+ * // $ gcloud auth application-default login
4992
+ * // ```
4993
+ * // - Install the npm module by running:
4994
+ * // ```sh
4995
+ * // $ npm install googleapis
4996
+ * // ```
4997
+ *
4998
+ * const {google} = require('googleapis');
4999
+ * const alloydb = google.alloydb('v1beta');
5000
+ *
5001
+ * async function main() {
5002
+ * const auth = new google.auth.GoogleAuth({
5003
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5004
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5005
+ * });
5006
+ *
5007
+ * // Acquire an auth client, and bind it to all future calls
5008
+ * const authClient = await auth.getClient();
5009
+ * google.options({auth: authClient});
5010
+ *
5011
+ * // Do the magic
5012
+ * const res =
5013
+ * await alloydb.projects.locations.clusters.instances.getConnectionInfo({
5014
+ * // Required. The name of the parent resource. The required format is: projects/{project\}/locations/{location\}/clusters/{cluster\}/instances/{instance\}
5015
+ * parent:
5016
+ * 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
5017
+ * // 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).
5018
+ * requestId: 'placeholder-value',
5019
+ * });
5020
+ * console.log(res.data);
5021
+ *
5022
+ * // Example response
5023
+ * // {
5024
+ * // "instanceUid": "my_instanceUid",
5025
+ * // "ipAddress": "my_ipAddress",
5026
+ * // "name": "my_name",
5027
+ * // "pemCertificateChain": [],
5028
+ * // "pscDnsName": "my_pscDnsName",
5029
+ * // "publicIpAddress": "my_publicIpAddress"
5030
+ * // }
5031
+ * }
5032
+ *
5033
+ * main().catch(e => {
5034
+ * console.error(e);
5035
+ * throw e;
5036
+ * });
5037
+ *
5038
+ * ```
3121
5039
  *
3122
5040
  * @param params - Parameters for request
3123
5041
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3132,6 +5050,66 @@ export declare namespace alloydb_v1beta {
3132
5050
  getConnectionInfo(callback: BodyResponseCallback<Schema$ConnectionInfo>): void;
3133
5051
  /**
3134
5052
  * Injects fault in an instance. Imperative only.
5053
+ * @example
5054
+ * ```js
5055
+ * // Before running the sample:
5056
+ * // - Enable the API at:
5057
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5058
+ * // - Login into gcloud by running:
5059
+ * // ```sh
5060
+ * // $ gcloud auth application-default login
5061
+ * // ```
5062
+ * // - Install the npm module by running:
5063
+ * // ```sh
5064
+ * // $ npm install googleapis
5065
+ * // ```
5066
+ *
5067
+ * const {google} = require('googleapis');
5068
+ * const alloydb = google.alloydb('v1beta');
5069
+ *
5070
+ * async function main() {
5071
+ * const auth = new google.auth.GoogleAuth({
5072
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5073
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5074
+ * });
5075
+ *
5076
+ * // Acquire an auth client, and bind it to all future calls
5077
+ * const authClient = await auth.getClient();
5078
+ * google.options({auth: authClient});
5079
+ *
5080
+ * // Do the magic
5081
+ * const res = await alloydb.projects.locations.clusters.instances.injectFault({
5082
+ * // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
5083
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
5084
+ *
5085
+ * // Request body metadata
5086
+ * requestBody: {
5087
+ * // request body parameters
5088
+ * // {
5089
+ * // "faultType": "my_faultType",
5090
+ * // "requestId": "my_requestId",
5091
+ * // "validateOnly": false
5092
+ * // }
5093
+ * },
5094
+ * });
5095
+ * console.log(res.data);
5096
+ *
5097
+ * // Example response
5098
+ * // {
5099
+ * // "done": false,
5100
+ * // "error": {},
5101
+ * // "metadata": {},
5102
+ * // "name": "my_name",
5103
+ * // "response": {}
5104
+ * // }
5105
+ * }
5106
+ *
5107
+ * main().catch(e => {
5108
+ * console.error(e);
5109
+ * throw e;
5110
+ * });
5111
+ *
5112
+ * ```
3135
5113
  *
3136
5114
  * @param params - Parameters for request
3137
5115
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3146,6 +5124,62 @@ export declare namespace alloydb_v1beta {
3146
5124
  injectFault(callback: BodyResponseCallback<Schema$Operation>): void;
3147
5125
  /**
3148
5126
  * Lists Instances in a given project and location.
5127
+ * @example
5128
+ * ```js
5129
+ * // Before running the sample:
5130
+ * // - Enable the API at:
5131
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5132
+ * // - Login into gcloud by running:
5133
+ * // ```sh
5134
+ * // $ gcloud auth application-default login
5135
+ * // ```
5136
+ * // - Install the npm module by running:
5137
+ * // ```sh
5138
+ * // $ npm install googleapis
5139
+ * // ```
5140
+ *
5141
+ * const {google} = require('googleapis');
5142
+ * const alloydb = google.alloydb('v1beta');
5143
+ *
5144
+ * async function main() {
5145
+ * const auth = new google.auth.GoogleAuth({
5146
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5147
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5148
+ * });
5149
+ *
5150
+ * // Acquire an auth client, and bind it to all future calls
5151
+ * const authClient = await auth.getClient();
5152
+ * google.options({auth: authClient});
5153
+ *
5154
+ * // Do the magic
5155
+ * const res = await alloydb.projects.locations.clusters.instances.list({
5156
+ * // Optional. Filtering results
5157
+ * filter: 'placeholder-value',
5158
+ * // Optional. Hint for how to order the results
5159
+ * orderBy: 'placeholder-value',
5160
+ * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
5161
+ * pageSize: 'placeholder-value',
5162
+ * // A token identifying a page of results the server should return.
5163
+ * pageToken: 'placeholder-value',
5164
+ * // 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/-
5165
+ * parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
5166
+ * });
5167
+ * console.log(res.data);
5168
+ *
5169
+ * // Example response
5170
+ * // {
5171
+ * // "instances": [],
5172
+ * // "nextPageToken": "my_nextPageToken",
5173
+ * // "unreachable": []
5174
+ * // }
5175
+ * }
5176
+ *
5177
+ * main().catch(e => {
5178
+ * console.error(e);
5179
+ * throw e;
5180
+ * });
5181
+ *
5182
+ * ```
3149
5183
  *
3150
5184
  * @param params - Parameters for request
3151
5185
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3160,6 +5194,104 @@ export declare namespace alloydb_v1beta {
3160
5194
  list(callback: BodyResponseCallback<Schema$ListInstancesResponse>): void;
3161
5195
  /**
3162
5196
  * Updates the parameters of a single Instance.
5197
+ * @example
5198
+ * ```js
5199
+ * // Before running the sample:
5200
+ * // - Enable the API at:
5201
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5202
+ * // - Login into gcloud by running:
5203
+ * // ```sh
5204
+ * // $ gcloud auth application-default login
5205
+ * // ```
5206
+ * // - Install the npm module by running:
5207
+ * // ```sh
5208
+ * // $ npm install googleapis
5209
+ * // ```
5210
+ *
5211
+ * const {google} = require('googleapis');
5212
+ * const alloydb = google.alloydb('v1beta');
5213
+ *
5214
+ * async function main() {
5215
+ * const auth = new google.auth.GoogleAuth({
5216
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5217
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5218
+ * });
5219
+ *
5220
+ * // Acquire an auth client, and bind it to all future calls
5221
+ * const authClient = await auth.getClient();
5222
+ * google.options({auth: authClient});
5223
+ *
5224
+ * // Do the magic
5225
+ * const res = await alloydb.projects.locations.clusters.instances.patch({
5226
+ * // 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.
5227
+ * allowMissing: 'placeholder-value',
5228
+ * // 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\}
5229
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
5230
+ * // 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).
5231
+ * requestId: 'placeholder-value',
5232
+ * // 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.
5233
+ * updateMask: 'placeholder-value',
5234
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
5235
+ * validateOnly: 'placeholder-value',
5236
+ *
5237
+ * // Request body metadata
5238
+ * requestBody: {
5239
+ * // request body parameters
5240
+ * // {
5241
+ * // "activationPolicy": "my_activationPolicy",
5242
+ * // "annotations": {},
5243
+ * // "availabilityType": "my_availabilityType",
5244
+ * // "clientConnectionConfig": {},
5245
+ * // "connectionPoolConfig": {},
5246
+ * // "createTime": "my_createTime",
5247
+ * // "databaseFlags": {},
5248
+ * // "deleteTime": "my_deleteTime",
5249
+ * // "displayName": "my_displayName",
5250
+ * // "etag": "my_etag",
5251
+ * // "gcaConfig": {},
5252
+ * // "gceZone": "my_gceZone",
5253
+ * // "geminiConfig": {},
5254
+ * // "instanceType": "my_instanceType",
5255
+ * // "ipAddress": "my_ipAddress",
5256
+ * // "labels": {},
5257
+ * // "machineConfig": {},
5258
+ * // "name": "my_name",
5259
+ * // "networkConfig": {},
5260
+ * // "nodes": [],
5261
+ * // "observabilityConfig": {},
5262
+ * // "outboundPublicIpAddresses": [],
5263
+ * // "pscInstanceConfig": {},
5264
+ * // "publicIpAddress": "my_publicIpAddress",
5265
+ * // "queryInsightsConfig": {},
5266
+ * // "readPoolConfig": {},
5267
+ * // "reconciling": false,
5268
+ * // "satisfiesPzs": false,
5269
+ * // "state": "my_state",
5270
+ * // "uid": "my_uid",
5271
+ * // "updatePolicy": {},
5272
+ * // "updateTime": "my_updateTime",
5273
+ * // "writableNode": {}
5274
+ * // }
5275
+ * },
5276
+ * });
5277
+ * console.log(res.data);
5278
+ *
5279
+ * // Example response
5280
+ * // {
5281
+ * // "done": false,
5282
+ * // "error": {},
5283
+ * // "metadata": {},
5284
+ * // "name": "my_name",
5285
+ * // "response": {}
5286
+ * // }
5287
+ * }
5288
+ *
5289
+ * main().catch(e => {
5290
+ * console.error(e);
5291
+ * throw e;
5292
+ * });
5293
+ *
5294
+ * ```
3163
5295
  *
3164
5296
  * @param params - Parameters for request
3165
5297
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3174,6 +5306,66 @@ export declare namespace alloydb_v1beta {
3174
5306
  patch(callback: BodyResponseCallback<Schema$Operation>): void;
3175
5307
  /**
3176
5308
  * Restart an Instance in a cluster. Imperative only.
5309
+ * @example
5310
+ * ```js
5311
+ * // Before running the sample:
5312
+ * // - Enable the API at:
5313
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5314
+ * // - Login into gcloud by running:
5315
+ * // ```sh
5316
+ * // $ gcloud auth application-default login
5317
+ * // ```
5318
+ * // - Install the npm module by running:
5319
+ * // ```sh
5320
+ * // $ npm install googleapis
5321
+ * // ```
5322
+ *
5323
+ * const {google} = require('googleapis');
5324
+ * const alloydb = google.alloydb('v1beta');
5325
+ *
5326
+ * async function main() {
5327
+ * const auth = new google.auth.GoogleAuth({
5328
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5329
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5330
+ * });
5331
+ *
5332
+ * // Acquire an auth client, and bind it to all future calls
5333
+ * const authClient = await auth.getClient();
5334
+ * google.options({auth: authClient});
5335
+ *
5336
+ * // Do the magic
5337
+ * const res = await alloydb.projects.locations.clusters.instances.restart({
5338
+ * // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
5339
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
5340
+ *
5341
+ * // Request body metadata
5342
+ * requestBody: {
5343
+ * // request body parameters
5344
+ * // {
5345
+ * // "nodeIds": [],
5346
+ * // "requestId": "my_requestId",
5347
+ * // "validateOnly": false
5348
+ * // }
5349
+ * },
5350
+ * });
5351
+ * console.log(res.data);
5352
+ *
5353
+ * // Example response
5354
+ * // {
5355
+ * // "done": false,
5356
+ * // "error": {},
5357
+ * // "metadata": {},
5358
+ * // "name": "my_name",
5359
+ * // "response": {}
5360
+ * // }
5361
+ * }
5362
+ *
5363
+ * main().catch(e => {
5364
+ * console.error(e);
5365
+ * throw e;
5366
+ * });
5367
+ *
5368
+ * ```
3177
5369
  *
3178
5370
  * @param params - Parameters for request
3179
5371
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3352,6 +5544,74 @@ export declare namespace alloydb_v1beta {
3352
5544
  constructor(context: APIRequestContext);
3353
5545
  /**
3354
5546
  * Creates a new User in a given project, location, and cluster.
5547
+ * @example
5548
+ * ```js
5549
+ * // Before running the sample:
5550
+ * // - Enable the API at:
5551
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5552
+ * // - Login into gcloud by running:
5553
+ * // ```sh
5554
+ * // $ gcloud auth application-default login
5555
+ * // ```
5556
+ * // - Install the npm module by running:
5557
+ * // ```sh
5558
+ * // $ npm install googleapis
5559
+ * // ```
5560
+ *
5561
+ * const {google} = require('googleapis');
5562
+ * const alloydb = google.alloydb('v1beta');
5563
+ *
5564
+ * async function main() {
5565
+ * const auth = new google.auth.GoogleAuth({
5566
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5567
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5568
+ * });
5569
+ *
5570
+ * // Acquire an auth client, and bind it to all future calls
5571
+ * const authClient = await auth.getClient();
5572
+ * google.options({auth: authClient});
5573
+ *
5574
+ * // Do the magic
5575
+ * const res = await alloydb.projects.locations.clusters.users.create({
5576
+ * // Required. Value for parent.
5577
+ * parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
5578
+ * // 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).
5579
+ * requestId: 'placeholder-value',
5580
+ * // Required. ID of the requesting object.
5581
+ * userId: 'placeholder-value',
5582
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
5583
+ * validateOnly: 'placeholder-value',
5584
+ *
5585
+ * // Request body metadata
5586
+ * requestBody: {
5587
+ * // request body parameters
5588
+ * // {
5589
+ * // "databaseRoles": [],
5590
+ * // "keepExtraRoles": false,
5591
+ * // "name": "my_name",
5592
+ * // "password": "my_password",
5593
+ * // "userType": "my_userType"
5594
+ * // }
5595
+ * },
5596
+ * });
5597
+ * console.log(res.data);
5598
+ *
5599
+ * // Example response
5600
+ * // {
5601
+ * // "databaseRoles": [],
5602
+ * // "keepExtraRoles": false,
5603
+ * // "name": "my_name",
5604
+ * // "password": "my_password",
5605
+ * // "userType": "my_userType"
5606
+ * // }
5607
+ * }
5608
+ *
5609
+ * main().catch(e => {
5610
+ * console.error(e);
5611
+ * throw e;
5612
+ * });
5613
+ *
5614
+ * ```
3355
5615
  *
3356
5616
  * @param params - Parameters for request
3357
5617
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3366,6 +5626,54 @@ export declare namespace alloydb_v1beta {
3366
5626
  create(callback: BodyResponseCallback<Schema$User>): void;
3367
5627
  /**
3368
5628
  * Deletes a single User.
5629
+ * @example
5630
+ * ```js
5631
+ * // Before running the sample:
5632
+ * // - Enable the API at:
5633
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5634
+ * // - Login into gcloud by running:
5635
+ * // ```sh
5636
+ * // $ gcloud auth application-default login
5637
+ * // ```
5638
+ * // - Install the npm module by running:
5639
+ * // ```sh
5640
+ * // $ npm install googleapis
5641
+ * // ```
5642
+ *
5643
+ * const {google} = require('googleapis');
5644
+ * const alloydb = google.alloydb('v1beta');
5645
+ *
5646
+ * async function main() {
5647
+ * const auth = new google.auth.GoogleAuth({
5648
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5649
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5650
+ * });
5651
+ *
5652
+ * // Acquire an auth client, and bind it to all future calls
5653
+ * const authClient = await auth.getClient();
5654
+ * google.options({auth: authClient});
5655
+ *
5656
+ * // Do the magic
5657
+ * const res = await alloydb.projects.locations.clusters.users.delete({
5658
+ * // Required. The name of the resource. For the required format, see the comment on the User.name field.
5659
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/users/my-user',
5660
+ * // 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).
5661
+ * requestId: 'placeholder-value',
5662
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
5663
+ * validateOnly: 'placeholder-value',
5664
+ * });
5665
+ * console.log(res.data);
5666
+ *
5667
+ * // Example response
5668
+ * // {}
5669
+ * }
5670
+ *
5671
+ * main().catch(e => {
5672
+ * console.error(e);
5673
+ * throw e;
5674
+ * });
5675
+ *
5676
+ * ```
3369
5677
  *
3370
5678
  * @param params - Parameters for request
3371
5679
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3380,6 +5688,56 @@ export declare namespace alloydb_v1beta {
3380
5688
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
3381
5689
  /**
3382
5690
  * Gets details of a single User.
5691
+ * @example
5692
+ * ```js
5693
+ * // Before running the sample:
5694
+ * // - Enable the API at:
5695
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5696
+ * // - Login into gcloud by running:
5697
+ * // ```sh
5698
+ * // $ gcloud auth application-default login
5699
+ * // ```
5700
+ * // - Install the npm module by running:
5701
+ * // ```sh
5702
+ * // $ npm install googleapis
5703
+ * // ```
5704
+ *
5705
+ * const {google} = require('googleapis');
5706
+ * const alloydb = google.alloydb('v1beta');
5707
+ *
5708
+ * async function main() {
5709
+ * const auth = new google.auth.GoogleAuth({
5710
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5711
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5712
+ * });
5713
+ *
5714
+ * // Acquire an auth client, and bind it to all future calls
5715
+ * const authClient = await auth.getClient();
5716
+ * google.options({auth: authClient});
5717
+ *
5718
+ * // Do the magic
5719
+ * const res = await alloydb.projects.locations.clusters.users.get({
5720
+ * // Required. The name of the resource. For the required format, see the comment on the User.name field.
5721
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/users/my-user',
5722
+ * });
5723
+ * console.log(res.data);
5724
+ *
5725
+ * // Example response
5726
+ * // {
5727
+ * // "databaseRoles": [],
5728
+ * // "keepExtraRoles": false,
5729
+ * // "name": "my_name",
5730
+ * // "password": "my_password",
5731
+ * // "userType": "my_userType"
5732
+ * // }
5733
+ * }
5734
+ *
5735
+ * main().catch(e => {
5736
+ * console.error(e);
5737
+ * throw e;
5738
+ * });
5739
+ *
5740
+ * ```
3383
5741
  *
3384
5742
  * @param params - Parameters for request
3385
5743
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3394,6 +5752,62 @@ export declare namespace alloydb_v1beta {
3394
5752
  get(callback: BodyResponseCallback<Schema$User>): void;
3395
5753
  /**
3396
5754
  * Lists Users in a given project and location.
5755
+ * @example
5756
+ * ```js
5757
+ * // Before running the sample:
5758
+ * // - Enable the API at:
5759
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5760
+ * // - Login into gcloud by running:
5761
+ * // ```sh
5762
+ * // $ gcloud auth application-default login
5763
+ * // ```
5764
+ * // - Install the npm module by running:
5765
+ * // ```sh
5766
+ * // $ npm install googleapis
5767
+ * // ```
5768
+ *
5769
+ * const {google} = require('googleapis');
5770
+ * const alloydb = google.alloydb('v1beta');
5771
+ *
5772
+ * async function main() {
5773
+ * const auth = new google.auth.GoogleAuth({
5774
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5775
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5776
+ * });
5777
+ *
5778
+ * // Acquire an auth client, and bind it to all future calls
5779
+ * const authClient = await auth.getClient();
5780
+ * google.options({auth: authClient});
5781
+ *
5782
+ * // Do the magic
5783
+ * const res = await alloydb.projects.locations.clusters.users.list({
5784
+ * // Optional. Filtering results
5785
+ * filter: 'placeholder-value',
5786
+ * // Optional. Hint for how to order the results
5787
+ * orderBy: 'placeholder-value',
5788
+ * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
5789
+ * pageSize: 'placeholder-value',
5790
+ * // Optional. A token identifying a page of results the server should return.
5791
+ * pageToken: 'placeholder-value',
5792
+ * // Required. Parent value for ListUsersRequest
5793
+ * parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
5794
+ * });
5795
+ * console.log(res.data);
5796
+ *
5797
+ * // Example response
5798
+ * // {
5799
+ * // "nextPageToken": "my_nextPageToken",
5800
+ * // "unreachable": [],
5801
+ * // "users": []
5802
+ * // }
5803
+ * }
5804
+ *
5805
+ * main().catch(e => {
5806
+ * console.error(e);
5807
+ * throw e;
5808
+ * });
5809
+ *
5810
+ * ```
3397
5811
  *
3398
5812
  * @param params - Parameters for request
3399
5813
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3408,6 +5822,76 @@ export declare namespace alloydb_v1beta {
3408
5822
  list(callback: BodyResponseCallback<Schema$ListUsersResponse>): void;
3409
5823
  /**
3410
5824
  * Updates the parameters of a single User.
5825
+ * @example
5826
+ * ```js
5827
+ * // Before running the sample:
5828
+ * // - Enable the API at:
5829
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5830
+ * // - Login into gcloud by running:
5831
+ * // ```sh
5832
+ * // $ gcloud auth application-default login
5833
+ * // ```
5834
+ * // - Install the npm module by running:
5835
+ * // ```sh
5836
+ * // $ npm install googleapis
5837
+ * // ```
5838
+ *
5839
+ * const {google} = require('googleapis');
5840
+ * const alloydb = google.alloydb('v1beta');
5841
+ *
5842
+ * async function main() {
5843
+ * const auth = new google.auth.GoogleAuth({
5844
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5845
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5846
+ * });
5847
+ *
5848
+ * // Acquire an auth client, and bind it to all future calls
5849
+ * const authClient = await auth.getClient();
5850
+ * google.options({auth: authClient});
5851
+ *
5852
+ * // Do the magic
5853
+ * const res = await alloydb.projects.locations.clusters.users.patch({
5854
+ * // Optional. Allow missing fields in the update mask.
5855
+ * allowMissing: 'placeholder-value',
5856
+ * // Output only. Name of the resource in the form of projects/{project\}/locations/{location\}/cluster/{cluster\}/users/{user\}.
5857
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/users/my-user',
5858
+ * // 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).
5859
+ * requestId: 'placeholder-value',
5860
+ * // 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.
5861
+ * updateMask: 'placeholder-value',
5862
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
5863
+ * validateOnly: 'placeholder-value',
5864
+ *
5865
+ * // Request body metadata
5866
+ * requestBody: {
5867
+ * // request body parameters
5868
+ * // {
5869
+ * // "databaseRoles": [],
5870
+ * // "keepExtraRoles": false,
5871
+ * // "name": "my_name",
5872
+ * // "password": "my_password",
5873
+ * // "userType": "my_userType"
5874
+ * // }
5875
+ * },
5876
+ * });
5877
+ * console.log(res.data);
5878
+ *
5879
+ * // Example response
5880
+ * // {
5881
+ * // "databaseRoles": [],
5882
+ * // "keepExtraRoles": false,
5883
+ * // "name": "my_name",
5884
+ * // "password": "my_password",
5885
+ * // "userType": "my_userType"
5886
+ * // }
5887
+ * }
5888
+ *
5889
+ * main().catch(e => {
5890
+ * console.error(e);
5891
+ * throw e;
5892
+ * });
5893
+ *
5894
+ * ```
3411
5895
  *
3412
5896
  * @param params - Parameters for request
3413
5897
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3516,6 +6000,50 @@ export declare namespace alloydb_v1beta {
3516
6000
  constructor(context: APIRequestContext);
3517
6001
  /**
3518
6002
  * 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`.
6003
+ * @example
6004
+ * ```js
6005
+ * // Before running the sample:
6006
+ * // - Enable the API at:
6007
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
6008
+ * // - Login into gcloud by running:
6009
+ * // ```sh
6010
+ * // $ gcloud auth application-default login
6011
+ * // ```
6012
+ * // - Install the npm module by running:
6013
+ * // ```sh
6014
+ * // $ npm install googleapis
6015
+ * // ```
6016
+ *
6017
+ * const {google} = require('googleapis');
6018
+ * const alloydb = google.alloydb('v1beta');
6019
+ *
6020
+ * async function main() {
6021
+ * const auth = new google.auth.GoogleAuth({
6022
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6023
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
6024
+ * });
6025
+ *
6026
+ * // Acquire an auth client, and bind it to all future calls
6027
+ * const authClient = await auth.getClient();
6028
+ * google.options({auth: authClient});
6029
+ *
6030
+ * // Do the magic
6031
+ * const res = await alloydb.projects.locations.operations.cancel({
6032
+ * // The name of the operation resource to be cancelled.
6033
+ * name: 'projects/my-project/locations/my-location/operations/my-operation',
6034
+ * });
6035
+ * console.log(res.data);
6036
+ *
6037
+ * // Example response
6038
+ * // {}
6039
+ * }
6040
+ *
6041
+ * main().catch(e => {
6042
+ * console.error(e);
6043
+ * throw e;
6044
+ * });
6045
+ *
6046
+ * ```
3519
6047
  *
3520
6048
  * @param params - Parameters for request
3521
6049
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3530,6 +6058,50 @@ export declare namespace alloydb_v1beta {
3530
6058
  cancel(callback: BodyResponseCallback<Schema$Empty>): void;
3531
6059
  /**
3532
6060
  * 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`.
6061
+ * @example
6062
+ * ```js
6063
+ * // Before running the sample:
6064
+ * // - Enable the API at:
6065
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
6066
+ * // - Login into gcloud by running:
6067
+ * // ```sh
6068
+ * // $ gcloud auth application-default login
6069
+ * // ```
6070
+ * // - Install the npm module by running:
6071
+ * // ```sh
6072
+ * // $ npm install googleapis
6073
+ * // ```
6074
+ *
6075
+ * const {google} = require('googleapis');
6076
+ * const alloydb = google.alloydb('v1beta');
6077
+ *
6078
+ * async function main() {
6079
+ * const auth = new google.auth.GoogleAuth({
6080
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6081
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
6082
+ * });
6083
+ *
6084
+ * // Acquire an auth client, and bind it to all future calls
6085
+ * const authClient = await auth.getClient();
6086
+ * google.options({auth: authClient});
6087
+ *
6088
+ * // Do the magic
6089
+ * const res = await alloydb.projects.locations.operations.delete({
6090
+ * // The name of the operation resource to be deleted.
6091
+ * name: 'projects/my-project/locations/my-location/operations/my-operation',
6092
+ * });
6093
+ * console.log(res.data);
6094
+ *
6095
+ * // Example response
6096
+ * // {}
6097
+ * }
6098
+ *
6099
+ * main().catch(e => {
6100
+ * console.error(e);
6101
+ * throw e;
6102
+ * });
6103
+ *
6104
+ * ```
3533
6105
  *
3534
6106
  * @param params - Parameters for request
3535
6107
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3544,6 +6116,56 @@ export declare namespace alloydb_v1beta {
3544
6116
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
3545
6117
  /**
3546
6118
  * 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.
6119
+ * @example
6120
+ * ```js
6121
+ * // Before running the sample:
6122
+ * // - Enable the API at:
6123
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
6124
+ * // - Login into gcloud by running:
6125
+ * // ```sh
6126
+ * // $ gcloud auth application-default login
6127
+ * // ```
6128
+ * // - Install the npm module by running:
6129
+ * // ```sh
6130
+ * // $ npm install googleapis
6131
+ * // ```
6132
+ *
6133
+ * const {google} = require('googleapis');
6134
+ * const alloydb = google.alloydb('v1beta');
6135
+ *
6136
+ * async function main() {
6137
+ * const auth = new google.auth.GoogleAuth({
6138
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6139
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
6140
+ * });
6141
+ *
6142
+ * // Acquire an auth client, and bind it to all future calls
6143
+ * const authClient = await auth.getClient();
6144
+ * google.options({auth: authClient});
6145
+ *
6146
+ * // Do the magic
6147
+ * const res = await alloydb.projects.locations.operations.get({
6148
+ * // The name of the operation resource.
6149
+ * name: 'projects/my-project/locations/my-location/operations/my-operation',
6150
+ * });
6151
+ * console.log(res.data);
6152
+ *
6153
+ * // Example response
6154
+ * // {
6155
+ * // "done": false,
6156
+ * // "error": {},
6157
+ * // "metadata": {},
6158
+ * // "name": "my_name",
6159
+ * // "response": {}
6160
+ * // }
6161
+ * }
6162
+ *
6163
+ * main().catch(e => {
6164
+ * console.error(e);
6165
+ * throw e;
6166
+ * });
6167
+ *
6168
+ * ```
3547
6169
  *
3548
6170
  * @param params - Parameters for request
3549
6171
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3558,6 +6180,59 @@ export declare namespace alloydb_v1beta {
3558
6180
  get(callback: BodyResponseCallback<Schema$Operation>): void;
3559
6181
  /**
3560
6182
  * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
6183
+ * @example
6184
+ * ```js
6185
+ * // Before running the sample:
6186
+ * // - Enable the API at:
6187
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
6188
+ * // - Login into gcloud by running:
6189
+ * // ```sh
6190
+ * // $ gcloud auth application-default login
6191
+ * // ```
6192
+ * // - Install the npm module by running:
6193
+ * // ```sh
6194
+ * // $ npm install googleapis
6195
+ * // ```
6196
+ *
6197
+ * const {google} = require('googleapis');
6198
+ * const alloydb = google.alloydb('v1beta');
6199
+ *
6200
+ * async function main() {
6201
+ * const auth = new google.auth.GoogleAuth({
6202
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6203
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
6204
+ * });
6205
+ *
6206
+ * // Acquire an auth client, and bind it to all future calls
6207
+ * const authClient = await auth.getClient();
6208
+ * google.options({auth: authClient});
6209
+ *
6210
+ * // Do the magic
6211
+ * const res = await alloydb.projects.locations.operations.list({
6212
+ * // The standard list filter.
6213
+ * filter: 'placeholder-value',
6214
+ * // The name of the operation's parent resource.
6215
+ * name: 'projects/my-project/locations/my-location',
6216
+ * // The standard list page size.
6217
+ * pageSize: 'placeholder-value',
6218
+ * // The standard list page token.
6219
+ * pageToken: 'placeholder-value',
6220
+ * });
6221
+ * console.log(res.data);
6222
+ *
6223
+ * // Example response
6224
+ * // {
6225
+ * // "nextPageToken": "my_nextPageToken",
6226
+ * // "operations": []
6227
+ * // }
6228
+ * }
6229
+ *
6230
+ * main().catch(e => {
6231
+ * console.error(e);
6232
+ * throw e;
6233
+ * });
6234
+ *
6235
+ * ```
3561
6236
  *
3562
6237
  * @param params - Parameters for request
3563
6238
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3612,6 +6287,59 @@ export declare namespace alloydb_v1beta {
3612
6287
  constructor(context: APIRequestContext);
3613
6288
  /**
3614
6289
  * Lists SupportedDatabaseFlags for a given project and location.
6290
+ * @example
6291
+ * ```js
6292
+ * // Before running the sample:
6293
+ * // - Enable the API at:
6294
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
6295
+ * // - Login into gcloud by running:
6296
+ * // ```sh
6297
+ * // $ gcloud auth application-default login
6298
+ * // ```
6299
+ * // - Install the npm module by running:
6300
+ * // ```sh
6301
+ * // $ npm install googleapis
6302
+ * // ```
6303
+ *
6304
+ * const {google} = require('googleapis');
6305
+ * const alloydb = google.alloydb('v1beta');
6306
+ *
6307
+ * async function main() {
6308
+ * const auth = new google.auth.GoogleAuth({
6309
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6310
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
6311
+ * });
6312
+ *
6313
+ * // Acquire an auth client, and bind it to all future calls
6314
+ * const authClient = await auth.getClient();
6315
+ * google.options({auth: authClient});
6316
+ *
6317
+ * // Do the magic
6318
+ * const res = await alloydb.projects.locations.supportedDatabaseFlags.list({
6319
+ * // Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
6320
+ * pageSize: 'placeholder-value',
6321
+ * // A token identifying a page of results the server should return.
6322
+ * pageToken: 'placeholder-value',
6323
+ * // 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.
6324
+ * parent: 'projects/my-project/locations/my-location',
6325
+ * // Optional. The scope for which supported flags are requested. If not specified, default is DATABASE.
6326
+ * scope: 'placeholder-value',
6327
+ * });
6328
+ * console.log(res.data);
6329
+ *
6330
+ * // Example response
6331
+ * // {
6332
+ * // "nextPageToken": "my_nextPageToken",
6333
+ * // "supportedDatabaseFlags": []
6334
+ * // }
6335
+ * }
6336
+ *
6337
+ * main().catch(e => {
6338
+ * console.error(e);
6339
+ * throw e;
6340
+ * });
6341
+ *
6342
+ * ```
3615
6343
  *
3616
6344
  * @param params - Parameters for request
3617
6345
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.