@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.
@@ -412,6 +412,10 @@ export declare namespace alloydb_v1alpha {
412
412
  * Cross Region replication config specific to SECONDARY cluster.
413
413
  */
414
414
  secondaryConfig?: Schema$SecondaryConfig;
415
+ /**
416
+ * 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.
417
+ */
418
+ serviceAccountEmail?: string | null;
415
419
  /**
416
420
  * SSL configuration for this AlloyDB cluster.
417
421
  */
@@ -506,7 +510,7 @@ export declare namespace alloydb_v1alpha {
506
510
  */
507
511
  export interface Schema$ConnectionPoolConfig {
508
512
  /**
509
- * Optional. Deprecated. Use 'flags' instead. The default pool size. Defaults to 20.
513
+ * 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.
510
514
  */
511
515
  defaultPoolSize?: string | null;
512
516
  /**
@@ -524,35 +528,39 @@ export declare namespace alloydb_v1alpha {
524
528
  [key: string]: string;
525
529
  } | null;
526
530
  /**
527
- * Optional. Deprecated. Use 'flags' instead. The list of startup parameters to ignore. Defaults to ["extra_float_digits"]
531
+ * 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.
528
532
  */
529
533
  ignoreStartupParameters?: string[] | null;
530
534
  /**
531
- * Optional. Deprecated. Use 'flags' instead. The maximum number of client connections allowed.
535
+ * 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.
532
536
  */
533
537
  maxClientConn?: string | null;
534
538
  /**
535
- * 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.
539
+ * 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.
536
540
  */
537
541
  maxPreparedStatements?: string | null;
538
542
  /**
539
- * Optional. Deprecated. Use 'flags' instead. The minimum pool size. Defaults to 0.
543
+ * 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.
540
544
  */
541
545
  minPoolSize?: string | null;
542
546
  /**
543
- * Optional. Deprecated. Use 'flags' instead. The pool mode. Defaults to `POOL_MODE_TRANSACTION`.
547
+ * Output only. The number of running poolers per instance.
548
+ */
549
+ poolerCount?: number | null;
550
+ /**
551
+ * 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.
544
552
  */
545
553
  poolMode?: string | null;
546
554
  /**
547
- * 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.
555
+ * 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.
548
556
  */
549
557
  queryWaitTimeout?: string | null;
550
558
  /**
551
- * Optional. Deprecated. Use 'flags' instead. The maximum number of seconds a server is allowed to be idle before it is disconnected. 0 disables.
559
+ * 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.
552
560
  */
553
561
  serverIdleTimeout?: string | null;
554
562
  /**
555
- * 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.
563
+ * 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.
556
564
  */
557
565
  statsUsers?: string[] | null;
558
566
  }
@@ -750,7 +758,7 @@ export declare namespace alloydb_v1alpha {
750
758
  uri?: string | null;
751
759
  }
752
760
  /**
753
- * Deprecated and unused. This field will be removed in the near future.
761
+ * Deprecated and unused. This message will be removed in the near future.
754
762
  */
755
763
  export interface Schema$GeminiClusterConfig {
756
764
  /**
@@ -759,7 +767,7 @@ export declare namespace alloydb_v1alpha {
759
767
  entitled?: boolean | null;
760
768
  }
761
769
  /**
762
- * Deprecated and unused. This field will be removed in the near future.
770
+ * Deprecated and unused. This message will be removed in the near future.
763
771
  */
764
772
  export interface Schema$GeminiInstanceConfig {
765
773
  /**
@@ -1041,7 +1049,7 @@ export declare namespace alloydb_v1alpha {
1041
1049
  */
1042
1050
  export interface Schema$InstanceNetworkConfig {
1043
1051
  /**
1044
- * 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://go/rfc/1035). Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.
1052
+ * 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])?.
1045
1053
  */
1046
1054
  allocatedIpRangeOverride?: string | null;
1047
1055
  /**
@@ -1062,7 +1070,7 @@ export declare namespace alloydb_v1alpha {
1062
1070
  network?: string | null;
1063
1071
  }
1064
1072
  /**
1065
- * Details regarding the upgrade of instaces associated with a cluster.
1073
+ * Details regarding the upgrade of instances associated with a cluster.
1066
1074
  */
1067
1075
  export interface Schema$InstanceUpgradeDetails {
1068
1076
  /**
@@ -1316,6 +1324,10 @@ export declare namespace alloydb_v1alpha {
1316
1324
  * Track actively running queries on the instance. If not set, this flag is "off" by default.
1317
1325
  */
1318
1326
  trackActiveQueries?: boolean | null;
1327
+ /**
1328
+ * Track client address for an instance. If not set, default value is "off".
1329
+ */
1330
+ trackClientAddress?: boolean | null;
1319
1331
  /**
1320
1332
  * 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.
1321
1333
  */
@@ -1675,6 +1687,27 @@ export declare namespace alloydb_v1alpha {
1675
1687
  */
1676
1688
  status?: string | null;
1677
1689
  }
1690
+ /**
1691
+ * Timing information for the stage execution.
1692
+ */
1693
+ export interface Schema$StageSchedule {
1694
+ /**
1695
+ * Actual end time of the stage. Set only if the stage has completed.
1696
+ */
1697
+ actualEndTime?: string | null;
1698
+ /**
1699
+ * Actual start time of the stage. Set only if the stage has started.
1700
+ */
1701
+ actualStartTime?: string | null;
1702
+ /**
1703
+ * When the stage is expected to end. Set only if the stage has not completed yet.
1704
+ */
1705
+ estimatedEndTime?: string | null;
1706
+ /**
1707
+ * When the stage is expected to start. Set only if the stage has not started yet.
1708
+ */
1709
+ estimatedStartTime?: string | null;
1710
+ }
1678
1711
  /**
1679
1712
  * Status of an upgrade stage.
1680
1713
  */
@@ -1683,6 +1716,10 @@ export declare namespace alloydb_v1alpha {
1683
1716
  * Read pool instances upgrade metadata.
1684
1717
  */
1685
1718
  readPoolInstancesUpgrade?: Schema$ReadPoolInstancesUpgradeStageStatus;
1719
+ /**
1720
+ * Output only. Timing information for the stage execution.
1721
+ */
1722
+ schedule?: Schema$StageSchedule;
1686
1723
  /**
1687
1724
  * Upgrade stage.
1688
1725
  */
@@ -1768,6 +1805,15 @@ export declare namespace alloydb_v1alpha {
1768
1805
  */
1769
1806
  pointInTimeRecoveryEnabled?: boolean | null;
1770
1807
  }
1808
+ /**
1809
+ * BackupDRConfiguration to capture the backup and disaster recovery details of database resource.
1810
+ */
1811
+ export interface Schema$StorageDatabasecenterPartnerapiV1mainBackupDRConfiguration {
1812
+ /**
1813
+ * Indicates if the resource is managed by BackupDR.
1814
+ */
1815
+ backupdrManaged?: boolean | null;
1816
+ }
1771
1817
  /**
1772
1818
  * A backup run.
1773
1819
  */
@@ -1802,6 +1848,31 @@ export declare namespace alloydb_v1alpha {
1802
1848
  */
1803
1849
  version?: string | null;
1804
1850
  }
1851
+ /**
1852
+ * 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.
1853
+ */
1854
+ export interface Schema$StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData {
1855
+ /**
1856
+ * Required. Full Resource name of the source resource.
1857
+ */
1858
+ fullResourceName?: string | null;
1859
+ /**
1860
+ * Required. Last time signal was refreshed
1861
+ */
1862
+ lastRefreshTime?: string | null;
1863
+ /**
1864
+ * Database resource id.
1865
+ */
1866
+ resourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId;
1867
+ /**
1868
+ * Signal data for boolean signals.
1869
+ */
1870
+ signalBoolValue?: boolean | null;
1871
+ /**
1872
+ * Required. Signal type of the signal
1873
+ */
1874
+ signalType?: string | null;
1875
+ }
1805
1876
  /**
1806
1877
  * 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
1807
1878
  */
@@ -1812,9 +1883,13 @@ export declare namespace alloydb_v1alpha {
1812
1883
  internalResourceMetadata?: Schema$StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata[];
1813
1884
  }
1814
1885
  /**
1815
- * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform.
1886
+ * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 9
1816
1887
  */
1817
1888
  export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed {
1889
+ /**
1890
+ * Config based signal data is used to ingest signals that are generated based on the configuration of the database resource.
1891
+ */
1892
+ configBasedSignalData?: Schema$StorageDatabasecenterPartnerapiV1mainConfigBasedSignalData;
1818
1893
  /**
1819
1894
  * Required. Timestamp when feed is generated.
1820
1895
  */
@@ -1858,6 +1933,10 @@ export declare namespace alloydb_v1alpha {
1858
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.
1859
1934
  */
1860
1935
  externalUri?: string | null;
1936
+ /**
1937
+ * This is used to identify the location of the resource. Example: "us-central1"
1938
+ */
1939
+ location?: string | null;
1861
1940
  /**
1862
1941
  * Required. The name of the signal, ex: PUBLIC_SQL_INSTANCE, SQL_LOG_ERROR_VERBOSITY etc.
1863
1942
  */
@@ -1905,7 +1984,7 @@ export declare namespace alloydb_v1alpha {
1905
1984
  */
1906
1985
  providerDescription?: string | null;
1907
1986
  /**
1908
- * 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
1909
1988
  */
1910
1989
  resourceType?: string | null;
1911
1990
  /**
@@ -1914,7 +1993,7 @@ export declare namespace alloydb_v1alpha {
1914
1993
  uniqueId?: string | null;
1915
1994
  }
1916
1995
  /**
1917
- * Common model for database resource instance metadata. Next ID: 25
1996
+ * Common model for database resource instance metadata. Next ID: 26
1918
1997
  */
1919
1998
  export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata {
1920
1999
  /**
@@ -1925,6 +2004,10 @@ export declare namespace alloydb_v1alpha {
1925
2004
  * Backup configuration for this instance
1926
2005
  */
1927
2006
  backupConfiguration?: Schema$StorageDatabasecenterPartnerapiV1mainBackupConfiguration;
2007
+ /**
2008
+ * Optional. BackupDR Configuration for the resource.
2009
+ */
2010
+ backupdrConfiguration?: Schema$StorageDatabasecenterPartnerapiV1mainBackupDRConfiguration;
1928
2011
  /**
1929
2012
  * Latest backup run information for this instance
1930
2013
  */
@@ -2194,6 +2277,10 @@ export declare namespace alloydb_v1alpha {
2194
2277
  * The specific engine that the underlying database is running.
2195
2278
  */
2196
2279
  engine?: string | null;
2280
+ /**
2281
+ * 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..
2282
+ */
2283
+ minorVersion?: string | null;
2197
2284
  /**
2198
2285
  * Type of specific database product. It could be CloudSQL, AlloyDB etc..
2199
2286
  */
@@ -2459,6 +2546,56 @@ export declare namespace alloydb_v1alpha {
2459
2546
  constructor(context: APIRequestContext);
2460
2547
  /**
2461
2548
  * Gets information about a location.
2549
+ * @example
2550
+ * ```js
2551
+ * // Before running the sample:
2552
+ * // - Enable the API at:
2553
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
2554
+ * // - Login into gcloud by running:
2555
+ * // ```sh
2556
+ * // $ gcloud auth application-default login
2557
+ * // ```
2558
+ * // - Install the npm module by running:
2559
+ * // ```sh
2560
+ * // $ npm install googleapis
2561
+ * // ```
2562
+ *
2563
+ * const {google} = require('googleapis');
2564
+ * const alloydb = google.alloydb('v1alpha');
2565
+ *
2566
+ * async function main() {
2567
+ * const auth = new google.auth.GoogleAuth({
2568
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2569
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2570
+ * });
2571
+ *
2572
+ * // Acquire an auth client, and bind it to all future calls
2573
+ * const authClient = await auth.getClient();
2574
+ * google.options({auth: authClient});
2575
+ *
2576
+ * // Do the magic
2577
+ * const res = await alloydb.projects.locations.get({
2578
+ * // Resource name for the location.
2579
+ * name: 'projects/my-project/locations/my-location',
2580
+ * });
2581
+ * console.log(res.data);
2582
+ *
2583
+ * // Example response
2584
+ * // {
2585
+ * // "displayName": "my_displayName",
2586
+ * // "labels": {},
2587
+ * // "locationId": "my_locationId",
2588
+ * // "metadata": {},
2589
+ * // "name": "my_name"
2590
+ * // }
2591
+ * }
2592
+ *
2593
+ * main().catch(e => {
2594
+ * console.error(e);
2595
+ * throw e;
2596
+ * });
2597
+ *
2598
+ * ```
2462
2599
  *
2463
2600
  * @param params - Parameters for request
2464
2601
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2473,6 +2610,61 @@ export declare namespace alloydb_v1alpha {
2473
2610
  get(callback: BodyResponseCallback<Schema$GoogleCloudLocationLocation>): void;
2474
2611
  /**
2475
2612
  * Lists information about the supported locations for this service.
2613
+ * @example
2614
+ * ```js
2615
+ * // Before running the sample:
2616
+ * // - Enable the API at:
2617
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
2618
+ * // - Login into gcloud by running:
2619
+ * // ```sh
2620
+ * // $ gcloud auth application-default login
2621
+ * // ```
2622
+ * // - Install the npm module by running:
2623
+ * // ```sh
2624
+ * // $ npm install googleapis
2625
+ * // ```
2626
+ *
2627
+ * const {google} = require('googleapis');
2628
+ * const alloydb = google.alloydb('v1alpha');
2629
+ *
2630
+ * async function main() {
2631
+ * const auth = new google.auth.GoogleAuth({
2632
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2633
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2634
+ * });
2635
+ *
2636
+ * // Acquire an auth client, and bind it to all future calls
2637
+ * const authClient = await auth.getClient();
2638
+ * google.options({auth: authClient});
2639
+ *
2640
+ * // Do the magic
2641
+ * const res = await alloydb.projects.locations.list({
2642
+ * // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.
2643
+ * extraLocationTypes: 'placeholder-value',
2644
+ * // 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).
2645
+ * filter: 'placeholder-value',
2646
+ * // The resource that owns the locations collection, if applicable.
2647
+ * name: 'projects/my-project',
2648
+ * // The maximum number of results to return. If not set, the service selects a default.
2649
+ * pageSize: 'placeholder-value',
2650
+ * // A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
2651
+ * pageToken: 'placeholder-value',
2652
+ * });
2653
+ * console.log(res.data);
2654
+ *
2655
+ * // Example response
2656
+ * // {
2657
+ * // "locations": [],
2658
+ * // "nextPageToken": "my_nextPageToken"
2659
+ * // }
2660
+ * }
2661
+ *
2662
+ * main().catch(e => {
2663
+ * console.error(e);
2664
+ * throw e;
2665
+ * });
2666
+ *
2667
+ * ```
2476
2668
  *
2477
2669
  * @param params - Parameters for request
2478
2670
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2519,6 +2711,94 @@ export declare namespace alloydb_v1alpha {
2519
2711
  constructor(context: APIRequestContext);
2520
2712
  /**
2521
2713
  * Creates a new Backup in a given project and location.
2714
+ * @example
2715
+ * ```js
2716
+ * // Before running the sample:
2717
+ * // - Enable the API at:
2718
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
2719
+ * // - Login into gcloud by running:
2720
+ * // ```sh
2721
+ * // $ gcloud auth application-default login
2722
+ * // ```
2723
+ * // - Install the npm module by running:
2724
+ * // ```sh
2725
+ * // $ npm install googleapis
2726
+ * // ```
2727
+ *
2728
+ * const {google} = require('googleapis');
2729
+ * const alloydb = google.alloydb('v1alpha');
2730
+ *
2731
+ * async function main() {
2732
+ * const auth = new google.auth.GoogleAuth({
2733
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2734
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2735
+ * });
2736
+ *
2737
+ * // Acquire an auth client, and bind it to all future calls
2738
+ * const authClient = await auth.getClient();
2739
+ * google.options({auth: authClient});
2740
+ *
2741
+ * // Do the magic
2742
+ * const res = await alloydb.projects.locations.backups.create({
2743
+ * // Required. ID of the requesting object.
2744
+ * backupId: 'placeholder-value',
2745
+ * // Required. Value for parent.
2746
+ * parent: 'projects/my-project/locations/my-location',
2747
+ * // 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).
2748
+ * requestId: 'placeholder-value',
2749
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
2750
+ * validateOnly: 'placeholder-value',
2751
+ *
2752
+ * // Request body metadata
2753
+ * requestBody: {
2754
+ * // request body parameters
2755
+ * // {
2756
+ * // "annotations": {},
2757
+ * // "clusterName": "my_clusterName",
2758
+ * // "clusterUid": "my_clusterUid",
2759
+ * // "createCompletionTime": "my_createCompletionTime",
2760
+ * // "createTime": "my_createTime",
2761
+ * // "databaseVersion": "my_databaseVersion",
2762
+ * // "deleteTime": "my_deleteTime",
2763
+ * // "description": "my_description",
2764
+ * // "displayName": "my_displayName",
2765
+ * // "encryptionConfig": {},
2766
+ * // "encryptionInfo": {},
2767
+ * // "etag": "my_etag",
2768
+ * // "expiryQuantity": {},
2769
+ * // "expiryTime": "my_expiryTime",
2770
+ * // "labels": {},
2771
+ * // "name": "my_name",
2772
+ * // "reconciling": false,
2773
+ * // "satisfiesPzi": false,
2774
+ * // "satisfiesPzs": false,
2775
+ * // "sizeBytes": "my_sizeBytes",
2776
+ * // "state": "my_state",
2777
+ * // "tags": {},
2778
+ * // "type": "my_type",
2779
+ * // "uid": "my_uid",
2780
+ * // "updateTime": "my_updateTime"
2781
+ * // }
2782
+ * },
2783
+ * });
2784
+ * console.log(res.data);
2785
+ *
2786
+ * // Example response
2787
+ * // {
2788
+ * // "done": false,
2789
+ * // "error": {},
2790
+ * // "metadata": {},
2791
+ * // "name": "my_name",
2792
+ * // "response": {}
2793
+ * // }
2794
+ * }
2795
+ *
2796
+ * main().catch(e => {
2797
+ * console.error(e);
2798
+ * throw e;
2799
+ * });
2800
+ *
2801
+ * ```
2522
2802
  *
2523
2803
  * @param params - Parameters for request
2524
2804
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2533,6 +2813,62 @@ export declare namespace alloydb_v1alpha {
2533
2813
  create(callback: BodyResponseCallback<Schema$Operation>): void;
2534
2814
  /**
2535
2815
  * Deletes a single Backup.
2816
+ * @example
2817
+ * ```js
2818
+ * // Before running the sample:
2819
+ * // - Enable the API at:
2820
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
2821
+ * // - Login into gcloud by running:
2822
+ * // ```sh
2823
+ * // $ gcloud auth application-default login
2824
+ * // ```
2825
+ * // - Install the npm module by running:
2826
+ * // ```sh
2827
+ * // $ npm install googleapis
2828
+ * // ```
2829
+ *
2830
+ * const {google} = require('googleapis');
2831
+ * const alloydb = google.alloydb('v1alpha');
2832
+ *
2833
+ * async function main() {
2834
+ * const auth = new google.auth.GoogleAuth({
2835
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2836
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2837
+ * });
2838
+ *
2839
+ * // Acquire an auth client, and bind it to all future calls
2840
+ * const authClient = await auth.getClient();
2841
+ * google.options({auth: authClient});
2842
+ *
2843
+ * // Do the magic
2844
+ * const res = await alloydb.projects.locations.backups.delete({
2845
+ * // 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.
2846
+ * etag: 'placeholder-value',
2847
+ * // Required. Name of the resource. For the required format, see the comment on the Backup.name field.
2848
+ * name: 'projects/my-project/locations/my-location/backups/my-backup',
2849
+ * // 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).
2850
+ * requestId: 'placeholder-value',
2851
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
2852
+ * validateOnly: 'placeholder-value',
2853
+ * });
2854
+ * console.log(res.data);
2855
+ *
2856
+ * // Example response
2857
+ * // {
2858
+ * // "done": false,
2859
+ * // "error": {},
2860
+ * // "metadata": {},
2861
+ * // "name": "my_name",
2862
+ * // "response": {}
2863
+ * // }
2864
+ * }
2865
+ *
2866
+ * main().catch(e => {
2867
+ * console.error(e);
2868
+ * throw e;
2869
+ * });
2870
+ *
2871
+ * ```
2536
2872
  *
2537
2873
  * @param params - Parameters for request
2538
2874
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2547,6 +2883,76 @@ export declare namespace alloydb_v1alpha {
2547
2883
  delete(callback: BodyResponseCallback<Schema$Operation>): void;
2548
2884
  /**
2549
2885
  * Gets details of a single Backup.
2886
+ * @example
2887
+ * ```js
2888
+ * // Before running the sample:
2889
+ * // - Enable the API at:
2890
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
2891
+ * // - Login into gcloud by running:
2892
+ * // ```sh
2893
+ * // $ gcloud auth application-default login
2894
+ * // ```
2895
+ * // - Install the npm module by running:
2896
+ * // ```sh
2897
+ * // $ npm install googleapis
2898
+ * // ```
2899
+ *
2900
+ * const {google} = require('googleapis');
2901
+ * const alloydb = google.alloydb('v1alpha');
2902
+ *
2903
+ * async function main() {
2904
+ * const auth = new google.auth.GoogleAuth({
2905
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2906
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2907
+ * });
2908
+ *
2909
+ * // Acquire an auth client, and bind it to all future calls
2910
+ * const authClient = await auth.getClient();
2911
+ * google.options({auth: authClient});
2912
+ *
2913
+ * // Do the magic
2914
+ * const res = await alloydb.projects.locations.backups.get({
2915
+ * // Required. Name of the resource
2916
+ * name: 'projects/my-project/locations/my-location/backups/my-backup',
2917
+ * });
2918
+ * console.log(res.data);
2919
+ *
2920
+ * // Example response
2921
+ * // {
2922
+ * // "annotations": {},
2923
+ * // "clusterName": "my_clusterName",
2924
+ * // "clusterUid": "my_clusterUid",
2925
+ * // "createCompletionTime": "my_createCompletionTime",
2926
+ * // "createTime": "my_createTime",
2927
+ * // "databaseVersion": "my_databaseVersion",
2928
+ * // "deleteTime": "my_deleteTime",
2929
+ * // "description": "my_description",
2930
+ * // "displayName": "my_displayName",
2931
+ * // "encryptionConfig": {},
2932
+ * // "encryptionInfo": {},
2933
+ * // "etag": "my_etag",
2934
+ * // "expiryQuantity": {},
2935
+ * // "expiryTime": "my_expiryTime",
2936
+ * // "labels": {},
2937
+ * // "name": "my_name",
2938
+ * // "reconciling": false,
2939
+ * // "satisfiesPzi": false,
2940
+ * // "satisfiesPzs": false,
2941
+ * // "sizeBytes": "my_sizeBytes",
2942
+ * // "state": "my_state",
2943
+ * // "tags": {},
2944
+ * // "type": "my_type",
2945
+ * // "uid": "my_uid",
2946
+ * // "updateTime": "my_updateTime"
2947
+ * // }
2948
+ * }
2949
+ *
2950
+ * main().catch(e => {
2951
+ * console.error(e);
2952
+ * throw e;
2953
+ * });
2954
+ *
2955
+ * ```
2550
2956
  *
2551
2957
  * @param params - Parameters for request
2552
2958
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2561,6 +2967,62 @@ export declare namespace alloydb_v1alpha {
2561
2967
  get(callback: BodyResponseCallback<Schema$Backup>): void;
2562
2968
  /**
2563
2969
  * Lists Backups in a given project and location.
2970
+ * @example
2971
+ * ```js
2972
+ * // Before running the sample:
2973
+ * // - Enable the API at:
2974
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
2975
+ * // - Login into gcloud by running:
2976
+ * // ```sh
2977
+ * // $ gcloud auth application-default login
2978
+ * // ```
2979
+ * // - Install the npm module by running:
2980
+ * // ```sh
2981
+ * // $ npm install googleapis
2982
+ * // ```
2983
+ *
2984
+ * const {google} = require('googleapis');
2985
+ * const alloydb = google.alloydb('v1alpha');
2986
+ *
2987
+ * async function main() {
2988
+ * const auth = new google.auth.GoogleAuth({
2989
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2990
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2991
+ * });
2992
+ *
2993
+ * // Acquire an auth client, and bind it to all future calls
2994
+ * const authClient = await auth.getClient();
2995
+ * google.options({auth: authClient});
2996
+ *
2997
+ * // Do the magic
2998
+ * const res = await alloydb.projects.locations.backups.list({
2999
+ * // Filtering results
3000
+ * filter: 'placeholder-value',
3001
+ * // Hint for how to order the results
3002
+ * orderBy: 'placeholder-value',
3003
+ * // Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
3004
+ * pageSize: 'placeholder-value',
3005
+ * // A token identifying a page of results the server should return.
3006
+ * pageToken: 'placeholder-value',
3007
+ * // Required. Parent value for ListBackupsRequest
3008
+ * parent: 'projects/my-project/locations/my-location',
3009
+ * });
3010
+ * console.log(res.data);
3011
+ *
3012
+ * // Example response
3013
+ * // {
3014
+ * // "backups": [],
3015
+ * // "nextPageToken": "my_nextPageToken",
3016
+ * // "unreachable": []
3017
+ * // }
3018
+ * }
3019
+ *
3020
+ * main().catch(e => {
3021
+ * console.error(e);
3022
+ * throw e;
3023
+ * });
3024
+ *
3025
+ * ```
2564
3026
  *
2565
3027
  * @param params - Parameters for request
2566
3028
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2575,6 +3037,96 @@ export declare namespace alloydb_v1alpha {
2575
3037
  list(callback: BodyResponseCallback<Schema$ListBackupsResponse>): void;
2576
3038
  /**
2577
3039
  * Updates the parameters of a single Backup.
3040
+ * @example
3041
+ * ```js
3042
+ * // Before running the sample:
3043
+ * // - Enable the API at:
3044
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3045
+ * // - Login into gcloud by running:
3046
+ * // ```sh
3047
+ * // $ gcloud auth application-default login
3048
+ * // ```
3049
+ * // - Install the npm module by running:
3050
+ * // ```sh
3051
+ * // $ npm install googleapis
3052
+ * // ```
3053
+ *
3054
+ * const {google} = require('googleapis');
3055
+ * const alloydb = google.alloydb('v1alpha');
3056
+ *
3057
+ * async function main() {
3058
+ * const auth = new google.auth.GoogleAuth({
3059
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3060
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3061
+ * });
3062
+ *
3063
+ * // Acquire an auth client, and bind it to all future calls
3064
+ * const authClient = await auth.getClient();
3065
+ * google.options({auth: authClient});
3066
+ *
3067
+ * // Do the magic
3068
+ * const res = await alloydb.projects.locations.backups.patch({
3069
+ * // 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.
3070
+ * allowMissing: 'placeholder-value',
3071
+ * // 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\}
3072
+ * name: 'projects/my-project/locations/my-location/backups/my-backup',
3073
+ * // 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).
3074
+ * requestId: 'placeholder-value',
3075
+ * // 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.
3076
+ * updateMask: 'placeholder-value',
3077
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
3078
+ * validateOnly: 'placeholder-value',
3079
+ *
3080
+ * // Request body metadata
3081
+ * requestBody: {
3082
+ * // request body parameters
3083
+ * // {
3084
+ * // "annotations": {},
3085
+ * // "clusterName": "my_clusterName",
3086
+ * // "clusterUid": "my_clusterUid",
3087
+ * // "createCompletionTime": "my_createCompletionTime",
3088
+ * // "createTime": "my_createTime",
3089
+ * // "databaseVersion": "my_databaseVersion",
3090
+ * // "deleteTime": "my_deleteTime",
3091
+ * // "description": "my_description",
3092
+ * // "displayName": "my_displayName",
3093
+ * // "encryptionConfig": {},
3094
+ * // "encryptionInfo": {},
3095
+ * // "etag": "my_etag",
3096
+ * // "expiryQuantity": {},
3097
+ * // "expiryTime": "my_expiryTime",
3098
+ * // "labels": {},
3099
+ * // "name": "my_name",
3100
+ * // "reconciling": false,
3101
+ * // "satisfiesPzi": false,
3102
+ * // "satisfiesPzs": false,
3103
+ * // "sizeBytes": "my_sizeBytes",
3104
+ * // "state": "my_state",
3105
+ * // "tags": {},
3106
+ * // "type": "my_type",
3107
+ * // "uid": "my_uid",
3108
+ * // "updateTime": "my_updateTime"
3109
+ * // }
3110
+ * },
3111
+ * });
3112
+ * console.log(res.data);
3113
+ *
3114
+ * // Example response
3115
+ * // {
3116
+ * // "done": false,
3117
+ * // "error": {},
3118
+ * // "metadata": {},
3119
+ * // "name": "my_name",
3120
+ * // "response": {}
3121
+ * // }
3122
+ * }
3123
+ *
3124
+ * main().catch(e => {
3125
+ * console.error(e);
3126
+ * throw e;
3127
+ * });
3128
+ *
3129
+ * ```
2578
3130
  *
2579
3131
  * @param params - Parameters for request
2580
3132
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2689,6 +3241,106 @@ export declare namespace alloydb_v1alpha {
2689
3241
  constructor(context: APIRequestContext);
2690
3242
  /**
2691
3243
  * Creates a new Cluster in a given project and location.
3244
+ * @example
3245
+ * ```js
3246
+ * // Before running the sample:
3247
+ * // - Enable the API at:
3248
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3249
+ * // - Login into gcloud by running:
3250
+ * // ```sh
3251
+ * // $ gcloud auth application-default login
3252
+ * // ```
3253
+ * // - Install the npm module by running:
3254
+ * // ```sh
3255
+ * // $ npm install googleapis
3256
+ * // ```
3257
+ *
3258
+ * const {google} = require('googleapis');
3259
+ * const alloydb = google.alloydb('v1alpha');
3260
+ *
3261
+ * async function main() {
3262
+ * const auth = new google.auth.GoogleAuth({
3263
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3264
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3265
+ * });
3266
+ *
3267
+ * // Acquire an auth client, and bind it to all future calls
3268
+ * const authClient = await auth.getClient();
3269
+ * google.options({auth: authClient});
3270
+ *
3271
+ * // Do the magic
3272
+ * const res = await alloydb.projects.locations.clusters.create({
3273
+ * // Required. ID of the requesting object.
3274
+ * clusterId: 'placeholder-value',
3275
+ * // Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field.
3276
+ * parent: 'projects/my-project/locations/my-location',
3277
+ * // 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).
3278
+ * requestId: 'placeholder-value',
3279
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
3280
+ * validateOnly: 'placeholder-value',
3281
+ *
3282
+ * // Request body metadata
3283
+ * requestBody: {
3284
+ * // request body parameters
3285
+ * // {
3286
+ * // "annotations": {},
3287
+ * // "automatedBackupPolicy": {},
3288
+ * // "backupSource": {},
3289
+ * // "cloudsqlBackupRunSource": {},
3290
+ * // "clusterType": "my_clusterType",
3291
+ * // "continuousBackupConfig": {},
3292
+ * // "continuousBackupInfo": {},
3293
+ * // "createTime": "my_createTime",
3294
+ * // "databaseVersion": "my_databaseVersion",
3295
+ * // "deleteTime": "my_deleteTime",
3296
+ * // "displayName": "my_displayName",
3297
+ * // "encryptionConfig": {},
3298
+ * // "encryptionInfo": {},
3299
+ * // "etag": "my_etag",
3300
+ * // "geminiConfig": {},
3301
+ * // "initialUser": {},
3302
+ * // "labels": {},
3303
+ * // "maintenanceSchedule": {},
3304
+ * // "maintenanceUpdatePolicy": {},
3305
+ * // "migrationSource": {},
3306
+ * // "name": "my_name",
3307
+ * // "network": "my_network",
3308
+ * // "networkConfig": {},
3309
+ * // "primaryConfig": {},
3310
+ * // "pscConfig": {},
3311
+ * // "reconciling": false,
3312
+ * // "satisfiesPzi": false,
3313
+ * // "satisfiesPzs": false,
3314
+ * // "secondaryConfig": {},
3315
+ * // "serviceAccountEmail": "my_serviceAccountEmail",
3316
+ * // "sslConfig": {},
3317
+ * // "state": "my_state",
3318
+ * // "subscriptionType": "my_subscriptionType",
3319
+ * // "tags": {},
3320
+ * // "trialMetadata": {},
3321
+ * // "uid": "my_uid",
3322
+ * // "updateTime": "my_updateTime"
3323
+ * // }
3324
+ * },
3325
+ * });
3326
+ * console.log(res.data);
3327
+ *
3328
+ * // Example response
3329
+ * // {
3330
+ * // "done": false,
3331
+ * // "error": {},
3332
+ * // "metadata": {},
3333
+ * // "name": "my_name",
3334
+ * // "response": {}
3335
+ * // }
3336
+ * }
3337
+ *
3338
+ * main().catch(e => {
3339
+ * console.error(e);
3340
+ * throw e;
3341
+ * });
3342
+ *
3343
+ * ```
2692
3344
  *
2693
3345
  * @param params - Parameters for request
2694
3346
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2703,6 +3355,106 @@ export declare namespace alloydb_v1alpha {
2703
3355
  create(callback: BodyResponseCallback<Schema$Operation>): void;
2704
3356
  /**
2705
3357
  * Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.
3358
+ * @example
3359
+ * ```js
3360
+ * // Before running the sample:
3361
+ * // - Enable the API at:
3362
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3363
+ * // - Login into gcloud by running:
3364
+ * // ```sh
3365
+ * // $ gcloud auth application-default login
3366
+ * // ```
3367
+ * // - Install the npm module by running:
3368
+ * // ```sh
3369
+ * // $ npm install googleapis
3370
+ * // ```
3371
+ *
3372
+ * const {google} = require('googleapis');
3373
+ * const alloydb = google.alloydb('v1alpha');
3374
+ *
3375
+ * async function main() {
3376
+ * const auth = new google.auth.GoogleAuth({
3377
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3378
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3379
+ * });
3380
+ *
3381
+ * // Acquire an auth client, and bind it to all future calls
3382
+ * const authClient = await auth.getClient();
3383
+ * google.options({auth: authClient});
3384
+ *
3385
+ * // Do the magic
3386
+ * const res = await alloydb.projects.locations.clusters.createsecondary({
3387
+ * // Required. ID of the requesting object (the secondary cluster).
3388
+ * clusterId: 'placeholder-value',
3389
+ * // Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field.
3390
+ * parent: 'projects/my-project/locations/my-location',
3391
+ * // 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).
3392
+ * requestId: 'placeholder-value',
3393
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
3394
+ * validateOnly: 'placeholder-value',
3395
+ *
3396
+ * // Request body metadata
3397
+ * requestBody: {
3398
+ * // request body parameters
3399
+ * // {
3400
+ * // "annotations": {},
3401
+ * // "automatedBackupPolicy": {},
3402
+ * // "backupSource": {},
3403
+ * // "cloudsqlBackupRunSource": {},
3404
+ * // "clusterType": "my_clusterType",
3405
+ * // "continuousBackupConfig": {},
3406
+ * // "continuousBackupInfo": {},
3407
+ * // "createTime": "my_createTime",
3408
+ * // "databaseVersion": "my_databaseVersion",
3409
+ * // "deleteTime": "my_deleteTime",
3410
+ * // "displayName": "my_displayName",
3411
+ * // "encryptionConfig": {},
3412
+ * // "encryptionInfo": {},
3413
+ * // "etag": "my_etag",
3414
+ * // "geminiConfig": {},
3415
+ * // "initialUser": {},
3416
+ * // "labels": {},
3417
+ * // "maintenanceSchedule": {},
3418
+ * // "maintenanceUpdatePolicy": {},
3419
+ * // "migrationSource": {},
3420
+ * // "name": "my_name",
3421
+ * // "network": "my_network",
3422
+ * // "networkConfig": {},
3423
+ * // "primaryConfig": {},
3424
+ * // "pscConfig": {},
3425
+ * // "reconciling": false,
3426
+ * // "satisfiesPzi": false,
3427
+ * // "satisfiesPzs": false,
3428
+ * // "secondaryConfig": {},
3429
+ * // "serviceAccountEmail": "my_serviceAccountEmail",
3430
+ * // "sslConfig": {},
3431
+ * // "state": "my_state",
3432
+ * // "subscriptionType": "my_subscriptionType",
3433
+ * // "tags": {},
3434
+ * // "trialMetadata": {},
3435
+ * // "uid": "my_uid",
3436
+ * // "updateTime": "my_updateTime"
3437
+ * // }
3438
+ * },
3439
+ * });
3440
+ * console.log(res.data);
3441
+ *
3442
+ * // Example response
3443
+ * // {
3444
+ * // "done": false,
3445
+ * // "error": {},
3446
+ * // "metadata": {},
3447
+ * // "name": "my_name",
3448
+ * // "response": {}
3449
+ * // }
3450
+ * }
3451
+ *
3452
+ * main().catch(e => {
3453
+ * console.error(e);
3454
+ * throw e;
3455
+ * });
3456
+ *
3457
+ * ```
2706
3458
  *
2707
3459
  * @param params - Parameters for request
2708
3460
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2717,6 +3469,64 @@ export declare namespace alloydb_v1alpha {
2717
3469
  createsecondary(callback: BodyResponseCallback<Schema$Operation>): void;
2718
3470
  /**
2719
3471
  * Deletes a single Cluster.
3472
+ * @example
3473
+ * ```js
3474
+ * // Before running the sample:
3475
+ * // - Enable the API at:
3476
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3477
+ * // - Login into gcloud by running:
3478
+ * // ```sh
3479
+ * // $ gcloud auth application-default login
3480
+ * // ```
3481
+ * // - Install the npm module by running:
3482
+ * // ```sh
3483
+ * // $ npm install googleapis
3484
+ * // ```
3485
+ *
3486
+ * const {google} = require('googleapis');
3487
+ * const alloydb = google.alloydb('v1alpha');
3488
+ *
3489
+ * async function main() {
3490
+ * const auth = new google.auth.GoogleAuth({
3491
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3492
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3493
+ * });
3494
+ *
3495
+ * // Acquire an auth client, and bind it to all future calls
3496
+ * const authClient = await auth.getClient();
3497
+ * google.options({auth: authClient});
3498
+ *
3499
+ * // Do the magic
3500
+ * const res = await alloydb.projects.locations.clusters.delete({
3501
+ * // 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.
3502
+ * etag: 'placeholder-value',
3503
+ * // Optional. Whether to cascade delete child instances for given cluster.
3504
+ * force: 'placeholder-value',
3505
+ * // Required. The name of the resource. For the required format, see the comment on the Cluster.name field.
3506
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
3507
+ * // 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).
3508
+ * requestId: 'placeholder-value',
3509
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
3510
+ * validateOnly: 'placeholder-value',
3511
+ * });
3512
+ * console.log(res.data);
3513
+ *
3514
+ * // Example response
3515
+ * // {
3516
+ * // "done": false,
3517
+ * // "error": {},
3518
+ * // "metadata": {},
3519
+ * // "name": "my_name",
3520
+ * // "response": {}
3521
+ * // }
3522
+ * }
3523
+ *
3524
+ * main().catch(e => {
3525
+ * console.error(e);
3526
+ * throw e;
3527
+ * });
3528
+ *
3529
+ * ```
2720
3530
  *
2721
3531
  * @param params - Parameters for request
2722
3532
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2731,6 +3541,67 @@ export declare namespace alloydb_v1alpha {
2731
3541
  delete(callback: BodyResponseCallback<Schema$Operation>): void;
2732
3542
  /**
2733
3543
  * Exports data from the cluster. Imperative only.
3544
+ * @example
3545
+ * ```js
3546
+ * // Before running the sample:
3547
+ * // - Enable the API at:
3548
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3549
+ * // - Login into gcloud by running:
3550
+ * // ```sh
3551
+ * // $ gcloud auth application-default login
3552
+ * // ```
3553
+ * // - Install the npm module by running:
3554
+ * // ```sh
3555
+ * // $ npm install googleapis
3556
+ * // ```
3557
+ *
3558
+ * const {google} = require('googleapis');
3559
+ * const alloydb = google.alloydb('v1alpha');
3560
+ *
3561
+ * async function main() {
3562
+ * const auth = new google.auth.GoogleAuth({
3563
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3564
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3565
+ * });
3566
+ *
3567
+ * // Acquire an auth client, and bind it to all future calls
3568
+ * const authClient = await auth.getClient();
3569
+ * google.options({auth: authClient});
3570
+ *
3571
+ * // Do the magic
3572
+ * const res = await alloydb.projects.locations.clusters.export({
3573
+ * // Required. The resource name of the cluster.
3574
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
3575
+ *
3576
+ * // Request body metadata
3577
+ * requestBody: {
3578
+ * // request body parameters
3579
+ * // {
3580
+ * // "csvExportOptions": {},
3581
+ * // "database": "my_database",
3582
+ * // "gcsDestination": {},
3583
+ * // "sqlExportOptions": {}
3584
+ * // }
3585
+ * },
3586
+ * });
3587
+ * console.log(res.data);
3588
+ *
3589
+ * // Example response
3590
+ * // {
3591
+ * // "done": false,
3592
+ * // "error": {},
3593
+ * // "metadata": {},
3594
+ * // "name": "my_name",
3595
+ * // "response": {}
3596
+ * // }
3597
+ * }
3598
+ *
3599
+ * main().catch(e => {
3600
+ * console.error(e);
3601
+ * throw e;
3602
+ * });
3603
+ *
3604
+ * ```
2734
3605
  *
2735
3606
  * @param params - Parameters for request
2736
3607
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2745,6 +3616,90 @@ export declare namespace alloydb_v1alpha {
2745
3616
  export(callback: BodyResponseCallback<Schema$Operation>): void;
2746
3617
  /**
2747
3618
  * Gets details of a single Cluster.
3619
+ * @example
3620
+ * ```js
3621
+ * // Before running the sample:
3622
+ * // - Enable the API at:
3623
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3624
+ * // - Login into gcloud by running:
3625
+ * // ```sh
3626
+ * // $ gcloud auth application-default login
3627
+ * // ```
3628
+ * // - Install the npm module by running:
3629
+ * // ```sh
3630
+ * // $ npm install googleapis
3631
+ * // ```
3632
+ *
3633
+ * const {google} = require('googleapis');
3634
+ * const alloydb = google.alloydb('v1alpha');
3635
+ *
3636
+ * async function main() {
3637
+ * const auth = new google.auth.GoogleAuth({
3638
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3639
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3640
+ * });
3641
+ *
3642
+ * // Acquire an auth client, and bind it to all future calls
3643
+ * const authClient = await auth.getClient();
3644
+ * google.options({auth: authClient});
3645
+ *
3646
+ * // Do the magic
3647
+ * const res = await alloydb.projects.locations.clusters.get({
3648
+ * // Required. The name of the resource. For the required format, see the comment on the Cluster.name field.
3649
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
3650
+ * // Optional. The view of the cluster to return. Returns all default fields if not set.
3651
+ * view: 'placeholder-value',
3652
+ * });
3653
+ * console.log(res.data);
3654
+ *
3655
+ * // Example response
3656
+ * // {
3657
+ * // "annotations": {},
3658
+ * // "automatedBackupPolicy": {},
3659
+ * // "backupSource": {},
3660
+ * // "cloudsqlBackupRunSource": {},
3661
+ * // "clusterType": "my_clusterType",
3662
+ * // "continuousBackupConfig": {},
3663
+ * // "continuousBackupInfo": {},
3664
+ * // "createTime": "my_createTime",
3665
+ * // "databaseVersion": "my_databaseVersion",
3666
+ * // "deleteTime": "my_deleteTime",
3667
+ * // "displayName": "my_displayName",
3668
+ * // "encryptionConfig": {},
3669
+ * // "encryptionInfo": {},
3670
+ * // "etag": "my_etag",
3671
+ * // "geminiConfig": {},
3672
+ * // "initialUser": {},
3673
+ * // "labels": {},
3674
+ * // "maintenanceSchedule": {},
3675
+ * // "maintenanceUpdatePolicy": {},
3676
+ * // "migrationSource": {},
3677
+ * // "name": "my_name",
3678
+ * // "network": "my_network",
3679
+ * // "networkConfig": {},
3680
+ * // "primaryConfig": {},
3681
+ * // "pscConfig": {},
3682
+ * // "reconciling": false,
3683
+ * // "satisfiesPzi": false,
3684
+ * // "satisfiesPzs": false,
3685
+ * // "secondaryConfig": {},
3686
+ * // "serviceAccountEmail": "my_serviceAccountEmail",
3687
+ * // "sslConfig": {},
3688
+ * // "state": "my_state",
3689
+ * // "subscriptionType": "my_subscriptionType",
3690
+ * // "tags": {},
3691
+ * // "trialMetadata": {},
3692
+ * // "uid": "my_uid",
3693
+ * // "updateTime": "my_updateTime"
3694
+ * // }
3695
+ * }
3696
+ *
3697
+ * main().catch(e => {
3698
+ * console.error(e);
3699
+ * throw e;
3700
+ * });
3701
+ *
3702
+ * ```
2748
3703
  *
2749
3704
  * @param params - Parameters for request
2750
3705
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2759,6 +3714,68 @@ export declare namespace alloydb_v1alpha {
2759
3714
  get(callback: BodyResponseCallback<Schema$Cluster>): void;
2760
3715
  /**
2761
3716
  * Imports data to the cluster. Imperative only.
3717
+ * @example
3718
+ * ```js
3719
+ * // Before running the sample:
3720
+ * // - Enable the API at:
3721
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3722
+ * // - Login into gcloud by running:
3723
+ * // ```sh
3724
+ * // $ gcloud auth application-default login
3725
+ * // ```
3726
+ * // - Install the npm module by running:
3727
+ * // ```sh
3728
+ * // $ npm install googleapis
3729
+ * // ```
3730
+ *
3731
+ * const {google} = require('googleapis');
3732
+ * const alloydb = google.alloydb('v1alpha');
3733
+ *
3734
+ * async function main() {
3735
+ * const auth = new google.auth.GoogleAuth({
3736
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3737
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3738
+ * });
3739
+ *
3740
+ * // Acquire an auth client, and bind it to all future calls
3741
+ * const authClient = await auth.getClient();
3742
+ * google.options({auth: authClient});
3743
+ *
3744
+ * // Do the magic
3745
+ * const res = await alloydb.projects.locations.clusters.import({
3746
+ * // Required. The resource name of the cluster.
3747
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
3748
+ *
3749
+ * // Request body metadata
3750
+ * requestBody: {
3751
+ * // request body parameters
3752
+ * // {
3753
+ * // "csvImportOptions": {},
3754
+ * // "database": "my_database",
3755
+ * // "gcsUri": "my_gcsUri",
3756
+ * // "sqlImportOptions": {},
3757
+ * // "user": "my_user"
3758
+ * // }
3759
+ * },
3760
+ * });
3761
+ * console.log(res.data);
3762
+ *
3763
+ * // Example response
3764
+ * // {
3765
+ * // "done": false,
3766
+ * // "error": {},
3767
+ * // "metadata": {},
3768
+ * // "name": "my_name",
3769
+ * // "response": {}
3770
+ * // }
3771
+ * }
3772
+ *
3773
+ * main().catch(e => {
3774
+ * console.error(e);
3775
+ * throw e;
3776
+ * });
3777
+ *
3778
+ * ```
2762
3779
  *
2763
3780
  * @param params - Parameters for request
2764
3781
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2773,6 +3790,62 @@ export declare namespace alloydb_v1alpha {
2773
3790
  import(callback: BodyResponseCallback<Schema$Operation>): void;
2774
3791
  /**
2775
3792
  * Lists Clusters in a given project and location.
3793
+ * @example
3794
+ * ```js
3795
+ * // Before running the sample:
3796
+ * // - Enable the API at:
3797
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3798
+ * // - Login into gcloud by running:
3799
+ * // ```sh
3800
+ * // $ gcloud auth application-default login
3801
+ * // ```
3802
+ * // - Install the npm module by running:
3803
+ * // ```sh
3804
+ * // $ npm install googleapis
3805
+ * // ```
3806
+ *
3807
+ * const {google} = require('googleapis');
3808
+ * const alloydb = google.alloydb('v1alpha');
3809
+ *
3810
+ * async function main() {
3811
+ * const auth = new google.auth.GoogleAuth({
3812
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3813
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3814
+ * });
3815
+ *
3816
+ * // Acquire an auth client, and bind it to all future calls
3817
+ * const authClient = await auth.getClient();
3818
+ * google.options({auth: authClient});
3819
+ *
3820
+ * // Do the magic
3821
+ * const res = await alloydb.projects.locations.clusters.list({
3822
+ * // Optional. Filtering results
3823
+ * filter: 'placeholder-value',
3824
+ * // Optional. Hint for how to order the results
3825
+ * orderBy: 'placeholder-value',
3826
+ * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
3827
+ * pageSize: 'placeholder-value',
3828
+ * // A token identifying a page of results the server should return.
3829
+ * pageToken: 'placeholder-value',
3830
+ * // 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/-
3831
+ * parent: 'projects/my-project/locations/my-location',
3832
+ * });
3833
+ * console.log(res.data);
3834
+ *
3835
+ * // Example response
3836
+ * // {
3837
+ * // "clusters": [],
3838
+ * // "nextPageToken": "my_nextPageToken",
3839
+ * // "unreachable": []
3840
+ * // }
3841
+ * }
3842
+ *
3843
+ * main().catch(e => {
3844
+ * console.error(e);
3845
+ * throw e;
3846
+ * });
3847
+ *
3848
+ * ```
2776
3849
  *
2777
3850
  * @param params - Parameters for request
2778
3851
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2787,6 +3860,108 @@ export declare namespace alloydb_v1alpha {
2787
3860
  list(callback: BodyResponseCallback<Schema$ListClustersResponse>): void;
2788
3861
  /**
2789
3862
  * Updates the parameters of a single Cluster.
3863
+ * @example
3864
+ * ```js
3865
+ * // Before running the sample:
3866
+ * // - Enable the API at:
3867
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3868
+ * // - Login into gcloud by running:
3869
+ * // ```sh
3870
+ * // $ gcloud auth application-default login
3871
+ * // ```
3872
+ * // - Install the npm module by running:
3873
+ * // ```sh
3874
+ * // $ npm install googleapis
3875
+ * // ```
3876
+ *
3877
+ * const {google} = require('googleapis');
3878
+ * const alloydb = google.alloydb('v1alpha');
3879
+ *
3880
+ * async function main() {
3881
+ * const auth = new google.auth.GoogleAuth({
3882
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3883
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3884
+ * });
3885
+ *
3886
+ * // Acquire an auth client, and bind it to all future calls
3887
+ * const authClient = await auth.getClient();
3888
+ * google.options({auth: authClient});
3889
+ *
3890
+ * // Do the magic
3891
+ * const res = await alloydb.projects.locations.clusters.patch({
3892
+ * // 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.
3893
+ * allowMissing: 'placeholder-value',
3894
+ * // 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\}
3895
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
3896
+ * // 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).
3897
+ * requestId: 'placeholder-value',
3898
+ * // 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.
3899
+ * updateMask: 'placeholder-value',
3900
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
3901
+ * validateOnly: 'placeholder-value',
3902
+ *
3903
+ * // Request body metadata
3904
+ * requestBody: {
3905
+ * // request body parameters
3906
+ * // {
3907
+ * // "annotations": {},
3908
+ * // "automatedBackupPolicy": {},
3909
+ * // "backupSource": {},
3910
+ * // "cloudsqlBackupRunSource": {},
3911
+ * // "clusterType": "my_clusterType",
3912
+ * // "continuousBackupConfig": {},
3913
+ * // "continuousBackupInfo": {},
3914
+ * // "createTime": "my_createTime",
3915
+ * // "databaseVersion": "my_databaseVersion",
3916
+ * // "deleteTime": "my_deleteTime",
3917
+ * // "displayName": "my_displayName",
3918
+ * // "encryptionConfig": {},
3919
+ * // "encryptionInfo": {},
3920
+ * // "etag": "my_etag",
3921
+ * // "geminiConfig": {},
3922
+ * // "initialUser": {},
3923
+ * // "labels": {},
3924
+ * // "maintenanceSchedule": {},
3925
+ * // "maintenanceUpdatePolicy": {},
3926
+ * // "migrationSource": {},
3927
+ * // "name": "my_name",
3928
+ * // "network": "my_network",
3929
+ * // "networkConfig": {},
3930
+ * // "primaryConfig": {},
3931
+ * // "pscConfig": {},
3932
+ * // "reconciling": false,
3933
+ * // "satisfiesPzi": false,
3934
+ * // "satisfiesPzs": false,
3935
+ * // "secondaryConfig": {},
3936
+ * // "serviceAccountEmail": "my_serviceAccountEmail",
3937
+ * // "sslConfig": {},
3938
+ * // "state": "my_state",
3939
+ * // "subscriptionType": "my_subscriptionType",
3940
+ * // "tags": {},
3941
+ * // "trialMetadata": {},
3942
+ * // "uid": "my_uid",
3943
+ * // "updateTime": "my_updateTime"
3944
+ * // }
3945
+ * },
3946
+ * });
3947
+ * console.log(res.data);
3948
+ *
3949
+ * // Example response
3950
+ * // {
3951
+ * // "done": false,
3952
+ * // "error": {},
3953
+ * // "metadata": {},
3954
+ * // "name": "my_name",
3955
+ * // "response": {}
3956
+ * // }
3957
+ * }
3958
+ *
3959
+ * main().catch(e => {
3960
+ * console.error(e);
3961
+ * throw e;
3962
+ * });
3963
+ *
3964
+ * ```
2790
3965
  *
2791
3966
  * @param params - Parameters for request
2792
3967
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2801,6 +3976,66 @@ export declare namespace alloydb_v1alpha {
2801
3976
  patch(callback: BodyResponseCallback<Schema$Operation>): void;
2802
3977
  /**
2803
3978
  * Promotes a SECONDARY cluster. This turns down replication from the PRIMARY cluster and promotes a secondary cluster into its own standalone cluster. Imperative only.
3979
+ * @example
3980
+ * ```js
3981
+ * // Before running the sample:
3982
+ * // - Enable the API at:
3983
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
3984
+ * // - Login into gcloud by running:
3985
+ * // ```sh
3986
+ * // $ gcloud auth application-default login
3987
+ * // ```
3988
+ * // - Install the npm module by running:
3989
+ * // ```sh
3990
+ * // $ npm install googleapis
3991
+ * // ```
3992
+ *
3993
+ * const {google} = require('googleapis');
3994
+ * const alloydb = google.alloydb('v1alpha');
3995
+ *
3996
+ * async function main() {
3997
+ * const auth = new google.auth.GoogleAuth({
3998
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3999
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4000
+ * });
4001
+ *
4002
+ * // Acquire an auth client, and bind it to all future calls
4003
+ * const authClient = await auth.getClient();
4004
+ * google.options({auth: authClient});
4005
+ *
4006
+ * // Do the magic
4007
+ * const res = await alloydb.projects.locations.clusters.promote({
4008
+ * // Required. The name of the resource. For the required format, see the comment on the Cluster.name field
4009
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
4010
+ *
4011
+ * // Request body metadata
4012
+ * requestBody: {
4013
+ * // request body parameters
4014
+ * // {
4015
+ * // "etag": "my_etag",
4016
+ * // "requestId": "my_requestId",
4017
+ * // "validateOnly": false
4018
+ * // }
4019
+ * },
4020
+ * });
4021
+ * console.log(res.data);
4022
+ *
4023
+ * // Example response
4024
+ * // {
4025
+ * // "done": false,
4026
+ * // "error": {},
4027
+ * // "metadata": {},
4028
+ * // "name": "my_name",
4029
+ * // "response": {}
4030
+ * // }
4031
+ * }
4032
+ *
4033
+ * main().catch(e => {
4034
+ * console.error(e);
4035
+ * throw e;
4036
+ * });
4037
+ *
4038
+ * ```
2804
4039
  *
2805
4040
  * @param params - Parameters for request
2806
4041
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2815,6 +4050,69 @@ export declare namespace alloydb_v1alpha {
2815
4050
  promote(callback: BodyResponseCallback<Schema$Operation>): void;
2816
4051
  /**
2817
4052
  * 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.
4053
+ * @example
4054
+ * ```js
4055
+ * // Before running the sample:
4056
+ * // - Enable the API at:
4057
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4058
+ * // - Login into gcloud by running:
4059
+ * // ```sh
4060
+ * // $ gcloud auth application-default login
4061
+ * // ```
4062
+ * // - Install the npm module by running:
4063
+ * // ```sh
4064
+ * // $ npm install googleapis
4065
+ * // ```
4066
+ *
4067
+ * const {google} = require('googleapis');
4068
+ * const alloydb = google.alloydb('v1alpha');
4069
+ *
4070
+ * async function main() {
4071
+ * const auth = new google.auth.GoogleAuth({
4072
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4073
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4074
+ * });
4075
+ *
4076
+ * // Acquire an auth client, and bind it to all future calls
4077
+ * const authClient = await auth.getClient();
4078
+ * google.options({auth: authClient});
4079
+ *
4080
+ * // Do the magic
4081
+ * const res = await alloydb.projects.locations.clusters.restore({
4082
+ * // Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field.
4083
+ * parent: 'projects/my-project/locations/my-location',
4084
+ *
4085
+ * // Request body metadata
4086
+ * requestBody: {
4087
+ * // request body parameters
4088
+ * // {
4089
+ * // "backupSource": {},
4090
+ * // "cluster": {},
4091
+ * // "clusterId": "my_clusterId",
4092
+ * // "continuousBackupSource": {},
4093
+ * // "requestId": "my_requestId",
4094
+ * // "validateOnly": false
4095
+ * // }
4096
+ * },
4097
+ * });
4098
+ * console.log(res.data);
4099
+ *
4100
+ * // Example response
4101
+ * // {
4102
+ * // "done": false,
4103
+ * // "error": {},
4104
+ * // "metadata": {},
4105
+ * // "name": "my_name",
4106
+ * // "response": {}
4107
+ * // }
4108
+ * }
4109
+ *
4110
+ * main().catch(e => {
4111
+ * console.error(e);
4112
+ * throw e;
4113
+ * });
4114
+ *
4115
+ * ```
2818
4116
  *
2819
4117
  * @param params - Parameters for request
2820
4118
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2829,6 +4127,66 @@ export declare namespace alloydb_v1alpha {
2829
4127
  restore(callback: BodyResponseCallback<Schema$Operation>): void;
2830
4128
  /**
2831
4129
  * Restores an AlloyDB cluster from a CloudSQL resource.
4130
+ * @example
4131
+ * ```js
4132
+ * // Before running the sample:
4133
+ * // - Enable the API at:
4134
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4135
+ * // - Login into gcloud by running:
4136
+ * // ```sh
4137
+ * // $ gcloud auth application-default login
4138
+ * // ```
4139
+ * // - Install the npm module by running:
4140
+ * // ```sh
4141
+ * // $ npm install googleapis
4142
+ * // ```
4143
+ *
4144
+ * const {google} = require('googleapis');
4145
+ * const alloydb = google.alloydb('v1alpha');
4146
+ *
4147
+ * async function main() {
4148
+ * const auth = new google.auth.GoogleAuth({
4149
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4150
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4151
+ * });
4152
+ *
4153
+ * // Acquire an auth client, and bind it to all future calls
4154
+ * const authClient = await auth.getClient();
4155
+ * google.options({auth: authClient});
4156
+ *
4157
+ * // Do the magic
4158
+ * const res = await alloydb.projects.locations.clusters.restoreFromCloudSQL({
4159
+ * // Required. The location of the new cluster. For the required format, see the comment on Cluster.name field.
4160
+ * parent: 'projects/my-project/locations/my-location',
4161
+ *
4162
+ * // Request body metadata
4163
+ * requestBody: {
4164
+ * // request body parameters
4165
+ * // {
4166
+ * // "cloudsqlBackupRunSource": {},
4167
+ * // "cluster": {},
4168
+ * // "clusterId": "my_clusterId"
4169
+ * // }
4170
+ * },
4171
+ * });
4172
+ * console.log(res.data);
4173
+ *
4174
+ * // Example response
4175
+ * // {
4176
+ * // "done": false,
4177
+ * // "error": {},
4178
+ * // "metadata": {},
4179
+ * // "name": "my_name",
4180
+ * // "response": {}
4181
+ * // }
4182
+ * }
4183
+ *
4184
+ * main().catch(e => {
4185
+ * console.error(e);
4186
+ * throw e;
4187
+ * });
4188
+ *
4189
+ * ```
2832
4190
  *
2833
4191
  * @param params - Parameters for request
2834
4192
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2843,6 +4201,65 @@ export declare namespace alloydb_v1alpha {
2843
4201
  restoreFromCloudSQL(callback: BodyResponseCallback<Schema$Operation>): void;
2844
4202
  /**
2845
4203
  * 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.
4204
+ * @example
4205
+ * ```js
4206
+ * // Before running the sample:
4207
+ * // - Enable the API at:
4208
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4209
+ * // - Login into gcloud by running:
4210
+ * // ```sh
4211
+ * // $ gcloud auth application-default login
4212
+ * // ```
4213
+ * // - Install the npm module by running:
4214
+ * // ```sh
4215
+ * // $ npm install googleapis
4216
+ * // ```
4217
+ *
4218
+ * const {google} = require('googleapis');
4219
+ * const alloydb = google.alloydb('v1alpha');
4220
+ *
4221
+ * async function main() {
4222
+ * const auth = new google.auth.GoogleAuth({
4223
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4224
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4225
+ * });
4226
+ *
4227
+ * // Acquire an auth client, and bind it to all future calls
4228
+ * const authClient = await auth.getClient();
4229
+ * google.options({auth: authClient});
4230
+ *
4231
+ * // Do the magic
4232
+ * const res = await alloydb.projects.locations.clusters.switchover({
4233
+ * // Required. The name of the resource. For the required format, see the comment on the Cluster.name field
4234
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
4235
+ *
4236
+ * // Request body metadata
4237
+ * requestBody: {
4238
+ * // request body parameters
4239
+ * // {
4240
+ * // "requestId": "my_requestId",
4241
+ * // "validateOnly": false
4242
+ * // }
4243
+ * },
4244
+ * });
4245
+ * console.log(res.data);
4246
+ *
4247
+ * // Example response
4248
+ * // {
4249
+ * // "done": false,
4250
+ * // "error": {},
4251
+ * // "metadata": {},
4252
+ * // "name": "my_name",
4253
+ * // "response": {}
4254
+ * // }
4255
+ * }
4256
+ *
4257
+ * main().catch(e => {
4258
+ * console.error(e);
4259
+ * throw e;
4260
+ * });
4261
+ *
4262
+ * ```
2846
4263
  *
2847
4264
  * @param params - Parameters for request
2848
4265
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2857,6 +4274,67 @@ export declare namespace alloydb_v1alpha {
2857
4274
  switchover(callback: BodyResponseCallback<Schema$Operation>): void;
2858
4275
  /**
2859
4276
  * Upgrades a single Cluster. Imperative only.
4277
+ * @example
4278
+ * ```js
4279
+ * // Before running the sample:
4280
+ * // - Enable the API at:
4281
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4282
+ * // - Login into gcloud by running:
4283
+ * // ```sh
4284
+ * // $ gcloud auth application-default login
4285
+ * // ```
4286
+ * // - Install the npm module by running:
4287
+ * // ```sh
4288
+ * // $ npm install googleapis
4289
+ * // ```
4290
+ *
4291
+ * const {google} = require('googleapis');
4292
+ * const alloydb = google.alloydb('v1alpha');
4293
+ *
4294
+ * async function main() {
4295
+ * const auth = new google.auth.GoogleAuth({
4296
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4297
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4298
+ * });
4299
+ *
4300
+ * // Acquire an auth client, and bind it to all future calls
4301
+ * const authClient = await auth.getClient();
4302
+ * google.options({auth: authClient});
4303
+ *
4304
+ * // Do the magic
4305
+ * const res = await alloydb.projects.locations.clusters.upgrade({
4306
+ * // Required. The resource name of the cluster.
4307
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster',
4308
+ *
4309
+ * // Request body metadata
4310
+ * requestBody: {
4311
+ * // request body parameters
4312
+ * // {
4313
+ * // "etag": "my_etag",
4314
+ * // "requestId": "my_requestId",
4315
+ * // "validateOnly": false,
4316
+ * // "version": "my_version"
4317
+ * // }
4318
+ * },
4319
+ * });
4320
+ * console.log(res.data);
4321
+ *
4322
+ * // Example response
4323
+ * // {
4324
+ * // "done": false,
4325
+ * // "error": {},
4326
+ * // "metadata": {},
4327
+ * // "name": "my_name",
4328
+ * // "response": {}
4329
+ * // }
4330
+ * }
4331
+ *
4332
+ * main().catch(e => {
4333
+ * console.error(e);
4334
+ * throw e;
4335
+ * });
4336
+ *
4337
+ * ```
2860
4338
  *
2861
4339
  * @param params - Parameters for request
2862
4340
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3069,6 +4547,103 @@ export declare namespace alloydb_v1alpha {
3069
4547
  constructor(context: APIRequestContext);
3070
4548
  /**
3071
4549
  * Creates a new Instance in a given project and location.
4550
+ * @example
4551
+ * ```js
4552
+ * // Before running the sample:
4553
+ * // - Enable the API at:
4554
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4555
+ * // - Login into gcloud by running:
4556
+ * // ```sh
4557
+ * // $ gcloud auth application-default login
4558
+ * // ```
4559
+ * // - Install the npm module by running:
4560
+ * // ```sh
4561
+ * // $ npm install googleapis
4562
+ * // ```
4563
+ *
4564
+ * const {google} = require('googleapis');
4565
+ * const alloydb = google.alloydb('v1alpha');
4566
+ *
4567
+ * async function main() {
4568
+ * const auth = new google.auth.GoogleAuth({
4569
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4570
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4571
+ * });
4572
+ *
4573
+ * // Acquire an auth client, and bind it to all future calls
4574
+ * const authClient = await auth.getClient();
4575
+ * google.options({auth: authClient});
4576
+ *
4577
+ * // Do the magic
4578
+ * const res = await alloydb.projects.locations.clusters.instances.create({
4579
+ * // Required. ID of the requesting object.
4580
+ * instanceId: 'placeholder-value',
4581
+ * // Required. The name of the parent resource. For the required format, see the comment on the Instance.name field.
4582
+ * parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
4583
+ * // 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).
4584
+ * requestId: 'placeholder-value',
4585
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
4586
+ * validateOnly: 'placeholder-value',
4587
+ *
4588
+ * // Request body metadata
4589
+ * requestBody: {
4590
+ * // request body parameters
4591
+ * // {
4592
+ * // "activationPolicy": "my_activationPolicy",
4593
+ * // "annotations": {},
4594
+ * // "availabilityType": "my_availabilityType",
4595
+ * // "clientConnectionConfig": {},
4596
+ * // "connectionPoolConfig": {},
4597
+ * // "createTime": "my_createTime",
4598
+ * // "databaseFlags": {},
4599
+ * // "deleteTime": "my_deleteTime",
4600
+ * // "displayName": "my_displayName",
4601
+ * // "etag": "my_etag",
4602
+ * // "gcaConfig": {},
4603
+ * // "gceZone": "my_gceZone",
4604
+ * // "geminiConfig": {},
4605
+ * // "instanceType": "my_instanceType",
4606
+ * // "ipAddress": "my_ipAddress",
4607
+ * // "labels": {},
4608
+ * // "machineConfig": {},
4609
+ * // "name": "my_name",
4610
+ * // "networkConfig": {},
4611
+ * // "nodes": [],
4612
+ * // "observabilityConfig": {},
4613
+ * // "outboundPublicIpAddresses": [],
4614
+ * // "pscInstanceConfig": {},
4615
+ * // "publicIpAddress": "my_publicIpAddress",
4616
+ * // "queryInsightsConfig": {},
4617
+ * // "readPoolConfig": {},
4618
+ * // "reconciling": false,
4619
+ * // "satisfiesPzi": false,
4620
+ * // "satisfiesPzs": false,
4621
+ * // "state": "my_state",
4622
+ * // "uid": "my_uid",
4623
+ * // "updatePolicy": {},
4624
+ * // "updateTime": "my_updateTime",
4625
+ * // "writableNode": {}
4626
+ * // }
4627
+ * },
4628
+ * });
4629
+ * console.log(res.data);
4630
+ *
4631
+ * // Example response
4632
+ * // {
4633
+ * // "done": false,
4634
+ * // "error": {},
4635
+ * // "metadata": {},
4636
+ * // "name": "my_name",
4637
+ * // "response": {}
4638
+ * // }
4639
+ * }
4640
+ *
4641
+ * main().catch(e => {
4642
+ * console.error(e);
4643
+ * throw e;
4644
+ * });
4645
+ *
4646
+ * ```
3072
4647
  *
3073
4648
  * @param params - Parameters for request
3074
4649
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3083,6 +4658,104 @@ export declare namespace alloydb_v1alpha {
3083
4658
  create(callback: BodyResponseCallback<Schema$Operation>): void;
3084
4659
  /**
3085
4660
  * Creates a new SECONDARY Instance in a given project and location.
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('v1alpha');
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 =
4690
+ * await alloydb.projects.locations.clusters.instances.createsecondary({
4691
+ * // Required. ID of the requesting object.
4692
+ * instanceId: 'placeholder-value',
4693
+ * // Required. The name of the parent resource. For the required format, see the comment on the Instance.name field.
4694
+ * parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
4695
+ * // 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).
4696
+ * requestId: 'placeholder-value',
4697
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
4698
+ * validateOnly: 'placeholder-value',
4699
+ *
4700
+ * // Request body metadata
4701
+ * requestBody: {
4702
+ * // request body parameters
4703
+ * // {
4704
+ * // "activationPolicy": "my_activationPolicy",
4705
+ * // "annotations": {},
4706
+ * // "availabilityType": "my_availabilityType",
4707
+ * // "clientConnectionConfig": {},
4708
+ * // "connectionPoolConfig": {},
4709
+ * // "createTime": "my_createTime",
4710
+ * // "databaseFlags": {},
4711
+ * // "deleteTime": "my_deleteTime",
4712
+ * // "displayName": "my_displayName",
4713
+ * // "etag": "my_etag",
4714
+ * // "gcaConfig": {},
4715
+ * // "gceZone": "my_gceZone",
4716
+ * // "geminiConfig": {},
4717
+ * // "instanceType": "my_instanceType",
4718
+ * // "ipAddress": "my_ipAddress",
4719
+ * // "labels": {},
4720
+ * // "machineConfig": {},
4721
+ * // "name": "my_name",
4722
+ * // "networkConfig": {},
4723
+ * // "nodes": [],
4724
+ * // "observabilityConfig": {},
4725
+ * // "outboundPublicIpAddresses": [],
4726
+ * // "pscInstanceConfig": {},
4727
+ * // "publicIpAddress": "my_publicIpAddress",
4728
+ * // "queryInsightsConfig": {},
4729
+ * // "readPoolConfig": {},
4730
+ * // "reconciling": false,
4731
+ * // "satisfiesPzi": false,
4732
+ * // "satisfiesPzs": false,
4733
+ * // "state": "my_state",
4734
+ * // "uid": "my_uid",
4735
+ * // "updatePolicy": {},
4736
+ * // "updateTime": "my_updateTime",
4737
+ * // "writableNode": {}
4738
+ * // }
4739
+ * },
4740
+ * });
4741
+ * console.log(res.data);
4742
+ *
4743
+ * // Example response
4744
+ * // {
4745
+ * // "done": false,
4746
+ * // "error": {},
4747
+ * // "metadata": {},
4748
+ * // "name": "my_name",
4749
+ * // "response": {}
4750
+ * // }
4751
+ * }
4752
+ *
4753
+ * main().catch(e => {
4754
+ * console.error(e);
4755
+ * throw e;
4756
+ * });
4757
+ *
4758
+ * ```
3086
4759
  *
3087
4760
  * @param params - Parameters for request
3088
4761
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3097,6 +4770,62 @@ export declare namespace alloydb_v1alpha {
3097
4770
  createsecondary(callback: BodyResponseCallback<Schema$Operation>): void;
3098
4771
  /**
3099
4772
  * Deletes a single Instance.
4773
+ * @example
4774
+ * ```js
4775
+ * // Before running the sample:
4776
+ * // - Enable the API at:
4777
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4778
+ * // - Login into gcloud by running:
4779
+ * // ```sh
4780
+ * // $ gcloud auth application-default login
4781
+ * // ```
4782
+ * // - Install the npm module by running:
4783
+ * // ```sh
4784
+ * // $ npm install googleapis
4785
+ * // ```
4786
+ *
4787
+ * const {google} = require('googleapis');
4788
+ * const alloydb = google.alloydb('v1alpha');
4789
+ *
4790
+ * async function main() {
4791
+ * const auth = new google.auth.GoogleAuth({
4792
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4793
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4794
+ * });
4795
+ *
4796
+ * // Acquire an auth client, and bind it to all future calls
4797
+ * const authClient = await auth.getClient();
4798
+ * google.options({auth: authClient});
4799
+ *
4800
+ * // Do the magic
4801
+ * const res = await alloydb.projects.locations.clusters.instances.delete({
4802
+ * // 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.
4803
+ * etag: 'placeholder-value',
4804
+ * // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
4805
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
4806
+ * // 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).
4807
+ * requestId: 'placeholder-value',
4808
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
4809
+ * validateOnly: 'placeholder-value',
4810
+ * });
4811
+ * console.log(res.data);
4812
+ *
4813
+ * // Example response
4814
+ * // {
4815
+ * // "done": false,
4816
+ * // "error": {},
4817
+ * // "metadata": {},
4818
+ * // "name": "my_name",
4819
+ * // "response": {}
4820
+ * // }
4821
+ * }
4822
+ *
4823
+ * main().catch(e => {
4824
+ * console.error(e);
4825
+ * throw e;
4826
+ * });
4827
+ *
4828
+ * ```
3100
4829
  *
3101
4830
  * @param params - Parameters for request
3102
4831
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3111,6 +4840,65 @@ export declare namespace alloydb_v1alpha {
3111
4840
  delete(callback: BodyResponseCallback<Schema$Operation>): void;
3112
4841
  /**
3113
4842
  * Forces a Failover for a highly available instance. Failover promotes the HA standby instance as the new primary. Imperative only.
4843
+ * @example
4844
+ * ```js
4845
+ * // Before running the sample:
4846
+ * // - Enable the API at:
4847
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4848
+ * // - Login into gcloud by running:
4849
+ * // ```sh
4850
+ * // $ gcloud auth application-default login
4851
+ * // ```
4852
+ * // - Install the npm module by running:
4853
+ * // ```sh
4854
+ * // $ npm install googleapis
4855
+ * // ```
4856
+ *
4857
+ * const {google} = require('googleapis');
4858
+ * const alloydb = google.alloydb('v1alpha');
4859
+ *
4860
+ * async function main() {
4861
+ * const auth = new google.auth.GoogleAuth({
4862
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4863
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4864
+ * });
4865
+ *
4866
+ * // Acquire an auth client, and bind it to all future calls
4867
+ * const authClient = await auth.getClient();
4868
+ * google.options({auth: authClient});
4869
+ *
4870
+ * // Do the magic
4871
+ * const res = await alloydb.projects.locations.clusters.instances.failover({
4872
+ * // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
4873
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
4874
+ *
4875
+ * // Request body metadata
4876
+ * requestBody: {
4877
+ * // request body parameters
4878
+ * // {
4879
+ * // "requestId": "my_requestId",
4880
+ * // "validateOnly": false
4881
+ * // }
4882
+ * },
4883
+ * });
4884
+ * console.log(res.data);
4885
+ *
4886
+ * // Example response
4887
+ * // {
4888
+ * // "done": false,
4889
+ * // "error": {},
4890
+ * // "metadata": {},
4891
+ * // "name": "my_name",
4892
+ * // "response": {}
4893
+ * // }
4894
+ * }
4895
+ *
4896
+ * main().catch(e => {
4897
+ * console.error(e);
4898
+ * throw e;
4899
+ * });
4900
+ *
4901
+ * ```
3114
4902
  *
3115
4903
  * @param params - Parameters for request
3116
4904
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3125,6 +4913,87 @@ export declare namespace alloydb_v1alpha {
3125
4913
  failover(callback: BodyResponseCallback<Schema$Operation>): void;
3126
4914
  /**
3127
4915
  * Gets details of a single Instance.
4916
+ * @example
4917
+ * ```js
4918
+ * // Before running the sample:
4919
+ * // - Enable the API at:
4920
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
4921
+ * // - Login into gcloud by running:
4922
+ * // ```sh
4923
+ * // $ gcloud auth application-default login
4924
+ * // ```
4925
+ * // - Install the npm module by running:
4926
+ * // ```sh
4927
+ * // $ npm install googleapis
4928
+ * // ```
4929
+ *
4930
+ * const {google} = require('googleapis');
4931
+ * const alloydb = google.alloydb('v1alpha');
4932
+ *
4933
+ * async function main() {
4934
+ * const auth = new google.auth.GoogleAuth({
4935
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4936
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4937
+ * });
4938
+ *
4939
+ * // Acquire an auth client, and bind it to all future calls
4940
+ * const authClient = await auth.getClient();
4941
+ * google.options({auth: authClient});
4942
+ *
4943
+ * // Do the magic
4944
+ * const res = await alloydb.projects.locations.clusters.instances.get({
4945
+ * // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
4946
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
4947
+ * // The view of the instance to return.
4948
+ * view: 'placeholder-value',
4949
+ * });
4950
+ * console.log(res.data);
4951
+ *
4952
+ * // Example response
4953
+ * // {
4954
+ * // "activationPolicy": "my_activationPolicy",
4955
+ * // "annotations": {},
4956
+ * // "availabilityType": "my_availabilityType",
4957
+ * // "clientConnectionConfig": {},
4958
+ * // "connectionPoolConfig": {},
4959
+ * // "createTime": "my_createTime",
4960
+ * // "databaseFlags": {},
4961
+ * // "deleteTime": "my_deleteTime",
4962
+ * // "displayName": "my_displayName",
4963
+ * // "etag": "my_etag",
4964
+ * // "gcaConfig": {},
4965
+ * // "gceZone": "my_gceZone",
4966
+ * // "geminiConfig": {},
4967
+ * // "instanceType": "my_instanceType",
4968
+ * // "ipAddress": "my_ipAddress",
4969
+ * // "labels": {},
4970
+ * // "machineConfig": {},
4971
+ * // "name": "my_name",
4972
+ * // "networkConfig": {},
4973
+ * // "nodes": [],
4974
+ * // "observabilityConfig": {},
4975
+ * // "outboundPublicIpAddresses": [],
4976
+ * // "pscInstanceConfig": {},
4977
+ * // "publicIpAddress": "my_publicIpAddress",
4978
+ * // "queryInsightsConfig": {},
4979
+ * // "readPoolConfig": {},
4980
+ * // "reconciling": false,
4981
+ * // "satisfiesPzi": false,
4982
+ * // "satisfiesPzs": false,
4983
+ * // "state": "my_state",
4984
+ * // "uid": "my_uid",
4985
+ * // "updatePolicy": {},
4986
+ * // "updateTime": "my_updateTime",
4987
+ * // "writableNode": {}
4988
+ * // }
4989
+ * }
4990
+ *
4991
+ * main().catch(e => {
4992
+ * console.error(e);
4993
+ * throw e;
4994
+ * });
4995
+ *
4996
+ * ```
3128
4997
  *
3129
4998
  * @param params - Parameters for request
3130
4999
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3139,6 +5008,61 @@ export declare namespace alloydb_v1alpha {
3139
5008
  get(callback: BodyResponseCallback<Schema$Instance>): void;
3140
5009
  /**
3141
5010
  * Get instance metadata used for a connection.
5011
+ * @example
5012
+ * ```js
5013
+ * // Before running the sample:
5014
+ * // - Enable the API at:
5015
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5016
+ * // - Login into gcloud by running:
5017
+ * // ```sh
5018
+ * // $ gcloud auth application-default login
5019
+ * // ```
5020
+ * // - Install the npm module by running:
5021
+ * // ```sh
5022
+ * // $ npm install googleapis
5023
+ * // ```
5024
+ *
5025
+ * const {google} = require('googleapis');
5026
+ * const alloydb = google.alloydb('v1alpha');
5027
+ *
5028
+ * async function main() {
5029
+ * const auth = new google.auth.GoogleAuth({
5030
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5031
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5032
+ * });
5033
+ *
5034
+ * // Acquire an auth client, and bind it to all future calls
5035
+ * const authClient = await auth.getClient();
5036
+ * google.options({auth: authClient});
5037
+ *
5038
+ * // Do the magic
5039
+ * const res =
5040
+ * await alloydb.projects.locations.clusters.instances.getConnectionInfo({
5041
+ * // Required. The name of the parent resource. The required format is: projects/{project\}/locations/{location\}/clusters/{cluster\}/instances/{instance\}
5042
+ * parent:
5043
+ * 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
5044
+ * // 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).
5045
+ * requestId: 'placeholder-value',
5046
+ * });
5047
+ * console.log(res.data);
5048
+ *
5049
+ * // Example response
5050
+ * // {
5051
+ * // "instanceUid": "my_instanceUid",
5052
+ * // "ipAddress": "my_ipAddress",
5053
+ * // "name": "my_name",
5054
+ * // "pemCertificateChain": [],
5055
+ * // "pscDnsName": "my_pscDnsName",
5056
+ * // "publicIpAddress": "my_publicIpAddress"
5057
+ * // }
5058
+ * }
5059
+ *
5060
+ * main().catch(e => {
5061
+ * console.error(e);
5062
+ * throw e;
5063
+ * });
5064
+ *
5065
+ * ```
3142
5066
  *
3143
5067
  * @param params - Parameters for request
3144
5068
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3153,6 +5077,66 @@ export declare namespace alloydb_v1alpha {
3153
5077
  getConnectionInfo(callback: BodyResponseCallback<Schema$ConnectionInfo>): void;
3154
5078
  /**
3155
5079
  * Injects fault in an instance. Imperative only.
5080
+ * @example
5081
+ * ```js
5082
+ * // Before running the sample:
5083
+ * // - Enable the API at:
5084
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5085
+ * // - Login into gcloud by running:
5086
+ * // ```sh
5087
+ * // $ gcloud auth application-default login
5088
+ * // ```
5089
+ * // - Install the npm module by running:
5090
+ * // ```sh
5091
+ * // $ npm install googleapis
5092
+ * // ```
5093
+ *
5094
+ * const {google} = require('googleapis');
5095
+ * const alloydb = google.alloydb('v1alpha');
5096
+ *
5097
+ * async function main() {
5098
+ * const auth = new google.auth.GoogleAuth({
5099
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5100
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5101
+ * });
5102
+ *
5103
+ * // Acquire an auth client, and bind it to all future calls
5104
+ * const authClient = await auth.getClient();
5105
+ * google.options({auth: authClient});
5106
+ *
5107
+ * // Do the magic
5108
+ * const res = await alloydb.projects.locations.clusters.instances.injectFault({
5109
+ * // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
5110
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
5111
+ *
5112
+ * // Request body metadata
5113
+ * requestBody: {
5114
+ * // request body parameters
5115
+ * // {
5116
+ * // "faultType": "my_faultType",
5117
+ * // "requestId": "my_requestId",
5118
+ * // "validateOnly": false
5119
+ * // }
5120
+ * },
5121
+ * });
5122
+ * console.log(res.data);
5123
+ *
5124
+ * // Example response
5125
+ * // {
5126
+ * // "done": false,
5127
+ * // "error": {},
5128
+ * // "metadata": {},
5129
+ * // "name": "my_name",
5130
+ * // "response": {}
5131
+ * // }
5132
+ * }
5133
+ *
5134
+ * main().catch(e => {
5135
+ * console.error(e);
5136
+ * throw e;
5137
+ * });
5138
+ *
5139
+ * ```
3156
5140
  *
3157
5141
  * @param params - Parameters for request
3158
5142
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3167,6 +5151,62 @@ export declare namespace alloydb_v1alpha {
3167
5151
  injectFault(callback: BodyResponseCallback<Schema$Operation>): void;
3168
5152
  /**
3169
5153
  * Lists Instances in a given project and location.
5154
+ * @example
5155
+ * ```js
5156
+ * // Before running the sample:
5157
+ * // - Enable the API at:
5158
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5159
+ * // - Login into gcloud by running:
5160
+ * // ```sh
5161
+ * // $ gcloud auth application-default login
5162
+ * // ```
5163
+ * // - Install the npm module by running:
5164
+ * // ```sh
5165
+ * // $ npm install googleapis
5166
+ * // ```
5167
+ *
5168
+ * const {google} = require('googleapis');
5169
+ * const alloydb = google.alloydb('v1alpha');
5170
+ *
5171
+ * async function main() {
5172
+ * const auth = new google.auth.GoogleAuth({
5173
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5174
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5175
+ * });
5176
+ *
5177
+ * // Acquire an auth client, and bind it to all future calls
5178
+ * const authClient = await auth.getClient();
5179
+ * google.options({auth: authClient});
5180
+ *
5181
+ * // Do the magic
5182
+ * const res = await alloydb.projects.locations.clusters.instances.list({
5183
+ * // Optional. Filtering results
5184
+ * filter: 'placeholder-value',
5185
+ * // Optional. Hint for how to order the results
5186
+ * orderBy: 'placeholder-value',
5187
+ * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
5188
+ * pageSize: 'placeholder-value',
5189
+ * // A token identifying a page of results the server should return.
5190
+ * pageToken: 'placeholder-value',
5191
+ * // 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/-
5192
+ * parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
5193
+ * });
5194
+ * console.log(res.data);
5195
+ *
5196
+ * // Example response
5197
+ * // {
5198
+ * // "instances": [],
5199
+ * // "nextPageToken": "my_nextPageToken",
5200
+ * // "unreachable": []
5201
+ * // }
5202
+ * }
5203
+ *
5204
+ * main().catch(e => {
5205
+ * console.error(e);
5206
+ * throw e;
5207
+ * });
5208
+ *
5209
+ * ```
3170
5210
  *
3171
5211
  * @param params - Parameters for request
3172
5212
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3181,6 +5221,105 @@ export declare namespace alloydb_v1alpha {
3181
5221
  list(callback: BodyResponseCallback<Schema$ListInstancesResponse>): void;
3182
5222
  /**
3183
5223
  * Updates the parameters of a single Instance.
5224
+ * @example
5225
+ * ```js
5226
+ * // Before running the sample:
5227
+ * // - Enable the API at:
5228
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5229
+ * // - Login into gcloud by running:
5230
+ * // ```sh
5231
+ * // $ gcloud auth application-default login
5232
+ * // ```
5233
+ * // - Install the npm module by running:
5234
+ * // ```sh
5235
+ * // $ npm install googleapis
5236
+ * // ```
5237
+ *
5238
+ * const {google} = require('googleapis');
5239
+ * const alloydb = google.alloydb('v1alpha');
5240
+ *
5241
+ * async function main() {
5242
+ * const auth = new google.auth.GoogleAuth({
5243
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5244
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5245
+ * });
5246
+ *
5247
+ * // Acquire an auth client, and bind it to all future calls
5248
+ * const authClient = await auth.getClient();
5249
+ * google.options({auth: authClient});
5250
+ *
5251
+ * // Do the magic
5252
+ * const res = await alloydb.projects.locations.clusters.instances.patch({
5253
+ * // 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.
5254
+ * allowMissing: 'placeholder-value',
5255
+ * // 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\}
5256
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
5257
+ * // 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).
5258
+ * requestId: 'placeholder-value',
5259
+ * // 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.
5260
+ * updateMask: 'placeholder-value',
5261
+ * // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
5262
+ * validateOnly: 'placeholder-value',
5263
+ *
5264
+ * // Request body metadata
5265
+ * requestBody: {
5266
+ * // request body parameters
5267
+ * // {
5268
+ * // "activationPolicy": "my_activationPolicy",
5269
+ * // "annotations": {},
5270
+ * // "availabilityType": "my_availabilityType",
5271
+ * // "clientConnectionConfig": {},
5272
+ * // "connectionPoolConfig": {},
5273
+ * // "createTime": "my_createTime",
5274
+ * // "databaseFlags": {},
5275
+ * // "deleteTime": "my_deleteTime",
5276
+ * // "displayName": "my_displayName",
5277
+ * // "etag": "my_etag",
5278
+ * // "gcaConfig": {},
5279
+ * // "gceZone": "my_gceZone",
5280
+ * // "geminiConfig": {},
5281
+ * // "instanceType": "my_instanceType",
5282
+ * // "ipAddress": "my_ipAddress",
5283
+ * // "labels": {},
5284
+ * // "machineConfig": {},
5285
+ * // "name": "my_name",
5286
+ * // "networkConfig": {},
5287
+ * // "nodes": [],
5288
+ * // "observabilityConfig": {},
5289
+ * // "outboundPublicIpAddresses": [],
5290
+ * // "pscInstanceConfig": {},
5291
+ * // "publicIpAddress": "my_publicIpAddress",
5292
+ * // "queryInsightsConfig": {},
5293
+ * // "readPoolConfig": {},
5294
+ * // "reconciling": false,
5295
+ * // "satisfiesPzi": false,
5296
+ * // "satisfiesPzs": false,
5297
+ * // "state": "my_state",
5298
+ * // "uid": "my_uid",
5299
+ * // "updatePolicy": {},
5300
+ * // "updateTime": "my_updateTime",
5301
+ * // "writableNode": {}
5302
+ * // }
5303
+ * },
5304
+ * });
5305
+ * console.log(res.data);
5306
+ *
5307
+ * // Example response
5308
+ * // {
5309
+ * // "done": false,
5310
+ * // "error": {},
5311
+ * // "metadata": {},
5312
+ * // "name": "my_name",
5313
+ * // "response": {}
5314
+ * // }
5315
+ * }
5316
+ *
5317
+ * main().catch(e => {
5318
+ * console.error(e);
5319
+ * throw e;
5320
+ * });
5321
+ *
5322
+ * ```
3184
5323
  *
3185
5324
  * @param params - Parameters for request
3186
5325
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3195,6 +5334,66 @@ export declare namespace alloydb_v1alpha {
3195
5334
  patch(callback: BodyResponseCallback<Schema$Operation>): void;
3196
5335
  /**
3197
5336
  * Restart an Instance in a cluster. Imperative only.
5337
+ * @example
5338
+ * ```js
5339
+ * // Before running the sample:
5340
+ * // - Enable the API at:
5341
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5342
+ * // - Login into gcloud by running:
5343
+ * // ```sh
5344
+ * // $ gcloud auth application-default login
5345
+ * // ```
5346
+ * // - Install the npm module by running:
5347
+ * // ```sh
5348
+ * // $ npm install googleapis
5349
+ * // ```
5350
+ *
5351
+ * const {google} = require('googleapis');
5352
+ * const alloydb = google.alloydb('v1alpha');
5353
+ *
5354
+ * async function main() {
5355
+ * const auth = new google.auth.GoogleAuth({
5356
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5357
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5358
+ * });
5359
+ *
5360
+ * // Acquire an auth client, and bind it to all future calls
5361
+ * const authClient = await auth.getClient();
5362
+ * google.options({auth: authClient});
5363
+ *
5364
+ * // Do the magic
5365
+ * const res = await alloydb.projects.locations.clusters.instances.restart({
5366
+ * // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
5367
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
5368
+ *
5369
+ * // Request body metadata
5370
+ * requestBody: {
5371
+ * // request body parameters
5372
+ * // {
5373
+ * // "nodeIds": [],
5374
+ * // "requestId": "my_requestId",
5375
+ * // "validateOnly": false
5376
+ * // }
5377
+ * },
5378
+ * });
5379
+ * console.log(res.data);
5380
+ *
5381
+ * // Example response
5382
+ * // {
5383
+ * // "done": false,
5384
+ * // "error": {},
5385
+ * // "metadata": {},
5386
+ * // "name": "my_name",
5387
+ * // "response": {}
5388
+ * // }
5389
+ * }
5390
+ *
5391
+ * main().catch(e => {
5392
+ * console.error(e);
5393
+ * throw e;
5394
+ * });
5395
+ *
5396
+ * ```
3198
5397
  *
3199
5398
  * @param params - Parameters for request
3200
5399
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3373,6 +5572,74 @@ export declare namespace alloydb_v1alpha {
3373
5572
  constructor(context: APIRequestContext);
3374
5573
  /**
3375
5574
  * Creates a new User in a given project, location, and cluster.
5575
+ * @example
5576
+ * ```js
5577
+ * // Before running the sample:
5578
+ * // - Enable the API at:
5579
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5580
+ * // - Login into gcloud by running:
5581
+ * // ```sh
5582
+ * // $ gcloud auth application-default login
5583
+ * // ```
5584
+ * // - Install the npm module by running:
5585
+ * // ```sh
5586
+ * // $ npm install googleapis
5587
+ * // ```
5588
+ *
5589
+ * const {google} = require('googleapis');
5590
+ * const alloydb = google.alloydb('v1alpha');
5591
+ *
5592
+ * async function main() {
5593
+ * const auth = new google.auth.GoogleAuth({
5594
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5595
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5596
+ * });
5597
+ *
5598
+ * // Acquire an auth client, and bind it to all future calls
5599
+ * const authClient = await auth.getClient();
5600
+ * google.options({auth: authClient});
5601
+ *
5602
+ * // Do the magic
5603
+ * const res = await alloydb.projects.locations.clusters.users.create({
5604
+ * // Required. Value for parent.
5605
+ * parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
5606
+ * // 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).
5607
+ * requestId: 'placeholder-value',
5608
+ * // Required. ID of the requesting object.
5609
+ * userId: 'placeholder-value',
5610
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
5611
+ * validateOnly: 'placeholder-value',
5612
+ *
5613
+ * // Request body metadata
5614
+ * requestBody: {
5615
+ * // request body parameters
5616
+ * // {
5617
+ * // "databaseRoles": [],
5618
+ * // "keepExtraRoles": false,
5619
+ * // "name": "my_name",
5620
+ * // "password": "my_password",
5621
+ * // "userType": "my_userType"
5622
+ * // }
5623
+ * },
5624
+ * });
5625
+ * console.log(res.data);
5626
+ *
5627
+ * // Example response
5628
+ * // {
5629
+ * // "databaseRoles": [],
5630
+ * // "keepExtraRoles": false,
5631
+ * // "name": "my_name",
5632
+ * // "password": "my_password",
5633
+ * // "userType": "my_userType"
5634
+ * // }
5635
+ * }
5636
+ *
5637
+ * main().catch(e => {
5638
+ * console.error(e);
5639
+ * throw e;
5640
+ * });
5641
+ *
5642
+ * ```
3376
5643
  *
3377
5644
  * @param params - Parameters for request
3378
5645
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3387,6 +5654,54 @@ export declare namespace alloydb_v1alpha {
3387
5654
  create(callback: BodyResponseCallback<Schema$User>): void;
3388
5655
  /**
3389
5656
  * Deletes a single User.
5657
+ * @example
5658
+ * ```js
5659
+ * // Before running the sample:
5660
+ * // - Enable the API at:
5661
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5662
+ * // - Login into gcloud by running:
5663
+ * // ```sh
5664
+ * // $ gcloud auth application-default login
5665
+ * // ```
5666
+ * // - Install the npm module by running:
5667
+ * // ```sh
5668
+ * // $ npm install googleapis
5669
+ * // ```
5670
+ *
5671
+ * const {google} = require('googleapis');
5672
+ * const alloydb = google.alloydb('v1alpha');
5673
+ *
5674
+ * async function main() {
5675
+ * const auth = new google.auth.GoogleAuth({
5676
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5677
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5678
+ * });
5679
+ *
5680
+ * // Acquire an auth client, and bind it to all future calls
5681
+ * const authClient = await auth.getClient();
5682
+ * google.options({auth: authClient});
5683
+ *
5684
+ * // Do the magic
5685
+ * const res = await alloydb.projects.locations.clusters.users.delete({
5686
+ * // Required. The name of the resource. For the required format, see the comment on the User.name field.
5687
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/users/my-user',
5688
+ * // 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).
5689
+ * requestId: 'placeholder-value',
5690
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
5691
+ * validateOnly: 'placeholder-value',
5692
+ * });
5693
+ * console.log(res.data);
5694
+ *
5695
+ * // Example response
5696
+ * // {}
5697
+ * }
5698
+ *
5699
+ * main().catch(e => {
5700
+ * console.error(e);
5701
+ * throw e;
5702
+ * });
5703
+ *
5704
+ * ```
3390
5705
  *
3391
5706
  * @param params - Parameters for request
3392
5707
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3401,6 +5716,56 @@ export declare namespace alloydb_v1alpha {
3401
5716
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
3402
5717
  /**
3403
5718
  * Gets details of a single User.
5719
+ * @example
5720
+ * ```js
5721
+ * // Before running the sample:
5722
+ * // - Enable the API at:
5723
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5724
+ * // - Login into gcloud by running:
5725
+ * // ```sh
5726
+ * // $ gcloud auth application-default login
5727
+ * // ```
5728
+ * // - Install the npm module by running:
5729
+ * // ```sh
5730
+ * // $ npm install googleapis
5731
+ * // ```
5732
+ *
5733
+ * const {google} = require('googleapis');
5734
+ * const alloydb = google.alloydb('v1alpha');
5735
+ *
5736
+ * async function main() {
5737
+ * const auth = new google.auth.GoogleAuth({
5738
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5739
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5740
+ * });
5741
+ *
5742
+ * // Acquire an auth client, and bind it to all future calls
5743
+ * const authClient = await auth.getClient();
5744
+ * google.options({auth: authClient});
5745
+ *
5746
+ * // Do the magic
5747
+ * const res = await alloydb.projects.locations.clusters.users.get({
5748
+ * // Required. The name of the resource. For the required format, see the comment on the User.name field.
5749
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/users/my-user',
5750
+ * });
5751
+ * console.log(res.data);
5752
+ *
5753
+ * // Example response
5754
+ * // {
5755
+ * // "databaseRoles": [],
5756
+ * // "keepExtraRoles": false,
5757
+ * // "name": "my_name",
5758
+ * // "password": "my_password",
5759
+ * // "userType": "my_userType"
5760
+ * // }
5761
+ * }
5762
+ *
5763
+ * main().catch(e => {
5764
+ * console.error(e);
5765
+ * throw e;
5766
+ * });
5767
+ *
5768
+ * ```
3404
5769
  *
3405
5770
  * @param params - Parameters for request
3406
5771
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3415,6 +5780,62 @@ export declare namespace alloydb_v1alpha {
3415
5780
  get(callback: BodyResponseCallback<Schema$User>): void;
3416
5781
  /**
3417
5782
  * Lists Users in a given project and location.
5783
+ * @example
5784
+ * ```js
5785
+ * // Before running the sample:
5786
+ * // - Enable the API at:
5787
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5788
+ * // - Login into gcloud by running:
5789
+ * // ```sh
5790
+ * // $ gcloud auth application-default login
5791
+ * // ```
5792
+ * // - Install the npm module by running:
5793
+ * // ```sh
5794
+ * // $ npm install googleapis
5795
+ * // ```
5796
+ *
5797
+ * const {google} = require('googleapis');
5798
+ * const alloydb = google.alloydb('v1alpha');
5799
+ *
5800
+ * async function main() {
5801
+ * const auth = new google.auth.GoogleAuth({
5802
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5803
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5804
+ * });
5805
+ *
5806
+ * // Acquire an auth client, and bind it to all future calls
5807
+ * const authClient = await auth.getClient();
5808
+ * google.options({auth: authClient});
5809
+ *
5810
+ * // Do the magic
5811
+ * const res = await alloydb.projects.locations.clusters.users.list({
5812
+ * // Optional. Filtering results
5813
+ * filter: 'placeholder-value',
5814
+ * // Optional. Hint for how to order the results
5815
+ * orderBy: 'placeholder-value',
5816
+ * // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
5817
+ * pageSize: 'placeholder-value',
5818
+ * // Optional. A token identifying a page of results the server should return.
5819
+ * pageToken: 'placeholder-value',
5820
+ * // Required. Parent value for ListUsersRequest
5821
+ * parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
5822
+ * });
5823
+ * console.log(res.data);
5824
+ *
5825
+ * // Example response
5826
+ * // {
5827
+ * // "nextPageToken": "my_nextPageToken",
5828
+ * // "unreachable": [],
5829
+ * // "users": []
5830
+ * // }
5831
+ * }
5832
+ *
5833
+ * main().catch(e => {
5834
+ * console.error(e);
5835
+ * throw e;
5836
+ * });
5837
+ *
5838
+ * ```
3418
5839
  *
3419
5840
  * @param params - Parameters for request
3420
5841
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3429,6 +5850,76 @@ export declare namespace alloydb_v1alpha {
3429
5850
  list(callback: BodyResponseCallback<Schema$ListUsersResponse>): void;
3430
5851
  /**
3431
5852
  * Updates the parameters of a single User.
5853
+ * @example
5854
+ * ```js
5855
+ * // Before running the sample:
5856
+ * // - Enable the API at:
5857
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
5858
+ * // - Login into gcloud by running:
5859
+ * // ```sh
5860
+ * // $ gcloud auth application-default login
5861
+ * // ```
5862
+ * // - Install the npm module by running:
5863
+ * // ```sh
5864
+ * // $ npm install googleapis
5865
+ * // ```
5866
+ *
5867
+ * const {google} = require('googleapis');
5868
+ * const alloydb = google.alloydb('v1alpha');
5869
+ *
5870
+ * async function main() {
5871
+ * const auth = new google.auth.GoogleAuth({
5872
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5873
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5874
+ * });
5875
+ *
5876
+ * // Acquire an auth client, and bind it to all future calls
5877
+ * const authClient = await auth.getClient();
5878
+ * google.options({auth: authClient});
5879
+ *
5880
+ * // Do the magic
5881
+ * const res = await alloydb.projects.locations.clusters.users.patch({
5882
+ * // Optional. Allow missing fields in the update mask.
5883
+ * allowMissing: 'placeholder-value',
5884
+ * // Output only. Name of the resource in the form of projects/{project\}/locations/{location\}/cluster/{cluster\}/users/{user\}.
5885
+ * name: 'projects/my-project/locations/my-location/clusters/my-cluster/users/my-user',
5886
+ * // 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).
5887
+ * requestId: 'placeholder-value',
5888
+ * // 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.
5889
+ * updateMask: 'placeholder-value',
5890
+ * // Optional. If set, the backend validates the request, but doesn't actually execute it.
5891
+ * validateOnly: 'placeholder-value',
5892
+ *
5893
+ * // Request body metadata
5894
+ * requestBody: {
5895
+ * // request body parameters
5896
+ * // {
5897
+ * // "databaseRoles": [],
5898
+ * // "keepExtraRoles": false,
5899
+ * // "name": "my_name",
5900
+ * // "password": "my_password",
5901
+ * // "userType": "my_userType"
5902
+ * // }
5903
+ * },
5904
+ * });
5905
+ * console.log(res.data);
5906
+ *
5907
+ * // Example response
5908
+ * // {
5909
+ * // "databaseRoles": [],
5910
+ * // "keepExtraRoles": false,
5911
+ * // "name": "my_name",
5912
+ * // "password": "my_password",
5913
+ * // "userType": "my_userType"
5914
+ * // }
5915
+ * }
5916
+ *
5917
+ * main().catch(e => {
5918
+ * console.error(e);
5919
+ * throw e;
5920
+ * });
5921
+ *
5922
+ * ```
3432
5923
  *
3433
5924
  * @param params - Parameters for request
3434
5925
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3537,6 +6028,56 @@ export declare namespace alloydb_v1alpha {
3537
6028
  constructor(context: APIRequestContext);
3538
6029
  /**
3539
6030
  * 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`.
6031
+ * @example
6032
+ * ```js
6033
+ * // Before running the sample:
6034
+ * // - Enable the API at:
6035
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
6036
+ * // - Login into gcloud by running:
6037
+ * // ```sh
6038
+ * // $ gcloud auth application-default login
6039
+ * // ```
6040
+ * // - Install the npm module by running:
6041
+ * // ```sh
6042
+ * // $ npm install googleapis
6043
+ * // ```
6044
+ *
6045
+ * const {google} = require('googleapis');
6046
+ * const alloydb = google.alloydb('v1alpha');
6047
+ *
6048
+ * async function main() {
6049
+ * const auth = new google.auth.GoogleAuth({
6050
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6051
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
6052
+ * });
6053
+ *
6054
+ * // Acquire an auth client, and bind it to all future calls
6055
+ * const authClient = await auth.getClient();
6056
+ * google.options({auth: authClient});
6057
+ *
6058
+ * // Do the magic
6059
+ * const res = await alloydb.projects.locations.operations.cancel({
6060
+ * // The name of the operation resource to be cancelled.
6061
+ * name: 'projects/my-project/locations/my-location/operations/my-operation',
6062
+ *
6063
+ * // Request body metadata
6064
+ * requestBody: {
6065
+ * // request body parameters
6066
+ * // {}
6067
+ * },
6068
+ * });
6069
+ * console.log(res.data);
6070
+ *
6071
+ * // Example response
6072
+ * // {}
6073
+ * }
6074
+ *
6075
+ * main().catch(e => {
6076
+ * console.error(e);
6077
+ * throw e;
6078
+ * });
6079
+ *
6080
+ * ```
3540
6081
  *
3541
6082
  * @param params - Parameters for request
3542
6083
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3551,6 +6092,50 @@ export declare namespace alloydb_v1alpha {
3551
6092
  cancel(callback: BodyResponseCallback<Schema$Empty>): void;
3552
6093
  /**
3553
6094
  * 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`.
6095
+ * @example
6096
+ * ```js
6097
+ * // Before running the sample:
6098
+ * // - Enable the API at:
6099
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
6100
+ * // - Login into gcloud by running:
6101
+ * // ```sh
6102
+ * // $ gcloud auth application-default login
6103
+ * // ```
6104
+ * // - Install the npm module by running:
6105
+ * // ```sh
6106
+ * // $ npm install googleapis
6107
+ * // ```
6108
+ *
6109
+ * const {google} = require('googleapis');
6110
+ * const alloydb = google.alloydb('v1alpha');
6111
+ *
6112
+ * async function main() {
6113
+ * const auth = new google.auth.GoogleAuth({
6114
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6115
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
6116
+ * });
6117
+ *
6118
+ * // Acquire an auth client, and bind it to all future calls
6119
+ * const authClient = await auth.getClient();
6120
+ * google.options({auth: authClient});
6121
+ *
6122
+ * // Do the magic
6123
+ * const res = await alloydb.projects.locations.operations.delete({
6124
+ * // The name of the operation resource to be deleted.
6125
+ * name: 'projects/my-project/locations/my-location/operations/my-operation',
6126
+ * });
6127
+ * console.log(res.data);
6128
+ *
6129
+ * // Example response
6130
+ * // {}
6131
+ * }
6132
+ *
6133
+ * main().catch(e => {
6134
+ * console.error(e);
6135
+ * throw e;
6136
+ * });
6137
+ *
6138
+ * ```
3554
6139
  *
3555
6140
  * @param params - Parameters for request
3556
6141
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3565,6 +6150,56 @@ export declare namespace alloydb_v1alpha {
3565
6150
  delete(callback: BodyResponseCallback<Schema$Empty>): void;
3566
6151
  /**
3567
6152
  * 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.
6153
+ * @example
6154
+ * ```js
6155
+ * // Before running the sample:
6156
+ * // - Enable the API at:
6157
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
6158
+ * // - Login into gcloud by running:
6159
+ * // ```sh
6160
+ * // $ gcloud auth application-default login
6161
+ * // ```
6162
+ * // - Install the npm module by running:
6163
+ * // ```sh
6164
+ * // $ npm install googleapis
6165
+ * // ```
6166
+ *
6167
+ * const {google} = require('googleapis');
6168
+ * const alloydb = google.alloydb('v1alpha');
6169
+ *
6170
+ * async function main() {
6171
+ * const auth = new google.auth.GoogleAuth({
6172
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6173
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
6174
+ * });
6175
+ *
6176
+ * // Acquire an auth client, and bind it to all future calls
6177
+ * const authClient = await auth.getClient();
6178
+ * google.options({auth: authClient});
6179
+ *
6180
+ * // Do the magic
6181
+ * const res = await alloydb.projects.locations.operations.get({
6182
+ * // The name of the operation resource.
6183
+ * name: 'projects/my-project/locations/my-location/operations/my-operation',
6184
+ * });
6185
+ * console.log(res.data);
6186
+ *
6187
+ * // Example response
6188
+ * // {
6189
+ * // "done": false,
6190
+ * // "error": {},
6191
+ * // "metadata": {},
6192
+ * // "name": "my_name",
6193
+ * // "response": {}
6194
+ * // }
6195
+ * }
6196
+ *
6197
+ * main().catch(e => {
6198
+ * console.error(e);
6199
+ * throw e;
6200
+ * });
6201
+ *
6202
+ * ```
3568
6203
  *
3569
6204
  * @param params - Parameters for request
3570
6205
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3579,6 +6214,59 @@ export declare namespace alloydb_v1alpha {
3579
6214
  get(callback: BodyResponseCallback<Schema$Operation>): void;
3580
6215
  /**
3581
6216
  * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
6217
+ * @example
6218
+ * ```js
6219
+ * // Before running the sample:
6220
+ * // - Enable the API at:
6221
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
6222
+ * // - Login into gcloud by running:
6223
+ * // ```sh
6224
+ * // $ gcloud auth application-default login
6225
+ * // ```
6226
+ * // - Install the npm module by running:
6227
+ * // ```sh
6228
+ * // $ npm install googleapis
6229
+ * // ```
6230
+ *
6231
+ * const {google} = require('googleapis');
6232
+ * const alloydb = google.alloydb('v1alpha');
6233
+ *
6234
+ * async function main() {
6235
+ * const auth = new google.auth.GoogleAuth({
6236
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6237
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
6238
+ * });
6239
+ *
6240
+ * // Acquire an auth client, and bind it to all future calls
6241
+ * const authClient = await auth.getClient();
6242
+ * google.options({auth: authClient});
6243
+ *
6244
+ * // Do the magic
6245
+ * const res = await alloydb.projects.locations.operations.list({
6246
+ * // The standard list filter.
6247
+ * filter: 'placeholder-value',
6248
+ * // The name of the operation's parent resource.
6249
+ * name: 'projects/my-project/locations/my-location',
6250
+ * // The standard list page size.
6251
+ * pageSize: 'placeholder-value',
6252
+ * // The standard list page token.
6253
+ * pageToken: 'placeholder-value',
6254
+ * });
6255
+ * console.log(res.data);
6256
+ *
6257
+ * // Example response
6258
+ * // {
6259
+ * // "nextPageToken": "my_nextPageToken",
6260
+ * // "operations": []
6261
+ * // }
6262
+ * }
6263
+ *
6264
+ * main().catch(e => {
6265
+ * console.error(e);
6266
+ * throw e;
6267
+ * });
6268
+ *
6269
+ * ```
3582
6270
  *
3583
6271
  * @param params - Parameters for request
3584
6272
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3637,6 +6325,59 @@ export declare namespace alloydb_v1alpha {
3637
6325
  constructor(context: APIRequestContext);
3638
6326
  /**
3639
6327
  * Lists SupportedDatabaseFlags for a given project and location.
6328
+ * @example
6329
+ * ```js
6330
+ * // Before running the sample:
6331
+ * // - Enable the API at:
6332
+ * // https://console.developers.google.com/apis/api/alloydb.googleapis.com
6333
+ * // - Login into gcloud by running:
6334
+ * // ```sh
6335
+ * // $ gcloud auth application-default login
6336
+ * // ```
6337
+ * // - Install the npm module by running:
6338
+ * // ```sh
6339
+ * // $ npm install googleapis
6340
+ * // ```
6341
+ *
6342
+ * const {google} = require('googleapis');
6343
+ * const alloydb = google.alloydb('v1alpha');
6344
+ *
6345
+ * async function main() {
6346
+ * const auth = new google.auth.GoogleAuth({
6347
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6348
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
6349
+ * });
6350
+ *
6351
+ * // Acquire an auth client, and bind it to all future calls
6352
+ * const authClient = await auth.getClient();
6353
+ * google.options({auth: authClient});
6354
+ *
6355
+ * // Do the magic
6356
+ * const res = await alloydb.projects.locations.supportedDatabaseFlags.list({
6357
+ * // Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
6358
+ * pageSize: 'placeholder-value',
6359
+ * // A token identifying a page of results the server should return.
6360
+ * pageToken: 'placeholder-value',
6361
+ * // 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.
6362
+ * parent: 'projects/my-project/locations/my-location',
6363
+ * // Optional. The scope for which supported flags are requested. If not specified, default is DATABASE.
6364
+ * scope: 'placeholder-value',
6365
+ * });
6366
+ * console.log(res.data);
6367
+ *
6368
+ * // Example response
6369
+ * // {
6370
+ * // "nextPageToken": "my_nextPageToken",
6371
+ * // "supportedDatabaseFlags": []
6372
+ * // }
6373
+ * }
6374
+ *
6375
+ * main().catch(e => {
6376
+ * console.error(e);
6377
+ * throw e;
6378
+ * });
6379
+ *
6380
+ * ```
3640
6381
  *
3641
6382
  * @param params - Parameters for request
3642
6383
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.