@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/v1beta.ts CHANGED
@@ -440,6 +440,10 @@ export namespace alloydb_v1beta {
440
440
  * Cross Region replication config specific to SECONDARY cluster.
441
441
  */
442
442
  secondaryConfig?: Schema$SecondaryConfig;
443
+ /**
444
+ * 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.
445
+ */
446
+ serviceAccountEmail?: string | null;
443
447
  /**
444
448
  * SSL configuration for this AlloyDB cluster.
445
449
  */
@@ -532,7 +536,7 @@ export namespace alloydb_v1beta {
532
536
  */
533
537
  export interface Schema$ConnectionPoolConfig {
534
538
  /**
535
- * Optional. Deprecated. Use 'flags' instead. The default pool size. Defaults to 20.
539
+ * 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.
536
540
  */
537
541
  defaultPoolSize?: string | null;
538
542
  /**
@@ -548,35 +552,39 @@ export namespace alloydb_v1beta {
548
552
  */
549
553
  flags?: {[key: string]: string} | null;
550
554
  /**
551
- * Optional. Deprecated. Use 'flags' instead. The list of startup parameters to ignore. Defaults to ["extra_float_digits"]
555
+ * 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.
552
556
  */
553
557
  ignoreStartupParameters?: string[] | null;
554
558
  /**
555
- * Optional. Deprecated. Use 'flags' instead. The maximum number of client connections allowed.
559
+ * 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.
556
560
  */
557
561
  maxClientConn?: string | null;
558
562
  /**
559
- * 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.
563
+ * 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.
560
564
  */
561
565
  maxPreparedStatements?: string | null;
562
566
  /**
563
- * Optional. Deprecated. Use 'flags' instead. The minimum pool size. Defaults to 0.
567
+ * 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.
564
568
  */
565
569
  minPoolSize?: string | null;
566
570
  /**
567
- * Optional. Deprecated. Use 'flags' instead. The pool mode. Defaults to `POOL_MODE_TRANSACTION`.
571
+ * Output only. The number of running poolers per instance.
572
+ */
573
+ poolerCount?: number | null;
574
+ /**
575
+ * 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.
568
576
  */
569
577
  poolMode?: string | null;
570
578
  /**
571
- * 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.
579
+ * 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.
572
580
  */
573
581
  queryWaitTimeout?: string | null;
574
582
  /**
575
- * Optional. Deprecated. Use 'flags' instead. The maximum number of seconds a server is allowed to be idle before it is disconnected. 0 disables.
583
+ * 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.
576
584
  */
577
585
  serverIdleTimeout?: string | null;
578
586
  /**
579
- * 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.
587
+ * 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.
580
588
  */
581
589
  statsUsers?: string[] | null;
582
590
  }
@@ -602,7 +610,7 @@ export namespace alloydb_v1beta {
602
610
  */
603
611
  export interface Schema$ContinuousBackupInfo {
604
612
  /**
605
- * Output only. The earliest restorable time that can be restored to. Output only field.
613
+ * 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.
606
614
  */
607
615
  earliestRestorableTime?: string | null;
608
616
  /**
@@ -614,7 +622,7 @@ export namespace alloydb_v1beta {
614
622
  */
615
623
  encryptionInfo?: Schema$EncryptionInfo;
616
624
  /**
617
- * Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.
625
+ * Output only. Days of the week on which a continuous backup is taken.
618
626
  */
619
627
  schedule?: string[] | null;
620
628
  }
@@ -773,7 +781,7 @@ export namespace alloydb_v1beta {
773
781
  uri?: string | null;
774
782
  }
775
783
  /**
776
- * Deprecated and unused. This field will be removed in the near future.
784
+ * Deprecated and unused. This message will be removed in the near future.
777
785
  */
778
786
  export interface Schema$GeminiClusterConfig {
779
787
  /**
@@ -782,7 +790,7 @@ export namespace alloydb_v1beta {
782
790
  entitled?: boolean | null;
783
791
  }
784
792
  /**
785
- * Deprecated and unused. This field will be removed in the near future.
793
+ * Deprecated and unused. This message will be removed in the near future.
786
794
  */
787
795
  export interface Schema$GeminiInstanceConfig {
788
796
  /**
@@ -1049,6 +1057,10 @@ export namespace alloydb_v1beta {
1049
1057
  * Metadata related to instance-level network configuration.
1050
1058
  */
1051
1059
  export interface Schema$InstanceNetworkConfig {
1060
+ /**
1061
+ * 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])?.
1062
+ */
1063
+ allocatedIpRangeOverride?: string | null;
1052
1064
  /**
1053
1065
  * Optional. A list of external network authorized to access this instance.
1054
1066
  */
@@ -1067,7 +1079,7 @@ export namespace alloydb_v1beta {
1067
1079
  network?: string | null;
1068
1080
  }
1069
1081
  /**
1070
- * Details regarding the upgrade of instaces associated with a cluster.
1082
+ * Details regarding the upgrade of instances associated with a cluster.
1071
1083
  */
1072
1084
  export interface Schema$InstanceUpgradeDetails {
1073
1085
  /**
@@ -1321,6 +1333,10 @@ export namespace alloydb_v1beta {
1321
1333
  * Track actively running queries on the instance. If not set, this flag is "off" by default.
1322
1334
  */
1323
1335
  trackActiveQueries?: boolean | null;
1336
+ /**
1337
+ * Track client address for an instance. If not set, default value is "off".
1338
+ */
1339
+ trackClientAddress?: boolean | null;
1324
1340
  /**
1325
1341
  * 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.
1326
1342
  */
@@ -1675,6 +1691,27 @@ export namespace alloydb_v1beta {
1675
1691
  */
1676
1692
  status?: string | null;
1677
1693
  }
1694
+ /**
1695
+ * Timing information for the stage execution.
1696
+ */
1697
+ export interface Schema$StageSchedule {
1698
+ /**
1699
+ * Actual end time of the stage. Set only if the stage has completed.
1700
+ */
1701
+ actualEndTime?: string | null;
1702
+ /**
1703
+ * Actual start time of the stage. Set only if the stage has started.
1704
+ */
1705
+ actualStartTime?: string | null;
1706
+ /**
1707
+ * When the stage is expected to end. Set only if the stage has not completed yet.
1708
+ */
1709
+ estimatedEndTime?: string | null;
1710
+ /**
1711
+ * When the stage is expected to start. Set only if the stage has not started yet.
1712
+ */
1713
+ estimatedStartTime?: string | null;
1714
+ }
1678
1715
  /**
1679
1716
  * Status of an upgrade stage.
1680
1717
  */
@@ -1683,6 +1720,10 @@ export namespace alloydb_v1beta {
1683
1720
  * Read pool instances upgrade metadata.
1684
1721
  */
1685
1722
  readPoolInstancesUpgrade?: Schema$ReadPoolInstancesUpgradeStageStatus;
1723
+ /**
1724
+ * Output only. Timing information for the stage execution.
1725
+ */
1726
+ schedule?: Schema$StageSchedule;
1686
1727
  /**
1687
1728
  * Upgrade stage.
1688
1729
  */
@@ -1766,6 +1807,15 @@ export namespace alloydb_v1beta {
1766
1807
  */
1767
1808
  pointInTimeRecoveryEnabled?: boolean | null;
1768
1809
  }
1810
+ /**
1811
+ * BackupDRConfiguration to capture the backup and disaster recovery details of database resource.
1812
+ */
1813
+ export interface Schema$StorageDatabasecenterPartnerapiV1mainBackupDRConfiguration {
1814
+ /**
1815
+ * Indicates if the resource is managed by BackupDR.
1816
+ */
1817
+ backupdrManaged?: boolean | null;
1818
+ }
1769
1819
  /**
1770
1820
  * A backup run.
1771
1821
  */
@@ -1800,6 +1850,31 @@ export namespace alloydb_v1beta {
1800
1850
  */
1801
1851
  version?: string | null;
1802
1852
  }
1853
+ /**
1854
+ * 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.
1855
+ */
1856
+ export interface Schema$StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData {
1857
+ /**
1858
+ * Required. Full Resource name of the source resource.
1859
+ */
1860
+ fullResourceName?: string | null;
1861
+ /**
1862
+ * Required. Last time signal was refreshed
1863
+ */
1864
+ lastRefreshTime?: string | null;
1865
+ /**
1866
+ * Database resource id.
1867
+ */
1868
+ resourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId;
1869
+ /**
1870
+ * Signal data for boolean signals.
1871
+ */
1872
+ signalBoolValue?: boolean | null;
1873
+ /**
1874
+ * Required. Signal type of the signal
1875
+ */
1876
+ signalType?: string | null;
1877
+ }
1803
1878
  /**
1804
1879
  * 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
1805
1880
  */
@@ -1810,9 +1885,13 @@ export namespace alloydb_v1beta {
1810
1885
  internalResourceMetadata?: Schema$StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata[];
1811
1886
  }
1812
1887
  /**
1813
- * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform.
1888
+ * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 9
1814
1889
  */
1815
1890
  export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed {
1891
+ /**
1892
+ * Config based signal data is used to ingest signals that are generated based on the configuration of the database resource.
1893
+ */
1894
+ configBasedSignalData?: Schema$StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData;
1816
1895
  /**
1817
1896
  * Required. Timestamp when feed is generated.
1818
1897
  */
@@ -1854,6 +1933,10 @@ export namespace alloydb_v1beta {
1854
1933
  * 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.
1855
1934
  */
1856
1935
  externalUri?: string | null;
1936
+ /**
1937
+ * This is used to identify the location of the resource. Example: "us-central1"
1938
+ */
1939
+ location?: string | null;
1857
1940
  /**
1858
1941
  * Required. The name of the signal, ex: PUBLIC_SQL_INSTANCE, SQL_LOG_ERROR_VERBOSITY etc.
1859
1942
  */
@@ -1901,7 +1984,7 @@ export namespace alloydb_v1beta {
1901
1984
  */
1902
1985
  providerDescription?: string | null;
1903
1986
  /**
1904
- * 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
1987
+ * 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
1905
1988
  */
1906
1989
  resourceType?: string | null;
1907
1990
  /**
@@ -1910,7 +1993,7 @@ export namespace alloydb_v1beta {
1910
1993
  uniqueId?: string | null;
1911
1994
  }
1912
1995
  /**
1913
- * Common model for database resource instance metadata. Next ID: 25
1996
+ * Common model for database resource instance metadata. Next ID: 26
1914
1997
  */
1915
1998
  export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata {
1916
1999
  /**
@@ -1921,6 +2004,10 @@ export namespace alloydb_v1beta {
1921
2004
  * Backup configuration for this instance
1922
2005
  */
1923
2006
  backupConfiguration?: Schema$StorageDatabasecenterPartnerapiV1mainBackupConfiguration;
2007
+ /**
2008
+ * Optional. BackupDR Configuration for the resource.
2009
+ */
2010
+ backupdrConfiguration?: Schema$StorageDatabasecenterPartnerapiV1mainBackupDRConfiguration;
1924
2011
  /**
1925
2012
  * Latest backup run information for this instance
1926
2013
  */
@@ -2184,6 +2271,10 @@ export namespace alloydb_v1beta {
2184
2271
  * The specific engine that the underlying database is running.
2185
2272
  */
2186
2273
  engine?: string | null;
2274
+ /**
2275
+ * 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..
2276
+ */
2277
+ minorVersion?: string | null;
2187
2278
  /**
2188
2279
  * Type of specific database product. It could be CloudSQL, AlloyDB etc..
2189
2280
  */
@@ -2464,6 +2555,56 @@ export namespace alloydb_v1beta {
2464
2555
 
2465
2556
  /**
2466
2557
  * Gets information about a location.
2558
+ * @example
2559
+ * ```js
2560
+ * // Before running the sample:
2561
+ * // - Enable the API at:
2562
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
2563
+ * // - Login into gcloud by running:
2564
+ * // ```sh
2565
+ * // $ gcloud auth application-default login
2566
+ * // ```
2567
+ * // - Install the npm module by running:
2568
+ * // ```sh
2569
+ * // $ npm install googleapis
2570
+ * // ```
2571
+ *
2572
+ * const {google} = require('googleapis');
2573
+ * const alloydb = google.alloydb('v1beta');
2574
+ *
2575
+ * async function main() {
2576
+ * const auth = new google.auth.GoogleAuth({
2577
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2578
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2579
+ * });
2580
+ *
2581
+ * // Acquire an auth client, and bind it to all future calls
2582
+ * const authClient = await auth.getClient();
2583
+ * google.options({auth: authClient});
2584
+ *
2585
+ * // Do the magic
2586
+ * const res = await alloydb.projects.locations.get({
2587
+ * // Resource name for the location.
2588
+ * name: 'projects/my-project/locations/my-location',
2589
+ * });
2590
+ * console.log(res.data);
2591
+ *
2592
+ * // Example response
2593
+ * // {
2594
+ * // "displayName": "my_displayName",
2595
+ * // "labels": {},
2596
+ * // "locationId": "my_locationId",
2597
+ * // "metadata": {},
2598
+ * // "name": "my_name"
2599
+ * // }
2600
+ * }
2601
+ *
2602
+ * main().catch(e => {
2603
+ * console.error(e);
2604
+ * throw e;
2605
+ * });
2606
+ *
2607
+ * ```
2467
2608
  *
2468
2609
  * @param params - Parameters for request
2469
2610
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2556,6 +2697,61 @@ export namespace alloydb_v1beta {
2556
2697
 
2557
2698
  /**
2558
2699
  * Lists information about the supported locations for this service.
2700
+ * @example
2701
+ * ```js
2702
+ * // Before running the sample:
2703
+ * // - Enable the API at:
2704
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
2705
+ * // - Login into gcloud by running:
2706
+ * // ```sh
2707
+ * // $ gcloud auth application-default login
2708
+ * // ```
2709
+ * // - Install the npm module by running:
2710
+ * // ```sh
2711
+ * // $ npm install googleapis
2712
+ * // ```
2713
+ *
2714
+ * const {google} = require('googleapis');
2715
+ * const alloydb = google.alloydb('v1beta');
2716
+ *
2717
+ * async function main() {
2718
+ * const auth = new google.auth.GoogleAuth({
2719
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2720
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2721
+ * });
2722
+ *
2723
+ * // Acquire an auth client, and bind it to all future calls
2724
+ * const authClient = await auth.getClient();
2725
+ * google.options({auth: authClient});
2726
+ *
2727
+ * // Do the magic
2728
+ * const res = await alloydb.projects.locations.list({
2729
+ * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.
2730
+ * extraLocationTypes: 'placeholder-value',
2731
+ * // 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).
2732
+ * filter: 'placeholder-value',
2733
+ * // The resource that owns the locations collection, if applicable.
2734
+ * name: 'projects/my-project',
2735
+ * // The maximum number of results to return. If not set, the service selects a default.
2736
+ * pageSize: 'placeholder-value',
2737
+ * // A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
2738
+ * pageToken: 'placeholder-value',
2739
+ * });
2740
+ * console.log(res.data);
2741
+ *
2742
+ * // Example response
2743
+ * // {
2744
+ * // "locations": [],
2745
+ * // "nextPageToken": "my_nextPageToken"
2746
+ * // }
2747
+ * }
2748
+ *
2749
+ * main().catch(e => {
2750
+ * console.error(e);
2751
+ * throw e;
2752
+ * });
2753
+ *
2754
+ * ```
2559
2755
  *
2560
2756
  * @param params - Parameters for request
2561
2757
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2695,6 +2891,93 @@ export namespace alloydb_v1beta {
2695
2891
 
2696
2892
  /**
2697
2893
  * Creates a new Backup in a given project and location.
2894
+ * @example
2895
+ * ```js
2896
+ * // Before running the sample:
2897
+ * // - Enable the API at:
2898
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
2899
+ * // - Login into gcloud by running:
2900
+ * // ```sh
2901
+ * // $ gcloud auth application-default login
2902
+ * // ```
2903
+ * // - Install the npm module by running:
2904
+ * // ```sh
2905
+ * // $ npm install googleapis
2906
+ * // ```
2907
+ *
2908
+ * const {google} = require('googleapis');
2909
+ * const alloydb = google.alloydb('v1beta');
2910
+ *
2911
+ * async function main() {
2912
+ * const auth = new google.auth.GoogleAuth({
2913
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2914
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2915
+ * });
2916
+ *
2917
+ * // Acquire an auth client, and bind it to all future calls
2918
+ * const authClient = await auth.getClient();
2919
+ * google.options({auth: authClient});
2920
+ *
2921
+ * // Do the magic
2922
+ * const res = await alloydb.projects.locations.backups.create({
2923
+ * // Required. ID of the requesting object.
2924
+ * backupId: 'placeholder-value',
2925
+ * // Required. Value for parent.
2926
+ * parent: 'projects/my-project/locations/my-location',
2927
+ * // 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).
2928
+ * requestId: 'placeholder-value',
2929
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
2930
+ * validateOnly: 'placeholder-value',
2931
+ *
2932
+ * // Request body metadata
2933
+ * requestBody: {
2934
+ * // request body parameters
2935
+ * // {
2936
+ * // "annotations": {},
2937
+ * // "clusterName": "my_clusterName",
2938
+ * // "clusterUid": "my_clusterUid",
2939
+ * // "createCompletionTime": "my_createCompletionTime",
2940
+ * // "createTime": "my_createTime",
2941
+ * // "databaseVersion": "my_databaseVersion",
2942
+ * // "deleteTime": "my_deleteTime",
2943
+ * // "description": "my_description",
2944
+ * // "displayName": "my_displayName",
2945
+ * // "encryptionConfig": {},
2946
+ * // "encryptionInfo": {},
2947
+ * // "etag": "my_etag",
2948
+ * // "expiryQuantity": {},
2949
+ * // "expiryTime": "my_expiryTime",
2950
+ * // "labels": {},
2951
+ * // "name": "my_name",
2952
+ * // "reconciling": false,
2953
+ * // "satisfiesPzs": false,
2954
+ * // "sizeBytes": "my_sizeBytes",
2955
+ * // "state": "my_state",
2956
+ * // "tags": {},
2957
+ * // "type": "my_type",
2958
+ * // "uid": "my_uid",
2959
+ * // "updateTime": "my_updateTime"
2960
+ * // }
2961
+ * },
2962
+ * });
2963
+ * console.log(res.data);
2964
+ *
2965
+ * // Example response
2966
+ * // {
2967
+ * // "done": false,
2968
+ * // "error": {},
2969
+ * // "metadata": {},
2970
+ * // "name": "my_name",
2971
+ * // "response": {}
2972
+ * // }
2973
+ * }
2974
+ *
2975
+ * main().catch(e => {
2976
+ * console.error(e);
2977
+ * throw e;
2978
+ * });
2979
+ *
2980
+ * ```
2698
2981
  *
2699
2982
  * @param params - Parameters for request
2700
2983
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2786,6 +3069,62 @@ export namespace alloydb_v1beta {
2786
3069
 
2787
3070
  /**
2788
3071
  * Deletes a single Backup.
3072
+ * @example
3073
+ * ```js
3074
+ * // Before running the sample:
3075
+ * // - Enable the API at:
3076
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3077
+ * // - Login into gcloud by running:
3078
+ * // ```sh
3079
+ * // $ gcloud auth application-default login
3080
+ * // ```
3081
+ * // - Install the npm module by running:
3082
+ * // ```sh
3083
+ * // $ npm install googleapis
3084
+ * // ```
3085
+ *
3086
+ * const {google} = require('googleapis');
3087
+ * const alloydb = google.alloydb('v1beta');
3088
+ *
3089
+ * async function main() {
3090
+ * const auth = new google.auth.GoogleAuth({
3091
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3092
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3093
+ * });
3094
+ *
3095
+ * // Acquire an auth client, and bind it to all future calls
3096
+ * const authClient = await auth.getClient();
3097
+ * google.options({auth: authClient});
3098
+ *
3099
+ * // Do the magic
3100
+ * const res = await alloydb.projects.locations.backups.delete({
3101
+ * // 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.
3102
+ * etag: 'placeholder-value',
3103
+ * // Required. Name of the resource. For the required format, see the comment on the Backup.name field.
3104
+ * name: 'projects/my-project/locations/my-location/backups/my-backup',
3105
+ * // 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).
3106
+ * requestId: 'placeholder-value',
3107
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
3108
+ * validateOnly: 'placeholder-value',
3109
+ * });
3110
+ * console.log(res.data);
3111
+ *
3112
+ * // Example response
3113
+ * // {
3114
+ * // "done": false,
3115
+ * // "error": {},
3116
+ * // "metadata": {},
3117
+ * // "name": "my_name",
3118
+ * // "response": {}
3119
+ * // }
3120
+ * }
3121
+ *
3122
+ * main().catch(e => {
3123
+ * console.error(e);
3124
+ * throw e;
3125
+ * });
3126
+ *
3127
+ * ```
2789
3128
  *
2790
3129
  * @param params - Parameters for request
2791
3130
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2874,6 +3213,75 @@ export namespace alloydb_v1beta {
2874
3213
 
2875
3214
  /**
2876
3215
  * Gets details of a single Backup.
3216
+ * @example
3217
+ * ```js
3218
+ * // Before running the sample:
3219
+ * // - Enable the API at:
3220
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3221
+ * // - Login into gcloud by running:
3222
+ * // ```sh
3223
+ * // $ gcloud auth application-default login
3224
+ * // ```
3225
+ * // - Install the npm module by running:
3226
+ * // ```sh
3227
+ * // $ npm install googleapis
3228
+ * // ```
3229
+ *
3230
+ * const {google} = require('googleapis');
3231
+ * const alloydb = google.alloydb('v1beta');
3232
+ *
3233
+ * async function main() {
3234
+ * const auth = new google.auth.GoogleAuth({
3235
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3236
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3237
+ * });
3238
+ *
3239
+ * // Acquire an auth client, and bind it to all future calls
3240
+ * const authClient = await auth.getClient();
3241
+ * google.options({auth: authClient});
3242
+ *
3243
+ * // Do the magic
3244
+ * const res = await alloydb.projects.locations.backups.get({
3245
+ * // Required. Name of the resource
3246
+ * name: 'projects/my-project/locations/my-location/backups/my-backup',
3247
+ * });
3248
+ * console.log(res.data);
3249
+ *
3250
+ * // Example response
3251
+ * // {
3252
+ * // "annotations": {},
3253
+ * // "clusterName": "my_clusterName",
3254
+ * // "clusterUid": "my_clusterUid",
3255
+ * // "createCompletionTime": "my_createCompletionTime",
3256
+ * // "createTime": "my_createTime",
3257
+ * // "databaseVersion": "my_databaseVersion",
3258
+ * // "deleteTime": "my_deleteTime",
3259
+ * // "description": "my_description",
3260
+ * // "displayName": "my_displayName",
3261
+ * // "encryptionConfig": {},
3262
+ * // "encryptionInfo": {},
3263
+ * // "etag": "my_etag",
3264
+ * // "expiryQuantity": {},
3265
+ * // "expiryTime": "my_expiryTime",
3266
+ * // "labels": {},
3267
+ * // "name": "my_name",
3268
+ * // "reconciling": false,
3269
+ * // "satisfiesPzs": false,
3270
+ * // "sizeBytes": "my_sizeBytes",
3271
+ * // "state": "my_state",
3272
+ * // "tags": {},
3273
+ * // "type": "my_type",
3274
+ * // "uid": "my_uid",
3275
+ * // "updateTime": "my_updateTime"
3276
+ * // }
3277
+ * }
3278
+ *
3279
+ * main().catch(e => {
3280
+ * console.error(e);
3281
+ * throw e;
3282
+ * });
3283
+ *
3284
+ * ```
2877
3285
  *
2878
3286
  * @param params - Parameters for request
2879
3287
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2962,6 +3370,62 @@ export namespace alloydb_v1beta {
2962
3370
 
2963
3371
  /**
2964
3372
  * Lists Backups in a given project and location.
3373
+ * @example
3374
+ * ```js
3375
+ * // Before running the sample:
3376
+ * // - Enable the API at:
3377
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3378
+ * // - Login into gcloud by running:
3379
+ * // ```sh
3380
+ * // $ gcloud auth application-default login
3381
+ * // ```
3382
+ * // - Install the npm module by running:
3383
+ * // ```sh
3384
+ * // $ npm install googleapis
3385
+ * // ```
3386
+ *
3387
+ * const {google} = require('googleapis');
3388
+ * const alloydb = google.alloydb('v1beta');
3389
+ *
3390
+ * async function main() {
3391
+ * const auth = new google.auth.GoogleAuth({
3392
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3393
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3394
+ * });
3395
+ *
3396
+ * // Acquire an auth client, and bind it to all future calls
3397
+ * const authClient = await auth.getClient();
3398
+ * google.options({auth: authClient});
3399
+ *
3400
+ * // Do the magic
3401
+ * const res = await alloydb.projects.locations.backups.list({
3402
+ * // Filtering results
3403
+ * filter: 'placeholder-value',
3404
+ * // Hint for how to order the results
3405
+ * orderBy: 'placeholder-value',
3406
+ * // Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
3407
+ * pageSize: 'placeholder-value',
3408
+ * // A token identifying a page of results the server should return.
3409
+ * pageToken: 'placeholder-value',
3410
+ * // Required. Parent value for ListBackupsRequest
3411
+ * parent: 'projects/my-project/locations/my-location',
3412
+ * });
3413
+ * console.log(res.data);
3414
+ *
3415
+ * // Example response
3416
+ * // {
3417
+ * // "backups": [],
3418
+ * // "nextPageToken": "my_nextPageToken",
3419
+ * // "unreachable": []
3420
+ * // }
3421
+ * }
3422
+ *
3423
+ * main().catch(e => {
3424
+ * console.error(e);
3425
+ * throw e;
3426
+ * });
3427
+ *
3428
+ * ```
2965
3429
  *
2966
3430
  * @param params - Parameters for request
2967
3431
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3053,6 +3517,95 @@ export namespace alloydb_v1beta {
3053
3517
 
3054
3518
  /**
3055
3519
  * Updates the parameters of a single Backup.
3520
+ * @example
3521
+ * ```js
3522
+ * // Before running the sample:
3523
+ * // - Enable the API at:
3524
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3525
+ * // - Login into gcloud by running:
3526
+ * // ```sh
3527
+ * // $ gcloud auth application-default login
3528
+ * // ```
3529
+ * // - Install the npm module by running:
3530
+ * // ```sh
3531
+ * // $ npm install googleapis
3532
+ * // ```
3533
+ *
3534
+ * const {google} = require('googleapis');
3535
+ * const alloydb = google.alloydb('v1beta');
3536
+ *
3537
+ * async function main() {
3538
+ * const auth = new google.auth.GoogleAuth({
3539
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3540
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3541
+ * });
3542
+ *
3543
+ * // Acquire an auth client, and bind it to all future calls
3544
+ * const authClient = await auth.getClient();
3545
+ * google.options({auth: authClient});
3546
+ *
3547
+ * // Do the magic
3548
+ * const res = await alloydb.projects.locations.backups.patch({
3549
+ * // 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.
3550
+ * allowMissing: 'placeholder-value',
3551
+ * // 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\}
3552
+ * name: 'projects/my-project/locations/my-location/backups/my-backup',
3553
+ * // 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).
3554
+ * requestId: 'placeholder-value',
3555
+ * // 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.
3556
+ * updateMask: 'placeholder-value',
3557
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
3558
+ * validateOnly: 'placeholder-value',
3559
+ *
3560
+ * // Request body metadata
3561
+ * requestBody: {
3562
+ * // request body parameters
3563
+ * // {
3564
+ * // "annotations": {},
3565
+ * // "clusterName": "my_clusterName",
3566
+ * // "clusterUid": "my_clusterUid",
3567
+ * // "createCompletionTime": "my_createCompletionTime",
3568
+ * // "createTime": "my_createTime",
3569
+ * // "databaseVersion": "my_databaseVersion",
3570
+ * // "deleteTime": "my_deleteTime",
3571
+ * // "description": "my_description",
3572
+ * // "displayName": "my_displayName",
3573
+ * // "encryptionConfig": {},
3574
+ * // "encryptionInfo": {},
3575
+ * // "etag": "my_etag",
3576
+ * // "expiryQuantity": {},
3577
+ * // "expiryTime": "my_expiryTime",
3578
+ * // "labels": {},
3579
+ * // "name": "my_name",
3580
+ * // "reconciling": false,
3581
+ * // "satisfiesPzs": false,
3582
+ * // "sizeBytes": "my_sizeBytes",
3583
+ * // "state": "my_state",
3584
+ * // "tags": {},
3585
+ * // "type": "my_type",
3586
+ * // "uid": "my_uid",
3587
+ * // "updateTime": "my_updateTime"
3588
+ * // }
3589
+ * },
3590
+ * });
3591
+ * console.log(res.data);
3592
+ *
3593
+ * // Example response
3594
+ * // {
3595
+ * // "done": false,
3596
+ * // "error": {},
3597
+ * // "metadata": {},
3598
+ * // "name": "my_name",
3599
+ * // "response": {}
3600
+ * // }
3601
+ * }
3602
+ *
3603
+ * main().catch(e => {
3604
+ * console.error(e);
3605
+ * throw e;
3606
+ * });
3607
+ *
3608
+ * ```
3056
3609
  *
3057
3610
  * @param params - Parameters for request
3058
3611
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3256,6 +3809,105 @@ export namespace alloydb_v1beta {
3256
3809
 
3257
3810
  /**
3258
3811
  * Creates a new Cluster in a given project and location.
3812
+ * @example
3813
+ * ```js
3814
+ * // Before running the sample:
3815
+ * // - Enable the API at:
3816
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3817
+ * // - Login into gcloud by running:
3818
+ * // ```sh
3819
+ * // $ gcloud auth application-default login
3820
+ * // ```
3821
+ * // - Install the npm module by running:
3822
+ * // ```sh
3823
+ * // $ npm install googleapis
3824
+ * // ```
3825
+ *
3826
+ * const {google} = require('googleapis');
3827
+ * const alloydb = google.alloydb('v1beta');
3828
+ *
3829
+ * async function main() {
3830
+ * const auth = new google.auth.GoogleAuth({
3831
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3832
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3833
+ * });
3834
+ *
3835
+ * // Acquire an auth client, and bind it to all future calls
3836
+ * const authClient = await auth.getClient();
3837
+ * google.options({auth: authClient});
3838
+ *
3839
+ * // Do the magic
3840
+ * const res = await alloydb.projects.locations.clusters.create({
3841
+ * // Required. ID of the requesting object.
3842
+ * clusterId: 'placeholder-value',
3843
+ * // Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field.
3844
+ * parent: 'projects/my-project/locations/my-location',
3845
+ * // 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).
3846
+ * requestId: 'placeholder-value',
3847
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
3848
+ * validateOnly: 'placeholder-value',
3849
+ *
3850
+ * // Request body metadata
3851
+ * requestBody: {
3852
+ * // request body parameters
3853
+ * // {
3854
+ * // "annotations": {},
3855
+ * // "automatedBackupPolicy": {},
3856
+ * // "backupSource": {},
3857
+ * // "cloudsqlBackupRunSource": {},
3858
+ * // "clusterType": "my_clusterType",
3859
+ * // "continuousBackupConfig": {},
3860
+ * // "continuousBackupInfo": {},
3861
+ * // "createTime": "my_createTime",
3862
+ * // "databaseVersion": "my_databaseVersion",
3863
+ * // "deleteTime": "my_deleteTime",
3864
+ * // "displayName": "my_displayName",
3865
+ * // "encryptionConfig": {},
3866
+ * // "encryptionInfo": {},
3867
+ * // "etag": "my_etag",
3868
+ * // "geminiConfig": {},
3869
+ * // "initialUser": {},
3870
+ * // "labels": {},
3871
+ * // "maintenanceSchedule": {},
3872
+ * // "maintenanceUpdatePolicy": {},
3873
+ * // "migrationSource": {},
3874
+ * // "name": "my_name",
3875
+ * // "network": "my_network",
3876
+ * // "networkConfig": {},
3877
+ * // "primaryConfig": {},
3878
+ * // "pscConfig": {},
3879
+ * // "reconciling": false,
3880
+ * // "satisfiesPzs": false,
3881
+ * // "secondaryConfig": {},
3882
+ * // "serviceAccountEmail": "my_serviceAccountEmail",
3883
+ * // "sslConfig": {},
3884
+ * // "state": "my_state",
3885
+ * // "subscriptionType": "my_subscriptionType",
3886
+ * // "tags": {},
3887
+ * // "trialMetadata": {},
3888
+ * // "uid": "my_uid",
3889
+ * // "updateTime": "my_updateTime"
3890
+ * // }
3891
+ * },
3892
+ * });
3893
+ * console.log(res.data);
3894
+ *
3895
+ * // Example response
3896
+ * // {
3897
+ * // "done": false,
3898
+ * // "error": {},
3899
+ * // "metadata": {},
3900
+ * // "name": "my_name",
3901
+ * // "response": {}
3902
+ * // }
3903
+ * }
3904
+ *
3905
+ * main().catch(e => {
3906
+ * console.error(e);
3907
+ * throw e;
3908
+ * });
3909
+ *
3910
+ * ```
3259
3911
  *
3260
3912
  * @param params - Parameters for request
3261
3913
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3347,6 +3999,105 @@ export namespace alloydb_v1beta {
3347
3999
 
3348
4000
  /**
3349
4001
  * Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.
4002
+ * @example
4003
+ * ```js
4004
+ * // Before running the sample:
4005
+ * // - Enable the API at:
4006
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4007
+ * // - Login into gcloud by running:
4008
+ * // ```sh
4009
+ * // $ gcloud auth application-default login
4010
+ * // ```
4011
+ * // - Install the npm module by running:
4012
+ * // ```sh
4013
+ * // $ npm install googleapis
4014
+ * // ```
4015
+ *
4016
+ * const {google} = require('googleapis');
4017
+ * const alloydb = google.alloydb('v1beta');
4018
+ *
4019
+ * async function main() {
4020
+ * const auth = new google.auth.GoogleAuth({
4021
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4022
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4023
+ * });
4024
+ *
4025
+ * // Acquire an auth client, and bind it to all future calls
4026
+ * const authClient = await auth.getClient();
4027
+ * google.options({auth: authClient});
4028
+ *
4029
+ * // Do the magic
4030
+ * const res = await alloydb.projects.locations.clusters.createsecondary({
4031
+ * // Required. ID of the requesting object (the secondary cluster).
4032
+ * clusterId: 'placeholder-value',
4033
+ * // Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field.
4034
+ * parent: 'projects/my-project/locations/my-location',
4035
+ * // 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).
4036
+ * requestId: 'placeholder-value',
4037
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
4038
+ * validateOnly: 'placeholder-value',
4039
+ *
4040
+ * // Request body metadata
4041
+ * requestBody: {
4042
+ * // request body parameters
4043
+ * // {
4044
+ * // "annotations": {},
4045
+ * // "automatedBackupPolicy": {},
4046
+ * // "backupSource": {},
4047
+ * // "cloudsqlBackupRunSource": {},
4048
+ * // "clusterType": "my_clusterType",
4049
+ * // "continuousBackupConfig": {},
4050
+ * // "continuousBackupInfo": {},
4051
+ * // "createTime": "my_createTime",
4052
+ * // "databaseVersion": "my_databaseVersion",
4053
+ * // "deleteTime": "my_deleteTime",
4054
+ * // "displayName": "my_displayName",
4055
+ * // "encryptionConfig": {},
4056
+ * // "encryptionInfo": {},
4057
+ * // "etag": "my_etag",
4058
+ * // "geminiConfig": {},
4059
+ * // "initialUser": {},
4060
+ * // "labels": {},
4061
+ * // "maintenanceSchedule": {},
4062
+ * // "maintenanceUpdatePolicy": {},
4063
+ * // "migrationSource": {},
4064
+ * // "name": "my_name",
4065
+ * // "network": "my_network",
4066
+ * // "networkConfig": {},
4067
+ * // "primaryConfig": {},
4068
+ * // "pscConfig": {},
4069
+ * // "reconciling": false,
4070
+ * // "satisfiesPzs": false,
4071
+ * // "secondaryConfig": {},
4072
+ * // "serviceAccountEmail": "my_serviceAccountEmail",
4073
+ * // "sslConfig": {},
4074
+ * // "state": "my_state",
4075
+ * // "subscriptionType": "my_subscriptionType",
4076
+ * // "tags": {},
4077
+ * // "trialMetadata": {},
4078
+ * // "uid": "my_uid",
4079
+ * // "updateTime": "my_updateTime"
4080
+ * // }
4081
+ * },
4082
+ * });
4083
+ * console.log(res.data);
4084
+ *
4085
+ * // Example response
4086
+ * // {
4087
+ * // "done": false,
4088
+ * // "error": {},
4089
+ * // "metadata": {},
4090
+ * // "name": "my_name",
4091
+ * // "response": {}
4092
+ * // }
4093
+ * }
4094
+ *
4095
+ * main().catch(e => {
4096
+ * console.error(e);
4097
+ * throw e;
4098
+ * });
4099
+ *
4100
+ * ```
3350
4101
  *
3351
4102
  * @param params - Parameters for request
3352
4103
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3438,6 +4189,64 @@ export namespace alloydb_v1beta {
3438
4189
 
3439
4190
  /**
3440
4191
  * Deletes a single Cluster.
4192
+ * @example
4193
+ * ```js
4194
+ * // Before running the sample:
4195
+ * // - Enable the API at:
4196
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4197
+ * // - Login into gcloud by running:
4198
+ * // ```sh
4199
+ * // $ gcloud auth application-default login
4200
+ * // ```
4201
+ * // - Install the npm module by running:
4202
+ * // ```sh
4203
+ * // $ npm install googleapis
4204
+ * // ```
4205
+ *
4206
+ * const {google} = require('googleapis');
4207
+ * const alloydb = google.alloydb('v1beta');
4208
+ *
4209
+ * async function main() {
4210
+ * const auth = new google.auth.GoogleAuth({
4211
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4212
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4213
+ * });
4214
+ *
4215
+ * // Acquire an auth client, and bind it to all future calls
4216
+ * const authClient = await auth.getClient();
4217
+ * google.options({auth: authClient});
4218
+ *
4219
+ * // Do the magic
4220
+ * const res = await alloydb.projects.locations.clusters.delete({
4221
+ * // 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.
4222
+ * etag: 'placeholder-value',
4223
+ * // Optional. Whether to cascade delete child instances for given cluster.
4224
+ * force: 'placeholder-value',
4225
+ * // Required. The name of the resource. For the required format, see the comment on the Cluster.name field.
4226
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
4227
+ * // 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).
4228
+ * requestId: 'placeholder-value',
4229
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
4230
+ * validateOnly: 'placeholder-value',
4231
+ * });
4232
+ * console.log(res.data);
4233
+ *
4234
+ * // Example response
4235
+ * // {
4236
+ * // "done": false,
4237
+ * // "error": {},
4238
+ * // "metadata": {},
4239
+ * // "name": "my_name",
4240
+ * // "response": {}
4241
+ * // }
4242
+ * }
4243
+ *
4244
+ * main().catch(e => {
4245
+ * console.error(e);
4246
+ * throw e;
4247
+ * });
4248
+ *
4249
+ * ```
3441
4250
  *
3442
4251
  * @param params - Parameters for request
3443
4252
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3526,6 +4335,67 @@ export namespace alloydb_v1beta {
3526
4335
 
3527
4336
  /**
3528
4337
  * Exports data from the cluster. Imperative only.
4338
+ * @example
4339
+ * ```js
4340
+ * // Before running the sample:
4341
+ * // - Enable the API at:
4342
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4343
+ * // - Login into gcloud by running:
4344
+ * // ```sh
4345
+ * // $ gcloud auth application-default login
4346
+ * // ```
4347
+ * // - Install the npm module by running:
4348
+ * // ```sh
4349
+ * // $ npm install googleapis
4350
+ * // ```
4351
+ *
4352
+ * const {google} = require('googleapis');
4353
+ * const alloydb = google.alloydb('v1beta');
4354
+ *
4355
+ * async function main() {
4356
+ * const auth = new google.auth.GoogleAuth({
4357
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4358
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4359
+ * });
4360
+ *
4361
+ * // Acquire an auth client, and bind it to all future calls
4362
+ * const authClient = await auth.getClient();
4363
+ * google.options({auth: authClient});
4364
+ *
4365
+ * // Do the magic
4366
+ * const res = await alloydb.projects.locations.clusters.export({
4367
+ * // Required. The resource name of the cluster.
4368
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
4369
+ *
4370
+ * // Request body metadata
4371
+ * requestBody: {
4372
+ * // request body parameters
4373
+ * // {
4374
+ * // "csvExportOptions": {},
4375
+ * // "database": "my_database",
4376
+ * // "gcsDestination": {},
4377
+ * // "sqlExportOptions": {}
4378
+ * // }
4379
+ * },
4380
+ * });
4381
+ * console.log(res.data);
4382
+ *
4383
+ * // Example response
4384
+ * // {
4385
+ * // "done": false,
4386
+ * // "error": {},
4387
+ * // "metadata": {},
4388
+ * // "name": "my_name",
4389
+ * // "response": {}
4390
+ * // }
4391
+ * }
4392
+ *
4393
+ * main().catch(e => {
4394
+ * console.error(e);
4395
+ * throw e;
4396
+ * });
4397
+ *
4398
+ * ```
3529
4399
  *
3530
4400
  * @param params - Parameters for request
3531
4401
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3617,6 +4487,89 @@ export namespace alloydb_v1beta {
3617
4487
 
3618
4488
  /**
3619
4489
  * Gets details of a single Cluster.
4490
+ * @example
4491
+ * ```js
4492
+ * // Before running the sample:
4493
+ * // - Enable the API at:
4494
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4495
+ * // - Login into gcloud by running:
4496
+ * // ```sh
4497
+ * // $ gcloud auth application-default login
4498
+ * // ```
4499
+ * // - Install the npm module by running:
4500
+ * // ```sh
4501
+ * // $ npm install googleapis
4502
+ * // ```
4503
+ *
4504
+ * const {google} = require('googleapis');
4505
+ * const alloydb = google.alloydb('v1beta');
4506
+ *
4507
+ * async function main() {
4508
+ * const auth = new google.auth.GoogleAuth({
4509
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4510
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4511
+ * });
4512
+ *
4513
+ * // Acquire an auth client, and bind it to all future calls
4514
+ * const authClient = await auth.getClient();
4515
+ * google.options({auth: authClient});
4516
+ *
4517
+ * // Do the magic
4518
+ * const res = await alloydb.projects.locations.clusters.get({
4519
+ * // Required. The name of the resource. For the required format, see the comment on the Cluster.name field.
4520
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
4521
+ * // Optional. The view of the cluster to return. Returns all default fields if not set.
4522
+ * view: 'placeholder-value',
4523
+ * });
4524
+ * console.log(res.data);
4525
+ *
4526
+ * // Example response
4527
+ * // {
4528
+ * // "annotations": {},
4529
+ * // "automatedBackupPolicy": {},
4530
+ * // "backupSource": {},
4531
+ * // "cloudsqlBackupRunSource": {},
4532
+ * // "clusterType": "my_clusterType",
4533
+ * // "continuousBackupConfig": {},
4534
+ * // "continuousBackupInfo": {},
4535
+ * // "createTime": "my_createTime",
4536
+ * // "databaseVersion": "my_databaseVersion",
4537
+ * // "deleteTime": "my_deleteTime",
4538
+ * // "displayName": "my_displayName",
4539
+ * // "encryptionConfig": {},
4540
+ * // "encryptionInfo": {},
4541
+ * // "etag": "my_etag",
4542
+ * // "geminiConfig": {},
4543
+ * // "initialUser": {},
4544
+ * // "labels": {},
4545
+ * // "maintenanceSchedule": {},
4546
+ * // "maintenanceUpdatePolicy": {},
4547
+ * // "migrationSource": {},
4548
+ * // "name": "my_name",
4549
+ * // "network": "my_network",
4550
+ * // "networkConfig": {},
4551
+ * // "primaryConfig": {},
4552
+ * // "pscConfig": {},
4553
+ * // "reconciling": false,
4554
+ * // "satisfiesPzs": false,
4555
+ * // "secondaryConfig": {},
4556
+ * // "serviceAccountEmail": "my_serviceAccountEmail",
4557
+ * // "sslConfig": {},
4558
+ * // "state": "my_state",
4559
+ * // "subscriptionType": "my_subscriptionType",
4560
+ * // "tags": {},
4561
+ * // "trialMetadata": {},
4562
+ * // "uid": "my_uid",
4563
+ * // "updateTime": "my_updateTime"
4564
+ * // }
4565
+ * }
4566
+ *
4567
+ * main().catch(e => {
4568
+ * console.error(e);
4569
+ * throw e;
4570
+ * });
4571
+ *
4572
+ * ```
3620
4573
  *
3621
4574
  * @param params - Parameters for request
3622
4575
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3705,6 +4658,68 @@ export namespace alloydb_v1beta {
3705
4658
 
3706
4659
  /**
3707
4660
  * Imports data to the cluster. Imperative only.
4661
+ * @example
4662
+ * ```js
4663
+ * // Before running the sample:
4664
+ * // - Enable the API at:
4665
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4666
+ * // - Login into gcloud by running:
4667
+ * // ```sh
4668
+ * // $ gcloud auth application-default login
4669
+ * // ```
4670
+ * // - Install the npm module by running:
4671
+ * // ```sh
4672
+ * // $ npm install googleapis
4673
+ * // ```
4674
+ *
4675
+ * const {google} = require('googleapis');
4676
+ * const alloydb = google.alloydb('v1beta');
4677
+ *
4678
+ * async function main() {
4679
+ * const auth = new google.auth.GoogleAuth({
4680
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4681
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4682
+ * });
4683
+ *
4684
+ * // Acquire an auth client, and bind it to all future calls
4685
+ * const authClient = await auth.getClient();
4686
+ * google.options({auth: authClient});
4687
+ *
4688
+ * // Do the magic
4689
+ * const res = await alloydb.projects.locations.clusters.import({
4690
+ * // Required. The resource name of the cluster.
4691
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
4692
+ *
4693
+ * // Request body metadata
4694
+ * requestBody: {
4695
+ * // request body parameters
4696
+ * // {
4697
+ * // "csvImportOptions": {},
4698
+ * // "database": "my_database",
4699
+ * // "gcsUri": "my_gcsUri",
4700
+ * // "sqlImportOptions": {},
4701
+ * // "user": "my_user"
4702
+ * // }
4703
+ * },
4704
+ * });
4705
+ * console.log(res.data);
4706
+ *
4707
+ * // Example response
4708
+ * // {
4709
+ * // "done": false,
4710
+ * // "error": {},
4711
+ * // "metadata": {},
4712
+ * // "name": "my_name",
4713
+ * // "response": {}
4714
+ * // }
4715
+ * }
4716
+ *
4717
+ * main().catch(e => {
4718
+ * console.error(e);
4719
+ * throw e;
4720
+ * });
4721
+ *
4722
+ * ```
3708
4723
  *
3709
4724
  * @param params - Parameters for request
3710
4725
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3796,6 +4811,62 @@ export namespace alloydb_v1beta {
3796
4811
 
3797
4812
  /**
3798
4813
  * Lists Clusters in a given project and location.
4814
+ * @example
4815
+ * ```js
4816
+ * // Before running the sample:
4817
+ * // - Enable the API at:
4818
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4819
+ * // - Login into gcloud by running:
4820
+ * // ```sh
4821
+ * // $ gcloud auth application-default login
4822
+ * // ```
4823
+ * // - Install the npm module by running:
4824
+ * // ```sh
4825
+ * // $ npm install googleapis
4826
+ * // ```
4827
+ *
4828
+ * const {google} = require('googleapis');
4829
+ * const alloydb = google.alloydb('v1beta');
4830
+ *
4831
+ * async function main() {
4832
+ * const auth = new google.auth.GoogleAuth({
4833
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4834
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4835
+ * });
4836
+ *
4837
+ * // Acquire an auth client, and bind it to all future calls
4838
+ * const authClient = await auth.getClient();
4839
+ * google.options({auth: authClient});
4840
+ *
4841
+ * // Do the magic
4842
+ * const res = await alloydb.projects.locations.clusters.list({
4843
+ * // Optional. Filtering results
4844
+ * filter: 'placeholder-value',
4845
+ * // Optional. Hint for how to order the results
4846
+ * orderBy: 'placeholder-value',
4847
+ * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
4848
+ * pageSize: 'placeholder-value',
4849
+ * // A token identifying a page of results the server should return.
4850
+ * pageToken: 'placeholder-value',
4851
+ * // 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/-
4852
+ * parent: 'projects/my-project/locations/my-location',
4853
+ * });
4854
+ * console.log(res.data);
4855
+ *
4856
+ * // Example response
4857
+ * // {
4858
+ * // "clusters": [],
4859
+ * // "nextPageToken": "my_nextPageToken",
4860
+ * // "unreachable": []
4861
+ * // }
4862
+ * }
4863
+ *
4864
+ * main().catch(e => {
4865
+ * console.error(e);
4866
+ * throw e;
4867
+ * });
4868
+ *
4869
+ * ```
3799
4870
  *
3800
4871
  * @param params - Parameters for request
3801
4872
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3889,6 +4960,107 @@ export namespace alloydb_v1beta {
3889
4960
 
3890
4961
  /**
3891
4962
  * Updates the parameters of a single Cluster.
4963
+ * @example
4964
+ * ```js
4965
+ * // Before running the sample:
4966
+ * // - Enable the API at:
4967
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4968
+ * // - Login into gcloud by running:
4969
+ * // ```sh
4970
+ * // $ gcloud auth application-default login
4971
+ * // ```
4972
+ * // - Install the npm module by running:
4973
+ * // ```sh
4974
+ * // $ npm install googleapis
4975
+ * // ```
4976
+ *
4977
+ * const {google} = require('googleapis');
4978
+ * const alloydb = google.alloydb('v1beta');
4979
+ *
4980
+ * async function main() {
4981
+ * const auth = new google.auth.GoogleAuth({
4982
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4983
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4984
+ * });
4985
+ *
4986
+ * // Acquire an auth client, and bind it to all future calls
4987
+ * const authClient = await auth.getClient();
4988
+ * google.options({auth: authClient});
4989
+ *
4990
+ * // Do the magic
4991
+ * const res = await alloydb.projects.locations.clusters.patch({
4992
+ * // 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.
4993
+ * allowMissing: 'placeholder-value',
4994
+ * // 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\}
4995
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
4996
+ * // 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).
4997
+ * requestId: 'placeholder-value',
4998
+ * // 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.
4999
+ * updateMask: 'placeholder-value',
5000
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
5001
+ * validateOnly: 'placeholder-value',
5002
+ *
5003
+ * // Request body metadata
5004
+ * requestBody: {
5005
+ * // request body parameters
5006
+ * // {
5007
+ * // "annotations": {},
5008
+ * // "automatedBackupPolicy": {},
5009
+ * // "backupSource": {},
5010
+ * // "cloudsqlBackupRunSource": {},
5011
+ * // "clusterType": "my_clusterType",
5012
+ * // "continuousBackupConfig": {},
5013
+ * // "continuousBackupInfo": {},
5014
+ * // "createTime": "my_createTime",
5015
+ * // "databaseVersion": "my_databaseVersion",
5016
+ * // "deleteTime": "my_deleteTime",
5017
+ * // "displayName": "my_displayName",
5018
+ * // "encryptionConfig": {},
5019
+ * // "encryptionInfo": {},
5020
+ * // "etag": "my_etag",
5021
+ * // "geminiConfig": {},
5022
+ * // "initialUser": {},
5023
+ * // "labels": {},
5024
+ * // "maintenanceSchedule": {},
5025
+ * // "maintenanceUpdatePolicy": {},
5026
+ * // "migrationSource": {},
5027
+ * // "name": "my_name",
5028
+ * // "network": "my_network",
5029
+ * // "networkConfig": {},
5030
+ * // "primaryConfig": {},
5031
+ * // "pscConfig": {},
5032
+ * // "reconciling": false,
5033
+ * // "satisfiesPzs": false,
5034
+ * // "secondaryConfig": {},
5035
+ * // "serviceAccountEmail": "my_serviceAccountEmail",
5036
+ * // "sslConfig": {},
5037
+ * // "state": "my_state",
5038
+ * // "subscriptionType": "my_subscriptionType",
5039
+ * // "tags": {},
5040
+ * // "trialMetadata": {},
5041
+ * // "uid": "my_uid",
5042
+ * // "updateTime": "my_updateTime"
5043
+ * // }
5044
+ * },
5045
+ * });
5046
+ * console.log(res.data);
5047
+ *
5048
+ * // Example response
5049
+ * // {
5050
+ * // "done": false,
5051
+ * // "error": {},
5052
+ * // "metadata": {},
5053
+ * // "name": "my_name",
5054
+ * // "response": {}
5055
+ * // }
5056
+ * }
5057
+ *
5058
+ * main().catch(e => {
5059
+ * console.error(e);
5060
+ * throw e;
5061
+ * });
5062
+ *
5063
+ * ```
3892
5064
  *
3893
5065
  * @param params - Parameters for request
3894
5066
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3977,6 +5149,66 @@ export namespace alloydb_v1beta {
3977
5149
 
3978
5150
  /**
3979
5151
  * Promotes a SECONDARY cluster. This turns down replication from the PRIMARY cluster and promotes a secondary cluster into its own standalone cluster. Imperative only.
5152
+ * @example
5153
+ * ```js
5154
+ * // Before running the sample:
5155
+ * // - Enable the API at:
5156
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5157
+ * // - Login into gcloud by running:
5158
+ * // ```sh
5159
+ * // $ gcloud auth application-default login
5160
+ * // ```
5161
+ * // - Install the npm module by running:
5162
+ * // ```sh
5163
+ * // $ npm install googleapis
5164
+ * // ```
5165
+ *
5166
+ * const {google} = require('googleapis');
5167
+ * const alloydb = google.alloydb('v1beta');
5168
+ *
5169
+ * async function main() {
5170
+ * const auth = new google.auth.GoogleAuth({
5171
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5172
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5173
+ * });
5174
+ *
5175
+ * // Acquire an auth client, and bind it to all future calls
5176
+ * const authClient = await auth.getClient();
5177
+ * google.options({auth: authClient});
5178
+ *
5179
+ * // Do the magic
5180
+ * const res = await alloydb.projects.locations.clusters.promote({
5181
+ * // Required. The name of the resource. For the required format, see the comment on the Cluster.name field
5182
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
5183
+ *
5184
+ * // Request body metadata
5185
+ * requestBody: {
5186
+ * // request body parameters
5187
+ * // {
5188
+ * // "etag": "my_etag",
5189
+ * // "requestId": "my_requestId",
5190
+ * // "validateOnly": false
5191
+ * // }
5192
+ * },
5193
+ * });
5194
+ * console.log(res.data);
5195
+ *
5196
+ * // Example response
5197
+ * // {
5198
+ * // "done": false,
5199
+ * // "error": {},
5200
+ * // "metadata": {},
5201
+ * // "name": "my_name",
5202
+ * // "response": {}
5203
+ * // }
5204
+ * }
5205
+ *
5206
+ * main().catch(e => {
5207
+ * console.error(e);
5208
+ * throw e;
5209
+ * });
5210
+ *
5211
+ * ```
3980
5212
  *
3981
5213
  * @param params - Parameters for request
3982
5214
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4068,6 +5300,69 @@ export namespace alloydb_v1beta {
4068
5300
 
4069
5301
  /**
4070
5302
  * 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.
5303
+ * @example
5304
+ * ```js
5305
+ * // Before running the sample:
5306
+ * // - Enable the API at:
5307
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5308
+ * // - Login into gcloud by running:
5309
+ * // ```sh
5310
+ * // $ gcloud auth application-default login
5311
+ * // ```
5312
+ * // - Install the npm module by running:
5313
+ * // ```sh
5314
+ * // $ npm install googleapis
5315
+ * // ```
5316
+ *
5317
+ * const {google} = require('googleapis');
5318
+ * const alloydb = google.alloydb('v1beta');
5319
+ *
5320
+ * async function main() {
5321
+ * const auth = new google.auth.GoogleAuth({
5322
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5323
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5324
+ * });
5325
+ *
5326
+ * // Acquire an auth client, and bind it to all future calls
5327
+ * const authClient = await auth.getClient();
5328
+ * google.options({auth: authClient});
5329
+ *
5330
+ * // Do the magic
5331
+ * const res = await alloydb.projects.locations.clusters.restore({
5332
+ * // Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field.
5333
+ * parent: 'projects/my-project/locations/my-location',
5334
+ *
5335
+ * // Request body metadata
5336
+ * requestBody: {
5337
+ * // request body parameters
5338
+ * // {
5339
+ * // "backupSource": {},
5340
+ * // "cluster": {},
5341
+ * // "clusterId": "my_clusterId",
5342
+ * // "continuousBackupSource": {},
5343
+ * // "requestId": "my_requestId",
5344
+ * // "validateOnly": false
5345
+ * // }
5346
+ * },
5347
+ * });
5348
+ * console.log(res.data);
5349
+ *
5350
+ * // Example response
5351
+ * // {
5352
+ * // "done": false,
5353
+ * // "error": {},
5354
+ * // "metadata": {},
5355
+ * // "name": "my_name",
5356
+ * // "response": {}
5357
+ * // }
5358
+ * }
5359
+ *
5360
+ * main().catch(e => {
5361
+ * console.error(e);
5362
+ * throw e;
5363
+ * });
5364
+ *
5365
+ * ```
4071
5366
  *
4072
5367
  * @param params - Parameters for request
4073
5368
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4159,6 +5454,66 @@ export namespace alloydb_v1beta {
4159
5454
 
4160
5455
  /**
4161
5456
  * Restores an AlloyDB cluster from a CloudSQL resource.
5457
+ * @example
5458
+ * ```js
5459
+ * // Before running the sample:
5460
+ * // - Enable the API at:
5461
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5462
+ * // - Login into gcloud by running:
5463
+ * // ```sh
5464
+ * // $ gcloud auth application-default login
5465
+ * // ```
5466
+ * // - Install the npm module by running:
5467
+ * // ```sh
5468
+ * // $ npm install googleapis
5469
+ * // ```
5470
+ *
5471
+ * const {google} = require('googleapis');
5472
+ * const alloydb = google.alloydb('v1beta');
5473
+ *
5474
+ * async function main() {
5475
+ * const auth = new google.auth.GoogleAuth({
5476
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5477
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5478
+ * });
5479
+ *
5480
+ * // Acquire an auth client, and bind it to all future calls
5481
+ * const authClient = await auth.getClient();
5482
+ * google.options({auth: authClient});
5483
+ *
5484
+ * // Do the magic
5485
+ * const res = await alloydb.projects.locations.clusters.restoreFromCloudSQL({
5486
+ * // Required. The location of the new cluster. For the required format, see the comment on Cluster.name field.
5487
+ * parent: 'projects/my-project/locations/my-location',
5488
+ *
5489
+ * // Request body metadata
5490
+ * requestBody: {
5491
+ * // request body parameters
5492
+ * // {
5493
+ * // "cloudsqlBackupRunSource": {},
5494
+ * // "cluster": {},
5495
+ * // "clusterId": "my_clusterId"
5496
+ * // }
5497
+ * },
5498
+ * });
5499
+ * console.log(res.data);
5500
+ *
5501
+ * // Example response
5502
+ * // {
5503
+ * // "done": false,
5504
+ * // "error": {},
5505
+ * // "metadata": {},
5506
+ * // "name": "my_name",
5507
+ * // "response": {}
5508
+ * // }
5509
+ * }
5510
+ *
5511
+ * main().catch(e => {
5512
+ * console.error(e);
5513
+ * throw e;
5514
+ * });
5515
+ *
5516
+ * ```
4162
5517
  *
4163
5518
  * @param params - Parameters for request
4164
5519
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4250,6 +5605,65 @@ export namespace alloydb_v1beta {
4250
5605
 
4251
5606
  /**
4252
5607
  * 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.
5608
+ * @example
5609
+ * ```js
5610
+ * // Before running the sample:
5611
+ * // - Enable the API at:
5612
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5613
+ * // - Login into gcloud by running:
5614
+ * // ```sh
5615
+ * // $ gcloud auth application-default login
5616
+ * // ```
5617
+ * // - Install the npm module by running:
5618
+ * // ```sh
5619
+ * // $ npm install googleapis
5620
+ * // ```
5621
+ *
5622
+ * const {google} = require('googleapis');
5623
+ * const alloydb = google.alloydb('v1beta');
5624
+ *
5625
+ * async function main() {
5626
+ * const auth = new google.auth.GoogleAuth({
5627
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5628
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5629
+ * });
5630
+ *
5631
+ * // Acquire an auth client, and bind it to all future calls
5632
+ * const authClient = await auth.getClient();
5633
+ * google.options({auth: authClient});
5634
+ *
5635
+ * // Do the magic
5636
+ * const res = await alloydb.projects.locations.clusters.switchover({
5637
+ * // Required. The name of the resource. For the required format, see the comment on the Cluster.name field
5638
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
5639
+ *
5640
+ * // Request body metadata
5641
+ * requestBody: {
5642
+ * // request body parameters
5643
+ * // {
5644
+ * // "requestId": "my_requestId",
5645
+ * // "validateOnly": false
5646
+ * // }
5647
+ * },
5648
+ * });
5649
+ * console.log(res.data);
5650
+ *
5651
+ * // Example response
5652
+ * // {
5653
+ * // "done": false,
5654
+ * // "error": {},
5655
+ * // "metadata": {},
5656
+ * // "name": "my_name",
5657
+ * // "response": {}
5658
+ * // }
5659
+ * }
5660
+ *
5661
+ * main().catch(e => {
5662
+ * console.error(e);
5663
+ * throw e;
5664
+ * });
5665
+ *
5666
+ * ```
4253
5667
  *
4254
5668
  * @param params - Parameters for request
4255
5669
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4341,6 +5755,67 @@ export namespace alloydb_v1beta {
4341
5755
 
4342
5756
  /**
4343
5757
  * Upgrades a single Cluster. Imperative only.
5758
+ * @example
5759
+ * ```js
5760
+ * // Before running the sample:
5761
+ * // - Enable the API at:
5762
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5763
+ * // - Login into gcloud by running:
5764
+ * // ```sh
5765
+ * // $ gcloud auth application-default login
5766
+ * // ```
5767
+ * // - Install the npm module by running:
5768
+ * // ```sh
5769
+ * // $ npm install googleapis
5770
+ * // ```
5771
+ *
5772
+ * const {google} = require('googleapis');
5773
+ * const alloydb = google.alloydb('v1beta');
5774
+ *
5775
+ * async function main() {
5776
+ * const auth = new google.auth.GoogleAuth({
5777
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5778
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5779
+ * });
5780
+ *
5781
+ * // Acquire an auth client, and bind it to all future calls
5782
+ * const authClient = await auth.getClient();
5783
+ * google.options({auth: authClient});
5784
+ *
5785
+ * // Do the magic
5786
+ * const res = await alloydb.projects.locations.clusters.upgrade({
5787
+ * // Required. The resource name of the cluster.
5788
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
5789
+ *
5790
+ * // Request body metadata
5791
+ * requestBody: {
5792
+ * // request body parameters
5793
+ * // {
5794
+ * // "etag": "my_etag",
5795
+ * // "requestId": "my_requestId",
5796
+ * // "validateOnly": false,
5797
+ * // "version": "my_version"
5798
+ * // }
5799
+ * },
5800
+ * });
5801
+ * console.log(res.data);
5802
+ *
5803
+ * // Example response
5804
+ * // {
5805
+ * // "done": false,
5806
+ * // "error": {},
5807
+ * // "metadata": {},
5808
+ * // "name": "my_name",
5809
+ * // "response": {}
5810
+ * // }
5811
+ * }
5812
+ *
5813
+ * main().catch(e => {
5814
+ * console.error(e);
5815
+ * throw e;
5816
+ * });
5817
+ *
5818
+ * ```
4344
5819
  *
4345
5820
  * @param params - Parameters for request
4346
5821
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4657,6 +6132,102 @@ export namespace alloydb_v1beta {
4657
6132
 
4658
6133
  /**
4659
6134
  * Creates a new Instance in a given project and location.
6135
+ * @example
6136
+ * ```js
6137
+ * // Before running the sample:
6138
+ * // - Enable the API at:
6139
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
6140
+ * // - Login into gcloud by running:
6141
+ * // ```sh
6142
+ * // $ gcloud auth application-default login
6143
+ * // ```
6144
+ * // - Install the npm module by running:
6145
+ * // ```sh
6146
+ * // $ npm install googleapis
6147
+ * // ```
6148
+ *
6149
+ * const {google} = require('googleapis');
6150
+ * const alloydb = google.alloydb('v1beta');
6151
+ *
6152
+ * async function main() {
6153
+ * const auth = new google.auth.GoogleAuth({
6154
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6155
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
6156
+ * });
6157
+ *
6158
+ * // Acquire an auth client, and bind it to all future calls
6159
+ * const authClient = await auth.getClient();
6160
+ * google.options({auth: authClient});
6161
+ *
6162
+ * // Do the magic
6163
+ * const res = await alloydb.projects.locations.clusters.instances.create({
6164
+ * // Required. ID of the requesting object.
6165
+ * instanceId: 'placeholder-value',
6166
+ * // Required. The name of the parent resource. For the required format, see the comment on the Instance.name field.
6167
+ * parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
6168
+ * // 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).
6169
+ * requestId: 'placeholder-value',
6170
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
6171
+ * validateOnly: 'placeholder-value',
6172
+ *
6173
+ * // Request body metadata
6174
+ * requestBody: {
6175
+ * // request body parameters
6176
+ * // {
6177
+ * // "activationPolicy": "my_activationPolicy",
6178
+ * // "annotations": {},
6179
+ * // "availabilityType": "my_availabilityType",
6180
+ * // "clientConnectionConfig": {},
6181
+ * // "connectionPoolConfig": {},
6182
+ * // "createTime": "my_createTime",
6183
+ * // "databaseFlags": {},
6184
+ * // "deleteTime": "my_deleteTime",
6185
+ * // "displayName": "my_displayName",
6186
+ * // "etag": "my_etag",
6187
+ * // "gcaConfig": {},
6188
+ * // "gceZone": "my_gceZone",
6189
+ * // "geminiConfig": {},
6190
+ * // "instanceType": "my_instanceType",
6191
+ * // "ipAddress": "my_ipAddress",
6192
+ * // "labels": {},
6193
+ * // "machineConfig": {},
6194
+ * // "name": "my_name",
6195
+ * // "networkConfig": {},
6196
+ * // "nodes": [],
6197
+ * // "observabilityConfig": {},
6198
+ * // "outboundPublicIpAddresses": [],
6199
+ * // "pscInstanceConfig": {},
6200
+ * // "publicIpAddress": "my_publicIpAddress",
6201
+ * // "queryInsightsConfig": {},
6202
+ * // "readPoolConfig": {},
6203
+ * // "reconciling": false,
6204
+ * // "satisfiesPzs": false,
6205
+ * // "state": "my_state",
6206
+ * // "uid": "my_uid",
6207
+ * // "updatePolicy": {},
6208
+ * // "updateTime": "my_updateTime",
6209
+ * // "writableNode": {}
6210
+ * // }
6211
+ * },
6212
+ * });
6213
+ * console.log(res.data);
6214
+ *
6215
+ * // Example response
6216
+ * // {
6217
+ * // "done": false,
6218
+ * // "error": {},
6219
+ * // "metadata": {},
6220
+ * // "name": "my_name",
6221
+ * // "response": {}
6222
+ * // }
6223
+ * }
6224
+ *
6225
+ * main().catch(e => {
6226
+ * console.error(e);
6227
+ * throw e;
6228
+ * });
6229
+ *
6230
+ * ```
4660
6231
  *
4661
6232
  * @param params - Parameters for request
4662
6233
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4749,6 +6320,103 @@ export namespace alloydb_v1beta {
4749
6320
 
4750
6321
  /**
4751
6322
  * Creates a new SECONDARY Instance in a given project and location.
6323
+ * @example
6324
+ * ```js
6325
+ * // Before running the sample:
6326
+ * // - Enable the API at:
6327
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
6328
+ * // - Login into gcloud by running:
6329
+ * // ```sh
6330
+ * // $ gcloud auth application-default login
6331
+ * // ```
6332
+ * // - Install the npm module by running:
6333
+ * // ```sh
6334
+ * // $ npm install googleapis
6335
+ * // ```
6336
+ *
6337
+ * const {google} = require('googleapis');
6338
+ * const alloydb = google.alloydb('v1beta');
6339
+ *
6340
+ * async function main() {
6341
+ * const auth = new google.auth.GoogleAuth({
6342
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6343
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
6344
+ * });
6345
+ *
6346
+ * // Acquire an auth client, and bind it to all future calls
6347
+ * const authClient = await auth.getClient();
6348
+ * google.options({auth: authClient});
6349
+ *
6350
+ * // Do the magic
6351
+ * const res =
6352
+ * await alloydb.projects.locations.clusters.instances.createsecondary({
6353
+ * // Required. ID of the requesting object.
6354
+ * instanceId: 'placeholder-value',
6355
+ * // Required. The name of the parent resource. For the required format, see the comment on the Instance.name field.
6356
+ * parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
6357
+ * // 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).
6358
+ * requestId: 'placeholder-value',
6359
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
6360
+ * validateOnly: 'placeholder-value',
6361
+ *
6362
+ * // Request body metadata
6363
+ * requestBody: {
6364
+ * // request body parameters
6365
+ * // {
6366
+ * // "activationPolicy": "my_activationPolicy",
6367
+ * // "annotations": {},
6368
+ * // "availabilityType": "my_availabilityType",
6369
+ * // "clientConnectionConfig": {},
6370
+ * // "connectionPoolConfig": {},
6371
+ * // "createTime": "my_createTime",
6372
+ * // "databaseFlags": {},
6373
+ * // "deleteTime": "my_deleteTime",
6374
+ * // "displayName": "my_displayName",
6375
+ * // "etag": "my_etag",
6376
+ * // "gcaConfig": {},
6377
+ * // "gceZone": "my_gceZone",
6378
+ * // "geminiConfig": {},
6379
+ * // "instanceType": "my_instanceType",
6380
+ * // "ipAddress": "my_ipAddress",
6381
+ * // "labels": {},
6382
+ * // "machineConfig": {},
6383
+ * // "name": "my_name",
6384
+ * // "networkConfig": {},
6385
+ * // "nodes": [],
6386
+ * // "observabilityConfig": {},
6387
+ * // "outboundPublicIpAddresses": [],
6388
+ * // "pscInstanceConfig": {},
6389
+ * // "publicIpAddress": "my_publicIpAddress",
6390
+ * // "queryInsightsConfig": {},
6391
+ * // "readPoolConfig": {},
6392
+ * // "reconciling": false,
6393
+ * // "satisfiesPzs": false,
6394
+ * // "state": "my_state",
6395
+ * // "uid": "my_uid",
6396
+ * // "updatePolicy": {},
6397
+ * // "updateTime": "my_updateTime",
6398
+ * // "writableNode": {}
6399
+ * // }
6400
+ * },
6401
+ * });
6402
+ * console.log(res.data);
6403
+ *
6404
+ * // Example response
6405
+ * // {
6406
+ * // "done": false,
6407
+ * // "error": {},
6408
+ * // "metadata": {},
6409
+ * // "name": "my_name",
6410
+ * // "response": {}
6411
+ * // }
6412
+ * }
6413
+ *
6414
+ * main().catch(e => {
6415
+ * console.error(e);
6416
+ * throw e;
6417
+ * });
6418
+ *
6419
+ * ```
4752
6420
  *
4753
6421
  * @param params - Parameters for request
4754
6422
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4840,6 +6508,62 @@ export namespace alloydb_v1beta {
4840
6508
 
4841
6509
  /**
4842
6510
  * Deletes a single Instance.
6511
+ * @example
6512
+ * ```js
6513
+ * // Before running the sample:
6514
+ * // - Enable the API at:
6515
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
6516
+ * // - Login into gcloud by running:
6517
+ * // ```sh
6518
+ * // $ gcloud auth application-default login
6519
+ * // ```
6520
+ * // - Install the npm module by running:
6521
+ * // ```sh
6522
+ * // $ npm install googleapis
6523
+ * // ```
6524
+ *
6525
+ * const {google} = require('googleapis');
6526
+ * const alloydb = google.alloydb('v1beta');
6527
+ *
6528
+ * async function main() {
6529
+ * const auth = new google.auth.GoogleAuth({
6530
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6531
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
6532
+ * });
6533
+ *
6534
+ * // Acquire an auth client, and bind it to all future calls
6535
+ * const authClient = await auth.getClient();
6536
+ * google.options({auth: authClient});
6537
+ *
6538
+ * // Do the magic
6539
+ * const res = await alloydb.projects.locations.clusters.instances.delete({
6540
+ * // 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.
6541
+ * etag: 'placeholder-value',
6542
+ * // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
6543
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
6544
+ * // 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).
6545
+ * requestId: 'placeholder-value',
6546
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
6547
+ * validateOnly: 'placeholder-value',
6548
+ * });
6549
+ * console.log(res.data);
6550
+ *
6551
+ * // Example response
6552
+ * // {
6553
+ * // "done": false,
6554
+ * // "error": {},
6555
+ * // "metadata": {},
6556
+ * // "name": "my_name",
6557
+ * // "response": {}
6558
+ * // }
6559
+ * }
6560
+ *
6561
+ * main().catch(e => {
6562
+ * console.error(e);
6563
+ * throw e;
6564
+ * });
6565
+ *
6566
+ * ```
4843
6567
  *
4844
6568
  * @param params - Parameters for request
4845
6569
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4929,6 +6653,65 @@ export namespace alloydb_v1beta {
4929
6653
 
4930
6654
  /**
4931
6655
  * Forces a Failover for a highly available instance. Failover promotes the HA standby instance as the new primary. Imperative only.
6656
+ * @example
6657
+ * ```js
6658
+ * // Before running the sample:
6659
+ * // - Enable the API at:
6660
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
6661
+ * // - Login into gcloud by running:
6662
+ * // ```sh
6663
+ * // $ gcloud auth application-default login
6664
+ * // ```
6665
+ * // - Install the npm module by running:
6666
+ * // ```sh
6667
+ * // $ npm install googleapis
6668
+ * // ```
6669
+ *
6670
+ * const {google} = require('googleapis');
6671
+ * const alloydb = google.alloydb('v1beta');
6672
+ *
6673
+ * async function main() {
6674
+ * const auth = new google.auth.GoogleAuth({
6675
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6676
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
6677
+ * });
6678
+ *
6679
+ * // Acquire an auth client, and bind it to all future calls
6680
+ * const authClient = await auth.getClient();
6681
+ * google.options({auth: authClient});
6682
+ *
6683
+ * // Do the magic
6684
+ * const res = await alloydb.projects.locations.clusters.instances.failover({
6685
+ * // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
6686
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
6687
+ *
6688
+ * // Request body metadata
6689
+ * requestBody: {
6690
+ * // request body parameters
6691
+ * // {
6692
+ * // "requestId": "my_requestId",
6693
+ * // "validateOnly": false
6694
+ * // }
6695
+ * },
6696
+ * });
6697
+ * console.log(res.data);
6698
+ *
6699
+ * // Example response
6700
+ * // {
6701
+ * // "done": false,
6702
+ * // "error": {},
6703
+ * // "metadata": {},
6704
+ * // "name": "my_name",
6705
+ * // "response": {}
6706
+ * // }
6707
+ * }
6708
+ *
6709
+ * main().catch(e => {
6710
+ * console.error(e);
6711
+ * throw e;
6712
+ * });
6713
+ *
6714
+ * ```
4932
6715
  *
4933
6716
  * @param params - Parameters for request
4934
6717
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5021,6 +6804,86 @@ export namespace alloydb_v1beta {
5021
6804
 
5022
6805
  /**
5023
6806
  * Gets details of a single Instance.
6807
+ * @example
6808
+ * ```js
6809
+ * // Before running the sample:
6810
+ * // - Enable the API at:
6811
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
6812
+ * // - Login into gcloud by running:
6813
+ * // ```sh
6814
+ * // $ gcloud auth application-default login
6815
+ * // ```
6816
+ * // - Install the npm module by running:
6817
+ * // ```sh
6818
+ * // $ npm install googleapis
6819
+ * // ```
6820
+ *
6821
+ * const {google} = require('googleapis');
6822
+ * const alloydb = google.alloydb('v1beta');
6823
+ *
6824
+ * async function main() {
6825
+ * const auth = new google.auth.GoogleAuth({
6826
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6827
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
6828
+ * });
6829
+ *
6830
+ * // Acquire an auth client, and bind it to all future calls
6831
+ * const authClient = await auth.getClient();
6832
+ * google.options({auth: authClient});
6833
+ *
6834
+ * // Do the magic
6835
+ * const res = await alloydb.projects.locations.clusters.instances.get({
6836
+ * // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
6837
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
6838
+ * // The view of the instance to return.
6839
+ * view: 'placeholder-value',
6840
+ * });
6841
+ * console.log(res.data);
6842
+ *
6843
+ * // Example response
6844
+ * // {
6845
+ * // "activationPolicy": "my_activationPolicy",
6846
+ * // "annotations": {},
6847
+ * // "availabilityType": "my_availabilityType",
6848
+ * // "clientConnectionConfig": {},
6849
+ * // "connectionPoolConfig": {},
6850
+ * // "createTime": "my_createTime",
6851
+ * // "databaseFlags": {},
6852
+ * // "deleteTime": "my_deleteTime",
6853
+ * // "displayName": "my_displayName",
6854
+ * // "etag": "my_etag",
6855
+ * // "gcaConfig": {},
6856
+ * // "gceZone": "my_gceZone",
6857
+ * // "geminiConfig": {},
6858
+ * // "instanceType": "my_instanceType",
6859
+ * // "ipAddress": "my_ipAddress",
6860
+ * // "labels": {},
6861
+ * // "machineConfig": {},
6862
+ * // "name": "my_name",
6863
+ * // "networkConfig": {},
6864
+ * // "nodes": [],
6865
+ * // "observabilityConfig": {},
6866
+ * // "outboundPublicIpAddresses": [],
6867
+ * // "pscInstanceConfig": {},
6868
+ * // "publicIpAddress": "my_publicIpAddress",
6869
+ * // "queryInsightsConfig": {},
6870
+ * // "readPoolConfig": {},
6871
+ * // "reconciling": false,
6872
+ * // "satisfiesPzs": false,
6873
+ * // "state": "my_state",
6874
+ * // "uid": "my_uid",
6875
+ * // "updatePolicy": {},
6876
+ * // "updateTime": "my_updateTime",
6877
+ * // "writableNode": {}
6878
+ * // }
6879
+ * }
6880
+ *
6881
+ * main().catch(e => {
6882
+ * console.error(e);
6883
+ * throw e;
6884
+ * });
6885
+ *
6886
+ * ```
5024
6887
  *
5025
6888
  * @param params - Parameters for request
5026
6889
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5110,6 +6973,61 @@ export namespace alloydb_v1beta {
5110
6973
 
5111
6974
  /**
5112
6975
  * Get instance metadata used for a connection.
6976
+ * @example
6977
+ * ```js
6978
+ * // Before running the sample:
6979
+ * // - Enable the API at:
6980
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
6981
+ * // - Login into gcloud by running:
6982
+ * // ```sh
6983
+ * // $ gcloud auth application-default login
6984
+ * // ```
6985
+ * // - Install the npm module by running:
6986
+ * // ```sh
6987
+ * // $ npm install googleapis
6988
+ * // ```
6989
+ *
6990
+ * const {google} = require('googleapis');
6991
+ * const alloydb = google.alloydb('v1beta');
6992
+ *
6993
+ * async function main() {
6994
+ * const auth = new google.auth.GoogleAuth({
6995
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6996
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
6997
+ * });
6998
+ *
6999
+ * // Acquire an auth client, and bind it to all future calls
7000
+ * const authClient = await auth.getClient();
7001
+ * google.options({auth: authClient});
7002
+ *
7003
+ * // Do the magic
7004
+ * const res =
7005
+ * await alloydb.projects.locations.clusters.instances.getConnectionInfo({
7006
+ * // Required. The name of the parent resource. The required format is: projects/{project\}/locations/{location\}/clusters/{cluster\}/instances/{instance\}
7007
+ * parent:
7008
+ * 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
7009
+ * // 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).
7010
+ * requestId: 'placeholder-value',
7011
+ * });
7012
+ * console.log(res.data);
7013
+ *
7014
+ * // Example response
7015
+ * // {
7016
+ * // "instanceUid": "my_instanceUid",
7017
+ * // "ipAddress": "my_ipAddress",
7018
+ * // "name": "my_name",
7019
+ * // "pemCertificateChain": [],
7020
+ * // "pscDnsName": "my_pscDnsName",
7021
+ * // "publicIpAddress": "my_publicIpAddress"
7022
+ * // }
7023
+ * }
7024
+ *
7025
+ * main().catch(e => {
7026
+ * console.error(e);
7027
+ * throw e;
7028
+ * });
7029
+ *
7030
+ * ```
5113
7031
  *
5114
7032
  * @param params - Parameters for request
5115
7033
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5204,6 +7122,66 @@ export namespace alloydb_v1beta {
5204
7122
 
5205
7123
  /**
5206
7124
  * Injects fault in an instance. Imperative only.
7125
+ * @example
7126
+ * ```js
7127
+ * // Before running the sample:
7128
+ * // - Enable the API at:
7129
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
7130
+ * // - Login into gcloud by running:
7131
+ * // ```sh
7132
+ * // $ gcloud auth application-default login
7133
+ * // ```
7134
+ * // - Install the npm module by running:
7135
+ * // ```sh
7136
+ * // $ npm install googleapis
7137
+ * // ```
7138
+ *
7139
+ * const {google} = require('googleapis');
7140
+ * const alloydb = google.alloydb('v1beta');
7141
+ *
7142
+ * async function main() {
7143
+ * const auth = new google.auth.GoogleAuth({
7144
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
7145
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
7146
+ * });
7147
+ *
7148
+ * // Acquire an auth client, and bind it to all future calls
7149
+ * const authClient = await auth.getClient();
7150
+ * google.options({auth: authClient});
7151
+ *
7152
+ * // Do the magic
7153
+ * const res = await alloydb.projects.locations.clusters.instances.injectFault({
7154
+ * // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
7155
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
7156
+ *
7157
+ * // Request body metadata
7158
+ * requestBody: {
7159
+ * // request body parameters
7160
+ * // {
7161
+ * // "faultType": "my_faultType",
7162
+ * // "requestId": "my_requestId",
7163
+ * // "validateOnly": false
7164
+ * // }
7165
+ * },
7166
+ * });
7167
+ * console.log(res.data);
7168
+ *
7169
+ * // Example response
7170
+ * // {
7171
+ * // "done": false,
7172
+ * // "error": {},
7173
+ * // "metadata": {},
7174
+ * // "name": "my_name",
7175
+ * // "response": {}
7176
+ * // }
7177
+ * }
7178
+ *
7179
+ * main().catch(e => {
7180
+ * console.error(e);
7181
+ * throw e;
7182
+ * });
7183
+ *
7184
+ * ```
5207
7185
  *
5208
7186
  * @param params - Parameters for request
5209
7187
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5296,6 +7274,62 @@ export namespace alloydb_v1beta {
5296
7274
 
5297
7275
  /**
5298
7276
  * Lists Instances in a given project and location.
7277
+ * @example
7278
+ * ```js
7279
+ * // Before running the sample:
7280
+ * // - Enable the API at:
7281
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
7282
+ * // - Login into gcloud by running:
7283
+ * // ```sh
7284
+ * // $ gcloud auth application-default login
7285
+ * // ```
7286
+ * // - Install the npm module by running:
7287
+ * // ```sh
7288
+ * // $ npm install googleapis
7289
+ * // ```
7290
+ *
7291
+ * const {google} = require('googleapis');
7292
+ * const alloydb = google.alloydb('v1beta');
7293
+ *
7294
+ * async function main() {
7295
+ * const auth = new google.auth.GoogleAuth({
7296
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
7297
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
7298
+ * });
7299
+ *
7300
+ * // Acquire an auth client, and bind it to all future calls
7301
+ * const authClient = await auth.getClient();
7302
+ * google.options({auth: authClient});
7303
+ *
7304
+ * // Do the magic
7305
+ * const res = await alloydb.projects.locations.clusters.instances.list({
7306
+ * // Optional. Filtering results
7307
+ * filter: 'placeholder-value',
7308
+ * // Optional. Hint for how to order the results
7309
+ * orderBy: 'placeholder-value',
7310
+ * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
7311
+ * pageSize: 'placeholder-value',
7312
+ * // A token identifying a page of results the server should return.
7313
+ * pageToken: 'placeholder-value',
7314
+ * // 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/-
7315
+ * parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
7316
+ * });
7317
+ * console.log(res.data);
7318
+ *
7319
+ * // Example response
7320
+ * // {
7321
+ * // "instances": [],
7322
+ * // "nextPageToken": "my_nextPageToken",
7323
+ * // "unreachable": []
7324
+ * // }
7325
+ * }
7326
+ *
7327
+ * main().catch(e => {
7328
+ * console.error(e);
7329
+ * throw e;
7330
+ * });
7331
+ *
7332
+ * ```
5299
7333
  *
5300
7334
  * @param params - Parameters for request
5301
7335
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5390,6 +7424,104 @@ export namespace alloydb_v1beta {
5390
7424
 
5391
7425
  /**
5392
7426
  * Updates the parameters of a single Instance.
7427
+ * @example
7428
+ * ```js
7429
+ * // Before running the sample:
7430
+ * // - Enable the API at:
7431
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
7432
+ * // - Login into gcloud by running:
7433
+ * // ```sh
7434
+ * // $ gcloud auth application-default login
7435
+ * // ```
7436
+ * // - Install the npm module by running:
7437
+ * // ```sh
7438
+ * // $ npm install googleapis
7439
+ * // ```
7440
+ *
7441
+ * const {google} = require('googleapis');
7442
+ * const alloydb = google.alloydb('v1beta');
7443
+ *
7444
+ * async function main() {
7445
+ * const auth = new google.auth.GoogleAuth({
7446
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
7447
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
7448
+ * });
7449
+ *
7450
+ * // Acquire an auth client, and bind it to all future calls
7451
+ * const authClient = await auth.getClient();
7452
+ * google.options({auth: authClient});
7453
+ *
7454
+ * // Do the magic
7455
+ * const res = await alloydb.projects.locations.clusters.instances.patch({
7456
+ * // 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.
7457
+ * allowMissing: 'placeholder-value',
7458
+ * // 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\}
7459
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
7460
+ * // 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).
7461
+ * requestId: 'placeholder-value',
7462
+ * // 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.
7463
+ * updateMask: 'placeholder-value',
7464
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
7465
+ * validateOnly: 'placeholder-value',
7466
+ *
7467
+ * // Request body metadata
7468
+ * requestBody: {
7469
+ * // request body parameters
7470
+ * // {
7471
+ * // "activationPolicy": "my_activationPolicy",
7472
+ * // "annotations": {},
7473
+ * // "availabilityType": "my_availabilityType",
7474
+ * // "clientConnectionConfig": {},
7475
+ * // "connectionPoolConfig": {},
7476
+ * // "createTime": "my_createTime",
7477
+ * // "databaseFlags": {},
7478
+ * // "deleteTime": "my_deleteTime",
7479
+ * // "displayName": "my_displayName",
7480
+ * // "etag": "my_etag",
7481
+ * // "gcaConfig": {},
7482
+ * // "gceZone": "my_gceZone",
7483
+ * // "geminiConfig": {},
7484
+ * // "instanceType": "my_instanceType",
7485
+ * // "ipAddress": "my_ipAddress",
7486
+ * // "labels": {},
7487
+ * // "machineConfig": {},
7488
+ * // "name": "my_name",
7489
+ * // "networkConfig": {},
7490
+ * // "nodes": [],
7491
+ * // "observabilityConfig": {},
7492
+ * // "outboundPublicIpAddresses": [],
7493
+ * // "pscInstanceConfig": {},
7494
+ * // "publicIpAddress": "my_publicIpAddress",
7495
+ * // "queryInsightsConfig": {},
7496
+ * // "readPoolConfig": {},
7497
+ * // "reconciling": false,
7498
+ * // "satisfiesPzs": false,
7499
+ * // "state": "my_state",
7500
+ * // "uid": "my_uid",
7501
+ * // "updatePolicy": {},
7502
+ * // "updateTime": "my_updateTime",
7503
+ * // "writableNode": {}
7504
+ * // }
7505
+ * },
7506
+ * });
7507
+ * console.log(res.data);
7508
+ *
7509
+ * // Example response
7510
+ * // {
7511
+ * // "done": false,
7512
+ * // "error": {},
7513
+ * // "metadata": {},
7514
+ * // "name": "my_name",
7515
+ * // "response": {}
7516
+ * // }
7517
+ * }
7518
+ *
7519
+ * main().catch(e => {
7520
+ * console.error(e);
7521
+ * throw e;
7522
+ * });
7523
+ *
7524
+ * ```
5393
7525
  *
5394
7526
  * @param params - Parameters for request
5395
7527
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5479,6 +7611,66 @@ export namespace alloydb_v1beta {
5479
7611
 
5480
7612
  /**
5481
7613
  * Restart an Instance in a cluster. Imperative only.
7614
+ * @example
7615
+ * ```js
7616
+ * // Before running the sample:
7617
+ * // - Enable the API at:
7618
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
7619
+ * // - Login into gcloud by running:
7620
+ * // ```sh
7621
+ * // $ gcloud auth application-default login
7622
+ * // ```
7623
+ * // - Install the npm module by running:
7624
+ * // ```sh
7625
+ * // $ npm install googleapis
7626
+ * // ```
7627
+ *
7628
+ * const {google} = require('googleapis');
7629
+ * const alloydb = google.alloydb('v1beta');
7630
+ *
7631
+ * async function main() {
7632
+ * const auth = new google.auth.GoogleAuth({
7633
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
7634
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
7635
+ * });
7636
+ *
7637
+ * // Acquire an auth client, and bind it to all future calls
7638
+ * const authClient = await auth.getClient();
7639
+ * google.options({auth: authClient});
7640
+ *
7641
+ * // Do the magic
7642
+ * const res = await alloydb.projects.locations.clusters.instances.restart({
7643
+ * // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
7644
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
7645
+ *
7646
+ * // Request body metadata
7647
+ * requestBody: {
7648
+ * // request body parameters
7649
+ * // {
7650
+ * // "nodeIds": [],
7651
+ * // "requestId": "my_requestId",
7652
+ * // "validateOnly": false
7653
+ * // }
7654
+ * },
7655
+ * });
7656
+ * console.log(res.data);
7657
+ *
7658
+ * // Example response
7659
+ * // {
7660
+ * // "done": false,
7661
+ * // "error": {},
7662
+ * // "metadata": {},
7663
+ * // "name": "my_name",
7664
+ * // "response": {}
7665
+ * // }
7666
+ * }
7667
+ *
7668
+ * main().catch(e => {
7669
+ * console.error(e);
7670
+ * throw e;
7671
+ * });
7672
+ *
7673
+ * ```
5482
7674
  *
5483
7675
  * @param params - Parameters for request
5484
7676
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5755,6 +7947,74 @@ export namespace alloydb_v1beta {
5755
7947
 
5756
7948
  /**
5757
7949
  * Creates a new User in a given project, location, and cluster.
7950
+ * @example
7951
+ * ```js
7952
+ * // Before running the sample:
7953
+ * // - Enable the API at:
7954
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
7955
+ * // - Login into gcloud by running:
7956
+ * // ```sh
7957
+ * // $ gcloud auth application-default login
7958
+ * // ```
7959
+ * // - Install the npm module by running:
7960
+ * // ```sh
7961
+ * // $ npm install googleapis
7962
+ * // ```
7963
+ *
7964
+ * const {google} = require('googleapis');
7965
+ * const alloydb = google.alloydb('v1beta');
7966
+ *
7967
+ * async function main() {
7968
+ * const auth = new google.auth.GoogleAuth({
7969
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
7970
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
7971
+ * });
7972
+ *
7973
+ * // Acquire an auth client, and bind it to all future calls
7974
+ * const authClient = await auth.getClient();
7975
+ * google.options({auth: authClient});
7976
+ *
7977
+ * // Do the magic
7978
+ * const res = await alloydb.projects.locations.clusters.users.create({
7979
+ * // Required. Value for parent.
7980
+ * parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
7981
+ * // 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).
7982
+ * requestId: 'placeholder-value',
7983
+ * // Required. ID of the requesting object.
7984
+ * userId: 'placeholder-value',
7985
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
7986
+ * validateOnly: 'placeholder-value',
7987
+ *
7988
+ * // Request body metadata
7989
+ * requestBody: {
7990
+ * // request body parameters
7991
+ * // {
7992
+ * // "databaseRoles": [],
7993
+ * // "keepExtraRoles": false,
7994
+ * // "name": "my_name",
7995
+ * // "password": "my_password",
7996
+ * // "userType": "my_userType"
7997
+ * // }
7998
+ * },
7999
+ * });
8000
+ * console.log(res.data);
8001
+ *
8002
+ * // Example response
8003
+ * // {
8004
+ * // "databaseRoles": [],
8005
+ * // "keepExtraRoles": false,
8006
+ * // "name": "my_name",
8007
+ * // "password": "my_password",
8008
+ * // "userType": "my_userType"
8009
+ * // }
8010
+ * }
8011
+ *
8012
+ * main().catch(e => {
8013
+ * console.error(e);
8014
+ * throw e;
8015
+ * });
8016
+ *
8017
+ * ```
5758
8018
  *
5759
8019
  * @param params - Parameters for request
5760
8020
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5846,6 +8106,54 @@ export namespace alloydb_v1beta {
5846
8106
 
5847
8107
  /**
5848
8108
  * Deletes a single User.
8109
+ * @example
8110
+ * ```js
8111
+ * // Before running the sample:
8112
+ * // - Enable the API at:
8113
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
8114
+ * // - Login into gcloud by running:
8115
+ * // ```sh
8116
+ * // $ gcloud auth application-default login
8117
+ * // ```
8118
+ * // - Install the npm module by running:
8119
+ * // ```sh
8120
+ * // $ npm install googleapis
8121
+ * // ```
8122
+ *
8123
+ * const {google} = require('googleapis');
8124
+ * const alloydb = google.alloydb('v1beta');
8125
+ *
8126
+ * async function main() {
8127
+ * const auth = new google.auth.GoogleAuth({
8128
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
8129
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
8130
+ * });
8131
+ *
8132
+ * // Acquire an auth client, and bind it to all future calls
8133
+ * const authClient = await auth.getClient();
8134
+ * google.options({auth: authClient});
8135
+ *
8136
+ * // Do the magic
8137
+ * const res = await alloydb.projects.locations.clusters.users.delete({
8138
+ * // Required. The name of the resource. For the required format, see the comment on the User.name field.
8139
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/users/my-user',
8140
+ * // 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).
8141
+ * requestId: 'placeholder-value',
8142
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
8143
+ * validateOnly: 'placeholder-value',
8144
+ * });
8145
+ * console.log(res.data);
8146
+ *
8147
+ * // Example response
8148
+ * // {}
8149
+ * }
8150
+ *
8151
+ * main().catch(e => {
8152
+ * console.error(e);
8153
+ * throw e;
8154
+ * });
8155
+ *
8156
+ * ```
5849
8157
  *
5850
8158
  * @param params - Parameters for request
5851
8159
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5934,6 +8242,56 @@ export namespace alloydb_v1beta {
5934
8242
 
5935
8243
  /**
5936
8244
  * Gets details of a single User.
8245
+ * @example
8246
+ * ```js
8247
+ * // Before running the sample:
8248
+ * // - Enable the API at:
8249
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
8250
+ * // - Login into gcloud by running:
8251
+ * // ```sh
8252
+ * // $ gcloud auth application-default login
8253
+ * // ```
8254
+ * // - Install the npm module by running:
8255
+ * // ```sh
8256
+ * // $ npm install googleapis
8257
+ * // ```
8258
+ *
8259
+ * const {google} = require('googleapis');
8260
+ * const alloydb = google.alloydb('v1beta');
8261
+ *
8262
+ * async function main() {
8263
+ * const auth = new google.auth.GoogleAuth({
8264
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
8265
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
8266
+ * });
8267
+ *
8268
+ * // Acquire an auth client, and bind it to all future calls
8269
+ * const authClient = await auth.getClient();
8270
+ * google.options({auth: authClient});
8271
+ *
8272
+ * // Do the magic
8273
+ * const res = await alloydb.projects.locations.clusters.users.get({
8274
+ * // Required. The name of the resource. For the required format, see the comment on the User.name field.
8275
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/users/my-user',
8276
+ * });
8277
+ * console.log(res.data);
8278
+ *
8279
+ * // Example response
8280
+ * // {
8281
+ * // "databaseRoles": [],
8282
+ * // "keepExtraRoles": false,
8283
+ * // "name": "my_name",
8284
+ * // "password": "my_password",
8285
+ * // "userType": "my_userType"
8286
+ * // }
8287
+ * }
8288
+ *
8289
+ * main().catch(e => {
8290
+ * console.error(e);
8291
+ * throw e;
8292
+ * });
8293
+ *
8294
+ * ```
5937
8295
  *
5938
8296
  * @param params - Parameters for request
5939
8297
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6022,6 +8380,62 @@ export namespace alloydb_v1beta {
6022
8380
 
6023
8381
  /**
6024
8382
  * Lists Users in a given project and location.
8383
+ * @example
8384
+ * ```js
8385
+ * // Before running the sample:
8386
+ * // - Enable the API at:
8387
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
8388
+ * // - Login into gcloud by running:
8389
+ * // ```sh
8390
+ * // $ gcloud auth application-default login
8391
+ * // ```
8392
+ * // - Install the npm module by running:
8393
+ * // ```sh
8394
+ * // $ npm install googleapis
8395
+ * // ```
8396
+ *
8397
+ * const {google} = require('googleapis');
8398
+ * const alloydb = google.alloydb('v1beta');
8399
+ *
8400
+ * async function main() {
8401
+ * const auth = new google.auth.GoogleAuth({
8402
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
8403
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
8404
+ * });
8405
+ *
8406
+ * // Acquire an auth client, and bind it to all future calls
8407
+ * const authClient = await auth.getClient();
8408
+ * google.options({auth: authClient});
8409
+ *
8410
+ * // Do the magic
8411
+ * const res = await alloydb.projects.locations.clusters.users.list({
8412
+ * // Optional. Filtering results
8413
+ * filter: 'placeholder-value',
8414
+ * // Optional. Hint for how to order the results
8415
+ * orderBy: 'placeholder-value',
8416
+ * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
8417
+ * pageSize: 'placeholder-value',
8418
+ * // Optional. A token identifying a page of results the server should return.
8419
+ * pageToken: 'placeholder-value',
8420
+ * // Required. Parent value for ListUsersRequest
8421
+ * parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
8422
+ * });
8423
+ * console.log(res.data);
8424
+ *
8425
+ * // Example response
8426
+ * // {
8427
+ * // "nextPageToken": "my_nextPageToken",
8428
+ * // "unreachable": [],
8429
+ * // "users": []
8430
+ * // }
8431
+ * }
8432
+ *
8433
+ * main().catch(e => {
8434
+ * console.error(e);
8435
+ * throw e;
8436
+ * });
8437
+ *
8438
+ * ```
6025
8439
  *
6026
8440
  * @param params - Parameters for request
6027
8441
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6113,6 +8527,76 @@ export namespace alloydb_v1beta {
6113
8527
 
6114
8528
  /**
6115
8529
  * Updates the parameters of a single User.
8530
+ * @example
8531
+ * ```js
8532
+ * // Before running the sample:
8533
+ * // - Enable the API at:
8534
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
8535
+ * // - Login into gcloud by running:
8536
+ * // ```sh
8537
+ * // $ gcloud auth application-default login
8538
+ * // ```
8539
+ * // - Install the npm module by running:
8540
+ * // ```sh
8541
+ * // $ npm install googleapis
8542
+ * // ```
8543
+ *
8544
+ * const {google} = require('googleapis');
8545
+ * const alloydb = google.alloydb('v1beta');
8546
+ *
8547
+ * async function main() {
8548
+ * const auth = new google.auth.GoogleAuth({
8549
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
8550
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
8551
+ * });
8552
+ *
8553
+ * // Acquire an auth client, and bind it to all future calls
8554
+ * const authClient = await auth.getClient();
8555
+ * google.options({auth: authClient});
8556
+ *
8557
+ * // Do the magic
8558
+ * const res = await alloydb.projects.locations.clusters.users.patch({
8559
+ * // Optional. Allow missing fields in the update mask.
8560
+ * allowMissing: 'placeholder-value',
8561
+ * // Output only. Name of the resource in the form of projects/{project\}/locations/{location\}/cluster/{cluster\}/users/{user\}.
8562
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/users/my-user',
8563
+ * // 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).
8564
+ * requestId: 'placeholder-value',
8565
+ * // 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.
8566
+ * updateMask: 'placeholder-value',
8567
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
8568
+ * validateOnly: 'placeholder-value',
8569
+ *
8570
+ * // Request body metadata
8571
+ * requestBody: {
8572
+ * // request body parameters
8573
+ * // {
8574
+ * // "databaseRoles": [],
8575
+ * // "keepExtraRoles": false,
8576
+ * // "name": "my_name",
8577
+ * // "password": "my_password",
8578
+ * // "userType": "my_userType"
8579
+ * // }
8580
+ * },
8581
+ * });
8582
+ * console.log(res.data);
8583
+ *
8584
+ * // Example response
8585
+ * // {
8586
+ * // "databaseRoles": [],
8587
+ * // "keepExtraRoles": false,
8588
+ * // "name": "my_name",
8589
+ * // "password": "my_password",
8590
+ * // "userType": "my_userType"
8591
+ * // }
8592
+ * }
8593
+ *
8594
+ * main().catch(e => {
8595
+ * console.error(e);
8596
+ * throw e;
8597
+ * });
8598
+ *
8599
+ * ```
6116
8600
  *
6117
8601
  * @param params - Parameters for request
6118
8602
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6306,6 +8790,50 @@ export namespace alloydb_v1beta {
6306
8790
 
6307
8791
  /**
6308
8792
  * 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`.
8793
+ * @example
8794
+ * ```js
8795
+ * // Before running the sample:
8796
+ * // - Enable the API at:
8797
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
8798
+ * // - Login into gcloud by running:
8799
+ * // ```sh
8800
+ * // $ gcloud auth application-default login
8801
+ * // ```
8802
+ * // - Install the npm module by running:
8803
+ * // ```sh
8804
+ * // $ npm install googleapis
8805
+ * // ```
8806
+ *
8807
+ * const {google} = require('googleapis');
8808
+ * const alloydb = google.alloydb('v1beta');
8809
+ *
8810
+ * async function main() {
8811
+ * const auth = new google.auth.GoogleAuth({
8812
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
8813
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
8814
+ * });
8815
+ *
8816
+ * // Acquire an auth client, and bind it to all future calls
8817
+ * const authClient = await auth.getClient();
8818
+ * google.options({auth: authClient});
8819
+ *
8820
+ * // Do the magic
8821
+ * const res = await alloydb.projects.locations.operations.cancel({
8822
+ * // The name of the operation resource to be cancelled.
8823
+ * name: 'projects/my-project/locations/my-location/operations/my-operation',
8824
+ * });
8825
+ * console.log(res.data);
8826
+ *
8827
+ * // Example response
8828
+ * // {}
8829
+ * }
8830
+ *
8831
+ * main().catch(e => {
8832
+ * console.error(e);
8833
+ * throw e;
8834
+ * });
8835
+ *
8836
+ * ```
6309
8837
  *
6310
8838
  * @param params - Parameters for request
6311
8839
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6397,6 +8925,50 @@ export namespace alloydb_v1beta {
6397
8925
 
6398
8926
  /**
6399
8927
  * 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`.
8928
+ * @example
8929
+ * ```js
8930
+ * // Before running the sample:
8931
+ * // - Enable the API at:
8932
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
8933
+ * // - Login into gcloud by running:
8934
+ * // ```sh
8935
+ * // $ gcloud auth application-default login
8936
+ * // ```
8937
+ * // - Install the npm module by running:
8938
+ * // ```sh
8939
+ * // $ npm install googleapis
8940
+ * // ```
8941
+ *
8942
+ * const {google} = require('googleapis');
8943
+ * const alloydb = google.alloydb('v1beta');
8944
+ *
8945
+ * async function main() {
8946
+ * const auth = new google.auth.GoogleAuth({
8947
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
8948
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
8949
+ * });
8950
+ *
8951
+ * // Acquire an auth client, and bind it to all future calls
8952
+ * const authClient = await auth.getClient();
8953
+ * google.options({auth: authClient});
8954
+ *
8955
+ * // Do the magic
8956
+ * const res = await alloydb.projects.locations.operations.delete({
8957
+ * // The name of the operation resource to be deleted.
8958
+ * name: 'projects/my-project/locations/my-location/operations/my-operation',
8959
+ * });
8960
+ * console.log(res.data);
8961
+ *
8962
+ * // Example response
8963
+ * // {}
8964
+ * }
8965
+ *
8966
+ * main().catch(e => {
8967
+ * console.error(e);
8968
+ * throw e;
8969
+ * });
8970
+ *
8971
+ * ```
6400
8972
  *
6401
8973
  * @param params - Parameters for request
6402
8974
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6485,6 +9057,56 @@ export namespace alloydb_v1beta {
6485
9057
 
6486
9058
  /**
6487
9059
  * 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.
9060
+ * @example
9061
+ * ```js
9062
+ * // Before running the sample:
9063
+ * // - Enable the API at:
9064
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
9065
+ * // - Login into gcloud by running:
9066
+ * // ```sh
9067
+ * // $ gcloud auth application-default login
9068
+ * // ```
9069
+ * // - Install the npm module by running:
9070
+ * // ```sh
9071
+ * // $ npm install googleapis
9072
+ * // ```
9073
+ *
9074
+ * const {google} = require('googleapis');
9075
+ * const alloydb = google.alloydb('v1beta');
9076
+ *
9077
+ * async function main() {
9078
+ * const auth = new google.auth.GoogleAuth({
9079
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
9080
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
9081
+ * });
9082
+ *
9083
+ * // Acquire an auth client, and bind it to all future calls
9084
+ * const authClient = await auth.getClient();
9085
+ * google.options({auth: authClient});
9086
+ *
9087
+ * // Do the magic
9088
+ * const res = await alloydb.projects.locations.operations.get({
9089
+ * // The name of the operation resource.
9090
+ * name: 'projects/my-project/locations/my-location/operations/my-operation',
9091
+ * });
9092
+ * console.log(res.data);
9093
+ *
9094
+ * // Example response
9095
+ * // {
9096
+ * // "done": false,
9097
+ * // "error": {},
9098
+ * // "metadata": {},
9099
+ * // "name": "my_name",
9100
+ * // "response": {}
9101
+ * // }
9102
+ * }
9103
+ *
9104
+ * main().catch(e => {
9105
+ * console.error(e);
9106
+ * throw e;
9107
+ * });
9108
+ *
9109
+ * ```
6488
9110
  *
6489
9111
  * @param params - Parameters for request
6490
9112
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6573,6 +9195,59 @@ export namespace alloydb_v1beta {
6573
9195
 
6574
9196
  /**
6575
9197
  * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
9198
+ * @example
9199
+ * ```js
9200
+ * // Before running the sample:
9201
+ * // - Enable the API at:
9202
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
9203
+ * // - Login into gcloud by running:
9204
+ * // ```sh
9205
+ * // $ gcloud auth application-default login
9206
+ * // ```
9207
+ * // - Install the npm module by running:
9208
+ * // ```sh
9209
+ * // $ npm install googleapis
9210
+ * // ```
9211
+ *
9212
+ * const {google} = require('googleapis');
9213
+ * const alloydb = google.alloydb('v1beta');
9214
+ *
9215
+ * async function main() {
9216
+ * const auth = new google.auth.GoogleAuth({
9217
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
9218
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
9219
+ * });
9220
+ *
9221
+ * // Acquire an auth client, and bind it to all future calls
9222
+ * const authClient = await auth.getClient();
9223
+ * google.options({auth: authClient});
9224
+ *
9225
+ * // Do the magic
9226
+ * const res = await alloydb.projects.locations.operations.list({
9227
+ * // The standard list filter.
9228
+ * filter: 'placeholder-value',
9229
+ * // The name of the operation's parent resource.
9230
+ * name: 'projects/my-project/locations/my-location',
9231
+ * // The standard list page size.
9232
+ * pageSize: 'placeholder-value',
9233
+ * // The standard list page token.
9234
+ * pageToken: 'placeholder-value',
9235
+ * });
9236
+ * console.log(res.data);
9237
+ *
9238
+ * // Example response
9239
+ * // {
9240
+ * // "nextPageToken": "my_nextPageToken",
9241
+ * // "operations": []
9242
+ * // }
9243
+ * }
9244
+ *
9245
+ * main().catch(e => {
9246
+ * console.error(e);
9247
+ * throw e;
9248
+ * });
9249
+ *
9250
+ * ```
6576
9251
  *
6577
9252
  * @param params - Parameters for request
6578
9253
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6714,6 +9389,59 @@ export namespace alloydb_v1beta {
6714
9389
 
6715
9390
  /**
6716
9391
  * Lists SupportedDatabaseFlags for a given project and location.
9392
+ * @example
9393
+ * ```js
9394
+ * // Before running the sample:
9395
+ * // - Enable the API at:
9396
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
9397
+ * // - Login into gcloud by running:
9398
+ * // ```sh
9399
+ * // $ gcloud auth application-default login
9400
+ * // ```
9401
+ * // - Install the npm module by running:
9402
+ * // ```sh
9403
+ * // $ npm install googleapis
9404
+ * // ```
9405
+ *
9406
+ * const {google} = require('googleapis');
9407
+ * const alloydb = google.alloydb('v1beta');
9408
+ *
9409
+ * async function main() {
9410
+ * const auth = new google.auth.GoogleAuth({
9411
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
9412
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
9413
+ * });
9414
+ *
9415
+ * // Acquire an auth client, and bind it to all future calls
9416
+ * const authClient = await auth.getClient();
9417
+ * google.options({auth: authClient});
9418
+ *
9419
+ * // Do the magic
9420
+ * const res = await alloydb.projects.locations.supportedDatabaseFlags.list({
9421
+ * // Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
9422
+ * pageSize: 'placeholder-value',
9423
+ * // A token identifying a page of results the server should return.
9424
+ * pageToken: 'placeholder-value',
9425
+ * // 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.
9426
+ * parent: 'projects/my-project/locations/my-location',
9427
+ * // Optional. The scope for which supported flags are requested. If not specified, default is DATABASE.
9428
+ * scope: 'placeholder-value',
9429
+ * });
9430
+ * console.log(res.data);
9431
+ *
9432
+ * // Example response
9433
+ * // {
9434
+ * // "nextPageToken": "my_nextPageToken",
9435
+ * // "supportedDatabaseFlags": []
9436
+ * // }
9437
+ * }
9438
+ *
9439
+ * main().catch(e => {
9440
+ * console.error(e);
9441
+ * throw e;
9442
+ * });
9443
+ *
9444
+ * ```
6717
9445
  *
6718
9446
  * @param params - Parameters for request
6719
9447
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.