@googleapis/alloydb 12.1.0 → 14.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +42 -0
- package/build/index.d.ts +1 -1
- package/build/index.js.map +1 -1
- package/build/v1.d.ts +2715 -86
- package/build/v1.js.map +1 -1
- package/build/v1alpha.d.ts +2775 -97
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +2758 -97
- package/build/v1beta.js.map +1 -1
- package/index.ts +0 -1
- package/package.json +2 -2
- package/v1.ts +2867 -134
- package/v1alpha.ts +2927 -145
- package/v1beta.ts +2910 -145
package/build/v1alpha.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/// <reference types="node" />
|
|
2
|
-
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient,
|
|
2
|
+
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
|
|
3
3
|
import { Readable } from 'stream';
|
|
4
4
|
export declare namespace alloydb_v1alpha {
|
|
5
5
|
export interface Options extends GlobalOptions {
|
|
@@ -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
|
-
*
|
|
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
|
}
|
|
@@ -578,7 +586,7 @@ export declare namespace alloydb_v1alpha {
|
|
|
578
586
|
*/
|
|
579
587
|
export interface Schema$ContinuousBackupInfo {
|
|
580
588
|
/**
|
|
581
|
-
* Output only. The earliest restorable time that can be restored to.
|
|
589
|
+
* Output only. The earliest restorable time that can be restored to. If continuous backups and recovery was recently enabled, the earliest restorable time is the creation time of the earliest eligible backup within this cluster's continuous backup recovery window. After a cluster has had continuous backups enabled for the duration of its recovery window, the earliest restorable time becomes "now minus the recovery window". For example, assuming a point in time recovery is attempted at 04/16/2025 3:23:00PM with a 14d recovery window, the earliest restorable time would be 04/02/2025 3:23:00PM. This field is only visible if the CLUSTER_VIEW_CONTINUOUS_BACKUP cluster view is provided.
|
|
582
590
|
*/
|
|
583
591
|
earliestRestorableTime?: string | null;
|
|
584
592
|
/**
|
|
@@ -590,7 +598,7 @@ export declare namespace alloydb_v1alpha {
|
|
|
590
598
|
*/
|
|
591
599
|
encryptionInfo?: Schema$EncryptionInfo;
|
|
592
600
|
/**
|
|
593
|
-
* Output only. Days of the week on which a continuous backup is taken.
|
|
601
|
+
* Output only. Days of the week on which a continuous backup is taken.
|
|
594
602
|
*/
|
|
595
603
|
schedule?: string[] | null;
|
|
596
604
|
}
|
|
@@ -750,7 +758,7 @@ export declare namespace alloydb_v1alpha {
|
|
|
750
758
|
uri?: string | null;
|
|
751
759
|
}
|
|
752
760
|
/**
|
|
753
|
-
* Deprecated and unused. This
|
|
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
|
|
770
|
+
* Deprecated and unused. This message will be removed in the near future.
|
|
763
771
|
*/
|
|
764
772
|
export interface Schema$GeminiInstanceConfig {
|
|
765
773
|
/**
|
|
@@ -893,6 +901,10 @@ export declare namespace alloydb_v1alpha {
|
|
|
893
901
|
* An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB.
|
|
894
902
|
*/
|
|
895
903
|
export interface Schema$Instance {
|
|
904
|
+
/**
|
|
905
|
+
* Optional. Specifies whether an instance needs to spin up. Once the instance is active, the activation policy can be updated to the `NEVER` to stop the instance. Likewise, the activation policy can be updated to `ALWAYS` to start the instance. There are restrictions around when an instance can/cannot be activated (for example, a read pool instance should be stopped before stopping primary etc.). Please refer to the API documentation for more details.
|
|
906
|
+
*/
|
|
907
|
+
activationPolicy?: string | null;
|
|
896
908
|
/**
|
|
897
909
|
* Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128
|
|
898
910
|
*/
|
|
@@ -1036,6 +1048,10 @@ export declare namespace alloydb_v1alpha {
|
|
|
1036
1048
|
* Metadata related to instance-level network configuration.
|
|
1037
1049
|
*/
|
|
1038
1050
|
export interface Schema$InstanceNetworkConfig {
|
|
1051
|
+
/**
|
|
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])?.
|
|
1053
|
+
*/
|
|
1054
|
+
allocatedIpRangeOverride?: string | null;
|
|
1039
1055
|
/**
|
|
1040
1056
|
* Optional. A list of external network authorized to access this instance.
|
|
1041
1057
|
*/
|
|
@@ -1054,7 +1070,7 @@ export declare namespace alloydb_v1alpha {
|
|
|
1054
1070
|
network?: string | null;
|
|
1055
1071
|
}
|
|
1056
1072
|
/**
|
|
1057
|
-
* Details regarding the upgrade of
|
|
1073
|
+
* Details regarding the upgrade of instances associated with a cluster.
|
|
1058
1074
|
*/
|
|
1059
1075
|
export interface Schema$InstanceUpgradeDetails {
|
|
1060
1076
|
/**
|
|
@@ -1308,6 +1324,10 @@ export declare namespace alloydb_v1alpha {
|
|
|
1308
1324
|
* Track actively running queries on the instance. If not set, this flag is "off" by default.
|
|
1309
1325
|
*/
|
|
1310
1326
|
trackActiveQueries?: boolean | null;
|
|
1327
|
+
/**
|
|
1328
|
+
* Track client address for an instance. If not set, default value is "off".
|
|
1329
|
+
*/
|
|
1330
|
+
trackClientAddress?: boolean | null;
|
|
1311
1331
|
/**
|
|
1312
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.
|
|
1313
1333
|
*/
|
|
@@ -1804,7 +1824,7 @@ export declare namespace alloydb_v1alpha {
|
|
|
1804
1824
|
internalResourceMetadata?: Schema$StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata[];
|
|
1805
1825
|
}
|
|
1806
1826
|
/**
|
|
1807
|
-
* DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform.
|
|
1827
|
+
* DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. Next ID: 8
|
|
1808
1828
|
*/
|
|
1809
1829
|
export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed {
|
|
1810
1830
|
/**
|
|
@@ -1850,6 +1870,10 @@ export declare namespace alloydb_v1alpha {
|
|
|
1850
1870
|
* 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.
|
|
1851
1871
|
*/
|
|
1852
1872
|
externalUri?: string | null;
|
|
1873
|
+
/**
|
|
1874
|
+
* This is used to identify the location of the resource. Example: "us-central1"
|
|
1875
|
+
*/
|
|
1876
|
+
location?: string | null;
|
|
1853
1877
|
/**
|
|
1854
1878
|
* Required. The name of the signal, ex: PUBLIC_SQL_INSTANCE, SQL_LOG_ERROR_VERBOSITY etc.
|
|
1855
1879
|
*/
|
|
@@ -1897,7 +1921,7 @@ export declare namespace alloydb_v1alpha {
|
|
|
1897
1921
|
*/
|
|
1898
1922
|
providerDescription?: string | null;
|
|
1899
1923
|
/**
|
|
1900
|
-
* Required. The type of resource this ID is identifying. Ex
|
|
1924
|
+
* 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
|
|
1901
1925
|
*/
|
|
1902
1926
|
resourceType?: string | null;
|
|
1903
1927
|
/**
|
|
@@ -2451,28 +2475,133 @@ export declare namespace alloydb_v1alpha {
|
|
|
2451
2475
|
constructor(context: APIRequestContext);
|
|
2452
2476
|
/**
|
|
2453
2477
|
* Gets information about a location.
|
|
2478
|
+
* @example
|
|
2479
|
+
* ```js
|
|
2480
|
+
* // Before running the sample:
|
|
2481
|
+
* // - Enable the API at:
|
|
2482
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
2483
|
+
* // - Login into gcloud by running:
|
|
2484
|
+
* // ```sh
|
|
2485
|
+
* // $ gcloud auth application-default login
|
|
2486
|
+
* // ```
|
|
2487
|
+
* // - Install the npm module by running:
|
|
2488
|
+
* // ```sh
|
|
2489
|
+
* // $ npm install googleapis
|
|
2490
|
+
* // ```
|
|
2491
|
+
*
|
|
2492
|
+
* const {google} = require('googleapis');
|
|
2493
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
2494
|
+
*
|
|
2495
|
+
* async function main() {
|
|
2496
|
+
* const auth = new google.auth.GoogleAuth({
|
|
2497
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2498
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
2499
|
+
* });
|
|
2500
|
+
*
|
|
2501
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
2502
|
+
* const authClient = await auth.getClient();
|
|
2503
|
+
* google.options({auth: authClient});
|
|
2504
|
+
*
|
|
2505
|
+
* // Do the magic
|
|
2506
|
+
* const res = await alloydb.projects.locations.get({
|
|
2507
|
+
* // Resource name for the location.
|
|
2508
|
+
* name: 'projects/my-project/locations/my-location',
|
|
2509
|
+
* });
|
|
2510
|
+
* console.log(res.data);
|
|
2511
|
+
*
|
|
2512
|
+
* // Example response
|
|
2513
|
+
* // {
|
|
2514
|
+
* // "displayName": "my_displayName",
|
|
2515
|
+
* // "labels": {},
|
|
2516
|
+
* // "locationId": "my_locationId",
|
|
2517
|
+
* // "metadata": {},
|
|
2518
|
+
* // "name": "my_name"
|
|
2519
|
+
* // }
|
|
2520
|
+
* }
|
|
2521
|
+
*
|
|
2522
|
+
* main().catch(e => {
|
|
2523
|
+
* console.error(e);
|
|
2524
|
+
* throw e;
|
|
2525
|
+
* });
|
|
2526
|
+
*
|
|
2527
|
+
* ```
|
|
2454
2528
|
*
|
|
2455
2529
|
* @param params - Parameters for request
|
|
2456
2530
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2457
2531
|
* @param callback - Optional callback that handles the response.
|
|
2458
2532
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2459
2533
|
*/
|
|
2460
|
-
get(params: Params$Resource$Projects$Locations$Get, options: StreamMethodOptions):
|
|
2461
|
-
get(params?: Params$Resource$Projects$Locations$Get, options?: MethodOptions):
|
|
2534
|
+
get(params: Params$Resource$Projects$Locations$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
2535
|
+
get(params?: Params$Resource$Projects$Locations$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudLocationLocation>>;
|
|
2462
2536
|
get(params: Params$Resource$Projects$Locations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2463
2537
|
get(params: Params$Resource$Projects$Locations$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudLocationLocation>, callback: BodyResponseCallback<Schema$GoogleCloudLocationLocation>): void;
|
|
2464
2538
|
get(params: Params$Resource$Projects$Locations$Get, callback: BodyResponseCallback<Schema$GoogleCloudLocationLocation>): void;
|
|
2465
2539
|
get(callback: BodyResponseCallback<Schema$GoogleCloudLocationLocation>): void;
|
|
2466
2540
|
/**
|
|
2467
2541
|
* Lists information about the supported locations for this service.
|
|
2542
|
+
* @example
|
|
2543
|
+
* ```js
|
|
2544
|
+
* // Before running the sample:
|
|
2545
|
+
* // - Enable the API at:
|
|
2546
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
2547
|
+
* // - Login into gcloud by running:
|
|
2548
|
+
* // ```sh
|
|
2549
|
+
* // $ gcloud auth application-default login
|
|
2550
|
+
* // ```
|
|
2551
|
+
* // - Install the npm module by running:
|
|
2552
|
+
* // ```sh
|
|
2553
|
+
* // $ npm install googleapis
|
|
2554
|
+
* // ```
|
|
2555
|
+
*
|
|
2556
|
+
* const {google} = require('googleapis');
|
|
2557
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
2558
|
+
*
|
|
2559
|
+
* async function main() {
|
|
2560
|
+
* const auth = new google.auth.GoogleAuth({
|
|
2561
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2562
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
2563
|
+
* });
|
|
2564
|
+
*
|
|
2565
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
2566
|
+
* const authClient = await auth.getClient();
|
|
2567
|
+
* google.options({auth: authClient});
|
|
2568
|
+
*
|
|
2569
|
+
* // Do the magic
|
|
2570
|
+
* const res = await alloydb.projects.locations.list({
|
|
2571
|
+
* // Optional. A list of extra location types that should be used as conditions for controlling the visibility of the locations.
|
|
2572
|
+
* extraLocationTypes: 'placeholder-value',
|
|
2573
|
+
* // 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).
|
|
2574
|
+
* filter: 'placeholder-value',
|
|
2575
|
+
* // The resource that owns the locations collection, if applicable.
|
|
2576
|
+
* name: 'projects/my-project',
|
|
2577
|
+
* // The maximum number of results to return. If not set, the service selects a default.
|
|
2578
|
+
* pageSize: 'placeholder-value',
|
|
2579
|
+
* // A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
|
|
2580
|
+
* pageToken: 'placeholder-value',
|
|
2581
|
+
* });
|
|
2582
|
+
* console.log(res.data);
|
|
2583
|
+
*
|
|
2584
|
+
* // Example response
|
|
2585
|
+
* // {
|
|
2586
|
+
* // "locations": [],
|
|
2587
|
+
* // "nextPageToken": "my_nextPageToken"
|
|
2588
|
+
* // }
|
|
2589
|
+
* }
|
|
2590
|
+
*
|
|
2591
|
+
* main().catch(e => {
|
|
2592
|
+
* console.error(e);
|
|
2593
|
+
* throw e;
|
|
2594
|
+
* });
|
|
2595
|
+
*
|
|
2596
|
+
* ```
|
|
2468
2597
|
*
|
|
2469
2598
|
* @param params - Parameters for request
|
|
2470
2599
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2471
2600
|
* @param callback - Optional callback that handles the response.
|
|
2472
2601
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2473
2602
|
*/
|
|
2474
|
-
list(params: Params$Resource$Projects$Locations$List, options: StreamMethodOptions):
|
|
2475
|
-
list(params?: Params$Resource$Projects$Locations$List, options?: MethodOptions):
|
|
2603
|
+
list(params: Params$Resource$Projects$Locations$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
2604
|
+
list(params?: Params$Resource$Projects$Locations$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudLocationListLocationsResponse>>;
|
|
2476
2605
|
list(params: Params$Resource$Projects$Locations$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2477
2606
|
list(params: Params$Resource$Projects$Locations$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudLocationListLocationsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudLocationListLocationsResponse>): void;
|
|
2478
2607
|
list(params: Params$Resource$Projects$Locations$List, callback: BodyResponseCallback<Schema$GoogleCloudLocationListLocationsResponse>): void;
|
|
@@ -2511,70 +2640,430 @@ export declare namespace alloydb_v1alpha {
|
|
|
2511
2640
|
constructor(context: APIRequestContext);
|
|
2512
2641
|
/**
|
|
2513
2642
|
* Creates a new Backup in a given project and location.
|
|
2643
|
+
* @example
|
|
2644
|
+
* ```js
|
|
2645
|
+
* // Before running the sample:
|
|
2646
|
+
* // - Enable the API at:
|
|
2647
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
2648
|
+
* // - Login into gcloud by running:
|
|
2649
|
+
* // ```sh
|
|
2650
|
+
* // $ gcloud auth application-default login
|
|
2651
|
+
* // ```
|
|
2652
|
+
* // - Install the npm module by running:
|
|
2653
|
+
* // ```sh
|
|
2654
|
+
* // $ npm install googleapis
|
|
2655
|
+
* // ```
|
|
2656
|
+
*
|
|
2657
|
+
* const {google} = require('googleapis');
|
|
2658
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
2659
|
+
*
|
|
2660
|
+
* async function main() {
|
|
2661
|
+
* const auth = new google.auth.GoogleAuth({
|
|
2662
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2663
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
2664
|
+
* });
|
|
2665
|
+
*
|
|
2666
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
2667
|
+
* const authClient = await auth.getClient();
|
|
2668
|
+
* google.options({auth: authClient});
|
|
2669
|
+
*
|
|
2670
|
+
* // Do the magic
|
|
2671
|
+
* const res = await alloydb.projects.locations.backups.create({
|
|
2672
|
+
* // Required. ID of the requesting object.
|
|
2673
|
+
* backupId: 'placeholder-value',
|
|
2674
|
+
* // Required. Value for parent.
|
|
2675
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
2676
|
+
* // 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).
|
|
2677
|
+
* requestId: 'placeholder-value',
|
|
2678
|
+
* // Optional. If set, the backend validates the request, but doesn't actually execute it.
|
|
2679
|
+
* validateOnly: 'placeholder-value',
|
|
2680
|
+
*
|
|
2681
|
+
* // Request body metadata
|
|
2682
|
+
* requestBody: {
|
|
2683
|
+
* // request body parameters
|
|
2684
|
+
* // {
|
|
2685
|
+
* // "annotations": {},
|
|
2686
|
+
* // "clusterName": "my_clusterName",
|
|
2687
|
+
* // "clusterUid": "my_clusterUid",
|
|
2688
|
+
* // "createCompletionTime": "my_createCompletionTime",
|
|
2689
|
+
* // "createTime": "my_createTime",
|
|
2690
|
+
* // "databaseVersion": "my_databaseVersion",
|
|
2691
|
+
* // "deleteTime": "my_deleteTime",
|
|
2692
|
+
* // "description": "my_description",
|
|
2693
|
+
* // "displayName": "my_displayName",
|
|
2694
|
+
* // "encryptionConfig": {},
|
|
2695
|
+
* // "encryptionInfo": {},
|
|
2696
|
+
* // "etag": "my_etag",
|
|
2697
|
+
* // "expiryQuantity": {},
|
|
2698
|
+
* // "expiryTime": "my_expiryTime",
|
|
2699
|
+
* // "labels": {},
|
|
2700
|
+
* // "name": "my_name",
|
|
2701
|
+
* // "reconciling": false,
|
|
2702
|
+
* // "satisfiesPzi": false,
|
|
2703
|
+
* // "satisfiesPzs": false,
|
|
2704
|
+
* // "sizeBytes": "my_sizeBytes",
|
|
2705
|
+
* // "state": "my_state",
|
|
2706
|
+
* // "tags": {},
|
|
2707
|
+
* // "type": "my_type",
|
|
2708
|
+
* // "uid": "my_uid",
|
|
2709
|
+
* // "updateTime": "my_updateTime"
|
|
2710
|
+
* // }
|
|
2711
|
+
* },
|
|
2712
|
+
* });
|
|
2713
|
+
* console.log(res.data);
|
|
2714
|
+
*
|
|
2715
|
+
* // Example response
|
|
2716
|
+
* // {
|
|
2717
|
+
* // "done": false,
|
|
2718
|
+
* // "error": {},
|
|
2719
|
+
* // "metadata": {},
|
|
2720
|
+
* // "name": "my_name",
|
|
2721
|
+
* // "response": {}
|
|
2722
|
+
* // }
|
|
2723
|
+
* }
|
|
2724
|
+
*
|
|
2725
|
+
* main().catch(e => {
|
|
2726
|
+
* console.error(e);
|
|
2727
|
+
* throw e;
|
|
2728
|
+
* });
|
|
2729
|
+
*
|
|
2730
|
+
* ```
|
|
2514
2731
|
*
|
|
2515
2732
|
* @param params - Parameters for request
|
|
2516
2733
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2517
2734
|
* @param callback - Optional callback that handles the response.
|
|
2518
2735
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2519
2736
|
*/
|
|
2520
|
-
create(params: Params$Resource$Projects$Locations$Backups$Create, options: StreamMethodOptions):
|
|
2521
|
-
create(params?: Params$Resource$Projects$Locations$Backups$Create, options?: MethodOptions):
|
|
2737
|
+
create(params: Params$Resource$Projects$Locations$Backups$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
2738
|
+
create(params?: Params$Resource$Projects$Locations$Backups$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
2522
2739
|
create(params: Params$Resource$Projects$Locations$Backups$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2523
2740
|
create(params: Params$Resource$Projects$Locations$Backups$Create, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2524
2741
|
create(params: Params$Resource$Projects$Locations$Backups$Create, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2525
2742
|
create(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2526
2743
|
/**
|
|
2527
2744
|
* Deletes a single Backup.
|
|
2745
|
+
* @example
|
|
2746
|
+
* ```js
|
|
2747
|
+
* // Before running the sample:
|
|
2748
|
+
* // - Enable the API at:
|
|
2749
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
2750
|
+
* // - Login into gcloud by running:
|
|
2751
|
+
* // ```sh
|
|
2752
|
+
* // $ gcloud auth application-default login
|
|
2753
|
+
* // ```
|
|
2754
|
+
* // - Install the npm module by running:
|
|
2755
|
+
* // ```sh
|
|
2756
|
+
* // $ npm install googleapis
|
|
2757
|
+
* // ```
|
|
2758
|
+
*
|
|
2759
|
+
* const {google} = require('googleapis');
|
|
2760
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
2761
|
+
*
|
|
2762
|
+
* async function main() {
|
|
2763
|
+
* const auth = new google.auth.GoogleAuth({
|
|
2764
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2765
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
2766
|
+
* });
|
|
2767
|
+
*
|
|
2768
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
2769
|
+
* const authClient = await auth.getClient();
|
|
2770
|
+
* google.options({auth: authClient});
|
|
2771
|
+
*
|
|
2772
|
+
* // Do the magic
|
|
2773
|
+
* const res = await alloydb.projects.locations.backups.delete({
|
|
2774
|
+
* // 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.
|
|
2775
|
+
* etag: 'placeholder-value',
|
|
2776
|
+
* // Required. Name of the resource. For the required format, see the comment on the Backup.name field.
|
|
2777
|
+
* name: 'projects/my-project/locations/my-location/backups/my-backup',
|
|
2778
|
+
* // 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).
|
|
2779
|
+
* requestId: 'placeholder-value',
|
|
2780
|
+
* // Optional. If set, the backend validates the request, but doesn't actually execute it.
|
|
2781
|
+
* validateOnly: 'placeholder-value',
|
|
2782
|
+
* });
|
|
2783
|
+
* console.log(res.data);
|
|
2784
|
+
*
|
|
2785
|
+
* // Example response
|
|
2786
|
+
* // {
|
|
2787
|
+
* // "done": false,
|
|
2788
|
+
* // "error": {},
|
|
2789
|
+
* // "metadata": {},
|
|
2790
|
+
* // "name": "my_name",
|
|
2791
|
+
* // "response": {}
|
|
2792
|
+
* // }
|
|
2793
|
+
* }
|
|
2794
|
+
*
|
|
2795
|
+
* main().catch(e => {
|
|
2796
|
+
* console.error(e);
|
|
2797
|
+
* throw e;
|
|
2798
|
+
* });
|
|
2799
|
+
*
|
|
2800
|
+
* ```
|
|
2528
2801
|
*
|
|
2529
2802
|
* @param params - Parameters for request
|
|
2530
2803
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2531
2804
|
* @param callback - Optional callback that handles the response.
|
|
2532
2805
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2533
2806
|
*/
|
|
2534
|
-
delete(params: Params$Resource$Projects$Locations$Backups$Delete, options: StreamMethodOptions):
|
|
2535
|
-
delete(params?: Params$Resource$Projects$Locations$Backups$Delete, options?: MethodOptions):
|
|
2807
|
+
delete(params: Params$Resource$Projects$Locations$Backups$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
2808
|
+
delete(params?: Params$Resource$Projects$Locations$Backups$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
2536
2809
|
delete(params: Params$Resource$Projects$Locations$Backups$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2537
2810
|
delete(params: Params$Resource$Projects$Locations$Backups$Delete, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2538
2811
|
delete(params: Params$Resource$Projects$Locations$Backups$Delete, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2539
2812
|
delete(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2540
2813
|
/**
|
|
2541
2814
|
* Gets details of a single Backup.
|
|
2815
|
+
* @example
|
|
2816
|
+
* ```js
|
|
2817
|
+
* // Before running the sample:
|
|
2818
|
+
* // - Enable the API at:
|
|
2819
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
2820
|
+
* // - Login into gcloud by running:
|
|
2821
|
+
* // ```sh
|
|
2822
|
+
* // $ gcloud auth application-default login
|
|
2823
|
+
* // ```
|
|
2824
|
+
* // - Install the npm module by running:
|
|
2825
|
+
* // ```sh
|
|
2826
|
+
* // $ npm install googleapis
|
|
2827
|
+
* // ```
|
|
2828
|
+
*
|
|
2829
|
+
* const {google} = require('googleapis');
|
|
2830
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
2831
|
+
*
|
|
2832
|
+
* async function main() {
|
|
2833
|
+
* const auth = new google.auth.GoogleAuth({
|
|
2834
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2835
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
2836
|
+
* });
|
|
2837
|
+
*
|
|
2838
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
2839
|
+
* const authClient = await auth.getClient();
|
|
2840
|
+
* google.options({auth: authClient});
|
|
2841
|
+
*
|
|
2842
|
+
* // Do the magic
|
|
2843
|
+
* const res = await alloydb.projects.locations.backups.get({
|
|
2844
|
+
* // Required. Name of the resource
|
|
2845
|
+
* name: 'projects/my-project/locations/my-location/backups/my-backup',
|
|
2846
|
+
* });
|
|
2847
|
+
* console.log(res.data);
|
|
2848
|
+
*
|
|
2849
|
+
* // Example response
|
|
2850
|
+
* // {
|
|
2851
|
+
* // "annotations": {},
|
|
2852
|
+
* // "clusterName": "my_clusterName",
|
|
2853
|
+
* // "clusterUid": "my_clusterUid",
|
|
2854
|
+
* // "createCompletionTime": "my_createCompletionTime",
|
|
2855
|
+
* // "createTime": "my_createTime",
|
|
2856
|
+
* // "databaseVersion": "my_databaseVersion",
|
|
2857
|
+
* // "deleteTime": "my_deleteTime",
|
|
2858
|
+
* // "description": "my_description",
|
|
2859
|
+
* // "displayName": "my_displayName",
|
|
2860
|
+
* // "encryptionConfig": {},
|
|
2861
|
+
* // "encryptionInfo": {},
|
|
2862
|
+
* // "etag": "my_etag",
|
|
2863
|
+
* // "expiryQuantity": {},
|
|
2864
|
+
* // "expiryTime": "my_expiryTime",
|
|
2865
|
+
* // "labels": {},
|
|
2866
|
+
* // "name": "my_name",
|
|
2867
|
+
* // "reconciling": false,
|
|
2868
|
+
* // "satisfiesPzi": false,
|
|
2869
|
+
* // "satisfiesPzs": false,
|
|
2870
|
+
* // "sizeBytes": "my_sizeBytes",
|
|
2871
|
+
* // "state": "my_state",
|
|
2872
|
+
* // "tags": {},
|
|
2873
|
+
* // "type": "my_type",
|
|
2874
|
+
* // "uid": "my_uid",
|
|
2875
|
+
* // "updateTime": "my_updateTime"
|
|
2876
|
+
* // }
|
|
2877
|
+
* }
|
|
2878
|
+
*
|
|
2879
|
+
* main().catch(e => {
|
|
2880
|
+
* console.error(e);
|
|
2881
|
+
* throw e;
|
|
2882
|
+
* });
|
|
2883
|
+
*
|
|
2884
|
+
* ```
|
|
2542
2885
|
*
|
|
2543
2886
|
* @param params - Parameters for request
|
|
2544
2887
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2545
2888
|
* @param callback - Optional callback that handles the response.
|
|
2546
2889
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2547
2890
|
*/
|
|
2548
|
-
get(params: Params$Resource$Projects$Locations$Backups$Get, options: StreamMethodOptions):
|
|
2549
|
-
get(params?: Params$Resource$Projects$Locations$Backups$Get, options?: MethodOptions):
|
|
2891
|
+
get(params: Params$Resource$Projects$Locations$Backups$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
2892
|
+
get(params?: Params$Resource$Projects$Locations$Backups$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Backup>>;
|
|
2550
2893
|
get(params: Params$Resource$Projects$Locations$Backups$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2551
2894
|
get(params: Params$Resource$Projects$Locations$Backups$Get, options: MethodOptions | BodyResponseCallback<Schema$Backup>, callback: BodyResponseCallback<Schema$Backup>): void;
|
|
2552
2895
|
get(params: Params$Resource$Projects$Locations$Backups$Get, callback: BodyResponseCallback<Schema$Backup>): void;
|
|
2553
2896
|
get(callback: BodyResponseCallback<Schema$Backup>): void;
|
|
2554
2897
|
/**
|
|
2555
2898
|
* Lists Backups in a given project and location.
|
|
2899
|
+
* @example
|
|
2900
|
+
* ```js
|
|
2901
|
+
* // Before running the sample:
|
|
2902
|
+
* // - Enable the API at:
|
|
2903
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
2904
|
+
* // - Login into gcloud by running:
|
|
2905
|
+
* // ```sh
|
|
2906
|
+
* // $ gcloud auth application-default login
|
|
2907
|
+
* // ```
|
|
2908
|
+
* // - Install the npm module by running:
|
|
2909
|
+
* // ```sh
|
|
2910
|
+
* // $ npm install googleapis
|
|
2911
|
+
* // ```
|
|
2912
|
+
*
|
|
2913
|
+
* const {google} = require('googleapis');
|
|
2914
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
2915
|
+
*
|
|
2916
|
+
* async function main() {
|
|
2917
|
+
* const auth = new google.auth.GoogleAuth({
|
|
2918
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2919
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
2920
|
+
* });
|
|
2921
|
+
*
|
|
2922
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
2923
|
+
* const authClient = await auth.getClient();
|
|
2924
|
+
* google.options({auth: authClient});
|
|
2925
|
+
*
|
|
2926
|
+
* // Do the magic
|
|
2927
|
+
* const res = await alloydb.projects.locations.backups.list({
|
|
2928
|
+
* // Filtering results
|
|
2929
|
+
* filter: 'placeholder-value',
|
|
2930
|
+
* // Hint for how to order the results
|
|
2931
|
+
* orderBy: 'placeholder-value',
|
|
2932
|
+
* // Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
|
|
2933
|
+
* pageSize: 'placeholder-value',
|
|
2934
|
+
* // A token identifying a page of results the server should return.
|
|
2935
|
+
* pageToken: 'placeholder-value',
|
|
2936
|
+
* // Required. Parent value for ListBackupsRequest
|
|
2937
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
2938
|
+
* });
|
|
2939
|
+
* console.log(res.data);
|
|
2940
|
+
*
|
|
2941
|
+
* // Example response
|
|
2942
|
+
* // {
|
|
2943
|
+
* // "backups": [],
|
|
2944
|
+
* // "nextPageToken": "my_nextPageToken",
|
|
2945
|
+
* // "unreachable": []
|
|
2946
|
+
* // }
|
|
2947
|
+
* }
|
|
2948
|
+
*
|
|
2949
|
+
* main().catch(e => {
|
|
2950
|
+
* console.error(e);
|
|
2951
|
+
* throw e;
|
|
2952
|
+
* });
|
|
2953
|
+
*
|
|
2954
|
+
* ```
|
|
2556
2955
|
*
|
|
2557
2956
|
* @param params - Parameters for request
|
|
2558
2957
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2559
2958
|
* @param callback - Optional callback that handles the response.
|
|
2560
2959
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2561
2960
|
*/
|
|
2562
|
-
list(params: Params$Resource$Projects$Locations$Backups$List, options: StreamMethodOptions):
|
|
2563
|
-
list(params?: Params$Resource$Projects$Locations$Backups$List, options?: MethodOptions):
|
|
2961
|
+
list(params: Params$Resource$Projects$Locations$Backups$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
2962
|
+
list(params?: Params$Resource$Projects$Locations$Backups$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ListBackupsResponse>>;
|
|
2564
2963
|
list(params: Params$Resource$Projects$Locations$Backups$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2565
2964
|
list(params: Params$Resource$Projects$Locations$Backups$List, options: MethodOptions | BodyResponseCallback<Schema$ListBackupsResponse>, callback: BodyResponseCallback<Schema$ListBackupsResponse>): void;
|
|
2566
2965
|
list(params: Params$Resource$Projects$Locations$Backups$List, callback: BodyResponseCallback<Schema$ListBackupsResponse>): void;
|
|
2567
2966
|
list(callback: BodyResponseCallback<Schema$ListBackupsResponse>): void;
|
|
2568
2967
|
/**
|
|
2569
2968
|
* Updates the parameters of a single Backup.
|
|
2969
|
+
* @example
|
|
2970
|
+
* ```js
|
|
2971
|
+
* // Before running the sample:
|
|
2972
|
+
* // - Enable the API at:
|
|
2973
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
2974
|
+
* // - Login into gcloud by running:
|
|
2975
|
+
* // ```sh
|
|
2976
|
+
* // $ gcloud auth application-default login
|
|
2977
|
+
* // ```
|
|
2978
|
+
* // - Install the npm module by running:
|
|
2979
|
+
* // ```sh
|
|
2980
|
+
* // $ npm install googleapis
|
|
2981
|
+
* // ```
|
|
2982
|
+
*
|
|
2983
|
+
* const {google} = require('googleapis');
|
|
2984
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
2985
|
+
*
|
|
2986
|
+
* async function main() {
|
|
2987
|
+
* const auth = new google.auth.GoogleAuth({
|
|
2988
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
2989
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
2990
|
+
* });
|
|
2991
|
+
*
|
|
2992
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
2993
|
+
* const authClient = await auth.getClient();
|
|
2994
|
+
* google.options({auth: authClient});
|
|
2995
|
+
*
|
|
2996
|
+
* // Do the magic
|
|
2997
|
+
* const res = await alloydb.projects.locations.backups.patch({
|
|
2998
|
+
* // 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.
|
|
2999
|
+
* allowMissing: 'placeholder-value',
|
|
3000
|
+
* // 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\}
|
|
3001
|
+
* name: 'projects/my-project/locations/my-location/backups/my-backup',
|
|
3002
|
+
* // 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).
|
|
3003
|
+
* requestId: 'placeholder-value',
|
|
3004
|
+
* // 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.
|
|
3005
|
+
* updateMask: 'placeholder-value',
|
|
3006
|
+
* // Optional. If set, the backend validates the request, but doesn't actually execute it.
|
|
3007
|
+
* validateOnly: 'placeholder-value',
|
|
3008
|
+
*
|
|
3009
|
+
* // Request body metadata
|
|
3010
|
+
* requestBody: {
|
|
3011
|
+
* // request body parameters
|
|
3012
|
+
* // {
|
|
3013
|
+
* // "annotations": {},
|
|
3014
|
+
* // "clusterName": "my_clusterName",
|
|
3015
|
+
* // "clusterUid": "my_clusterUid",
|
|
3016
|
+
* // "createCompletionTime": "my_createCompletionTime",
|
|
3017
|
+
* // "createTime": "my_createTime",
|
|
3018
|
+
* // "databaseVersion": "my_databaseVersion",
|
|
3019
|
+
* // "deleteTime": "my_deleteTime",
|
|
3020
|
+
* // "description": "my_description",
|
|
3021
|
+
* // "displayName": "my_displayName",
|
|
3022
|
+
* // "encryptionConfig": {},
|
|
3023
|
+
* // "encryptionInfo": {},
|
|
3024
|
+
* // "etag": "my_etag",
|
|
3025
|
+
* // "expiryQuantity": {},
|
|
3026
|
+
* // "expiryTime": "my_expiryTime",
|
|
3027
|
+
* // "labels": {},
|
|
3028
|
+
* // "name": "my_name",
|
|
3029
|
+
* // "reconciling": false,
|
|
3030
|
+
* // "satisfiesPzi": false,
|
|
3031
|
+
* // "satisfiesPzs": false,
|
|
3032
|
+
* // "sizeBytes": "my_sizeBytes",
|
|
3033
|
+
* // "state": "my_state",
|
|
3034
|
+
* // "tags": {},
|
|
3035
|
+
* // "type": "my_type",
|
|
3036
|
+
* // "uid": "my_uid",
|
|
3037
|
+
* // "updateTime": "my_updateTime"
|
|
3038
|
+
* // }
|
|
3039
|
+
* },
|
|
3040
|
+
* });
|
|
3041
|
+
* console.log(res.data);
|
|
3042
|
+
*
|
|
3043
|
+
* // Example response
|
|
3044
|
+
* // {
|
|
3045
|
+
* // "done": false,
|
|
3046
|
+
* // "error": {},
|
|
3047
|
+
* // "metadata": {},
|
|
3048
|
+
* // "name": "my_name",
|
|
3049
|
+
* // "response": {}
|
|
3050
|
+
* // }
|
|
3051
|
+
* }
|
|
3052
|
+
*
|
|
3053
|
+
* main().catch(e => {
|
|
3054
|
+
* console.error(e);
|
|
3055
|
+
* throw e;
|
|
3056
|
+
* });
|
|
3057
|
+
*
|
|
3058
|
+
* ```
|
|
2570
3059
|
*
|
|
2571
3060
|
* @param params - Parameters for request
|
|
2572
3061
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2573
3062
|
* @param callback - Optional callback that handles the response.
|
|
2574
3063
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2575
3064
|
*/
|
|
2576
|
-
patch(params: Params$Resource$Projects$Locations$Backups$Patch, options: StreamMethodOptions):
|
|
2577
|
-
patch(params?: Params$Resource$Projects$Locations$Backups$Patch, options?: MethodOptions):
|
|
3065
|
+
patch(params: Params$Resource$Projects$Locations$Backups$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
3066
|
+
patch(params?: Params$Resource$Projects$Locations$Backups$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
2578
3067
|
patch(params: Params$Resource$Projects$Locations$Backups$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2579
3068
|
patch(params: Params$Resource$Projects$Locations$Backups$Patch, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2580
3069
|
patch(params: Params$Resource$Projects$Locations$Backups$Patch, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
@@ -2681,182 +3170,1108 @@ export declare namespace alloydb_v1alpha {
|
|
|
2681
3170
|
constructor(context: APIRequestContext);
|
|
2682
3171
|
/**
|
|
2683
3172
|
* Creates a new Cluster in a given project and location.
|
|
3173
|
+
* @example
|
|
3174
|
+
* ```js
|
|
3175
|
+
* // Before running the sample:
|
|
3176
|
+
* // - Enable the API at:
|
|
3177
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
3178
|
+
* // - Login into gcloud by running:
|
|
3179
|
+
* // ```sh
|
|
3180
|
+
* // $ gcloud auth application-default login
|
|
3181
|
+
* // ```
|
|
3182
|
+
* // - Install the npm module by running:
|
|
3183
|
+
* // ```sh
|
|
3184
|
+
* // $ npm install googleapis
|
|
3185
|
+
* // ```
|
|
3186
|
+
*
|
|
3187
|
+
* const {google} = require('googleapis');
|
|
3188
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
3189
|
+
*
|
|
3190
|
+
* async function main() {
|
|
3191
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3192
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3193
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
3194
|
+
* });
|
|
3195
|
+
*
|
|
3196
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3197
|
+
* const authClient = await auth.getClient();
|
|
3198
|
+
* google.options({auth: authClient});
|
|
3199
|
+
*
|
|
3200
|
+
* // Do the magic
|
|
3201
|
+
* const res = await alloydb.projects.locations.clusters.create({
|
|
3202
|
+
* // Required. ID of the requesting object.
|
|
3203
|
+
* clusterId: 'placeholder-value',
|
|
3204
|
+
* // Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field.
|
|
3205
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
3206
|
+
* // 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).
|
|
3207
|
+
* requestId: 'placeholder-value',
|
|
3208
|
+
* // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
|
|
3209
|
+
* validateOnly: 'placeholder-value',
|
|
3210
|
+
*
|
|
3211
|
+
* // Request body metadata
|
|
3212
|
+
* requestBody: {
|
|
3213
|
+
* // request body parameters
|
|
3214
|
+
* // {
|
|
3215
|
+
* // "annotations": {},
|
|
3216
|
+
* // "automatedBackupPolicy": {},
|
|
3217
|
+
* // "backupSource": {},
|
|
3218
|
+
* // "cloudsqlBackupRunSource": {},
|
|
3219
|
+
* // "clusterType": "my_clusterType",
|
|
3220
|
+
* // "continuousBackupConfig": {},
|
|
3221
|
+
* // "continuousBackupInfo": {},
|
|
3222
|
+
* // "createTime": "my_createTime",
|
|
3223
|
+
* // "databaseVersion": "my_databaseVersion",
|
|
3224
|
+
* // "deleteTime": "my_deleteTime",
|
|
3225
|
+
* // "displayName": "my_displayName",
|
|
3226
|
+
* // "encryptionConfig": {},
|
|
3227
|
+
* // "encryptionInfo": {},
|
|
3228
|
+
* // "etag": "my_etag",
|
|
3229
|
+
* // "geminiConfig": {},
|
|
3230
|
+
* // "initialUser": {},
|
|
3231
|
+
* // "labels": {},
|
|
3232
|
+
* // "maintenanceSchedule": {},
|
|
3233
|
+
* // "maintenanceUpdatePolicy": {},
|
|
3234
|
+
* // "migrationSource": {},
|
|
3235
|
+
* // "name": "my_name",
|
|
3236
|
+
* // "network": "my_network",
|
|
3237
|
+
* // "networkConfig": {},
|
|
3238
|
+
* // "primaryConfig": {},
|
|
3239
|
+
* // "pscConfig": {},
|
|
3240
|
+
* // "reconciling": false,
|
|
3241
|
+
* // "satisfiesPzi": false,
|
|
3242
|
+
* // "satisfiesPzs": false,
|
|
3243
|
+
* // "secondaryConfig": {},
|
|
3244
|
+
* // "serviceAccountEmail": "my_serviceAccountEmail",
|
|
3245
|
+
* // "sslConfig": {},
|
|
3246
|
+
* // "state": "my_state",
|
|
3247
|
+
* // "subscriptionType": "my_subscriptionType",
|
|
3248
|
+
* // "tags": {},
|
|
3249
|
+
* // "trialMetadata": {},
|
|
3250
|
+
* // "uid": "my_uid",
|
|
3251
|
+
* // "updateTime": "my_updateTime"
|
|
3252
|
+
* // }
|
|
3253
|
+
* },
|
|
3254
|
+
* });
|
|
3255
|
+
* console.log(res.data);
|
|
3256
|
+
*
|
|
3257
|
+
* // Example response
|
|
3258
|
+
* // {
|
|
3259
|
+
* // "done": false,
|
|
3260
|
+
* // "error": {},
|
|
3261
|
+
* // "metadata": {},
|
|
3262
|
+
* // "name": "my_name",
|
|
3263
|
+
* // "response": {}
|
|
3264
|
+
* // }
|
|
3265
|
+
* }
|
|
3266
|
+
*
|
|
3267
|
+
* main().catch(e => {
|
|
3268
|
+
* console.error(e);
|
|
3269
|
+
* throw e;
|
|
3270
|
+
* });
|
|
3271
|
+
*
|
|
3272
|
+
* ```
|
|
2684
3273
|
*
|
|
2685
3274
|
* @param params - Parameters for request
|
|
2686
3275
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2687
3276
|
* @param callback - Optional callback that handles the response.
|
|
2688
3277
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2689
3278
|
*/
|
|
2690
|
-
create(params: Params$Resource$Projects$Locations$Clusters$Create, options: StreamMethodOptions):
|
|
2691
|
-
create(params?: Params$Resource$Projects$Locations$Clusters$Create, options?: MethodOptions):
|
|
3279
|
+
create(params: Params$Resource$Projects$Locations$Clusters$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
3280
|
+
create(params?: Params$Resource$Projects$Locations$Clusters$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
2692
3281
|
create(params: Params$Resource$Projects$Locations$Clusters$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2693
3282
|
create(params: Params$Resource$Projects$Locations$Clusters$Create, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2694
3283
|
create(params: Params$Resource$Projects$Locations$Clusters$Create, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2695
3284
|
create(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2696
3285
|
/**
|
|
2697
3286
|
* Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.
|
|
3287
|
+
* @example
|
|
3288
|
+
* ```js
|
|
3289
|
+
* // Before running the sample:
|
|
3290
|
+
* // - Enable the API at:
|
|
3291
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
3292
|
+
* // - Login into gcloud by running:
|
|
3293
|
+
* // ```sh
|
|
3294
|
+
* // $ gcloud auth application-default login
|
|
3295
|
+
* // ```
|
|
3296
|
+
* // - Install the npm module by running:
|
|
3297
|
+
* // ```sh
|
|
3298
|
+
* // $ npm install googleapis
|
|
3299
|
+
* // ```
|
|
3300
|
+
*
|
|
3301
|
+
* const {google} = require('googleapis');
|
|
3302
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
3303
|
+
*
|
|
3304
|
+
* async function main() {
|
|
3305
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3306
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3307
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
3308
|
+
* });
|
|
3309
|
+
*
|
|
3310
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3311
|
+
* const authClient = await auth.getClient();
|
|
3312
|
+
* google.options({auth: authClient});
|
|
3313
|
+
*
|
|
3314
|
+
* // Do the magic
|
|
3315
|
+
* const res = await alloydb.projects.locations.clusters.createsecondary({
|
|
3316
|
+
* // Required. ID of the requesting object (the secondary cluster).
|
|
3317
|
+
* clusterId: 'placeholder-value',
|
|
3318
|
+
* // Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field.
|
|
3319
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
3320
|
+
* // 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).
|
|
3321
|
+
* requestId: 'placeholder-value',
|
|
3322
|
+
* // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
|
|
3323
|
+
* validateOnly: 'placeholder-value',
|
|
3324
|
+
*
|
|
3325
|
+
* // Request body metadata
|
|
3326
|
+
* requestBody: {
|
|
3327
|
+
* // request body parameters
|
|
3328
|
+
* // {
|
|
3329
|
+
* // "annotations": {},
|
|
3330
|
+
* // "automatedBackupPolicy": {},
|
|
3331
|
+
* // "backupSource": {},
|
|
3332
|
+
* // "cloudsqlBackupRunSource": {},
|
|
3333
|
+
* // "clusterType": "my_clusterType",
|
|
3334
|
+
* // "continuousBackupConfig": {},
|
|
3335
|
+
* // "continuousBackupInfo": {},
|
|
3336
|
+
* // "createTime": "my_createTime",
|
|
3337
|
+
* // "databaseVersion": "my_databaseVersion",
|
|
3338
|
+
* // "deleteTime": "my_deleteTime",
|
|
3339
|
+
* // "displayName": "my_displayName",
|
|
3340
|
+
* // "encryptionConfig": {},
|
|
3341
|
+
* // "encryptionInfo": {},
|
|
3342
|
+
* // "etag": "my_etag",
|
|
3343
|
+
* // "geminiConfig": {},
|
|
3344
|
+
* // "initialUser": {},
|
|
3345
|
+
* // "labels": {},
|
|
3346
|
+
* // "maintenanceSchedule": {},
|
|
3347
|
+
* // "maintenanceUpdatePolicy": {},
|
|
3348
|
+
* // "migrationSource": {},
|
|
3349
|
+
* // "name": "my_name",
|
|
3350
|
+
* // "network": "my_network",
|
|
3351
|
+
* // "networkConfig": {},
|
|
3352
|
+
* // "primaryConfig": {},
|
|
3353
|
+
* // "pscConfig": {},
|
|
3354
|
+
* // "reconciling": false,
|
|
3355
|
+
* // "satisfiesPzi": false,
|
|
3356
|
+
* // "satisfiesPzs": false,
|
|
3357
|
+
* // "secondaryConfig": {},
|
|
3358
|
+
* // "serviceAccountEmail": "my_serviceAccountEmail",
|
|
3359
|
+
* // "sslConfig": {},
|
|
3360
|
+
* // "state": "my_state",
|
|
3361
|
+
* // "subscriptionType": "my_subscriptionType",
|
|
3362
|
+
* // "tags": {},
|
|
3363
|
+
* // "trialMetadata": {},
|
|
3364
|
+
* // "uid": "my_uid",
|
|
3365
|
+
* // "updateTime": "my_updateTime"
|
|
3366
|
+
* // }
|
|
3367
|
+
* },
|
|
3368
|
+
* });
|
|
3369
|
+
* console.log(res.data);
|
|
3370
|
+
*
|
|
3371
|
+
* // Example response
|
|
3372
|
+
* // {
|
|
3373
|
+
* // "done": false,
|
|
3374
|
+
* // "error": {},
|
|
3375
|
+
* // "metadata": {},
|
|
3376
|
+
* // "name": "my_name",
|
|
3377
|
+
* // "response": {}
|
|
3378
|
+
* // }
|
|
3379
|
+
* }
|
|
3380
|
+
*
|
|
3381
|
+
* main().catch(e => {
|
|
3382
|
+
* console.error(e);
|
|
3383
|
+
* throw e;
|
|
3384
|
+
* });
|
|
3385
|
+
*
|
|
3386
|
+
* ```
|
|
2698
3387
|
*
|
|
2699
3388
|
* @param params - Parameters for request
|
|
2700
3389
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2701
3390
|
* @param callback - Optional callback that handles the response.
|
|
2702
3391
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2703
3392
|
*/
|
|
2704
|
-
createsecondary(params: Params$Resource$Projects$Locations$Clusters$Createsecondary, options: StreamMethodOptions):
|
|
2705
|
-
createsecondary(params?: Params$Resource$Projects$Locations$Clusters$Createsecondary, options?: MethodOptions):
|
|
3393
|
+
createsecondary(params: Params$Resource$Projects$Locations$Clusters$Createsecondary, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
3394
|
+
createsecondary(params?: Params$Resource$Projects$Locations$Clusters$Createsecondary, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
2706
3395
|
createsecondary(params: Params$Resource$Projects$Locations$Clusters$Createsecondary, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2707
3396
|
createsecondary(params: Params$Resource$Projects$Locations$Clusters$Createsecondary, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2708
3397
|
createsecondary(params: Params$Resource$Projects$Locations$Clusters$Createsecondary, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2709
3398
|
createsecondary(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2710
3399
|
/**
|
|
2711
3400
|
* Deletes a single Cluster.
|
|
3401
|
+
* @example
|
|
3402
|
+
* ```js
|
|
3403
|
+
* // Before running the sample:
|
|
3404
|
+
* // - Enable the API at:
|
|
3405
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
3406
|
+
* // - Login into gcloud by running:
|
|
3407
|
+
* // ```sh
|
|
3408
|
+
* // $ gcloud auth application-default login
|
|
3409
|
+
* // ```
|
|
3410
|
+
* // - Install the npm module by running:
|
|
3411
|
+
* // ```sh
|
|
3412
|
+
* // $ npm install googleapis
|
|
3413
|
+
* // ```
|
|
3414
|
+
*
|
|
3415
|
+
* const {google} = require('googleapis');
|
|
3416
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
3417
|
+
*
|
|
3418
|
+
* async function main() {
|
|
3419
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3420
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3421
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
3422
|
+
* });
|
|
3423
|
+
*
|
|
3424
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3425
|
+
* const authClient = await auth.getClient();
|
|
3426
|
+
* google.options({auth: authClient});
|
|
3427
|
+
*
|
|
3428
|
+
* // Do the magic
|
|
3429
|
+
* const res = await alloydb.projects.locations.clusters.delete({
|
|
3430
|
+
* // 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.
|
|
3431
|
+
* etag: 'placeholder-value',
|
|
3432
|
+
* // Optional. Whether to cascade delete child instances for given cluster.
|
|
3433
|
+
* force: 'placeholder-value',
|
|
3434
|
+
* // Required. The name of the resource. For the required format, see the comment on the Cluster.name field.
|
|
3435
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster',
|
|
3436
|
+
* // 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).
|
|
3437
|
+
* requestId: 'placeholder-value',
|
|
3438
|
+
* // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
|
|
3439
|
+
* validateOnly: 'placeholder-value',
|
|
3440
|
+
* });
|
|
3441
|
+
* console.log(res.data);
|
|
3442
|
+
*
|
|
3443
|
+
* // Example response
|
|
3444
|
+
* // {
|
|
3445
|
+
* // "done": false,
|
|
3446
|
+
* // "error": {},
|
|
3447
|
+
* // "metadata": {},
|
|
3448
|
+
* // "name": "my_name",
|
|
3449
|
+
* // "response": {}
|
|
3450
|
+
* // }
|
|
3451
|
+
* }
|
|
3452
|
+
*
|
|
3453
|
+
* main().catch(e => {
|
|
3454
|
+
* console.error(e);
|
|
3455
|
+
* throw e;
|
|
3456
|
+
* });
|
|
3457
|
+
*
|
|
3458
|
+
* ```
|
|
2712
3459
|
*
|
|
2713
3460
|
* @param params - Parameters for request
|
|
2714
3461
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2715
3462
|
* @param callback - Optional callback that handles the response.
|
|
2716
3463
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2717
3464
|
*/
|
|
2718
|
-
delete(params: Params$Resource$Projects$Locations$Clusters$Delete, options: StreamMethodOptions):
|
|
2719
|
-
delete(params?: Params$Resource$Projects$Locations$Clusters$Delete, options?: MethodOptions):
|
|
3465
|
+
delete(params: Params$Resource$Projects$Locations$Clusters$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
3466
|
+
delete(params?: Params$Resource$Projects$Locations$Clusters$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
2720
3467
|
delete(params: Params$Resource$Projects$Locations$Clusters$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2721
3468
|
delete(params: Params$Resource$Projects$Locations$Clusters$Delete, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2722
3469
|
delete(params: Params$Resource$Projects$Locations$Clusters$Delete, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2723
3470
|
delete(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2724
3471
|
/**
|
|
2725
3472
|
* Exports data from the cluster. Imperative only.
|
|
3473
|
+
* @example
|
|
3474
|
+
* ```js
|
|
3475
|
+
* // Before running the sample:
|
|
3476
|
+
* // - Enable the API at:
|
|
3477
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
3478
|
+
* // - Login into gcloud by running:
|
|
3479
|
+
* // ```sh
|
|
3480
|
+
* // $ gcloud auth application-default login
|
|
3481
|
+
* // ```
|
|
3482
|
+
* // - Install the npm module by running:
|
|
3483
|
+
* // ```sh
|
|
3484
|
+
* // $ npm install googleapis
|
|
3485
|
+
* // ```
|
|
3486
|
+
*
|
|
3487
|
+
* const {google} = require('googleapis');
|
|
3488
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
3489
|
+
*
|
|
3490
|
+
* async function main() {
|
|
3491
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3492
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3493
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
3494
|
+
* });
|
|
3495
|
+
*
|
|
3496
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3497
|
+
* const authClient = await auth.getClient();
|
|
3498
|
+
* google.options({auth: authClient});
|
|
3499
|
+
*
|
|
3500
|
+
* // Do the magic
|
|
3501
|
+
* const res = await alloydb.projects.locations.clusters.export({
|
|
3502
|
+
* // Required. The resource name of the cluster.
|
|
3503
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster',
|
|
3504
|
+
*
|
|
3505
|
+
* // Request body metadata
|
|
3506
|
+
* requestBody: {
|
|
3507
|
+
* // request body parameters
|
|
3508
|
+
* // {
|
|
3509
|
+
* // "csvExportOptions": {},
|
|
3510
|
+
* // "database": "my_database",
|
|
3511
|
+
* // "gcsDestination": {},
|
|
3512
|
+
* // "sqlExportOptions": {}
|
|
3513
|
+
* // }
|
|
3514
|
+
* },
|
|
3515
|
+
* });
|
|
3516
|
+
* console.log(res.data);
|
|
3517
|
+
*
|
|
3518
|
+
* // Example response
|
|
3519
|
+
* // {
|
|
3520
|
+
* // "done": false,
|
|
3521
|
+
* // "error": {},
|
|
3522
|
+
* // "metadata": {},
|
|
3523
|
+
* // "name": "my_name",
|
|
3524
|
+
* // "response": {}
|
|
3525
|
+
* // }
|
|
3526
|
+
* }
|
|
3527
|
+
*
|
|
3528
|
+
* main().catch(e => {
|
|
3529
|
+
* console.error(e);
|
|
3530
|
+
* throw e;
|
|
3531
|
+
* });
|
|
3532
|
+
*
|
|
3533
|
+
* ```
|
|
2726
3534
|
*
|
|
2727
3535
|
* @param params - Parameters for request
|
|
2728
3536
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2729
3537
|
* @param callback - Optional callback that handles the response.
|
|
2730
3538
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2731
3539
|
*/
|
|
2732
|
-
export(params: Params$Resource$Projects$Locations$Clusters$Export, options: StreamMethodOptions):
|
|
2733
|
-
export(params?: Params$Resource$Projects$Locations$Clusters$Export, options?: MethodOptions):
|
|
3540
|
+
export(params: Params$Resource$Projects$Locations$Clusters$Export, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
3541
|
+
export(params?: Params$Resource$Projects$Locations$Clusters$Export, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
2734
3542
|
export(params: Params$Resource$Projects$Locations$Clusters$Export, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2735
3543
|
export(params: Params$Resource$Projects$Locations$Clusters$Export, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2736
3544
|
export(params: Params$Resource$Projects$Locations$Clusters$Export, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2737
3545
|
export(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2738
3546
|
/**
|
|
2739
3547
|
* Gets details of a single Cluster.
|
|
3548
|
+
* @example
|
|
3549
|
+
* ```js
|
|
3550
|
+
* // Before running the sample:
|
|
3551
|
+
* // - Enable the API at:
|
|
3552
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
3553
|
+
* // - Login into gcloud by running:
|
|
3554
|
+
* // ```sh
|
|
3555
|
+
* // $ gcloud auth application-default login
|
|
3556
|
+
* // ```
|
|
3557
|
+
* // - Install the npm module by running:
|
|
3558
|
+
* // ```sh
|
|
3559
|
+
* // $ npm install googleapis
|
|
3560
|
+
* // ```
|
|
3561
|
+
*
|
|
3562
|
+
* const {google} = require('googleapis');
|
|
3563
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
3564
|
+
*
|
|
3565
|
+
* async function main() {
|
|
3566
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3567
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3568
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
3569
|
+
* });
|
|
3570
|
+
*
|
|
3571
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3572
|
+
* const authClient = await auth.getClient();
|
|
3573
|
+
* google.options({auth: authClient});
|
|
3574
|
+
*
|
|
3575
|
+
* // Do the magic
|
|
3576
|
+
* const res = await alloydb.projects.locations.clusters.get({
|
|
3577
|
+
* // Required. The name of the resource. For the required format, see the comment on the Cluster.name field.
|
|
3578
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster',
|
|
3579
|
+
* // Optional. The view of the cluster to return. Returns all default fields if not set.
|
|
3580
|
+
* view: 'placeholder-value',
|
|
3581
|
+
* });
|
|
3582
|
+
* console.log(res.data);
|
|
3583
|
+
*
|
|
3584
|
+
* // Example response
|
|
3585
|
+
* // {
|
|
3586
|
+
* // "annotations": {},
|
|
3587
|
+
* // "automatedBackupPolicy": {},
|
|
3588
|
+
* // "backupSource": {},
|
|
3589
|
+
* // "cloudsqlBackupRunSource": {},
|
|
3590
|
+
* // "clusterType": "my_clusterType",
|
|
3591
|
+
* // "continuousBackupConfig": {},
|
|
3592
|
+
* // "continuousBackupInfo": {},
|
|
3593
|
+
* // "createTime": "my_createTime",
|
|
3594
|
+
* // "databaseVersion": "my_databaseVersion",
|
|
3595
|
+
* // "deleteTime": "my_deleteTime",
|
|
3596
|
+
* // "displayName": "my_displayName",
|
|
3597
|
+
* // "encryptionConfig": {},
|
|
3598
|
+
* // "encryptionInfo": {},
|
|
3599
|
+
* // "etag": "my_etag",
|
|
3600
|
+
* // "geminiConfig": {},
|
|
3601
|
+
* // "initialUser": {},
|
|
3602
|
+
* // "labels": {},
|
|
3603
|
+
* // "maintenanceSchedule": {},
|
|
3604
|
+
* // "maintenanceUpdatePolicy": {},
|
|
3605
|
+
* // "migrationSource": {},
|
|
3606
|
+
* // "name": "my_name",
|
|
3607
|
+
* // "network": "my_network",
|
|
3608
|
+
* // "networkConfig": {},
|
|
3609
|
+
* // "primaryConfig": {},
|
|
3610
|
+
* // "pscConfig": {},
|
|
3611
|
+
* // "reconciling": false,
|
|
3612
|
+
* // "satisfiesPzi": false,
|
|
3613
|
+
* // "satisfiesPzs": false,
|
|
3614
|
+
* // "secondaryConfig": {},
|
|
3615
|
+
* // "serviceAccountEmail": "my_serviceAccountEmail",
|
|
3616
|
+
* // "sslConfig": {},
|
|
3617
|
+
* // "state": "my_state",
|
|
3618
|
+
* // "subscriptionType": "my_subscriptionType",
|
|
3619
|
+
* // "tags": {},
|
|
3620
|
+
* // "trialMetadata": {},
|
|
3621
|
+
* // "uid": "my_uid",
|
|
3622
|
+
* // "updateTime": "my_updateTime"
|
|
3623
|
+
* // }
|
|
3624
|
+
* }
|
|
3625
|
+
*
|
|
3626
|
+
* main().catch(e => {
|
|
3627
|
+
* console.error(e);
|
|
3628
|
+
* throw e;
|
|
3629
|
+
* });
|
|
3630
|
+
*
|
|
3631
|
+
* ```
|
|
2740
3632
|
*
|
|
2741
3633
|
* @param params - Parameters for request
|
|
2742
3634
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2743
3635
|
* @param callback - Optional callback that handles the response.
|
|
2744
3636
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2745
3637
|
*/
|
|
2746
|
-
get(params: Params$Resource$Projects$Locations$Clusters$Get, options: StreamMethodOptions):
|
|
2747
|
-
get(params?: Params$Resource$Projects$Locations$Clusters$Get, options?: MethodOptions):
|
|
3638
|
+
get(params: Params$Resource$Projects$Locations$Clusters$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
3639
|
+
get(params?: Params$Resource$Projects$Locations$Clusters$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Cluster>>;
|
|
2748
3640
|
get(params: Params$Resource$Projects$Locations$Clusters$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2749
3641
|
get(params: Params$Resource$Projects$Locations$Clusters$Get, options: MethodOptions | BodyResponseCallback<Schema$Cluster>, callback: BodyResponseCallback<Schema$Cluster>): void;
|
|
2750
3642
|
get(params: Params$Resource$Projects$Locations$Clusters$Get, callback: BodyResponseCallback<Schema$Cluster>): void;
|
|
2751
3643
|
get(callback: BodyResponseCallback<Schema$Cluster>): void;
|
|
2752
3644
|
/**
|
|
2753
3645
|
* Imports data to the cluster. Imperative only.
|
|
3646
|
+
* @example
|
|
3647
|
+
* ```js
|
|
3648
|
+
* // Before running the sample:
|
|
3649
|
+
* // - Enable the API at:
|
|
3650
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
3651
|
+
* // - Login into gcloud by running:
|
|
3652
|
+
* // ```sh
|
|
3653
|
+
* // $ gcloud auth application-default login
|
|
3654
|
+
* // ```
|
|
3655
|
+
* // - Install the npm module by running:
|
|
3656
|
+
* // ```sh
|
|
3657
|
+
* // $ npm install googleapis
|
|
3658
|
+
* // ```
|
|
3659
|
+
*
|
|
3660
|
+
* const {google} = require('googleapis');
|
|
3661
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
3662
|
+
*
|
|
3663
|
+
* async function main() {
|
|
3664
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3665
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3666
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
3667
|
+
* });
|
|
3668
|
+
*
|
|
3669
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3670
|
+
* const authClient = await auth.getClient();
|
|
3671
|
+
* google.options({auth: authClient});
|
|
3672
|
+
*
|
|
3673
|
+
* // Do the magic
|
|
3674
|
+
* const res = await alloydb.projects.locations.clusters.import({
|
|
3675
|
+
* // Required. The resource name of the cluster.
|
|
3676
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster',
|
|
3677
|
+
*
|
|
3678
|
+
* // Request body metadata
|
|
3679
|
+
* requestBody: {
|
|
3680
|
+
* // request body parameters
|
|
3681
|
+
* // {
|
|
3682
|
+
* // "csvImportOptions": {},
|
|
3683
|
+
* // "database": "my_database",
|
|
3684
|
+
* // "gcsUri": "my_gcsUri",
|
|
3685
|
+
* // "sqlImportOptions": {},
|
|
3686
|
+
* // "user": "my_user"
|
|
3687
|
+
* // }
|
|
3688
|
+
* },
|
|
3689
|
+
* });
|
|
3690
|
+
* console.log(res.data);
|
|
3691
|
+
*
|
|
3692
|
+
* // Example response
|
|
3693
|
+
* // {
|
|
3694
|
+
* // "done": false,
|
|
3695
|
+
* // "error": {},
|
|
3696
|
+
* // "metadata": {},
|
|
3697
|
+
* // "name": "my_name",
|
|
3698
|
+
* // "response": {}
|
|
3699
|
+
* // }
|
|
3700
|
+
* }
|
|
3701
|
+
*
|
|
3702
|
+
* main().catch(e => {
|
|
3703
|
+
* console.error(e);
|
|
3704
|
+
* throw e;
|
|
3705
|
+
* });
|
|
3706
|
+
*
|
|
3707
|
+
* ```
|
|
2754
3708
|
*
|
|
2755
3709
|
* @param params - Parameters for request
|
|
2756
3710
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2757
3711
|
* @param callback - Optional callback that handles the response.
|
|
2758
3712
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2759
3713
|
*/
|
|
2760
|
-
import(params: Params$Resource$Projects$Locations$Clusters$Import, options: StreamMethodOptions):
|
|
2761
|
-
import(params?: Params$Resource$Projects$Locations$Clusters$Import, options?: MethodOptions):
|
|
3714
|
+
import(params: Params$Resource$Projects$Locations$Clusters$Import, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
3715
|
+
import(params?: Params$Resource$Projects$Locations$Clusters$Import, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
2762
3716
|
import(params: Params$Resource$Projects$Locations$Clusters$Import, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2763
3717
|
import(params: Params$Resource$Projects$Locations$Clusters$Import, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2764
3718
|
import(params: Params$Resource$Projects$Locations$Clusters$Import, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2765
3719
|
import(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2766
3720
|
/**
|
|
2767
3721
|
* Lists Clusters in a given project and location.
|
|
3722
|
+
* @example
|
|
3723
|
+
* ```js
|
|
3724
|
+
* // Before running the sample:
|
|
3725
|
+
* // - Enable the API at:
|
|
3726
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
3727
|
+
* // - Login into gcloud by running:
|
|
3728
|
+
* // ```sh
|
|
3729
|
+
* // $ gcloud auth application-default login
|
|
3730
|
+
* // ```
|
|
3731
|
+
* // - Install the npm module by running:
|
|
3732
|
+
* // ```sh
|
|
3733
|
+
* // $ npm install googleapis
|
|
3734
|
+
* // ```
|
|
3735
|
+
*
|
|
3736
|
+
* const {google} = require('googleapis');
|
|
3737
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
3738
|
+
*
|
|
3739
|
+
* async function main() {
|
|
3740
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3741
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3742
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
3743
|
+
* });
|
|
3744
|
+
*
|
|
3745
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3746
|
+
* const authClient = await auth.getClient();
|
|
3747
|
+
* google.options({auth: authClient});
|
|
3748
|
+
*
|
|
3749
|
+
* // Do the magic
|
|
3750
|
+
* const res = await alloydb.projects.locations.clusters.list({
|
|
3751
|
+
* // Optional. Filtering results
|
|
3752
|
+
* filter: 'placeholder-value',
|
|
3753
|
+
* // Optional. Hint for how to order the results
|
|
3754
|
+
* orderBy: 'placeholder-value',
|
|
3755
|
+
* // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
|
|
3756
|
+
* pageSize: 'placeholder-value',
|
|
3757
|
+
* // A token identifying a page of results the server should return.
|
|
3758
|
+
* pageToken: 'placeholder-value',
|
|
3759
|
+
* // 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/-
|
|
3760
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
3761
|
+
* });
|
|
3762
|
+
* console.log(res.data);
|
|
3763
|
+
*
|
|
3764
|
+
* // Example response
|
|
3765
|
+
* // {
|
|
3766
|
+
* // "clusters": [],
|
|
3767
|
+
* // "nextPageToken": "my_nextPageToken",
|
|
3768
|
+
* // "unreachable": []
|
|
3769
|
+
* // }
|
|
3770
|
+
* }
|
|
3771
|
+
*
|
|
3772
|
+
* main().catch(e => {
|
|
3773
|
+
* console.error(e);
|
|
3774
|
+
* throw e;
|
|
3775
|
+
* });
|
|
3776
|
+
*
|
|
3777
|
+
* ```
|
|
2768
3778
|
*
|
|
2769
3779
|
* @param params - Parameters for request
|
|
2770
3780
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2771
3781
|
* @param callback - Optional callback that handles the response.
|
|
2772
3782
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2773
3783
|
*/
|
|
2774
|
-
list(params: Params$Resource$Projects$Locations$Clusters$List, options: StreamMethodOptions):
|
|
2775
|
-
list(params?: Params$Resource$Projects$Locations$Clusters$List, options?: MethodOptions):
|
|
3784
|
+
list(params: Params$Resource$Projects$Locations$Clusters$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
3785
|
+
list(params?: Params$Resource$Projects$Locations$Clusters$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ListClustersResponse>>;
|
|
2776
3786
|
list(params: Params$Resource$Projects$Locations$Clusters$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2777
3787
|
list(params: Params$Resource$Projects$Locations$Clusters$List, options: MethodOptions | BodyResponseCallback<Schema$ListClustersResponse>, callback: BodyResponseCallback<Schema$ListClustersResponse>): void;
|
|
2778
3788
|
list(params: Params$Resource$Projects$Locations$Clusters$List, callback: BodyResponseCallback<Schema$ListClustersResponse>): void;
|
|
2779
3789
|
list(callback: BodyResponseCallback<Schema$ListClustersResponse>): void;
|
|
2780
3790
|
/**
|
|
2781
3791
|
* Updates the parameters of a single Cluster.
|
|
3792
|
+
* @example
|
|
3793
|
+
* ```js
|
|
3794
|
+
* // Before running the sample:
|
|
3795
|
+
* // - Enable the API at:
|
|
3796
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
3797
|
+
* // - Login into gcloud by running:
|
|
3798
|
+
* // ```sh
|
|
3799
|
+
* // $ gcloud auth application-default login
|
|
3800
|
+
* // ```
|
|
3801
|
+
* // - Install the npm module by running:
|
|
3802
|
+
* // ```sh
|
|
3803
|
+
* // $ npm install googleapis
|
|
3804
|
+
* // ```
|
|
3805
|
+
*
|
|
3806
|
+
* const {google} = require('googleapis');
|
|
3807
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
3808
|
+
*
|
|
3809
|
+
* async function main() {
|
|
3810
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3811
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3812
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
3813
|
+
* });
|
|
3814
|
+
*
|
|
3815
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3816
|
+
* const authClient = await auth.getClient();
|
|
3817
|
+
* google.options({auth: authClient});
|
|
3818
|
+
*
|
|
3819
|
+
* // Do the magic
|
|
3820
|
+
* const res = await alloydb.projects.locations.clusters.patch({
|
|
3821
|
+
* // 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.
|
|
3822
|
+
* allowMissing: 'placeholder-value',
|
|
3823
|
+
* // 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\}
|
|
3824
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster',
|
|
3825
|
+
* // 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).
|
|
3826
|
+
* requestId: 'placeholder-value',
|
|
3827
|
+
* // 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.
|
|
3828
|
+
* updateMask: 'placeholder-value',
|
|
3829
|
+
* // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
|
|
3830
|
+
* validateOnly: 'placeholder-value',
|
|
3831
|
+
*
|
|
3832
|
+
* // Request body metadata
|
|
3833
|
+
* requestBody: {
|
|
3834
|
+
* // request body parameters
|
|
3835
|
+
* // {
|
|
3836
|
+
* // "annotations": {},
|
|
3837
|
+
* // "automatedBackupPolicy": {},
|
|
3838
|
+
* // "backupSource": {},
|
|
3839
|
+
* // "cloudsqlBackupRunSource": {},
|
|
3840
|
+
* // "clusterType": "my_clusterType",
|
|
3841
|
+
* // "continuousBackupConfig": {},
|
|
3842
|
+
* // "continuousBackupInfo": {},
|
|
3843
|
+
* // "createTime": "my_createTime",
|
|
3844
|
+
* // "databaseVersion": "my_databaseVersion",
|
|
3845
|
+
* // "deleteTime": "my_deleteTime",
|
|
3846
|
+
* // "displayName": "my_displayName",
|
|
3847
|
+
* // "encryptionConfig": {},
|
|
3848
|
+
* // "encryptionInfo": {},
|
|
3849
|
+
* // "etag": "my_etag",
|
|
3850
|
+
* // "geminiConfig": {},
|
|
3851
|
+
* // "initialUser": {},
|
|
3852
|
+
* // "labels": {},
|
|
3853
|
+
* // "maintenanceSchedule": {},
|
|
3854
|
+
* // "maintenanceUpdatePolicy": {},
|
|
3855
|
+
* // "migrationSource": {},
|
|
3856
|
+
* // "name": "my_name",
|
|
3857
|
+
* // "network": "my_network",
|
|
3858
|
+
* // "networkConfig": {},
|
|
3859
|
+
* // "primaryConfig": {},
|
|
3860
|
+
* // "pscConfig": {},
|
|
3861
|
+
* // "reconciling": false,
|
|
3862
|
+
* // "satisfiesPzi": false,
|
|
3863
|
+
* // "satisfiesPzs": false,
|
|
3864
|
+
* // "secondaryConfig": {},
|
|
3865
|
+
* // "serviceAccountEmail": "my_serviceAccountEmail",
|
|
3866
|
+
* // "sslConfig": {},
|
|
3867
|
+
* // "state": "my_state",
|
|
3868
|
+
* // "subscriptionType": "my_subscriptionType",
|
|
3869
|
+
* // "tags": {},
|
|
3870
|
+
* // "trialMetadata": {},
|
|
3871
|
+
* // "uid": "my_uid",
|
|
3872
|
+
* // "updateTime": "my_updateTime"
|
|
3873
|
+
* // }
|
|
3874
|
+
* },
|
|
3875
|
+
* });
|
|
3876
|
+
* console.log(res.data);
|
|
3877
|
+
*
|
|
3878
|
+
* // Example response
|
|
3879
|
+
* // {
|
|
3880
|
+
* // "done": false,
|
|
3881
|
+
* // "error": {},
|
|
3882
|
+
* // "metadata": {},
|
|
3883
|
+
* // "name": "my_name",
|
|
3884
|
+
* // "response": {}
|
|
3885
|
+
* // }
|
|
3886
|
+
* }
|
|
3887
|
+
*
|
|
3888
|
+
* main().catch(e => {
|
|
3889
|
+
* console.error(e);
|
|
3890
|
+
* throw e;
|
|
3891
|
+
* });
|
|
3892
|
+
*
|
|
3893
|
+
* ```
|
|
2782
3894
|
*
|
|
2783
3895
|
* @param params - Parameters for request
|
|
2784
3896
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2785
3897
|
* @param callback - Optional callback that handles the response.
|
|
2786
3898
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2787
3899
|
*/
|
|
2788
|
-
patch(params: Params$Resource$Projects$Locations$Clusters$Patch, options: StreamMethodOptions):
|
|
2789
|
-
patch(params?: Params$Resource$Projects$Locations$Clusters$Patch, options?: MethodOptions):
|
|
3900
|
+
patch(params: Params$Resource$Projects$Locations$Clusters$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
3901
|
+
patch(params?: Params$Resource$Projects$Locations$Clusters$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
2790
3902
|
patch(params: Params$Resource$Projects$Locations$Clusters$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2791
3903
|
patch(params: Params$Resource$Projects$Locations$Clusters$Patch, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2792
3904
|
patch(params: Params$Resource$Projects$Locations$Clusters$Patch, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2793
3905
|
patch(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2794
3906
|
/**
|
|
2795
3907
|
* Promotes a SECONDARY cluster. This turns down replication from the PRIMARY cluster and promotes a secondary cluster into its own standalone cluster. Imperative only.
|
|
3908
|
+
* @example
|
|
3909
|
+
* ```js
|
|
3910
|
+
* // Before running the sample:
|
|
3911
|
+
* // - Enable the API at:
|
|
3912
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
3913
|
+
* // - Login into gcloud by running:
|
|
3914
|
+
* // ```sh
|
|
3915
|
+
* // $ gcloud auth application-default login
|
|
3916
|
+
* // ```
|
|
3917
|
+
* // - Install the npm module by running:
|
|
3918
|
+
* // ```sh
|
|
3919
|
+
* // $ npm install googleapis
|
|
3920
|
+
* // ```
|
|
3921
|
+
*
|
|
3922
|
+
* const {google} = require('googleapis');
|
|
3923
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
3924
|
+
*
|
|
3925
|
+
* async function main() {
|
|
3926
|
+
* const auth = new google.auth.GoogleAuth({
|
|
3927
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
3928
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
3929
|
+
* });
|
|
3930
|
+
*
|
|
3931
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
3932
|
+
* const authClient = await auth.getClient();
|
|
3933
|
+
* google.options({auth: authClient});
|
|
3934
|
+
*
|
|
3935
|
+
* // Do the magic
|
|
3936
|
+
* const res = await alloydb.projects.locations.clusters.promote({
|
|
3937
|
+
* // Required. The name of the resource. For the required format, see the comment on the Cluster.name field
|
|
3938
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster',
|
|
3939
|
+
*
|
|
3940
|
+
* // Request body metadata
|
|
3941
|
+
* requestBody: {
|
|
3942
|
+
* // request body parameters
|
|
3943
|
+
* // {
|
|
3944
|
+
* // "etag": "my_etag",
|
|
3945
|
+
* // "requestId": "my_requestId",
|
|
3946
|
+
* // "validateOnly": false
|
|
3947
|
+
* // }
|
|
3948
|
+
* },
|
|
3949
|
+
* });
|
|
3950
|
+
* console.log(res.data);
|
|
3951
|
+
*
|
|
3952
|
+
* // Example response
|
|
3953
|
+
* // {
|
|
3954
|
+
* // "done": false,
|
|
3955
|
+
* // "error": {},
|
|
3956
|
+
* // "metadata": {},
|
|
3957
|
+
* // "name": "my_name",
|
|
3958
|
+
* // "response": {}
|
|
3959
|
+
* // }
|
|
3960
|
+
* }
|
|
3961
|
+
*
|
|
3962
|
+
* main().catch(e => {
|
|
3963
|
+
* console.error(e);
|
|
3964
|
+
* throw e;
|
|
3965
|
+
* });
|
|
3966
|
+
*
|
|
3967
|
+
* ```
|
|
2796
3968
|
*
|
|
2797
3969
|
* @param params - Parameters for request
|
|
2798
3970
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2799
3971
|
* @param callback - Optional callback that handles the response.
|
|
2800
3972
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2801
3973
|
*/
|
|
2802
|
-
promote(params: Params$Resource$Projects$Locations$Clusters$Promote, options: StreamMethodOptions):
|
|
2803
|
-
promote(params?: Params$Resource$Projects$Locations$Clusters$Promote, options?: MethodOptions):
|
|
3974
|
+
promote(params: Params$Resource$Projects$Locations$Clusters$Promote, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
3975
|
+
promote(params?: Params$Resource$Projects$Locations$Clusters$Promote, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
2804
3976
|
promote(params: Params$Resource$Projects$Locations$Clusters$Promote, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2805
3977
|
promote(params: Params$Resource$Projects$Locations$Clusters$Promote, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2806
3978
|
promote(params: Params$Resource$Projects$Locations$Clusters$Promote, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2807
3979
|
promote(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2808
3980
|
/**
|
|
2809
3981
|
* 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.
|
|
3982
|
+
* @example
|
|
3983
|
+
* ```js
|
|
3984
|
+
* // Before running the sample:
|
|
3985
|
+
* // - Enable the API at:
|
|
3986
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
3987
|
+
* // - Login into gcloud by running:
|
|
3988
|
+
* // ```sh
|
|
3989
|
+
* // $ gcloud auth application-default login
|
|
3990
|
+
* // ```
|
|
3991
|
+
* // - Install the npm module by running:
|
|
3992
|
+
* // ```sh
|
|
3993
|
+
* // $ npm install googleapis
|
|
3994
|
+
* // ```
|
|
3995
|
+
*
|
|
3996
|
+
* const {google} = require('googleapis');
|
|
3997
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
3998
|
+
*
|
|
3999
|
+
* async function main() {
|
|
4000
|
+
* const auth = new google.auth.GoogleAuth({
|
|
4001
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
4002
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
4003
|
+
* });
|
|
4004
|
+
*
|
|
4005
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
4006
|
+
* const authClient = await auth.getClient();
|
|
4007
|
+
* google.options({auth: authClient});
|
|
4008
|
+
*
|
|
4009
|
+
* // Do the magic
|
|
4010
|
+
* const res = await alloydb.projects.locations.clusters.restore({
|
|
4011
|
+
* // Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field.
|
|
4012
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
4013
|
+
*
|
|
4014
|
+
* // Request body metadata
|
|
4015
|
+
* requestBody: {
|
|
4016
|
+
* // request body parameters
|
|
4017
|
+
* // {
|
|
4018
|
+
* // "backupSource": {},
|
|
4019
|
+
* // "cluster": {},
|
|
4020
|
+
* // "clusterId": "my_clusterId",
|
|
4021
|
+
* // "continuousBackupSource": {},
|
|
4022
|
+
* // "requestId": "my_requestId",
|
|
4023
|
+
* // "validateOnly": false
|
|
4024
|
+
* // }
|
|
4025
|
+
* },
|
|
4026
|
+
* });
|
|
4027
|
+
* console.log(res.data);
|
|
4028
|
+
*
|
|
4029
|
+
* // Example response
|
|
4030
|
+
* // {
|
|
4031
|
+
* // "done": false,
|
|
4032
|
+
* // "error": {},
|
|
4033
|
+
* // "metadata": {},
|
|
4034
|
+
* // "name": "my_name",
|
|
4035
|
+
* // "response": {}
|
|
4036
|
+
* // }
|
|
4037
|
+
* }
|
|
4038
|
+
*
|
|
4039
|
+
* main().catch(e => {
|
|
4040
|
+
* console.error(e);
|
|
4041
|
+
* throw e;
|
|
4042
|
+
* });
|
|
4043
|
+
*
|
|
4044
|
+
* ```
|
|
2810
4045
|
*
|
|
2811
4046
|
* @param params - Parameters for request
|
|
2812
4047
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2813
4048
|
* @param callback - Optional callback that handles the response.
|
|
2814
4049
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2815
4050
|
*/
|
|
2816
|
-
restore(params: Params$Resource$Projects$Locations$Clusters$Restore, options: StreamMethodOptions):
|
|
2817
|
-
restore(params?: Params$Resource$Projects$Locations$Clusters$Restore, options?: MethodOptions):
|
|
4051
|
+
restore(params: Params$Resource$Projects$Locations$Clusters$Restore, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
4052
|
+
restore(params?: Params$Resource$Projects$Locations$Clusters$Restore, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
2818
4053
|
restore(params: Params$Resource$Projects$Locations$Clusters$Restore, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2819
4054
|
restore(params: Params$Resource$Projects$Locations$Clusters$Restore, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2820
4055
|
restore(params: Params$Resource$Projects$Locations$Clusters$Restore, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2821
4056
|
restore(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2822
4057
|
/**
|
|
2823
4058
|
* Restores an AlloyDB cluster from a CloudSQL resource.
|
|
4059
|
+
* @example
|
|
4060
|
+
* ```js
|
|
4061
|
+
* // Before running the sample:
|
|
4062
|
+
* // - Enable the API at:
|
|
4063
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
4064
|
+
* // - Login into gcloud by running:
|
|
4065
|
+
* // ```sh
|
|
4066
|
+
* // $ gcloud auth application-default login
|
|
4067
|
+
* // ```
|
|
4068
|
+
* // - Install the npm module by running:
|
|
4069
|
+
* // ```sh
|
|
4070
|
+
* // $ npm install googleapis
|
|
4071
|
+
* // ```
|
|
4072
|
+
*
|
|
4073
|
+
* const {google} = require('googleapis');
|
|
4074
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
4075
|
+
*
|
|
4076
|
+
* async function main() {
|
|
4077
|
+
* const auth = new google.auth.GoogleAuth({
|
|
4078
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
4079
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
4080
|
+
* });
|
|
4081
|
+
*
|
|
4082
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
4083
|
+
* const authClient = await auth.getClient();
|
|
4084
|
+
* google.options({auth: authClient});
|
|
4085
|
+
*
|
|
4086
|
+
* // Do the magic
|
|
4087
|
+
* const res = await alloydb.projects.locations.clusters.restoreFromCloudSQL({
|
|
4088
|
+
* // Required. The location of the new cluster. For the required format, see the comment on Cluster.name field.
|
|
4089
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
4090
|
+
*
|
|
4091
|
+
* // Request body metadata
|
|
4092
|
+
* requestBody: {
|
|
4093
|
+
* // request body parameters
|
|
4094
|
+
* // {
|
|
4095
|
+
* // "cloudsqlBackupRunSource": {},
|
|
4096
|
+
* // "cluster": {},
|
|
4097
|
+
* // "clusterId": "my_clusterId"
|
|
4098
|
+
* // }
|
|
4099
|
+
* },
|
|
4100
|
+
* });
|
|
4101
|
+
* console.log(res.data);
|
|
4102
|
+
*
|
|
4103
|
+
* // Example response
|
|
4104
|
+
* // {
|
|
4105
|
+
* // "done": false,
|
|
4106
|
+
* // "error": {},
|
|
4107
|
+
* // "metadata": {},
|
|
4108
|
+
* // "name": "my_name",
|
|
4109
|
+
* // "response": {}
|
|
4110
|
+
* // }
|
|
4111
|
+
* }
|
|
4112
|
+
*
|
|
4113
|
+
* main().catch(e => {
|
|
4114
|
+
* console.error(e);
|
|
4115
|
+
* throw e;
|
|
4116
|
+
* });
|
|
4117
|
+
*
|
|
4118
|
+
* ```
|
|
2824
4119
|
*
|
|
2825
4120
|
* @param params - Parameters for request
|
|
2826
4121
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2827
4122
|
* @param callback - Optional callback that handles the response.
|
|
2828
4123
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2829
4124
|
*/
|
|
2830
|
-
restoreFromCloudSQL(params: Params$Resource$Projects$Locations$Clusters$Restorefromcloudsql, options: StreamMethodOptions):
|
|
2831
|
-
restoreFromCloudSQL(params?: Params$Resource$Projects$Locations$Clusters$Restorefromcloudsql, options?: MethodOptions):
|
|
4125
|
+
restoreFromCloudSQL(params: Params$Resource$Projects$Locations$Clusters$Restorefromcloudsql, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
4126
|
+
restoreFromCloudSQL(params?: Params$Resource$Projects$Locations$Clusters$Restorefromcloudsql, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
2832
4127
|
restoreFromCloudSQL(params: Params$Resource$Projects$Locations$Clusters$Restorefromcloudsql, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2833
4128
|
restoreFromCloudSQL(params: Params$Resource$Projects$Locations$Clusters$Restorefromcloudsql, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2834
4129
|
restoreFromCloudSQL(params: Params$Resource$Projects$Locations$Clusters$Restorefromcloudsql, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2835
4130
|
restoreFromCloudSQL(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2836
4131
|
/**
|
|
2837
4132
|
* 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.
|
|
4133
|
+
* @example
|
|
4134
|
+
* ```js
|
|
4135
|
+
* // Before running the sample:
|
|
4136
|
+
* // - Enable the API at:
|
|
4137
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
4138
|
+
* // - Login into gcloud by running:
|
|
4139
|
+
* // ```sh
|
|
4140
|
+
* // $ gcloud auth application-default login
|
|
4141
|
+
* // ```
|
|
4142
|
+
* // - Install the npm module by running:
|
|
4143
|
+
* // ```sh
|
|
4144
|
+
* // $ npm install googleapis
|
|
4145
|
+
* // ```
|
|
4146
|
+
*
|
|
4147
|
+
* const {google} = require('googleapis');
|
|
4148
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
4149
|
+
*
|
|
4150
|
+
* async function main() {
|
|
4151
|
+
* const auth = new google.auth.GoogleAuth({
|
|
4152
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
4153
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
4154
|
+
* });
|
|
4155
|
+
*
|
|
4156
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
4157
|
+
* const authClient = await auth.getClient();
|
|
4158
|
+
* google.options({auth: authClient});
|
|
4159
|
+
*
|
|
4160
|
+
* // Do the magic
|
|
4161
|
+
* const res = await alloydb.projects.locations.clusters.switchover({
|
|
4162
|
+
* // Required. The name of the resource. For the required format, see the comment on the Cluster.name field
|
|
4163
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster',
|
|
4164
|
+
*
|
|
4165
|
+
* // Request body metadata
|
|
4166
|
+
* requestBody: {
|
|
4167
|
+
* // request body parameters
|
|
4168
|
+
* // {
|
|
4169
|
+
* // "requestId": "my_requestId",
|
|
4170
|
+
* // "validateOnly": false
|
|
4171
|
+
* // }
|
|
4172
|
+
* },
|
|
4173
|
+
* });
|
|
4174
|
+
* console.log(res.data);
|
|
4175
|
+
*
|
|
4176
|
+
* // Example response
|
|
4177
|
+
* // {
|
|
4178
|
+
* // "done": false,
|
|
4179
|
+
* // "error": {},
|
|
4180
|
+
* // "metadata": {},
|
|
4181
|
+
* // "name": "my_name",
|
|
4182
|
+
* // "response": {}
|
|
4183
|
+
* // }
|
|
4184
|
+
* }
|
|
4185
|
+
*
|
|
4186
|
+
* main().catch(e => {
|
|
4187
|
+
* console.error(e);
|
|
4188
|
+
* throw e;
|
|
4189
|
+
* });
|
|
4190
|
+
*
|
|
4191
|
+
* ```
|
|
2838
4192
|
*
|
|
2839
4193
|
* @param params - Parameters for request
|
|
2840
4194
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2841
4195
|
* @param callback - Optional callback that handles the response.
|
|
2842
4196
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2843
4197
|
*/
|
|
2844
|
-
switchover(params: Params$Resource$Projects$Locations$Clusters$Switchover, options: StreamMethodOptions):
|
|
2845
|
-
switchover(params?: Params$Resource$Projects$Locations$Clusters$Switchover, options?: MethodOptions):
|
|
4198
|
+
switchover(params: Params$Resource$Projects$Locations$Clusters$Switchover, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
4199
|
+
switchover(params?: Params$Resource$Projects$Locations$Clusters$Switchover, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
2846
4200
|
switchover(params: Params$Resource$Projects$Locations$Clusters$Switchover, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2847
4201
|
switchover(params: Params$Resource$Projects$Locations$Clusters$Switchover, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2848
4202
|
switchover(params: Params$Resource$Projects$Locations$Clusters$Switchover, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2849
4203
|
switchover(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2850
4204
|
/**
|
|
2851
4205
|
* Upgrades a single Cluster. Imperative only.
|
|
4206
|
+
* @example
|
|
4207
|
+
* ```js
|
|
4208
|
+
* // Before running the sample:
|
|
4209
|
+
* // - Enable the API at:
|
|
4210
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
4211
|
+
* // - Login into gcloud by running:
|
|
4212
|
+
* // ```sh
|
|
4213
|
+
* // $ gcloud auth application-default login
|
|
4214
|
+
* // ```
|
|
4215
|
+
* // - Install the npm module by running:
|
|
4216
|
+
* // ```sh
|
|
4217
|
+
* // $ npm install googleapis
|
|
4218
|
+
* // ```
|
|
4219
|
+
*
|
|
4220
|
+
* const {google} = require('googleapis');
|
|
4221
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
4222
|
+
*
|
|
4223
|
+
* async function main() {
|
|
4224
|
+
* const auth = new google.auth.GoogleAuth({
|
|
4225
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
4226
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
4227
|
+
* });
|
|
4228
|
+
*
|
|
4229
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
4230
|
+
* const authClient = await auth.getClient();
|
|
4231
|
+
* google.options({auth: authClient});
|
|
4232
|
+
*
|
|
4233
|
+
* // Do the magic
|
|
4234
|
+
* const res = await alloydb.projects.locations.clusters.upgrade({
|
|
4235
|
+
* // Required. The resource name of the cluster.
|
|
4236
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster',
|
|
4237
|
+
*
|
|
4238
|
+
* // Request body metadata
|
|
4239
|
+
* requestBody: {
|
|
4240
|
+
* // request body parameters
|
|
4241
|
+
* // {
|
|
4242
|
+
* // "etag": "my_etag",
|
|
4243
|
+
* // "requestId": "my_requestId",
|
|
4244
|
+
* // "validateOnly": false,
|
|
4245
|
+
* // "version": "my_version"
|
|
4246
|
+
* // }
|
|
4247
|
+
* },
|
|
4248
|
+
* });
|
|
4249
|
+
* console.log(res.data);
|
|
4250
|
+
*
|
|
4251
|
+
* // Example response
|
|
4252
|
+
* // {
|
|
4253
|
+
* // "done": false,
|
|
4254
|
+
* // "error": {},
|
|
4255
|
+
* // "metadata": {},
|
|
4256
|
+
* // "name": "my_name",
|
|
4257
|
+
* // "response": {}
|
|
4258
|
+
* // }
|
|
4259
|
+
* }
|
|
4260
|
+
*
|
|
4261
|
+
* main().catch(e => {
|
|
4262
|
+
* console.error(e);
|
|
4263
|
+
* throw e;
|
|
4264
|
+
* });
|
|
4265
|
+
*
|
|
4266
|
+
* ```
|
|
2852
4267
|
*
|
|
2853
4268
|
* @param params - Parameters for request
|
|
2854
4269
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
2855
4270
|
* @param callback - Optional callback that handles the response.
|
|
2856
4271
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
2857
4272
|
*/
|
|
2858
|
-
upgrade(params: Params$Resource$Projects$Locations$Clusters$Upgrade, options: StreamMethodOptions):
|
|
2859
|
-
upgrade(params?: Params$Resource$Projects$Locations$Clusters$Upgrade, options?: MethodOptions):
|
|
4273
|
+
upgrade(params: Params$Resource$Projects$Locations$Clusters$Upgrade, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
4274
|
+
upgrade(params?: Params$Resource$Projects$Locations$Clusters$Upgrade, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
2860
4275
|
upgrade(params: Params$Resource$Projects$Locations$Clusters$Upgrade, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
2861
4276
|
upgrade(params: Params$Resource$Projects$Locations$Clusters$Upgrade, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
2862
4277
|
upgrade(params: Params$Resource$Projects$Locations$Clusters$Upgrade, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
@@ -3061,140 +4476,861 @@ export declare namespace alloydb_v1alpha {
|
|
|
3061
4476
|
constructor(context: APIRequestContext);
|
|
3062
4477
|
/**
|
|
3063
4478
|
* Creates a new Instance in a given project and location.
|
|
4479
|
+
* @example
|
|
4480
|
+
* ```js
|
|
4481
|
+
* // Before running the sample:
|
|
4482
|
+
* // - Enable the API at:
|
|
4483
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
4484
|
+
* // - Login into gcloud by running:
|
|
4485
|
+
* // ```sh
|
|
4486
|
+
* // $ gcloud auth application-default login
|
|
4487
|
+
* // ```
|
|
4488
|
+
* // - Install the npm module by running:
|
|
4489
|
+
* // ```sh
|
|
4490
|
+
* // $ npm install googleapis
|
|
4491
|
+
* // ```
|
|
4492
|
+
*
|
|
4493
|
+
* const {google} = require('googleapis');
|
|
4494
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
4495
|
+
*
|
|
4496
|
+
* async function main() {
|
|
4497
|
+
* const auth = new google.auth.GoogleAuth({
|
|
4498
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
4499
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
4500
|
+
* });
|
|
4501
|
+
*
|
|
4502
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
4503
|
+
* const authClient = await auth.getClient();
|
|
4504
|
+
* google.options({auth: authClient});
|
|
4505
|
+
*
|
|
4506
|
+
* // Do the magic
|
|
4507
|
+
* const res = await alloydb.projects.locations.clusters.instances.create({
|
|
4508
|
+
* // Required. ID of the requesting object.
|
|
4509
|
+
* instanceId: 'placeholder-value',
|
|
4510
|
+
* // Required. The name of the parent resource. For the required format, see the comment on the Instance.name field.
|
|
4511
|
+
* parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
|
|
4512
|
+
* // 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).
|
|
4513
|
+
* requestId: 'placeholder-value',
|
|
4514
|
+
* // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
|
|
4515
|
+
* validateOnly: 'placeholder-value',
|
|
4516
|
+
*
|
|
4517
|
+
* // Request body metadata
|
|
4518
|
+
* requestBody: {
|
|
4519
|
+
* // request body parameters
|
|
4520
|
+
* // {
|
|
4521
|
+
* // "activationPolicy": "my_activationPolicy",
|
|
4522
|
+
* // "annotations": {},
|
|
4523
|
+
* // "availabilityType": "my_availabilityType",
|
|
4524
|
+
* // "clientConnectionConfig": {},
|
|
4525
|
+
* // "connectionPoolConfig": {},
|
|
4526
|
+
* // "createTime": "my_createTime",
|
|
4527
|
+
* // "databaseFlags": {},
|
|
4528
|
+
* // "deleteTime": "my_deleteTime",
|
|
4529
|
+
* // "displayName": "my_displayName",
|
|
4530
|
+
* // "etag": "my_etag",
|
|
4531
|
+
* // "gcaConfig": {},
|
|
4532
|
+
* // "gceZone": "my_gceZone",
|
|
4533
|
+
* // "geminiConfig": {},
|
|
4534
|
+
* // "instanceType": "my_instanceType",
|
|
4535
|
+
* // "ipAddress": "my_ipAddress",
|
|
4536
|
+
* // "labels": {},
|
|
4537
|
+
* // "machineConfig": {},
|
|
4538
|
+
* // "name": "my_name",
|
|
4539
|
+
* // "networkConfig": {},
|
|
4540
|
+
* // "nodes": [],
|
|
4541
|
+
* // "observabilityConfig": {},
|
|
4542
|
+
* // "outboundPublicIpAddresses": [],
|
|
4543
|
+
* // "pscInstanceConfig": {},
|
|
4544
|
+
* // "publicIpAddress": "my_publicIpAddress",
|
|
4545
|
+
* // "queryInsightsConfig": {},
|
|
4546
|
+
* // "readPoolConfig": {},
|
|
4547
|
+
* // "reconciling": false,
|
|
4548
|
+
* // "satisfiesPzi": false,
|
|
4549
|
+
* // "satisfiesPzs": false,
|
|
4550
|
+
* // "state": "my_state",
|
|
4551
|
+
* // "uid": "my_uid",
|
|
4552
|
+
* // "updatePolicy": {},
|
|
4553
|
+
* // "updateTime": "my_updateTime",
|
|
4554
|
+
* // "writableNode": {}
|
|
4555
|
+
* // }
|
|
4556
|
+
* },
|
|
4557
|
+
* });
|
|
4558
|
+
* console.log(res.data);
|
|
4559
|
+
*
|
|
4560
|
+
* // Example response
|
|
4561
|
+
* // {
|
|
4562
|
+
* // "done": false,
|
|
4563
|
+
* // "error": {},
|
|
4564
|
+
* // "metadata": {},
|
|
4565
|
+
* // "name": "my_name",
|
|
4566
|
+
* // "response": {}
|
|
4567
|
+
* // }
|
|
4568
|
+
* }
|
|
4569
|
+
*
|
|
4570
|
+
* main().catch(e => {
|
|
4571
|
+
* console.error(e);
|
|
4572
|
+
* throw e;
|
|
4573
|
+
* });
|
|
4574
|
+
*
|
|
4575
|
+
* ```
|
|
3064
4576
|
*
|
|
3065
4577
|
* @param params - Parameters for request
|
|
3066
4578
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3067
4579
|
* @param callback - Optional callback that handles the response.
|
|
3068
4580
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3069
4581
|
*/
|
|
3070
|
-
create(params: Params$Resource$Projects$Locations$Clusters$Instances$Create, options: StreamMethodOptions):
|
|
3071
|
-
create(params?: Params$Resource$Projects$Locations$Clusters$Instances$Create, options?: MethodOptions):
|
|
4582
|
+
create(params: Params$Resource$Projects$Locations$Clusters$Instances$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
4583
|
+
create(params?: Params$Resource$Projects$Locations$Clusters$Instances$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
3072
4584
|
create(params: Params$Resource$Projects$Locations$Clusters$Instances$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3073
4585
|
create(params: Params$Resource$Projects$Locations$Clusters$Instances$Create, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
3074
4586
|
create(params: Params$Resource$Projects$Locations$Clusters$Instances$Create, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
3075
4587
|
create(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
3076
4588
|
/**
|
|
3077
4589
|
* Creates a new SECONDARY Instance in a given project and location.
|
|
4590
|
+
* @example
|
|
4591
|
+
* ```js
|
|
4592
|
+
* // Before running the sample:
|
|
4593
|
+
* // - Enable the API at:
|
|
4594
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
4595
|
+
* // - Login into gcloud by running:
|
|
4596
|
+
* // ```sh
|
|
4597
|
+
* // $ gcloud auth application-default login
|
|
4598
|
+
* // ```
|
|
4599
|
+
* // - Install the npm module by running:
|
|
4600
|
+
* // ```sh
|
|
4601
|
+
* // $ npm install googleapis
|
|
4602
|
+
* // ```
|
|
4603
|
+
*
|
|
4604
|
+
* const {google} = require('googleapis');
|
|
4605
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
4606
|
+
*
|
|
4607
|
+
* async function main() {
|
|
4608
|
+
* const auth = new google.auth.GoogleAuth({
|
|
4609
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
4610
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
4611
|
+
* });
|
|
4612
|
+
*
|
|
4613
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
4614
|
+
* const authClient = await auth.getClient();
|
|
4615
|
+
* google.options({auth: authClient});
|
|
4616
|
+
*
|
|
4617
|
+
* // Do the magic
|
|
4618
|
+
* const res =
|
|
4619
|
+
* await alloydb.projects.locations.clusters.instances.createsecondary({
|
|
4620
|
+
* // Required. ID of the requesting object.
|
|
4621
|
+
* instanceId: 'placeholder-value',
|
|
4622
|
+
* // Required. The name of the parent resource. For the required format, see the comment on the Instance.name field.
|
|
4623
|
+
* parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
|
|
4624
|
+
* // 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).
|
|
4625
|
+
* requestId: 'placeholder-value',
|
|
4626
|
+
* // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
|
|
4627
|
+
* validateOnly: 'placeholder-value',
|
|
4628
|
+
*
|
|
4629
|
+
* // Request body metadata
|
|
4630
|
+
* requestBody: {
|
|
4631
|
+
* // request body parameters
|
|
4632
|
+
* // {
|
|
4633
|
+
* // "activationPolicy": "my_activationPolicy",
|
|
4634
|
+
* // "annotations": {},
|
|
4635
|
+
* // "availabilityType": "my_availabilityType",
|
|
4636
|
+
* // "clientConnectionConfig": {},
|
|
4637
|
+
* // "connectionPoolConfig": {},
|
|
4638
|
+
* // "createTime": "my_createTime",
|
|
4639
|
+
* // "databaseFlags": {},
|
|
4640
|
+
* // "deleteTime": "my_deleteTime",
|
|
4641
|
+
* // "displayName": "my_displayName",
|
|
4642
|
+
* // "etag": "my_etag",
|
|
4643
|
+
* // "gcaConfig": {},
|
|
4644
|
+
* // "gceZone": "my_gceZone",
|
|
4645
|
+
* // "geminiConfig": {},
|
|
4646
|
+
* // "instanceType": "my_instanceType",
|
|
4647
|
+
* // "ipAddress": "my_ipAddress",
|
|
4648
|
+
* // "labels": {},
|
|
4649
|
+
* // "machineConfig": {},
|
|
4650
|
+
* // "name": "my_name",
|
|
4651
|
+
* // "networkConfig": {},
|
|
4652
|
+
* // "nodes": [],
|
|
4653
|
+
* // "observabilityConfig": {},
|
|
4654
|
+
* // "outboundPublicIpAddresses": [],
|
|
4655
|
+
* // "pscInstanceConfig": {},
|
|
4656
|
+
* // "publicIpAddress": "my_publicIpAddress",
|
|
4657
|
+
* // "queryInsightsConfig": {},
|
|
4658
|
+
* // "readPoolConfig": {},
|
|
4659
|
+
* // "reconciling": false,
|
|
4660
|
+
* // "satisfiesPzi": false,
|
|
4661
|
+
* // "satisfiesPzs": false,
|
|
4662
|
+
* // "state": "my_state",
|
|
4663
|
+
* // "uid": "my_uid",
|
|
4664
|
+
* // "updatePolicy": {},
|
|
4665
|
+
* // "updateTime": "my_updateTime",
|
|
4666
|
+
* // "writableNode": {}
|
|
4667
|
+
* // }
|
|
4668
|
+
* },
|
|
4669
|
+
* });
|
|
4670
|
+
* console.log(res.data);
|
|
4671
|
+
*
|
|
4672
|
+
* // Example response
|
|
4673
|
+
* // {
|
|
4674
|
+
* // "done": false,
|
|
4675
|
+
* // "error": {},
|
|
4676
|
+
* // "metadata": {},
|
|
4677
|
+
* // "name": "my_name",
|
|
4678
|
+
* // "response": {}
|
|
4679
|
+
* // }
|
|
4680
|
+
* }
|
|
4681
|
+
*
|
|
4682
|
+
* main().catch(e => {
|
|
4683
|
+
* console.error(e);
|
|
4684
|
+
* throw e;
|
|
4685
|
+
* });
|
|
4686
|
+
*
|
|
4687
|
+
* ```
|
|
3078
4688
|
*
|
|
3079
4689
|
* @param params - Parameters for request
|
|
3080
4690
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3081
4691
|
* @param callback - Optional callback that handles the response.
|
|
3082
4692
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3083
4693
|
*/
|
|
3084
|
-
createsecondary(params: Params$Resource$Projects$Locations$Clusters$Instances$Createsecondary, options: StreamMethodOptions):
|
|
3085
|
-
createsecondary(params?: Params$Resource$Projects$Locations$Clusters$Instances$Createsecondary, options?: MethodOptions):
|
|
4694
|
+
createsecondary(params: Params$Resource$Projects$Locations$Clusters$Instances$Createsecondary, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
4695
|
+
createsecondary(params?: Params$Resource$Projects$Locations$Clusters$Instances$Createsecondary, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
3086
4696
|
createsecondary(params: Params$Resource$Projects$Locations$Clusters$Instances$Createsecondary, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3087
4697
|
createsecondary(params: Params$Resource$Projects$Locations$Clusters$Instances$Createsecondary, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
3088
4698
|
createsecondary(params: Params$Resource$Projects$Locations$Clusters$Instances$Createsecondary, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
3089
4699
|
createsecondary(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
3090
4700
|
/**
|
|
3091
4701
|
* Deletes a single Instance.
|
|
4702
|
+
* @example
|
|
4703
|
+
* ```js
|
|
4704
|
+
* // Before running the sample:
|
|
4705
|
+
* // - Enable the API at:
|
|
4706
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
4707
|
+
* // - Login into gcloud by running:
|
|
4708
|
+
* // ```sh
|
|
4709
|
+
* // $ gcloud auth application-default login
|
|
4710
|
+
* // ```
|
|
4711
|
+
* // - Install the npm module by running:
|
|
4712
|
+
* // ```sh
|
|
4713
|
+
* // $ npm install googleapis
|
|
4714
|
+
* // ```
|
|
4715
|
+
*
|
|
4716
|
+
* const {google} = require('googleapis');
|
|
4717
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
4718
|
+
*
|
|
4719
|
+
* async function main() {
|
|
4720
|
+
* const auth = new google.auth.GoogleAuth({
|
|
4721
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
4722
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
4723
|
+
* });
|
|
4724
|
+
*
|
|
4725
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
4726
|
+
* const authClient = await auth.getClient();
|
|
4727
|
+
* google.options({auth: authClient});
|
|
4728
|
+
*
|
|
4729
|
+
* // Do the magic
|
|
4730
|
+
* const res = await alloydb.projects.locations.clusters.instances.delete({
|
|
4731
|
+
* // 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.
|
|
4732
|
+
* etag: 'placeholder-value',
|
|
4733
|
+
* // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
|
|
4734
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
|
|
4735
|
+
* // 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).
|
|
4736
|
+
* requestId: 'placeholder-value',
|
|
4737
|
+
* // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
|
|
4738
|
+
* validateOnly: 'placeholder-value',
|
|
4739
|
+
* });
|
|
4740
|
+
* console.log(res.data);
|
|
4741
|
+
*
|
|
4742
|
+
* // Example response
|
|
4743
|
+
* // {
|
|
4744
|
+
* // "done": false,
|
|
4745
|
+
* // "error": {},
|
|
4746
|
+
* // "metadata": {},
|
|
4747
|
+
* // "name": "my_name",
|
|
4748
|
+
* // "response": {}
|
|
4749
|
+
* // }
|
|
4750
|
+
* }
|
|
4751
|
+
*
|
|
4752
|
+
* main().catch(e => {
|
|
4753
|
+
* console.error(e);
|
|
4754
|
+
* throw e;
|
|
4755
|
+
* });
|
|
4756
|
+
*
|
|
4757
|
+
* ```
|
|
3092
4758
|
*
|
|
3093
4759
|
* @param params - Parameters for request
|
|
3094
4760
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3095
4761
|
* @param callback - Optional callback that handles the response.
|
|
3096
4762
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3097
4763
|
*/
|
|
3098
|
-
delete(params: Params$Resource$Projects$Locations$Clusters$Instances$Delete, options: StreamMethodOptions):
|
|
3099
|
-
delete(params?: Params$Resource$Projects$Locations$Clusters$Instances$Delete, options?: MethodOptions):
|
|
4764
|
+
delete(params: Params$Resource$Projects$Locations$Clusters$Instances$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
4765
|
+
delete(params?: Params$Resource$Projects$Locations$Clusters$Instances$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
3100
4766
|
delete(params: Params$Resource$Projects$Locations$Clusters$Instances$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3101
4767
|
delete(params: Params$Resource$Projects$Locations$Clusters$Instances$Delete, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
3102
4768
|
delete(params: Params$Resource$Projects$Locations$Clusters$Instances$Delete, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
3103
4769
|
delete(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
3104
4770
|
/**
|
|
3105
4771
|
* Forces a Failover for a highly available instance. Failover promotes the HA standby instance as the new primary. Imperative only.
|
|
4772
|
+
* @example
|
|
4773
|
+
* ```js
|
|
4774
|
+
* // Before running the sample:
|
|
4775
|
+
* // - Enable the API at:
|
|
4776
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
4777
|
+
* // - Login into gcloud by running:
|
|
4778
|
+
* // ```sh
|
|
4779
|
+
* // $ gcloud auth application-default login
|
|
4780
|
+
* // ```
|
|
4781
|
+
* // - Install the npm module by running:
|
|
4782
|
+
* // ```sh
|
|
4783
|
+
* // $ npm install googleapis
|
|
4784
|
+
* // ```
|
|
4785
|
+
*
|
|
4786
|
+
* const {google} = require('googleapis');
|
|
4787
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
4788
|
+
*
|
|
4789
|
+
* async function main() {
|
|
4790
|
+
* const auth = new google.auth.GoogleAuth({
|
|
4791
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
4792
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
4793
|
+
* });
|
|
4794
|
+
*
|
|
4795
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
4796
|
+
* const authClient = await auth.getClient();
|
|
4797
|
+
* google.options({auth: authClient});
|
|
4798
|
+
*
|
|
4799
|
+
* // Do the magic
|
|
4800
|
+
* const res = await alloydb.projects.locations.clusters.instances.failover({
|
|
4801
|
+
* // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
|
|
4802
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
|
|
4803
|
+
*
|
|
4804
|
+
* // Request body metadata
|
|
4805
|
+
* requestBody: {
|
|
4806
|
+
* // request body parameters
|
|
4807
|
+
* // {
|
|
4808
|
+
* // "requestId": "my_requestId",
|
|
4809
|
+
* // "validateOnly": false
|
|
4810
|
+
* // }
|
|
4811
|
+
* },
|
|
4812
|
+
* });
|
|
4813
|
+
* console.log(res.data);
|
|
4814
|
+
*
|
|
4815
|
+
* // Example response
|
|
4816
|
+
* // {
|
|
4817
|
+
* // "done": false,
|
|
4818
|
+
* // "error": {},
|
|
4819
|
+
* // "metadata": {},
|
|
4820
|
+
* // "name": "my_name",
|
|
4821
|
+
* // "response": {}
|
|
4822
|
+
* // }
|
|
4823
|
+
* }
|
|
4824
|
+
*
|
|
4825
|
+
* main().catch(e => {
|
|
4826
|
+
* console.error(e);
|
|
4827
|
+
* throw e;
|
|
4828
|
+
* });
|
|
4829
|
+
*
|
|
4830
|
+
* ```
|
|
3106
4831
|
*
|
|
3107
4832
|
* @param params - Parameters for request
|
|
3108
4833
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3109
4834
|
* @param callback - Optional callback that handles the response.
|
|
3110
4835
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3111
4836
|
*/
|
|
3112
|
-
failover(params: Params$Resource$Projects$Locations$Clusters$Instances$Failover, options: StreamMethodOptions):
|
|
3113
|
-
failover(params?: Params$Resource$Projects$Locations$Clusters$Instances$Failover, options?: MethodOptions):
|
|
4837
|
+
failover(params: Params$Resource$Projects$Locations$Clusters$Instances$Failover, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
4838
|
+
failover(params?: Params$Resource$Projects$Locations$Clusters$Instances$Failover, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
3114
4839
|
failover(params: Params$Resource$Projects$Locations$Clusters$Instances$Failover, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3115
4840
|
failover(params: Params$Resource$Projects$Locations$Clusters$Instances$Failover, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
3116
4841
|
failover(params: Params$Resource$Projects$Locations$Clusters$Instances$Failover, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
3117
4842
|
failover(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
3118
4843
|
/**
|
|
3119
4844
|
* Gets details of a single Instance.
|
|
4845
|
+
* @example
|
|
4846
|
+
* ```js
|
|
4847
|
+
* // Before running the sample:
|
|
4848
|
+
* // - Enable the API at:
|
|
4849
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
4850
|
+
* // - Login into gcloud by running:
|
|
4851
|
+
* // ```sh
|
|
4852
|
+
* // $ gcloud auth application-default login
|
|
4853
|
+
* // ```
|
|
4854
|
+
* // - Install the npm module by running:
|
|
4855
|
+
* // ```sh
|
|
4856
|
+
* // $ npm install googleapis
|
|
4857
|
+
* // ```
|
|
4858
|
+
*
|
|
4859
|
+
* const {google} = require('googleapis');
|
|
4860
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
4861
|
+
*
|
|
4862
|
+
* async function main() {
|
|
4863
|
+
* const auth = new google.auth.GoogleAuth({
|
|
4864
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
4865
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
4866
|
+
* });
|
|
4867
|
+
*
|
|
4868
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
4869
|
+
* const authClient = await auth.getClient();
|
|
4870
|
+
* google.options({auth: authClient});
|
|
4871
|
+
*
|
|
4872
|
+
* // Do the magic
|
|
4873
|
+
* const res = await alloydb.projects.locations.clusters.instances.get({
|
|
4874
|
+
* // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
|
|
4875
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
|
|
4876
|
+
* // The view of the instance to return.
|
|
4877
|
+
* view: 'placeholder-value',
|
|
4878
|
+
* });
|
|
4879
|
+
* console.log(res.data);
|
|
4880
|
+
*
|
|
4881
|
+
* // Example response
|
|
4882
|
+
* // {
|
|
4883
|
+
* // "activationPolicy": "my_activationPolicy",
|
|
4884
|
+
* // "annotations": {},
|
|
4885
|
+
* // "availabilityType": "my_availabilityType",
|
|
4886
|
+
* // "clientConnectionConfig": {},
|
|
4887
|
+
* // "connectionPoolConfig": {},
|
|
4888
|
+
* // "createTime": "my_createTime",
|
|
4889
|
+
* // "databaseFlags": {},
|
|
4890
|
+
* // "deleteTime": "my_deleteTime",
|
|
4891
|
+
* // "displayName": "my_displayName",
|
|
4892
|
+
* // "etag": "my_etag",
|
|
4893
|
+
* // "gcaConfig": {},
|
|
4894
|
+
* // "gceZone": "my_gceZone",
|
|
4895
|
+
* // "geminiConfig": {},
|
|
4896
|
+
* // "instanceType": "my_instanceType",
|
|
4897
|
+
* // "ipAddress": "my_ipAddress",
|
|
4898
|
+
* // "labels": {},
|
|
4899
|
+
* // "machineConfig": {},
|
|
4900
|
+
* // "name": "my_name",
|
|
4901
|
+
* // "networkConfig": {},
|
|
4902
|
+
* // "nodes": [],
|
|
4903
|
+
* // "observabilityConfig": {},
|
|
4904
|
+
* // "outboundPublicIpAddresses": [],
|
|
4905
|
+
* // "pscInstanceConfig": {},
|
|
4906
|
+
* // "publicIpAddress": "my_publicIpAddress",
|
|
4907
|
+
* // "queryInsightsConfig": {},
|
|
4908
|
+
* // "readPoolConfig": {},
|
|
4909
|
+
* // "reconciling": false,
|
|
4910
|
+
* // "satisfiesPzi": false,
|
|
4911
|
+
* // "satisfiesPzs": false,
|
|
4912
|
+
* // "state": "my_state",
|
|
4913
|
+
* // "uid": "my_uid",
|
|
4914
|
+
* // "updatePolicy": {},
|
|
4915
|
+
* // "updateTime": "my_updateTime",
|
|
4916
|
+
* // "writableNode": {}
|
|
4917
|
+
* // }
|
|
4918
|
+
* }
|
|
4919
|
+
*
|
|
4920
|
+
* main().catch(e => {
|
|
4921
|
+
* console.error(e);
|
|
4922
|
+
* throw e;
|
|
4923
|
+
* });
|
|
4924
|
+
*
|
|
4925
|
+
* ```
|
|
3120
4926
|
*
|
|
3121
4927
|
* @param params - Parameters for request
|
|
3122
4928
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3123
4929
|
* @param callback - Optional callback that handles the response.
|
|
3124
4930
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3125
4931
|
*/
|
|
3126
|
-
get(params: Params$Resource$Projects$Locations$Clusters$Instances$Get, options: StreamMethodOptions):
|
|
3127
|
-
get(params?: Params$Resource$Projects$Locations$Clusters$Instances$Get, options?: MethodOptions):
|
|
4932
|
+
get(params: Params$Resource$Projects$Locations$Clusters$Instances$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
4933
|
+
get(params?: Params$Resource$Projects$Locations$Clusters$Instances$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Instance>>;
|
|
3128
4934
|
get(params: Params$Resource$Projects$Locations$Clusters$Instances$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3129
4935
|
get(params: Params$Resource$Projects$Locations$Clusters$Instances$Get, options: MethodOptions | BodyResponseCallback<Schema$Instance>, callback: BodyResponseCallback<Schema$Instance>): void;
|
|
3130
4936
|
get(params: Params$Resource$Projects$Locations$Clusters$Instances$Get, callback: BodyResponseCallback<Schema$Instance>): void;
|
|
3131
4937
|
get(callback: BodyResponseCallback<Schema$Instance>): void;
|
|
3132
4938
|
/**
|
|
3133
4939
|
* Get instance metadata used for a connection.
|
|
4940
|
+
* @example
|
|
4941
|
+
* ```js
|
|
4942
|
+
* // Before running the sample:
|
|
4943
|
+
* // - Enable the API at:
|
|
4944
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
4945
|
+
* // - Login into gcloud by running:
|
|
4946
|
+
* // ```sh
|
|
4947
|
+
* // $ gcloud auth application-default login
|
|
4948
|
+
* // ```
|
|
4949
|
+
* // - Install the npm module by running:
|
|
4950
|
+
* // ```sh
|
|
4951
|
+
* // $ npm install googleapis
|
|
4952
|
+
* // ```
|
|
4953
|
+
*
|
|
4954
|
+
* const {google} = require('googleapis');
|
|
4955
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
4956
|
+
*
|
|
4957
|
+
* async function main() {
|
|
4958
|
+
* const auth = new google.auth.GoogleAuth({
|
|
4959
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
4960
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
4961
|
+
* });
|
|
4962
|
+
*
|
|
4963
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
4964
|
+
* const authClient = await auth.getClient();
|
|
4965
|
+
* google.options({auth: authClient});
|
|
4966
|
+
*
|
|
4967
|
+
* // Do the magic
|
|
4968
|
+
* const res =
|
|
4969
|
+
* await alloydb.projects.locations.clusters.instances.getConnectionInfo({
|
|
4970
|
+
* // Required. The name of the parent resource. The required format is: projects/{project\}/locations/{location\}/clusters/{cluster\}/instances/{instance\}
|
|
4971
|
+
* parent:
|
|
4972
|
+
* 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
|
|
4973
|
+
* // 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).
|
|
4974
|
+
* requestId: 'placeholder-value',
|
|
4975
|
+
* });
|
|
4976
|
+
* console.log(res.data);
|
|
4977
|
+
*
|
|
4978
|
+
* // Example response
|
|
4979
|
+
* // {
|
|
4980
|
+
* // "instanceUid": "my_instanceUid",
|
|
4981
|
+
* // "ipAddress": "my_ipAddress",
|
|
4982
|
+
* // "name": "my_name",
|
|
4983
|
+
* // "pemCertificateChain": [],
|
|
4984
|
+
* // "pscDnsName": "my_pscDnsName",
|
|
4985
|
+
* // "publicIpAddress": "my_publicIpAddress"
|
|
4986
|
+
* // }
|
|
4987
|
+
* }
|
|
4988
|
+
*
|
|
4989
|
+
* main().catch(e => {
|
|
4990
|
+
* console.error(e);
|
|
4991
|
+
* throw e;
|
|
4992
|
+
* });
|
|
4993
|
+
*
|
|
4994
|
+
* ```
|
|
3134
4995
|
*
|
|
3135
4996
|
* @param params - Parameters for request
|
|
3136
4997
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3137
4998
|
* @param callback - Optional callback that handles the response.
|
|
3138
4999
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3139
5000
|
*/
|
|
3140
|
-
getConnectionInfo(params: Params$Resource$Projects$Locations$Clusters$Instances$Getconnectioninfo, options: StreamMethodOptions):
|
|
3141
|
-
getConnectionInfo(params?: Params$Resource$Projects$Locations$Clusters$Instances$Getconnectioninfo, options?: MethodOptions):
|
|
5001
|
+
getConnectionInfo(params: Params$Resource$Projects$Locations$Clusters$Instances$Getconnectioninfo, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
5002
|
+
getConnectionInfo(params?: Params$Resource$Projects$Locations$Clusters$Instances$Getconnectioninfo, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ConnectionInfo>>;
|
|
3142
5003
|
getConnectionInfo(params: Params$Resource$Projects$Locations$Clusters$Instances$Getconnectioninfo, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3143
5004
|
getConnectionInfo(params: Params$Resource$Projects$Locations$Clusters$Instances$Getconnectioninfo, options: MethodOptions | BodyResponseCallback<Schema$ConnectionInfo>, callback: BodyResponseCallback<Schema$ConnectionInfo>): void;
|
|
3144
5005
|
getConnectionInfo(params: Params$Resource$Projects$Locations$Clusters$Instances$Getconnectioninfo, callback: BodyResponseCallback<Schema$ConnectionInfo>): void;
|
|
3145
5006
|
getConnectionInfo(callback: BodyResponseCallback<Schema$ConnectionInfo>): void;
|
|
3146
5007
|
/**
|
|
3147
5008
|
* Injects fault in an instance. Imperative only.
|
|
5009
|
+
* @example
|
|
5010
|
+
* ```js
|
|
5011
|
+
* // Before running the sample:
|
|
5012
|
+
* // - Enable the API at:
|
|
5013
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
5014
|
+
* // - Login into gcloud by running:
|
|
5015
|
+
* // ```sh
|
|
5016
|
+
* // $ gcloud auth application-default login
|
|
5017
|
+
* // ```
|
|
5018
|
+
* // - Install the npm module by running:
|
|
5019
|
+
* // ```sh
|
|
5020
|
+
* // $ npm install googleapis
|
|
5021
|
+
* // ```
|
|
5022
|
+
*
|
|
5023
|
+
* const {google} = require('googleapis');
|
|
5024
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
5025
|
+
*
|
|
5026
|
+
* async function main() {
|
|
5027
|
+
* const auth = new google.auth.GoogleAuth({
|
|
5028
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
5029
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
5030
|
+
* });
|
|
5031
|
+
*
|
|
5032
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
5033
|
+
* const authClient = await auth.getClient();
|
|
5034
|
+
* google.options({auth: authClient});
|
|
5035
|
+
*
|
|
5036
|
+
* // Do the magic
|
|
5037
|
+
* const res = await alloydb.projects.locations.clusters.instances.injectFault({
|
|
5038
|
+
* // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
|
|
5039
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
|
|
5040
|
+
*
|
|
5041
|
+
* // Request body metadata
|
|
5042
|
+
* requestBody: {
|
|
5043
|
+
* // request body parameters
|
|
5044
|
+
* // {
|
|
5045
|
+
* // "faultType": "my_faultType",
|
|
5046
|
+
* // "requestId": "my_requestId",
|
|
5047
|
+
* // "validateOnly": false
|
|
5048
|
+
* // }
|
|
5049
|
+
* },
|
|
5050
|
+
* });
|
|
5051
|
+
* console.log(res.data);
|
|
5052
|
+
*
|
|
5053
|
+
* // Example response
|
|
5054
|
+
* // {
|
|
5055
|
+
* // "done": false,
|
|
5056
|
+
* // "error": {},
|
|
5057
|
+
* // "metadata": {},
|
|
5058
|
+
* // "name": "my_name",
|
|
5059
|
+
* // "response": {}
|
|
5060
|
+
* // }
|
|
5061
|
+
* }
|
|
5062
|
+
*
|
|
5063
|
+
* main().catch(e => {
|
|
5064
|
+
* console.error(e);
|
|
5065
|
+
* throw e;
|
|
5066
|
+
* });
|
|
5067
|
+
*
|
|
5068
|
+
* ```
|
|
3148
5069
|
*
|
|
3149
5070
|
* @param params - Parameters for request
|
|
3150
5071
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3151
5072
|
* @param callback - Optional callback that handles the response.
|
|
3152
5073
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3153
5074
|
*/
|
|
3154
|
-
injectFault(params: Params$Resource$Projects$Locations$Clusters$Instances$Injectfault, options: StreamMethodOptions):
|
|
3155
|
-
injectFault(params?: Params$Resource$Projects$Locations$Clusters$Instances$Injectfault, options?: MethodOptions):
|
|
5075
|
+
injectFault(params: Params$Resource$Projects$Locations$Clusters$Instances$Injectfault, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
5076
|
+
injectFault(params?: Params$Resource$Projects$Locations$Clusters$Instances$Injectfault, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
3156
5077
|
injectFault(params: Params$Resource$Projects$Locations$Clusters$Instances$Injectfault, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3157
5078
|
injectFault(params: Params$Resource$Projects$Locations$Clusters$Instances$Injectfault, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
3158
5079
|
injectFault(params: Params$Resource$Projects$Locations$Clusters$Instances$Injectfault, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
3159
5080
|
injectFault(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
3160
5081
|
/**
|
|
3161
5082
|
* Lists Instances in a given project and location.
|
|
5083
|
+
* @example
|
|
5084
|
+
* ```js
|
|
5085
|
+
* // Before running the sample:
|
|
5086
|
+
* // - Enable the API at:
|
|
5087
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
5088
|
+
* // - Login into gcloud by running:
|
|
5089
|
+
* // ```sh
|
|
5090
|
+
* // $ gcloud auth application-default login
|
|
5091
|
+
* // ```
|
|
5092
|
+
* // - Install the npm module by running:
|
|
5093
|
+
* // ```sh
|
|
5094
|
+
* // $ npm install googleapis
|
|
5095
|
+
* // ```
|
|
5096
|
+
*
|
|
5097
|
+
* const {google} = require('googleapis');
|
|
5098
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
5099
|
+
*
|
|
5100
|
+
* async function main() {
|
|
5101
|
+
* const auth = new google.auth.GoogleAuth({
|
|
5102
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
5103
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
5104
|
+
* });
|
|
5105
|
+
*
|
|
5106
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
5107
|
+
* const authClient = await auth.getClient();
|
|
5108
|
+
* google.options({auth: authClient});
|
|
5109
|
+
*
|
|
5110
|
+
* // Do the magic
|
|
5111
|
+
* const res = await alloydb.projects.locations.clusters.instances.list({
|
|
5112
|
+
* // Optional. Filtering results
|
|
5113
|
+
* filter: 'placeholder-value',
|
|
5114
|
+
* // Optional. Hint for how to order the results
|
|
5115
|
+
* orderBy: 'placeholder-value',
|
|
5116
|
+
* // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
|
|
5117
|
+
* pageSize: 'placeholder-value',
|
|
5118
|
+
* // A token identifying a page of results the server should return.
|
|
5119
|
+
* pageToken: 'placeholder-value',
|
|
5120
|
+
* // 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/-
|
|
5121
|
+
* parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
|
|
5122
|
+
* });
|
|
5123
|
+
* console.log(res.data);
|
|
5124
|
+
*
|
|
5125
|
+
* // Example response
|
|
5126
|
+
* // {
|
|
5127
|
+
* // "instances": [],
|
|
5128
|
+
* // "nextPageToken": "my_nextPageToken",
|
|
5129
|
+
* // "unreachable": []
|
|
5130
|
+
* // }
|
|
5131
|
+
* }
|
|
5132
|
+
*
|
|
5133
|
+
* main().catch(e => {
|
|
5134
|
+
* console.error(e);
|
|
5135
|
+
* throw e;
|
|
5136
|
+
* });
|
|
5137
|
+
*
|
|
5138
|
+
* ```
|
|
3162
5139
|
*
|
|
3163
5140
|
* @param params - Parameters for request
|
|
3164
5141
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3165
5142
|
* @param callback - Optional callback that handles the response.
|
|
3166
5143
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3167
5144
|
*/
|
|
3168
|
-
list(params: Params$Resource$Projects$Locations$Clusters$Instances$List, options: StreamMethodOptions):
|
|
3169
|
-
list(params?: Params$Resource$Projects$Locations$Clusters$Instances$List, options?: MethodOptions):
|
|
5145
|
+
list(params: Params$Resource$Projects$Locations$Clusters$Instances$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
5146
|
+
list(params?: Params$Resource$Projects$Locations$Clusters$Instances$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ListInstancesResponse>>;
|
|
3170
5147
|
list(params: Params$Resource$Projects$Locations$Clusters$Instances$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3171
5148
|
list(params: Params$Resource$Projects$Locations$Clusters$Instances$List, options: MethodOptions | BodyResponseCallback<Schema$ListInstancesResponse>, callback: BodyResponseCallback<Schema$ListInstancesResponse>): void;
|
|
3172
5149
|
list(params: Params$Resource$Projects$Locations$Clusters$Instances$List, callback: BodyResponseCallback<Schema$ListInstancesResponse>): void;
|
|
3173
5150
|
list(callback: BodyResponseCallback<Schema$ListInstancesResponse>): void;
|
|
3174
5151
|
/**
|
|
3175
5152
|
* Updates the parameters of a single Instance.
|
|
5153
|
+
* @example
|
|
5154
|
+
* ```js
|
|
5155
|
+
* // Before running the sample:
|
|
5156
|
+
* // - Enable the API at:
|
|
5157
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
5158
|
+
* // - Login into gcloud by running:
|
|
5159
|
+
* // ```sh
|
|
5160
|
+
* // $ gcloud auth application-default login
|
|
5161
|
+
* // ```
|
|
5162
|
+
* // - Install the npm module by running:
|
|
5163
|
+
* // ```sh
|
|
5164
|
+
* // $ npm install googleapis
|
|
5165
|
+
* // ```
|
|
5166
|
+
*
|
|
5167
|
+
* const {google} = require('googleapis');
|
|
5168
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
5169
|
+
*
|
|
5170
|
+
* async function main() {
|
|
5171
|
+
* const auth = new google.auth.GoogleAuth({
|
|
5172
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
5173
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
5174
|
+
* });
|
|
5175
|
+
*
|
|
5176
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
5177
|
+
* const authClient = await auth.getClient();
|
|
5178
|
+
* google.options({auth: authClient});
|
|
5179
|
+
*
|
|
5180
|
+
* // Do the magic
|
|
5181
|
+
* const res = await alloydb.projects.locations.clusters.instances.patch({
|
|
5182
|
+
* // 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.
|
|
5183
|
+
* allowMissing: 'placeholder-value',
|
|
5184
|
+
* // 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\}
|
|
5185
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
|
|
5186
|
+
* // 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).
|
|
5187
|
+
* requestId: 'placeholder-value',
|
|
5188
|
+
* // 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.
|
|
5189
|
+
* updateMask: 'placeholder-value',
|
|
5190
|
+
* // Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.
|
|
5191
|
+
* validateOnly: 'placeholder-value',
|
|
5192
|
+
*
|
|
5193
|
+
* // Request body metadata
|
|
5194
|
+
* requestBody: {
|
|
5195
|
+
* // request body parameters
|
|
5196
|
+
* // {
|
|
5197
|
+
* // "activationPolicy": "my_activationPolicy",
|
|
5198
|
+
* // "annotations": {},
|
|
5199
|
+
* // "availabilityType": "my_availabilityType",
|
|
5200
|
+
* // "clientConnectionConfig": {},
|
|
5201
|
+
* // "connectionPoolConfig": {},
|
|
5202
|
+
* // "createTime": "my_createTime",
|
|
5203
|
+
* // "databaseFlags": {},
|
|
5204
|
+
* // "deleteTime": "my_deleteTime",
|
|
5205
|
+
* // "displayName": "my_displayName",
|
|
5206
|
+
* // "etag": "my_etag",
|
|
5207
|
+
* // "gcaConfig": {},
|
|
5208
|
+
* // "gceZone": "my_gceZone",
|
|
5209
|
+
* // "geminiConfig": {},
|
|
5210
|
+
* // "instanceType": "my_instanceType",
|
|
5211
|
+
* // "ipAddress": "my_ipAddress",
|
|
5212
|
+
* // "labels": {},
|
|
5213
|
+
* // "machineConfig": {},
|
|
5214
|
+
* // "name": "my_name",
|
|
5215
|
+
* // "networkConfig": {},
|
|
5216
|
+
* // "nodes": [],
|
|
5217
|
+
* // "observabilityConfig": {},
|
|
5218
|
+
* // "outboundPublicIpAddresses": [],
|
|
5219
|
+
* // "pscInstanceConfig": {},
|
|
5220
|
+
* // "publicIpAddress": "my_publicIpAddress",
|
|
5221
|
+
* // "queryInsightsConfig": {},
|
|
5222
|
+
* // "readPoolConfig": {},
|
|
5223
|
+
* // "reconciling": false,
|
|
5224
|
+
* // "satisfiesPzi": false,
|
|
5225
|
+
* // "satisfiesPzs": false,
|
|
5226
|
+
* // "state": "my_state",
|
|
5227
|
+
* // "uid": "my_uid",
|
|
5228
|
+
* // "updatePolicy": {},
|
|
5229
|
+
* // "updateTime": "my_updateTime",
|
|
5230
|
+
* // "writableNode": {}
|
|
5231
|
+
* // }
|
|
5232
|
+
* },
|
|
5233
|
+
* });
|
|
5234
|
+
* console.log(res.data);
|
|
5235
|
+
*
|
|
5236
|
+
* // Example response
|
|
5237
|
+
* // {
|
|
5238
|
+
* // "done": false,
|
|
5239
|
+
* // "error": {},
|
|
5240
|
+
* // "metadata": {},
|
|
5241
|
+
* // "name": "my_name",
|
|
5242
|
+
* // "response": {}
|
|
5243
|
+
* // }
|
|
5244
|
+
* }
|
|
5245
|
+
*
|
|
5246
|
+
* main().catch(e => {
|
|
5247
|
+
* console.error(e);
|
|
5248
|
+
* throw e;
|
|
5249
|
+
* });
|
|
5250
|
+
*
|
|
5251
|
+
* ```
|
|
3176
5252
|
*
|
|
3177
5253
|
* @param params - Parameters for request
|
|
3178
5254
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3179
5255
|
* @param callback - Optional callback that handles the response.
|
|
3180
5256
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3181
5257
|
*/
|
|
3182
|
-
patch(params: Params$Resource$Projects$Locations$Clusters$Instances$Patch, options: StreamMethodOptions):
|
|
3183
|
-
patch(params?: Params$Resource$Projects$Locations$Clusters$Instances$Patch, options?: MethodOptions):
|
|
5258
|
+
patch(params: Params$Resource$Projects$Locations$Clusters$Instances$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
5259
|
+
patch(params?: Params$Resource$Projects$Locations$Clusters$Instances$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
3184
5260
|
patch(params: Params$Resource$Projects$Locations$Clusters$Instances$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3185
5261
|
patch(params: Params$Resource$Projects$Locations$Clusters$Instances$Patch, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
3186
5262
|
patch(params: Params$Resource$Projects$Locations$Clusters$Instances$Patch, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
3187
5263
|
patch(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
3188
5264
|
/**
|
|
3189
5265
|
* Restart an Instance in a cluster. Imperative only.
|
|
5266
|
+
* @example
|
|
5267
|
+
* ```js
|
|
5268
|
+
* // Before running the sample:
|
|
5269
|
+
* // - Enable the API at:
|
|
5270
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
5271
|
+
* // - Login into gcloud by running:
|
|
5272
|
+
* // ```sh
|
|
5273
|
+
* // $ gcloud auth application-default login
|
|
5274
|
+
* // ```
|
|
5275
|
+
* // - Install the npm module by running:
|
|
5276
|
+
* // ```sh
|
|
5277
|
+
* // $ npm install googleapis
|
|
5278
|
+
* // ```
|
|
5279
|
+
*
|
|
5280
|
+
* const {google} = require('googleapis');
|
|
5281
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
5282
|
+
*
|
|
5283
|
+
* async function main() {
|
|
5284
|
+
* const auth = new google.auth.GoogleAuth({
|
|
5285
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
5286
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
5287
|
+
* });
|
|
5288
|
+
*
|
|
5289
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
5290
|
+
* const authClient = await auth.getClient();
|
|
5291
|
+
* google.options({auth: authClient});
|
|
5292
|
+
*
|
|
5293
|
+
* // Do the magic
|
|
5294
|
+
* const res = await alloydb.projects.locations.clusters.instances.restart({
|
|
5295
|
+
* // Required. The name of the resource. For the required format, see the comment on the Instance.name field.
|
|
5296
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster/instances/my-instance',
|
|
5297
|
+
*
|
|
5298
|
+
* // Request body metadata
|
|
5299
|
+
* requestBody: {
|
|
5300
|
+
* // request body parameters
|
|
5301
|
+
* // {
|
|
5302
|
+
* // "nodeIds": [],
|
|
5303
|
+
* // "requestId": "my_requestId",
|
|
5304
|
+
* // "validateOnly": false
|
|
5305
|
+
* // }
|
|
5306
|
+
* },
|
|
5307
|
+
* });
|
|
5308
|
+
* console.log(res.data);
|
|
5309
|
+
*
|
|
5310
|
+
* // Example response
|
|
5311
|
+
* // {
|
|
5312
|
+
* // "done": false,
|
|
5313
|
+
* // "error": {},
|
|
5314
|
+
* // "metadata": {},
|
|
5315
|
+
* // "name": "my_name",
|
|
5316
|
+
* // "response": {}
|
|
5317
|
+
* // }
|
|
5318
|
+
* }
|
|
5319
|
+
*
|
|
5320
|
+
* main().catch(e => {
|
|
5321
|
+
* console.error(e);
|
|
5322
|
+
* throw e;
|
|
5323
|
+
* });
|
|
5324
|
+
*
|
|
5325
|
+
* ```
|
|
3190
5326
|
*
|
|
3191
5327
|
* @param params - Parameters for request
|
|
3192
5328
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3193
5329
|
* @param callback - Optional callback that handles the response.
|
|
3194
5330
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3195
5331
|
*/
|
|
3196
|
-
restart(params: Params$Resource$Projects$Locations$Clusters$Instances$Restart, options: StreamMethodOptions):
|
|
3197
|
-
restart(params?: Params$Resource$Projects$Locations$Clusters$Instances$Restart, options?: MethodOptions):
|
|
5332
|
+
restart(params: Params$Resource$Projects$Locations$Clusters$Instances$Restart, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
5333
|
+
restart(params?: Params$Resource$Projects$Locations$Clusters$Instances$Restart, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
3198
5334
|
restart(params: Params$Resource$Projects$Locations$Clusters$Instances$Restart, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3199
5335
|
restart(params: Params$Resource$Projects$Locations$Clusters$Instances$Restart, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
3200
5336
|
restart(params: Params$Resource$Projects$Locations$Clusters$Instances$Restart, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
@@ -3365,70 +5501,362 @@ export declare namespace alloydb_v1alpha {
|
|
|
3365
5501
|
constructor(context: APIRequestContext);
|
|
3366
5502
|
/**
|
|
3367
5503
|
* Creates a new User in a given project, location, and cluster.
|
|
5504
|
+
* @example
|
|
5505
|
+
* ```js
|
|
5506
|
+
* // Before running the sample:
|
|
5507
|
+
* // - Enable the API at:
|
|
5508
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
5509
|
+
* // - Login into gcloud by running:
|
|
5510
|
+
* // ```sh
|
|
5511
|
+
* // $ gcloud auth application-default login
|
|
5512
|
+
* // ```
|
|
5513
|
+
* // - Install the npm module by running:
|
|
5514
|
+
* // ```sh
|
|
5515
|
+
* // $ npm install googleapis
|
|
5516
|
+
* // ```
|
|
5517
|
+
*
|
|
5518
|
+
* const {google} = require('googleapis');
|
|
5519
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
5520
|
+
*
|
|
5521
|
+
* async function main() {
|
|
5522
|
+
* const auth = new google.auth.GoogleAuth({
|
|
5523
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
5524
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
5525
|
+
* });
|
|
5526
|
+
*
|
|
5527
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
5528
|
+
* const authClient = await auth.getClient();
|
|
5529
|
+
* google.options({auth: authClient});
|
|
5530
|
+
*
|
|
5531
|
+
* // Do the magic
|
|
5532
|
+
* const res = await alloydb.projects.locations.clusters.users.create({
|
|
5533
|
+
* // Required. Value for parent.
|
|
5534
|
+
* parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
|
|
5535
|
+
* // 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).
|
|
5536
|
+
* requestId: 'placeholder-value',
|
|
5537
|
+
* // Required. ID of the requesting object.
|
|
5538
|
+
* userId: 'placeholder-value',
|
|
5539
|
+
* // Optional. If set, the backend validates the request, but doesn't actually execute it.
|
|
5540
|
+
* validateOnly: 'placeholder-value',
|
|
5541
|
+
*
|
|
5542
|
+
* // Request body metadata
|
|
5543
|
+
* requestBody: {
|
|
5544
|
+
* // request body parameters
|
|
5545
|
+
* // {
|
|
5546
|
+
* // "databaseRoles": [],
|
|
5547
|
+
* // "keepExtraRoles": false,
|
|
5548
|
+
* // "name": "my_name",
|
|
5549
|
+
* // "password": "my_password",
|
|
5550
|
+
* // "userType": "my_userType"
|
|
5551
|
+
* // }
|
|
5552
|
+
* },
|
|
5553
|
+
* });
|
|
5554
|
+
* console.log(res.data);
|
|
5555
|
+
*
|
|
5556
|
+
* // Example response
|
|
5557
|
+
* // {
|
|
5558
|
+
* // "databaseRoles": [],
|
|
5559
|
+
* // "keepExtraRoles": false,
|
|
5560
|
+
* // "name": "my_name",
|
|
5561
|
+
* // "password": "my_password",
|
|
5562
|
+
* // "userType": "my_userType"
|
|
5563
|
+
* // }
|
|
5564
|
+
* }
|
|
5565
|
+
*
|
|
5566
|
+
* main().catch(e => {
|
|
5567
|
+
* console.error(e);
|
|
5568
|
+
* throw e;
|
|
5569
|
+
* });
|
|
5570
|
+
*
|
|
5571
|
+
* ```
|
|
3368
5572
|
*
|
|
3369
5573
|
* @param params - Parameters for request
|
|
3370
5574
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3371
5575
|
* @param callback - Optional callback that handles the response.
|
|
3372
5576
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3373
5577
|
*/
|
|
3374
|
-
create(params: Params$Resource$Projects$Locations$Clusters$Users$Create, options: StreamMethodOptions):
|
|
3375
|
-
create(params?: Params$Resource$Projects$Locations$Clusters$Users$Create, options?: MethodOptions):
|
|
5578
|
+
create(params: Params$Resource$Projects$Locations$Clusters$Users$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
5579
|
+
create(params?: Params$Resource$Projects$Locations$Clusters$Users$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$User>>;
|
|
3376
5580
|
create(params: Params$Resource$Projects$Locations$Clusters$Users$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3377
5581
|
create(params: Params$Resource$Projects$Locations$Clusters$Users$Create, options: MethodOptions | BodyResponseCallback<Schema$User>, callback: BodyResponseCallback<Schema$User>): void;
|
|
3378
5582
|
create(params: Params$Resource$Projects$Locations$Clusters$Users$Create, callback: BodyResponseCallback<Schema$User>): void;
|
|
3379
5583
|
create(callback: BodyResponseCallback<Schema$User>): void;
|
|
3380
5584
|
/**
|
|
3381
5585
|
* Deletes a single User.
|
|
5586
|
+
* @example
|
|
5587
|
+
* ```js
|
|
5588
|
+
* // Before running the sample:
|
|
5589
|
+
* // - Enable the API at:
|
|
5590
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
5591
|
+
* // - Login into gcloud by running:
|
|
5592
|
+
* // ```sh
|
|
5593
|
+
* // $ gcloud auth application-default login
|
|
5594
|
+
* // ```
|
|
5595
|
+
* // - Install the npm module by running:
|
|
5596
|
+
* // ```sh
|
|
5597
|
+
* // $ npm install googleapis
|
|
5598
|
+
* // ```
|
|
5599
|
+
*
|
|
5600
|
+
* const {google} = require('googleapis');
|
|
5601
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
5602
|
+
*
|
|
5603
|
+
* async function main() {
|
|
5604
|
+
* const auth = new google.auth.GoogleAuth({
|
|
5605
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
5606
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
5607
|
+
* });
|
|
5608
|
+
*
|
|
5609
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
5610
|
+
* const authClient = await auth.getClient();
|
|
5611
|
+
* google.options({auth: authClient});
|
|
5612
|
+
*
|
|
5613
|
+
* // Do the magic
|
|
5614
|
+
* const res = await alloydb.projects.locations.clusters.users.delete({
|
|
5615
|
+
* // Required. The name of the resource. For the required format, see the comment on the User.name field.
|
|
5616
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster/users/my-user',
|
|
5617
|
+
* // 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).
|
|
5618
|
+
* requestId: 'placeholder-value',
|
|
5619
|
+
* // Optional. If set, the backend validates the request, but doesn't actually execute it.
|
|
5620
|
+
* validateOnly: 'placeholder-value',
|
|
5621
|
+
* });
|
|
5622
|
+
* console.log(res.data);
|
|
5623
|
+
*
|
|
5624
|
+
* // Example response
|
|
5625
|
+
* // {}
|
|
5626
|
+
* }
|
|
5627
|
+
*
|
|
5628
|
+
* main().catch(e => {
|
|
5629
|
+
* console.error(e);
|
|
5630
|
+
* throw e;
|
|
5631
|
+
* });
|
|
5632
|
+
*
|
|
5633
|
+
* ```
|
|
3382
5634
|
*
|
|
3383
5635
|
* @param params - Parameters for request
|
|
3384
5636
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3385
5637
|
* @param callback - Optional callback that handles the response.
|
|
3386
5638
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3387
5639
|
*/
|
|
3388
|
-
delete(params: Params$Resource$Projects$Locations$Clusters$Users$Delete, options: StreamMethodOptions):
|
|
3389
|
-
delete(params?: Params$Resource$Projects$Locations$Clusters$Users$Delete, options?: MethodOptions):
|
|
5640
|
+
delete(params: Params$Resource$Projects$Locations$Clusters$Users$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
5641
|
+
delete(params?: Params$Resource$Projects$Locations$Clusters$Users$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Empty>>;
|
|
3390
5642
|
delete(params: Params$Resource$Projects$Locations$Clusters$Users$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3391
5643
|
delete(params: Params$Resource$Projects$Locations$Clusters$Users$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
|
|
3392
5644
|
delete(params: Params$Resource$Projects$Locations$Clusters$Users$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
|
|
3393
5645
|
delete(callback: BodyResponseCallback<Schema$Empty>): void;
|
|
3394
5646
|
/**
|
|
3395
5647
|
* Gets details of a single User.
|
|
5648
|
+
* @example
|
|
5649
|
+
* ```js
|
|
5650
|
+
* // Before running the sample:
|
|
5651
|
+
* // - Enable the API at:
|
|
5652
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
5653
|
+
* // - Login into gcloud by running:
|
|
5654
|
+
* // ```sh
|
|
5655
|
+
* // $ gcloud auth application-default login
|
|
5656
|
+
* // ```
|
|
5657
|
+
* // - Install the npm module by running:
|
|
5658
|
+
* // ```sh
|
|
5659
|
+
* // $ npm install googleapis
|
|
5660
|
+
* // ```
|
|
5661
|
+
*
|
|
5662
|
+
* const {google} = require('googleapis');
|
|
5663
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
5664
|
+
*
|
|
5665
|
+
* async function main() {
|
|
5666
|
+
* const auth = new google.auth.GoogleAuth({
|
|
5667
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
5668
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
5669
|
+
* });
|
|
5670
|
+
*
|
|
5671
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
5672
|
+
* const authClient = await auth.getClient();
|
|
5673
|
+
* google.options({auth: authClient});
|
|
5674
|
+
*
|
|
5675
|
+
* // Do the magic
|
|
5676
|
+
* const res = await alloydb.projects.locations.clusters.users.get({
|
|
5677
|
+
* // Required. The name of the resource. For the required format, see the comment on the User.name field.
|
|
5678
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster/users/my-user',
|
|
5679
|
+
* });
|
|
5680
|
+
* console.log(res.data);
|
|
5681
|
+
*
|
|
5682
|
+
* // Example response
|
|
5683
|
+
* // {
|
|
5684
|
+
* // "databaseRoles": [],
|
|
5685
|
+
* // "keepExtraRoles": false,
|
|
5686
|
+
* // "name": "my_name",
|
|
5687
|
+
* // "password": "my_password",
|
|
5688
|
+
* // "userType": "my_userType"
|
|
5689
|
+
* // }
|
|
5690
|
+
* }
|
|
5691
|
+
*
|
|
5692
|
+
* main().catch(e => {
|
|
5693
|
+
* console.error(e);
|
|
5694
|
+
* throw e;
|
|
5695
|
+
* });
|
|
5696
|
+
*
|
|
5697
|
+
* ```
|
|
3396
5698
|
*
|
|
3397
5699
|
* @param params - Parameters for request
|
|
3398
5700
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3399
5701
|
* @param callback - Optional callback that handles the response.
|
|
3400
5702
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3401
5703
|
*/
|
|
3402
|
-
get(params: Params$Resource$Projects$Locations$Clusters$Users$Get, options: StreamMethodOptions):
|
|
3403
|
-
get(params?: Params$Resource$Projects$Locations$Clusters$Users$Get, options?: MethodOptions):
|
|
5704
|
+
get(params: Params$Resource$Projects$Locations$Clusters$Users$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
5705
|
+
get(params?: Params$Resource$Projects$Locations$Clusters$Users$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$User>>;
|
|
3404
5706
|
get(params: Params$Resource$Projects$Locations$Clusters$Users$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3405
5707
|
get(params: Params$Resource$Projects$Locations$Clusters$Users$Get, options: MethodOptions | BodyResponseCallback<Schema$User>, callback: BodyResponseCallback<Schema$User>): void;
|
|
3406
5708
|
get(params: Params$Resource$Projects$Locations$Clusters$Users$Get, callback: BodyResponseCallback<Schema$User>): void;
|
|
3407
5709
|
get(callback: BodyResponseCallback<Schema$User>): void;
|
|
3408
5710
|
/**
|
|
3409
5711
|
* Lists Users in a given project and location.
|
|
5712
|
+
* @example
|
|
5713
|
+
* ```js
|
|
5714
|
+
* // Before running the sample:
|
|
5715
|
+
* // - Enable the API at:
|
|
5716
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
5717
|
+
* // - Login into gcloud by running:
|
|
5718
|
+
* // ```sh
|
|
5719
|
+
* // $ gcloud auth application-default login
|
|
5720
|
+
* // ```
|
|
5721
|
+
* // - Install the npm module by running:
|
|
5722
|
+
* // ```sh
|
|
5723
|
+
* // $ npm install googleapis
|
|
5724
|
+
* // ```
|
|
5725
|
+
*
|
|
5726
|
+
* const {google} = require('googleapis');
|
|
5727
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
5728
|
+
*
|
|
5729
|
+
* async function main() {
|
|
5730
|
+
* const auth = new google.auth.GoogleAuth({
|
|
5731
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
5732
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
5733
|
+
* });
|
|
5734
|
+
*
|
|
5735
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
5736
|
+
* const authClient = await auth.getClient();
|
|
5737
|
+
* google.options({auth: authClient});
|
|
5738
|
+
*
|
|
5739
|
+
* // Do the magic
|
|
5740
|
+
* const res = await alloydb.projects.locations.clusters.users.list({
|
|
5741
|
+
* // Optional. Filtering results
|
|
5742
|
+
* filter: 'placeholder-value',
|
|
5743
|
+
* // Optional. Hint for how to order the results
|
|
5744
|
+
* orderBy: 'placeholder-value',
|
|
5745
|
+
* // Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
|
|
5746
|
+
* pageSize: 'placeholder-value',
|
|
5747
|
+
* // Optional. A token identifying a page of results the server should return.
|
|
5748
|
+
* pageToken: 'placeholder-value',
|
|
5749
|
+
* // Required. Parent value for ListUsersRequest
|
|
5750
|
+
* parent: 'projects/my-project/locations/my-location/clusters/my-cluster',
|
|
5751
|
+
* });
|
|
5752
|
+
* console.log(res.data);
|
|
5753
|
+
*
|
|
5754
|
+
* // Example response
|
|
5755
|
+
* // {
|
|
5756
|
+
* // "nextPageToken": "my_nextPageToken",
|
|
5757
|
+
* // "unreachable": [],
|
|
5758
|
+
* // "users": []
|
|
5759
|
+
* // }
|
|
5760
|
+
* }
|
|
5761
|
+
*
|
|
5762
|
+
* main().catch(e => {
|
|
5763
|
+
* console.error(e);
|
|
5764
|
+
* throw e;
|
|
5765
|
+
* });
|
|
5766
|
+
*
|
|
5767
|
+
* ```
|
|
3410
5768
|
*
|
|
3411
5769
|
* @param params - Parameters for request
|
|
3412
5770
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3413
5771
|
* @param callback - Optional callback that handles the response.
|
|
3414
5772
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3415
5773
|
*/
|
|
3416
|
-
list(params: Params$Resource$Projects$Locations$Clusters$Users$List, options: StreamMethodOptions):
|
|
3417
|
-
list(params?: Params$Resource$Projects$Locations$Clusters$Users$List, options?: MethodOptions):
|
|
5774
|
+
list(params: Params$Resource$Projects$Locations$Clusters$Users$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
5775
|
+
list(params?: Params$Resource$Projects$Locations$Clusters$Users$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ListUsersResponse>>;
|
|
3418
5776
|
list(params: Params$Resource$Projects$Locations$Clusters$Users$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3419
5777
|
list(params: Params$Resource$Projects$Locations$Clusters$Users$List, options: MethodOptions | BodyResponseCallback<Schema$ListUsersResponse>, callback: BodyResponseCallback<Schema$ListUsersResponse>): void;
|
|
3420
5778
|
list(params: Params$Resource$Projects$Locations$Clusters$Users$List, callback: BodyResponseCallback<Schema$ListUsersResponse>): void;
|
|
3421
5779
|
list(callback: BodyResponseCallback<Schema$ListUsersResponse>): void;
|
|
3422
5780
|
/**
|
|
3423
5781
|
* Updates the parameters of a single User.
|
|
5782
|
+
* @example
|
|
5783
|
+
* ```js
|
|
5784
|
+
* // Before running the sample:
|
|
5785
|
+
* // - Enable the API at:
|
|
5786
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
5787
|
+
* // - Login into gcloud by running:
|
|
5788
|
+
* // ```sh
|
|
5789
|
+
* // $ gcloud auth application-default login
|
|
5790
|
+
* // ```
|
|
5791
|
+
* // - Install the npm module by running:
|
|
5792
|
+
* // ```sh
|
|
5793
|
+
* // $ npm install googleapis
|
|
5794
|
+
* // ```
|
|
5795
|
+
*
|
|
5796
|
+
* const {google} = require('googleapis');
|
|
5797
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
5798
|
+
*
|
|
5799
|
+
* async function main() {
|
|
5800
|
+
* const auth = new google.auth.GoogleAuth({
|
|
5801
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
5802
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
5803
|
+
* });
|
|
5804
|
+
*
|
|
5805
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
5806
|
+
* const authClient = await auth.getClient();
|
|
5807
|
+
* google.options({auth: authClient});
|
|
5808
|
+
*
|
|
5809
|
+
* // Do the magic
|
|
5810
|
+
* const res = await alloydb.projects.locations.clusters.users.patch({
|
|
5811
|
+
* // Optional. Allow missing fields in the update mask.
|
|
5812
|
+
* allowMissing: 'placeholder-value',
|
|
5813
|
+
* // Output only. Name of the resource in the form of projects/{project\}/locations/{location\}/cluster/{cluster\}/users/{user\}.
|
|
5814
|
+
* name: 'projects/my-project/locations/my-location/clusters/my-cluster/users/my-user',
|
|
5815
|
+
* // 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).
|
|
5816
|
+
* requestId: 'placeholder-value',
|
|
5817
|
+
* // 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.
|
|
5818
|
+
* updateMask: 'placeholder-value',
|
|
5819
|
+
* // Optional. If set, the backend validates the request, but doesn't actually execute it.
|
|
5820
|
+
* validateOnly: 'placeholder-value',
|
|
5821
|
+
*
|
|
5822
|
+
* // Request body metadata
|
|
5823
|
+
* requestBody: {
|
|
5824
|
+
* // request body parameters
|
|
5825
|
+
* // {
|
|
5826
|
+
* // "databaseRoles": [],
|
|
5827
|
+
* // "keepExtraRoles": false,
|
|
5828
|
+
* // "name": "my_name",
|
|
5829
|
+
* // "password": "my_password",
|
|
5830
|
+
* // "userType": "my_userType"
|
|
5831
|
+
* // }
|
|
5832
|
+
* },
|
|
5833
|
+
* });
|
|
5834
|
+
* console.log(res.data);
|
|
5835
|
+
*
|
|
5836
|
+
* // Example response
|
|
5837
|
+
* // {
|
|
5838
|
+
* // "databaseRoles": [],
|
|
5839
|
+
* // "keepExtraRoles": false,
|
|
5840
|
+
* // "name": "my_name",
|
|
5841
|
+
* // "password": "my_password",
|
|
5842
|
+
* // "userType": "my_userType"
|
|
5843
|
+
* // }
|
|
5844
|
+
* }
|
|
5845
|
+
*
|
|
5846
|
+
* main().catch(e => {
|
|
5847
|
+
* console.error(e);
|
|
5848
|
+
* throw e;
|
|
5849
|
+
* });
|
|
5850
|
+
*
|
|
5851
|
+
* ```
|
|
3424
5852
|
*
|
|
3425
5853
|
* @param params - Parameters for request
|
|
3426
5854
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3427
5855
|
* @param callback - Optional callback that handles the response.
|
|
3428
5856
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3429
5857
|
*/
|
|
3430
|
-
patch(params: Params$Resource$Projects$Locations$Clusters$Users$Patch, options: StreamMethodOptions):
|
|
3431
|
-
patch(params?: Params$Resource$Projects$Locations$Clusters$Users$Patch, options?: MethodOptions):
|
|
5858
|
+
patch(params: Params$Resource$Projects$Locations$Clusters$Users$Patch, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
5859
|
+
patch(params?: Params$Resource$Projects$Locations$Clusters$Users$Patch, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$User>>;
|
|
3432
5860
|
patch(params: Params$Resource$Projects$Locations$Clusters$Users$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3433
5861
|
patch(params: Params$Resource$Projects$Locations$Clusters$Users$Patch, options: MethodOptions | BodyResponseCallback<Schema$User>, callback: BodyResponseCallback<Schema$User>): void;
|
|
3434
5862
|
patch(params: Params$Resource$Projects$Locations$Clusters$Users$Patch, callback: BodyResponseCallback<Schema$User>): void;
|
|
@@ -3529,56 +5957,253 @@ export declare namespace alloydb_v1alpha {
|
|
|
3529
5957
|
constructor(context: APIRequestContext);
|
|
3530
5958
|
/**
|
|
3531
5959
|
* 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`.
|
|
5960
|
+
* @example
|
|
5961
|
+
* ```js
|
|
5962
|
+
* // Before running the sample:
|
|
5963
|
+
* // - Enable the API at:
|
|
5964
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
5965
|
+
* // - Login into gcloud by running:
|
|
5966
|
+
* // ```sh
|
|
5967
|
+
* // $ gcloud auth application-default login
|
|
5968
|
+
* // ```
|
|
5969
|
+
* // - Install the npm module by running:
|
|
5970
|
+
* // ```sh
|
|
5971
|
+
* // $ npm install googleapis
|
|
5972
|
+
* // ```
|
|
5973
|
+
*
|
|
5974
|
+
* const {google} = require('googleapis');
|
|
5975
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
5976
|
+
*
|
|
5977
|
+
* async function main() {
|
|
5978
|
+
* const auth = new google.auth.GoogleAuth({
|
|
5979
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
5980
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
5981
|
+
* });
|
|
5982
|
+
*
|
|
5983
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
5984
|
+
* const authClient = await auth.getClient();
|
|
5985
|
+
* google.options({auth: authClient});
|
|
5986
|
+
*
|
|
5987
|
+
* // Do the magic
|
|
5988
|
+
* const res = await alloydb.projects.locations.operations.cancel({
|
|
5989
|
+
* // The name of the operation resource to be cancelled.
|
|
5990
|
+
* name: 'projects/my-project/locations/my-location/operations/my-operation',
|
|
5991
|
+
*
|
|
5992
|
+
* // Request body metadata
|
|
5993
|
+
* requestBody: {
|
|
5994
|
+
* // request body parameters
|
|
5995
|
+
* // {}
|
|
5996
|
+
* },
|
|
5997
|
+
* });
|
|
5998
|
+
* console.log(res.data);
|
|
5999
|
+
*
|
|
6000
|
+
* // Example response
|
|
6001
|
+
* // {}
|
|
6002
|
+
* }
|
|
6003
|
+
*
|
|
6004
|
+
* main().catch(e => {
|
|
6005
|
+
* console.error(e);
|
|
6006
|
+
* throw e;
|
|
6007
|
+
* });
|
|
6008
|
+
*
|
|
6009
|
+
* ```
|
|
3532
6010
|
*
|
|
3533
6011
|
* @param params - Parameters for request
|
|
3534
6012
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3535
6013
|
* @param callback - Optional callback that handles the response.
|
|
3536
6014
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3537
6015
|
*/
|
|
3538
|
-
cancel(params: Params$Resource$Projects$Locations$Operations$Cancel, options: StreamMethodOptions):
|
|
3539
|
-
cancel(params?: Params$Resource$Projects$Locations$Operations$Cancel, options?: MethodOptions):
|
|
6016
|
+
cancel(params: Params$Resource$Projects$Locations$Operations$Cancel, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
6017
|
+
cancel(params?: Params$Resource$Projects$Locations$Operations$Cancel, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Empty>>;
|
|
3540
6018
|
cancel(params: Params$Resource$Projects$Locations$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3541
6019
|
cancel(params: Params$Resource$Projects$Locations$Operations$Cancel, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
|
|
3542
6020
|
cancel(params: Params$Resource$Projects$Locations$Operations$Cancel, callback: BodyResponseCallback<Schema$Empty>): void;
|
|
3543
6021
|
cancel(callback: BodyResponseCallback<Schema$Empty>): void;
|
|
3544
6022
|
/**
|
|
3545
6023
|
* 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`.
|
|
6024
|
+
* @example
|
|
6025
|
+
* ```js
|
|
6026
|
+
* // Before running the sample:
|
|
6027
|
+
* // - Enable the API at:
|
|
6028
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
6029
|
+
* // - Login into gcloud by running:
|
|
6030
|
+
* // ```sh
|
|
6031
|
+
* // $ gcloud auth application-default login
|
|
6032
|
+
* // ```
|
|
6033
|
+
* // - Install the npm module by running:
|
|
6034
|
+
* // ```sh
|
|
6035
|
+
* // $ npm install googleapis
|
|
6036
|
+
* // ```
|
|
6037
|
+
*
|
|
6038
|
+
* const {google} = require('googleapis');
|
|
6039
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
6040
|
+
*
|
|
6041
|
+
* async function main() {
|
|
6042
|
+
* const auth = new google.auth.GoogleAuth({
|
|
6043
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
6044
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
6045
|
+
* });
|
|
6046
|
+
*
|
|
6047
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
6048
|
+
* const authClient = await auth.getClient();
|
|
6049
|
+
* google.options({auth: authClient});
|
|
6050
|
+
*
|
|
6051
|
+
* // Do the magic
|
|
6052
|
+
* const res = await alloydb.projects.locations.operations.delete({
|
|
6053
|
+
* // The name of the operation resource to be deleted.
|
|
6054
|
+
* name: 'projects/my-project/locations/my-location/operations/my-operation',
|
|
6055
|
+
* });
|
|
6056
|
+
* console.log(res.data);
|
|
6057
|
+
*
|
|
6058
|
+
* // Example response
|
|
6059
|
+
* // {}
|
|
6060
|
+
* }
|
|
6061
|
+
*
|
|
6062
|
+
* main().catch(e => {
|
|
6063
|
+
* console.error(e);
|
|
6064
|
+
* throw e;
|
|
6065
|
+
* });
|
|
6066
|
+
*
|
|
6067
|
+
* ```
|
|
3546
6068
|
*
|
|
3547
6069
|
* @param params - Parameters for request
|
|
3548
6070
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3549
6071
|
* @param callback - Optional callback that handles the response.
|
|
3550
6072
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3551
6073
|
*/
|
|
3552
|
-
delete(params: Params$Resource$Projects$Locations$Operations$Delete, options: StreamMethodOptions):
|
|
3553
|
-
delete(params?: Params$Resource$Projects$Locations$Operations$Delete, options?: MethodOptions):
|
|
6074
|
+
delete(params: Params$Resource$Projects$Locations$Operations$Delete, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
6075
|
+
delete(params?: Params$Resource$Projects$Locations$Operations$Delete, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Empty>>;
|
|
3554
6076
|
delete(params: Params$Resource$Projects$Locations$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3555
6077
|
delete(params: Params$Resource$Projects$Locations$Operations$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
|
|
3556
6078
|
delete(params: Params$Resource$Projects$Locations$Operations$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
|
|
3557
6079
|
delete(callback: BodyResponseCallback<Schema$Empty>): void;
|
|
3558
6080
|
/**
|
|
3559
6081
|
* 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.
|
|
6082
|
+
* @example
|
|
6083
|
+
* ```js
|
|
6084
|
+
* // Before running the sample:
|
|
6085
|
+
* // - Enable the API at:
|
|
6086
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
6087
|
+
* // - Login into gcloud by running:
|
|
6088
|
+
* // ```sh
|
|
6089
|
+
* // $ gcloud auth application-default login
|
|
6090
|
+
* // ```
|
|
6091
|
+
* // - Install the npm module by running:
|
|
6092
|
+
* // ```sh
|
|
6093
|
+
* // $ npm install googleapis
|
|
6094
|
+
* // ```
|
|
6095
|
+
*
|
|
6096
|
+
* const {google} = require('googleapis');
|
|
6097
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
6098
|
+
*
|
|
6099
|
+
* async function main() {
|
|
6100
|
+
* const auth = new google.auth.GoogleAuth({
|
|
6101
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
6102
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
6103
|
+
* });
|
|
6104
|
+
*
|
|
6105
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
6106
|
+
* const authClient = await auth.getClient();
|
|
6107
|
+
* google.options({auth: authClient});
|
|
6108
|
+
*
|
|
6109
|
+
* // Do the magic
|
|
6110
|
+
* const res = await alloydb.projects.locations.operations.get({
|
|
6111
|
+
* // The name of the operation resource.
|
|
6112
|
+
* name: 'projects/my-project/locations/my-location/operations/my-operation',
|
|
6113
|
+
* });
|
|
6114
|
+
* console.log(res.data);
|
|
6115
|
+
*
|
|
6116
|
+
* // Example response
|
|
6117
|
+
* // {
|
|
6118
|
+
* // "done": false,
|
|
6119
|
+
* // "error": {},
|
|
6120
|
+
* // "metadata": {},
|
|
6121
|
+
* // "name": "my_name",
|
|
6122
|
+
* // "response": {}
|
|
6123
|
+
* // }
|
|
6124
|
+
* }
|
|
6125
|
+
*
|
|
6126
|
+
* main().catch(e => {
|
|
6127
|
+
* console.error(e);
|
|
6128
|
+
* throw e;
|
|
6129
|
+
* });
|
|
6130
|
+
*
|
|
6131
|
+
* ```
|
|
3560
6132
|
*
|
|
3561
6133
|
* @param params - Parameters for request
|
|
3562
6134
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3563
6135
|
* @param callback - Optional callback that handles the response.
|
|
3564
6136
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3565
6137
|
*/
|
|
3566
|
-
get(params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions):
|
|
3567
|
-
get(params?: Params$Resource$Projects$Locations$Operations$Get, options?: MethodOptions):
|
|
6138
|
+
get(params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
6139
|
+
get(params?: Params$Resource$Projects$Locations$Operations$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Operation>>;
|
|
3568
6140
|
get(params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3569
6141
|
get(params: Params$Resource$Projects$Locations$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
3570
6142
|
get(params: Params$Resource$Projects$Locations$Operations$Get, callback: BodyResponseCallback<Schema$Operation>): void;
|
|
3571
6143
|
get(callback: BodyResponseCallback<Schema$Operation>): void;
|
|
3572
6144
|
/**
|
|
3573
6145
|
* Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
|
|
6146
|
+
* @example
|
|
6147
|
+
* ```js
|
|
6148
|
+
* // Before running the sample:
|
|
6149
|
+
* // - Enable the API at:
|
|
6150
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
6151
|
+
* // - Login into gcloud by running:
|
|
6152
|
+
* // ```sh
|
|
6153
|
+
* // $ gcloud auth application-default login
|
|
6154
|
+
* // ```
|
|
6155
|
+
* // - Install the npm module by running:
|
|
6156
|
+
* // ```sh
|
|
6157
|
+
* // $ npm install googleapis
|
|
6158
|
+
* // ```
|
|
6159
|
+
*
|
|
6160
|
+
* const {google} = require('googleapis');
|
|
6161
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
6162
|
+
*
|
|
6163
|
+
* async function main() {
|
|
6164
|
+
* const auth = new google.auth.GoogleAuth({
|
|
6165
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
6166
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
6167
|
+
* });
|
|
6168
|
+
*
|
|
6169
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
6170
|
+
* const authClient = await auth.getClient();
|
|
6171
|
+
* google.options({auth: authClient});
|
|
6172
|
+
*
|
|
6173
|
+
* // Do the magic
|
|
6174
|
+
* const res = await alloydb.projects.locations.operations.list({
|
|
6175
|
+
* // The standard list filter.
|
|
6176
|
+
* filter: 'placeholder-value',
|
|
6177
|
+
* // The name of the operation's parent resource.
|
|
6178
|
+
* name: 'projects/my-project/locations/my-location',
|
|
6179
|
+
* // The standard list page size.
|
|
6180
|
+
* pageSize: 'placeholder-value',
|
|
6181
|
+
* // The standard list page token.
|
|
6182
|
+
* pageToken: 'placeholder-value',
|
|
6183
|
+
* });
|
|
6184
|
+
* console.log(res.data);
|
|
6185
|
+
*
|
|
6186
|
+
* // Example response
|
|
6187
|
+
* // {
|
|
6188
|
+
* // "nextPageToken": "my_nextPageToken",
|
|
6189
|
+
* // "operations": []
|
|
6190
|
+
* // }
|
|
6191
|
+
* }
|
|
6192
|
+
*
|
|
6193
|
+
* main().catch(e => {
|
|
6194
|
+
* console.error(e);
|
|
6195
|
+
* throw e;
|
|
6196
|
+
* });
|
|
6197
|
+
*
|
|
6198
|
+
* ```
|
|
3574
6199
|
*
|
|
3575
6200
|
* @param params - Parameters for request
|
|
3576
6201
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3577
6202
|
* @param callback - Optional callback that handles the response.
|
|
3578
6203
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3579
6204
|
*/
|
|
3580
|
-
list(params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions):
|
|
3581
|
-
list(params?: Params$Resource$Projects$Locations$Operations$List, options?: MethodOptions):
|
|
6205
|
+
list(params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
6206
|
+
list(params?: Params$Resource$Projects$Locations$Operations$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ListOperationsResponse>>;
|
|
3582
6207
|
list(params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3583
6208
|
list(params: Params$Resource$Projects$Locations$Operations$List, options: MethodOptions | BodyResponseCallback<Schema$ListOperationsResponse>, callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
|
|
3584
6209
|
list(params: Params$Resource$Projects$Locations$Operations$List, callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
|
|
@@ -3629,14 +6254,67 @@ export declare namespace alloydb_v1alpha {
|
|
|
3629
6254
|
constructor(context: APIRequestContext);
|
|
3630
6255
|
/**
|
|
3631
6256
|
* Lists SupportedDatabaseFlags for a given project and location.
|
|
6257
|
+
* @example
|
|
6258
|
+
* ```js
|
|
6259
|
+
* // Before running the sample:
|
|
6260
|
+
* // - Enable the API at:
|
|
6261
|
+
* // https://console.developers.google.com/apis/api/alloydb.googleapis.com
|
|
6262
|
+
* // - Login into gcloud by running:
|
|
6263
|
+
* // ```sh
|
|
6264
|
+
* // $ gcloud auth application-default login
|
|
6265
|
+
* // ```
|
|
6266
|
+
* // - Install the npm module by running:
|
|
6267
|
+
* // ```sh
|
|
6268
|
+
* // $ npm install googleapis
|
|
6269
|
+
* // ```
|
|
6270
|
+
*
|
|
6271
|
+
* const {google} = require('googleapis');
|
|
6272
|
+
* const alloydb = google.alloydb('v1alpha');
|
|
6273
|
+
*
|
|
6274
|
+
* async function main() {
|
|
6275
|
+
* const auth = new google.auth.GoogleAuth({
|
|
6276
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
6277
|
+
* scopes: ['https://www.googleapis.com/auth/cloud-platform'],
|
|
6278
|
+
* });
|
|
6279
|
+
*
|
|
6280
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
6281
|
+
* const authClient = await auth.getClient();
|
|
6282
|
+
* google.options({auth: authClient});
|
|
6283
|
+
*
|
|
6284
|
+
* // Do the magic
|
|
6285
|
+
* const res = await alloydb.projects.locations.supportedDatabaseFlags.list({
|
|
6286
|
+
* // Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
|
|
6287
|
+
* pageSize: 'placeholder-value',
|
|
6288
|
+
* // A token identifying a page of results the server should return.
|
|
6289
|
+
* pageToken: 'placeholder-value',
|
|
6290
|
+
* // 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.
|
|
6291
|
+
* parent: 'projects/my-project/locations/my-location',
|
|
6292
|
+
* // Optional. The scope for which supported flags are requested. If not specified, default is DATABASE.
|
|
6293
|
+
* scope: 'placeholder-value',
|
|
6294
|
+
* });
|
|
6295
|
+
* console.log(res.data);
|
|
6296
|
+
*
|
|
6297
|
+
* // Example response
|
|
6298
|
+
* // {
|
|
6299
|
+
* // "nextPageToken": "my_nextPageToken",
|
|
6300
|
+
* // "supportedDatabaseFlags": []
|
|
6301
|
+
* // }
|
|
6302
|
+
* }
|
|
6303
|
+
*
|
|
6304
|
+
* main().catch(e => {
|
|
6305
|
+
* console.error(e);
|
|
6306
|
+
* throw e;
|
|
6307
|
+
* });
|
|
6308
|
+
*
|
|
6309
|
+
* ```
|
|
3632
6310
|
*
|
|
3633
6311
|
* @param params - Parameters for request
|
|
3634
6312
|
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
3635
6313
|
* @param callback - Optional callback that handles the response.
|
|
3636
6314
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
3637
6315
|
*/
|
|
3638
|
-
list(params: Params$Resource$Projects$Locations$Supporteddatabaseflags$List, options: StreamMethodOptions):
|
|
3639
|
-
list(params?: Params$Resource$Projects$Locations$Supporteddatabaseflags$List, options?: MethodOptions):
|
|
6316
|
+
list(params: Params$Resource$Projects$Locations$Supporteddatabaseflags$List, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
6317
|
+
list(params?: Params$Resource$Projects$Locations$Supporteddatabaseflags$List, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$ListSupportedDatabaseFlagsResponse>>;
|
|
3640
6318
|
list(params: Params$Resource$Projects$Locations$Supporteddatabaseflags$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
3641
6319
|
list(params: Params$Resource$Projects$Locations$Supporteddatabaseflags$List, options: MethodOptions | BodyResponseCallback<Schema$ListSupportedDatabaseFlagsResponse>, callback: BodyResponseCallback<Schema$ListSupportedDatabaseFlagsResponse>): void;
|
|
3642
6320
|
list(params: Params$Resource$Projects$Locations$Supporteddatabaseflags$List, callback: BodyResponseCallback<Schema$ListSupportedDatabaseFlagsResponse>): void;
|