Service describing handlers for resources v1alpha
Package
@google-cloud/alloydbConstructors
(constructor)(opts, gaxInstance)
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
Construct an instance of AlloyDBAdminClient.
Parameters | |
---|---|
Name | Description |
opts |
ClientOptions
|
gaxInstance |
typeof gax | typeof fallback
: loaded instance of |
Properties
alloyDBAdminStub
alloyDBAdminStub?: Promise<{
[name: string]: Function;
}>;
apiEndpoint
get apiEndpoint(): string;
The DNS address for this API service.
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath.
auth
auth: gax.GoogleAuth;
descriptors
descriptors: Descriptors;
iamClient
iamClient: IamClient;
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
locationsClient
locationsClient: LocationsClient;
operationsClient
operationsClient: gax.OperationsClient;
pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};
port
static get port(): number;
The port for this API service.
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static get servicePath(): string;
The DNS address for this API service.
universeDomain
get universeDomain(): string;
warn
warn: (code: string, message: string, warnType?: string) => void;
Methods
backupPath(project, location, backup)
backupPath(project: string, location: string, backup: string): string;
Return a fully-qualified backup resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
backup |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
batchCreateInstances(request, options)
batchCreateInstances(request?: protos.google.cloud.alloydb.v1alpha.IBatchCreateInstancesRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.alloydb.v1alpha.IBatchCreateInstancesResponse, protos.google.cloud.alloydb.v1alpha.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Creates new instances under the given project, location and cluster. There can be only one primary instance in a cluster. If the primary instance exists in the cluster as well as this request, then API will throw an error. The primary instance should exist before any read pool instance is created. If the primary instance is a part of the request payload, then the API will take care of creating instances in the correct order. This method is here to support Google-internal use cases, and is not meant for external customers to consume. Please do not start relying on it; its behavior is subject to change without notice.
Parameters | |
---|---|
Name | Description |
request |
IBatchCreateInstancesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.alloydb.v1alpha.IBatchCreateInstancesResponse, protos.google.cloud.alloydb.v1alpha.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the parent resource.
*/
// const parent = 'abc123'
/**
* Required. Resources being created.
*/
// const requests = {}
/**
* Optional. An optional request ID to identify requests. Specify a unique
* request ID so that if you must retry your request, the server will know to
* ignore the request if it has already been completed. The server will
* guarantee 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 original operation with the same request ID
* was received, and if so, will ignore 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).
*/
// const requestId = 'abc123'
// Imports the Alloydb library
const {AlloyDBAdminClient} = require('@google-cloud/alloydb').v1alpha;
// Instantiates a client
const alloydbClient = new AlloyDBAdminClient();
async function callBatchCreateInstances() {
// Construct request
const request = {
parent,
requests,
};
// Run request
const [operation] = await alloydbClient.batchCreateInstances(request);
const [response] = await operation.promise();
console.log(response);
}
callBatchCreateInstances();
batchCreateInstances(request, options, callback)
batchCreateInstances(request: protos.google.cloud.alloydb.v1alpha.IBatchCreateInstancesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.alloydb.v1alpha.IBatchCreateInstancesResponse, protos.google.cloud.alloydb.v1alpha.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IBatchCreateInstancesRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.alloydb.v1alpha.IBatchCreateInstancesResponse, protos.google.cloud.alloydb.v1alpha.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
batchCreateInstances(request, callback)
batchCreateInstances(request: protos.google.cloud.alloydb.v1alpha.IBatchCreateInstancesRequest, callback: Callback<LROperation<protos.google.cloud.alloydb.v1alpha.IBatchCreateInstancesResponse, protos.google.cloud.alloydb.v1alpha.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IBatchCreateInstancesRequest
|
callback |
Callback<LROperation<protos.google.cloud.alloydb.v1alpha.IBatchCreateInstancesResponse, protos.google.cloud.alloydb.v1alpha.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
cancelOperation(request, options, callback)
cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;
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 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 value with a of 1, corresponding to Code.CANCELLED
.
Parameters | |
---|---|
Name | Description |
request |
CancelOperationRequest
The request object that will be sent. |
options |
CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
callback |
Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call. |
Returns | |
---|---|
Type | Description |
Promise<protos.google.protobuf.Empty> |
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
checkBatchCreateInstancesProgress(name)
checkBatchCreateInstancesProgress(name: string): Promise<LROperation<protos.google.cloud.alloydb.v1alpha.BatchCreateInstancesResponse, protos.google.cloud.alloydb.v1alpha.OperationMetadata>>;
Check the status of the long running operation returned by batchCreateInstances()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.alloydb.v1alpha.BatchCreateInstancesResponse, protos.google.cloud.alloydb.v1alpha.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the parent resource.
*/
// const parent = 'abc123'
/**
* Required. Resources being created.
*/
// const requests = {}
/**
* Optional. An optional request ID to identify requests. Specify a unique
* request ID so that if you must retry your request, the server will know to
* ignore the request if it has already been completed. The server will
* guarantee 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 original operation with the same request ID
* was received, and if so, will ignore 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).
*/
// const requestId = 'abc123'
// Imports the Alloydb library
const {AlloyDBAdminClient} = require('@google-cloud/alloydb').v1alpha;
// Instantiates a client
const alloydbClient = new AlloyDBAdminClient();
async function callBatchCreateInstances() {
// Construct request
const request = {
parent,
requests,
};
// Run request
const [operation] = await alloydbClient.batchCreateInstances(request);
const [response] = await operation.promise();
console.log(response);
}
callBatchCreateInstances();
checkCreateBackupProgress(name)
checkCreateBackupProgress(name: string): Promise<LROperation<protos.google.cloud.alloydb.v1alpha.Backup, protos.google.cloud.alloydb.v1alpha.OperationMetadata>>;
Check the status of the long running operation returned by createBackup()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.alloydb.v1alpha.Backup, protos.google.cloud.alloydb.v1alpha.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Value for parent.
*/
// const parent = 'abc123'
/**
* Required. ID of the requesting object.
*/
// const backupId = 'abc123'
/**
* Required. The resource being created
*/
// const backup = {}
/**
* Optional. An optional request ID to identify requests. Specify a unique
* request ID so that if you must retry your request, the server will know to
* ignore the request if it has already been completed. The server will
* guarantee 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 original operation with the same request ID
* was received, and if so, will ignore 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).
*/
// const requestId = 'abc123'
/**
* Optional. If set, the backend validates the request, but doesn't actually
* execute it.
*/
// const validateOnly = true
// Imports the Alloydb library
const {AlloyDBAdminClient} = require('@google-cloud/alloydb').v1alpha;
// Instantiates a client
const alloydbClient = new AlloyDBAdminClient();
async function callCreateBackup() {
// Construct request
const request = {
parent,
backupId,
backup,
};
// Run request
const [operation] = await alloydbClient.createBackup(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateBackup();
checkCreateClusterProgress(name)
checkCreateClusterProgress(name: string): Promise<LROperation<protos.google.cloud.alloydb.v1alpha.Cluster, protos.google.cloud.alloydb.v1alpha.OperationMetadata>>;
Check the status of the long running operation returned by createCluster()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.alloydb.v1alpha.Cluster, protos.google.cloud.alloydb.v1alpha.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The location of the new cluster. For the required format, see the
* comment on the Cluster.name field.
*/
// const parent = 'abc123'
/**
* Required. ID of the requesting object.
*/
// const clusterId = 'abc123'
/**
* Required. The resource being created
*/
// const cluster = {}
/**
* Optional. An optional request ID to identify requests. Specify a unique
* request ID so that if you must retry your request, the server will know to
* ignore the request if it has already been completed. The server will
* guarantee 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 original operation with the same request ID
* was received, and if so, will ignore 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).
*/
// const requestId = 'abc123'
/**
* Optional. If set, performs request validation (e.g. permission checks and
* any other type of validation), but do not actually execute the create
* request.
*/
// const validateOnly = true
// Imports the Alloydb library
const {AlloyDBAdminClient} = require('@google-cloud/alloydb').v1alpha;
// Instantiates a client
const alloydbClient = new AlloyDBAdminClient();
async function callCreateCluster() {
// Construct request
const request = {
parent,
clusterId,
cluster,
};
// Run request
const [operation] = await alloydbClient.createCluster(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateCluster();
checkCreateInstanceProgress(name)
checkCreateInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.alloydb.v1alpha.Instance, protos.google.cloud.alloydb.v1alpha.OperationMetadata>>;
Check the status of the long running operation returned by createInstance()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.alloydb.v1alpha.Instance, protos.google.cloud.alloydb.v1alpha.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the parent resource. For the required format, see the
* comment on the Instance.name field.
*/
// const parent = 'abc123'
/**
* Required. ID of the requesting object.
*/
// const instanceId = 'abc123'
/**
* Required. The resource being created
*/
// const instance = {}
/**
* Optional. An optional request ID to identify requests. Specify a unique
* request ID so that if you must retry your request, the server will know to
* ignore the request if it has already been completed. The server will
* guarantee 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 original operation with the same request ID
* was received, and if so, will ignore 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).
*/
// const requestId = 'abc123'
/**
* Optional. If set, performs request validation (e.g. permission checks and
* any other type of validation), but do not actually execute the create
* request.
*/
// const validateOnly = true
// Imports the Alloydb library
const {AlloyDBAdminClient} = require('@google-cloud/alloydb').v1alpha;
// Instantiates a client
const alloydbClient = new AlloyDBAdminClient();
async function callCreateInstance() {
// Construct request
const request = {
parent,
instanceId,
instance,
};
// Run request
const [operation] = await alloydbClient.createInstance(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateInstance();
checkCreateSecondaryClusterProgress(name)
checkCreateSecondaryClusterProgress(name: string): Promise<LROperation<protos.google.cloud.alloydb.v1alpha.Cluster, protos.google.cloud.alloydb.v1alpha.OperationMetadata>>;
Check the status of the long running operation returned by createSecondaryCluster()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.alloydb.v1alpha.Cluster, protos.google.cloud.alloydb.v1alpha.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The location of the new cluster. For the required
* format, see the comment on the Cluster.name field.
*/
// const parent = 'abc123'
/**
* Required. ID of the requesting object (the secondary cluster).
*/
// const clusterId = 'abc123'
/**
* Required. Configuration of the requesting object (the secondary cluster).
*/
// const cluster = {}
/**
* Optional. An optional request ID to identify requests. Specify a unique
* request ID so that if you must retry your request, the server will know to
* ignore the request if it has already been completed. The server will
* guarantee 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 original operation with the same request ID
* was received, and if so, will ignore 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).
*/
// const requestId = 'abc123'
/**
* Optional. If set, performs request validation (e.g. permission checks and
* any other type of validation), but do not actually execute the create
* request.
*/
// const validateOnly = true
// Imports the Alloydb library
const {AlloyDBAdminClient} = require('@google-cloud/alloydb').v1alpha;
// Instantiates a client
const alloydbClient = new AlloyDBAdminClient();
async function callCreateSecondaryCluster() {
// Construct request
const request = {
parent,
clusterId,
cluster,
};
// Run request
const [operation] = await alloydbClient.createSecondaryCluster(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateSecondaryCluster();
checkCreateSecondaryInstanceProgress(name)
checkCreateSecondaryInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.alloydb.v1alpha.Instance, protos.google.cloud.alloydb.v1alpha.OperationMetadata>>;
Check the status of the long running operation returned by createSecondaryInstance()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.alloydb.v1alpha.Instance, protos.google.cloud.alloydb.v1alpha.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the parent resource. For the required format, see the
* comment on the Instance.name field.
*/
// const parent = 'abc123'
/**
* Required. ID of the requesting object.
*/
// const instanceId = 'abc123'
/**
* Required. The resource being created
*/
// const instance = {}
/**
* Optional. An optional request ID to identify requests. Specify a unique
* request ID so that if you must retry your request, the server will know to
* ignore the request if it has already been completed. The server will
* guarantee 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 original operation with the same request ID
* was received, and if so, will ignore 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).
*/
// const requestId = 'abc123'
/**
* Optional. If set, performs request validation (e.g. permission checks and
* any other type of validation), but do not actually execute the create
* request.
*/
// const validateOnly = true
// Imports the Alloydb library
const {AlloyDBAdminClient} = require('@google-cloud/alloydb').v1alpha;
// Instantiates a client
const alloydbClient = new AlloyDBAdminClient();
async function callCreateSecondaryInstance() {
// Construct request
const request = {
parent,
instanceId,
instance,
};
// Run request
const [operation] = await alloydbClient.createSecondaryInstance(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateSecondaryInstance();
checkDeleteBackupProgress(name)
checkDeleteBackupProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.alloydb.v1alpha.OperationMetadata>>;
Check the status of the long running operation returned by deleteBackup()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.alloydb.v1alpha.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the resource. For the required format, see the comment on
* the Backup.name field.
*/
// const name = 'abc123'
/**
* Optional. An optional request ID to identify requests. Specify a unique
* request ID so that if you must retry your request, the server will know to
* ignore the request if it has already been completed. The server will
* guarantee that for at least 60 minutes after 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 original operation with the same request ID
* was received, and if so, will ignore 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).
*/
// const requestId = 'abc123'
/**
* Optional. If set, the backend validates the request, but doesn't actually
* execute it.
*/
// const validateOnly = true
/**
* 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.
*/
// const etag = 'abc123'
// Imports the Alloydb library
const {AlloyDBAdminClient} = require('@google-cloud/alloydb').v1alpha;
// Instantiates a client
const alloydbClient = new AlloyDBAdminClient();
async function callDeleteBackup() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await alloydbClient.deleteBackup(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteBackup();
checkDeleteClusterProgress(name)
checkDeleteClusterProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.alloydb.v1alpha.OperationMetadata>>;
Check the status of the long running operation returned by deleteCluster()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.alloydb.v1alpha.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the resource. For the required format, see the
* comment on the Cluster.name field.
*/
// const name = 'abc123'
/**
* Optional. An optional request ID to identify requests. Specify a unique
* request ID so that if you must retry your request, the server will know to
* ignore the request if it has already been completed. The server will
* guarantee that for at least 60 minutes after 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 original operation with the same request ID
* was received, and if so, will ignore 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).
*/
// const requestId = 'abc123'
/**
* 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.
*/
// const etag = 'abc123'
/**
* Optional. If set, performs request validation (e.g. permission checks and
* any other type of validation), but do not actually execute the delete.
*/
// const validateOnly = true
/**
* Optional. Whether to cascade delete child instances for given cluster.
*/
// const force = true
// Imports the Alloydb library
const {AlloyDBAdminClient} = require('@google-cloud/alloydb').v1alpha;
// Instantiates a client
const alloydbClient = new AlloyDBAdminClient();
async function callDeleteCluster() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await alloydbClient.deleteCluster(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteCluster();
checkDeleteInstanceProgress(name)
checkDeleteInstanceProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.alloydb.v1alpha.OperationMetadata>>;
Check the status of the long running operation returned by deleteInstance()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.alloydb.v1alpha.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the resource. For the required format, see the
* comment on the Instance.name field.
*/
// const name = 'abc123'
/**
* Optional. An optional request ID to identify requests. Specify a unique
* request ID so that if you must retry your request, the server will know to
* ignore the request if it has already been completed. The server will
* guarantee that for at least 60 minutes after 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 original operation with the same request ID
* was received, and if so, will ignore 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).
*/
// const requestId = 'abc123'
/**
* 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.
*/
// const etag = 'abc123'
/**
* Optional. If set, performs request validation (e.g. permission checks and
* any other type of validation), but do not actually execute the delete.
*/
// const validateOnly = true
// Imports the Alloydb library
const {AlloyDBAdminClient} = require('@google-cloud/alloydb').v1alpha;
// Instantiates a client
const alloydbClient = new AlloyDBAdminClient();
async function callDeleteInstance() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await alloydbClient.deleteInstance(request);
const [response] = await operation.promise();
console.log(response);
}
callDeleteInstance();
checkFailoverInstanceProgress(name)
checkFailoverInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.alloydb.v1alpha.Instance, protos.google.cloud.alloydb.v1alpha.OperationMetadata>>;
Check the status of the long running operation returned by failoverInstance()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.alloydb.v1alpha.Instance, protos.google.cloud.alloydb.v1alpha.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the resource. For the required format, see the
* comment on the Instance.name field.
*/
// const name = 'abc123'
/**
* Optional. An optional request ID to identify requests. Specify a unique
* request ID so that if you must retry your request, the server will know to
* ignore the request if it has already been completed. The server will
* guarantee that for at least 60 minutes after 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 original operation with the same request ID
* was received, and if so, will ignore 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).
*/
// const requestId = 'abc123'
/**
* Optional. If set, performs request validation (e.g. permission checks and
* any other type of validation), but do not actually execute the failover.
*/
// const validateOnly = true
// Imports the Alloydb library
const {AlloyDBAdminClient} = require('@google-cloud/alloydb').v1alpha;
// Instantiates a client
const alloydbClient = new AlloyDBAdminClient();
async function callFailoverInstance() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await alloydbClient.failoverInstance(request);
const [response] = await operation.promise();
console.log(response);
}
callFailoverInstance();
checkInjectFaultProgress(name)
checkInjectFaultProgress(name: string): Promise<LROperation<protos.google.cloud.alloydb.v1alpha.Instance, protos.google.cloud.alloydb.v1alpha.OperationMetadata>>;
Check the status of the long running operation returned by injectFault()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.alloydb.v1alpha.Instance, protos.google.cloud.alloydb.v1alpha.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The type of fault to be injected in an instance.
*/
// const faultType = {}
/**
* Required. The name of the resource. For the required format, see the
* comment on the Instance.name field.
*/
// const name = 'abc123'
/**
* Optional. An optional request ID to identify requests. Specify a unique
* request ID so that if you must retry your request, the server will know to
* ignore the request if it has already been completed. The server will
* guarantee that for at least 60 minutes after 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 original operation with the same request ID
* was received, and if so, will ignore 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).
*/
// const requestId = 'abc123'
/**
* Optional. If set, performs request validation (e.g. permission checks and
* any other type of validation), but do not actually execute the fault
* injection.
*/
// const validateOnly = true
// Imports the Alloydb library
const {AlloyDBAdminClient} = require('@google-cloud/alloydb').v1alpha;
// Instantiates a client
const alloydbClient = new AlloyDBAdminClient();
async function callInjectFault() {
// Construct request
const request = {
faultType,
name,
};
// Run request
const [operation] = await alloydbClient.injectFault(request);
const [response] = await operation.promise();
console.log(response);
}
callInjectFault();
checkPromoteClusterProgress(name)
checkPromoteClusterProgress(name: string): Promise<LROperation<protos.google.cloud.alloydb.v1alpha.Cluster, protos.google.cloud.alloydb.v1alpha.OperationMetadata>>;
Check the status of the long running operation returned by promoteCluster()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.alloydb.v1alpha.Cluster, protos.google.cloud.alloydb.v1alpha.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the resource. For the required format, see the
* comment on the Cluster.name field
*/
// const name = 'abc123'
/**
* Optional. An optional request ID to identify requests. Specify a unique
* request ID so that if you must retry your request, the server will know to
* ignore the request if it has already been completed. The server will
* guarantee that for at least 60 minutes after 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 original operation with the same request ID
* was received, and if so, will ignore 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).
*/
// const requestId = 'abc123'
/**
* 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.
*/
// const etag = 'abc123'
/**
* Optional. If set, performs request validation (e.g. permission checks and
* any other type of validation), but do not actually execute the delete.
*/
// const validateOnly = true
// Imports the Alloydb library
const {AlloyDBAdminClient} = require('@google-cloud/alloydb').v1alpha;
// Instantiates a client
const alloydbClient = new AlloyDBAdminClient();
async function callPromoteCluster() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await alloydbClient.promoteCluster(request);
const [response] = await operation.promise();
console.log(response);
}
callPromoteCluster();
checkRestartInstanceProgress(name)
checkRestartInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.alloydb.v1alpha.Instance, protos.google.cloud.alloydb.v1alpha.OperationMetadata>>;
Check the status of the long running operation returned by restartInstance()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.alloydb.v1alpha.Instance, protos.google.cloud.alloydb.v1alpha.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the resource. For the required format, see the
* comment on the Instance.name field.
*/
// const name = 'abc123'
/**
* Optional. An optional request ID to identify requests. Specify a unique
* request ID so that if you must retry your request, the server will know to
* ignore the request if it has already been completed. The server will
* guarantee that for at least 60 minutes after 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 original operation with the same request ID
* was received, and if so, will ignore 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).
*/
// const requestId = 'abc123'
/**
* Optional. If set, performs request validation (e.g. permission checks and
* any other type of validation), but do not actually execute the restart.
*/
// const validateOnly = true
// Imports the Alloydb library
const {AlloyDBAdminClient} = require('@google-cloud/alloydb').v1alpha;
// Instantiates a client
const alloydbClient = new AlloyDBAdminClient();
async function callRestartInstance() {
// Construct request
const request = {
name,
};
// Run request
const [operation] = await alloydbClient.restartInstance(request);
const [response] = await operation.promise();
console.log(response);
}
callRestartInstance();
checkRestoreClusterProgress(name)
checkRestoreClusterProgress(name: string): Promise<LROperation<protos.google.cloud.alloydb.v1alpha.Cluster, protos.google.cloud.alloydb.v1alpha.OperationMetadata>>;
Check the status of the long running operation returned by restoreCluster()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.alloydb.v1alpha.Cluster, protos.google.cloud.alloydb.v1alpha.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Backup source.
*/
// const backupSource = {}
/**
* ContinuousBackup source. Continuous backup needs to be enabled in the
* source cluster for this operation to succeed.
*/
// const continuousBackupSource = {}
/**
* Required. The name of the parent resource. For the required format, see the
* comment on the Cluster.name field.
*/
// const parent = 'abc123'
/**
* Required. ID of the requesting object.
*/
// const clusterId = 'abc123'
/**
* Required. The resource being created
*/
// const cluster = {}
/**
* Optional. An optional request ID to identify requests. Specify a unique
* request ID so that if you must retry your request, the server will know to
* ignore the request if it has already been completed. The server will
* guarantee 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 original operation with the same request ID
* was received, and if so, will ignore 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).
*/
// const requestId = 'abc123'
/**
* Optional. If set, performs request validation (e.g. permission checks and
* any other type of validation), but do not actually execute the import
* request.
*/
// const validateOnly = true
// Imports the Alloydb library
const {AlloyDBAdminClient} = require('@google-cloud/alloydb').v1alpha;
// Instantiates a client
const alloydbClient = new AlloyDBAdminClient();
async function callRestoreCluster() {
// Construct request
const request = {
parent,
clusterId,
cluster,
};
// Run request
const [operation] = await alloydbClient.restoreCluster(request);
const [response] = await operation.promise();
console.log(response);
}
callRestoreCluster();
checkUpdateBackupProgress(name)
checkUpdateBackupProgress(name: string): Promise<LROperation<protos.google.cloud.alloydb.v1alpha.Backup, protos.google.cloud.alloydb.v1alpha.OperationMetadata>>;
Check the status of the long running operation returned by updateBackup()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.alloydb.v1alpha.Backup, protos.google.cloud.alloydb.v1alpha.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* 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.
*/
// const updateMask = {}
/**
* Required. The resource being updated
*/
// const backup = {}
/**
* Optional. An optional request ID to identify requests. Specify a unique
* request ID so that if you must retry your request, the server will know to
* ignore the request if it has already been completed. The server will
* guarantee 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 original operation with the same request ID
* was received, and if so, will ignore 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).
*/
// const requestId = 'abc123'
/**
* Optional. If set, the backend validates the request, but doesn't actually
* execute it.
*/
// const validateOnly = true
/**
* 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.
*/
// const allowMissing = true
// Imports the Alloydb library
const {AlloyDBAdminClient} = require('@google-cloud/alloydb').v1alpha;
// Instantiates a client
const alloydbClient = new AlloyDBAdminClient();
async function callUpdateBackup() {
// Construct request
const request = {
backup,
};
// Run request
const [operation] = await alloydbClient.updateBackup(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateBackup();
checkUpdateClusterProgress(name)
checkUpdateClusterProgress(name: string): Promise<LROperation<protos.google.cloud.alloydb.v1alpha.Cluster, protos.google.cloud.alloydb.v1alpha.OperationMetadata>>;
Check the status of the long running operation returned by updateCluster()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.alloydb.v1alpha.Cluster, protos.google.cloud.alloydb.v1alpha.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* 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.
*/
// const updateMask = {}
/**
* Required. The resource being updated
*/
// const cluster = {}
/**
* Optional. An optional request ID to identify requests. Specify a unique
* request ID so that if you must retry your request, the server will know to
* ignore the request if it has already been completed. The server will
* guarantee 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 original operation with the same request ID
* was received, and if so, will ignore 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).
*/
// const requestId = 'abc123'
/**
* Optional. If set, performs request validation (e.g. permission checks and
* any other type of validation), but do not actually execute the update
* request.
*/
// const validateOnly = true
/**
* 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.
*/
// const allowMissing = true
// Imports the Alloydb library
const {AlloyDBAdminClient} = require('@google-cloud/alloydb').v1alpha;
// Instantiates a client
const alloydbClient = new AlloyDBAdminClient();
async function callUpdateCluster() {
// Construct request
const request = {
cluster,
};
// Run request
const [operation] = await alloydbClient.updateCluster(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateCluster();
checkUpdateInstanceProgress(name)
checkUpdateInstanceProgress(name: string): Promise<LROperation<protos.google.cloud.alloydb.v1alpha.Instance, protos.google.cloud.alloydb.v1alpha.OperationMetadata>>;
Check the status of the long running operation returned by updateInstance()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.alloydb.v1alpha.Instance, protos.google.cloud.alloydb.v1alpha.OperationMetadata>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* 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.
*/
// const updateMask = {}
/**
* Required. The resource being updated
*/
// const instance = {}
/**
* Optional. An optional request ID to identify requests. Specify a unique
* request ID so that if you must retry your request, the server will know to
* ignore the request if it has already been completed. The server will
* guarantee 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 original operation with the same request ID
* was received, and if so, will ignore 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).
*/
// const requestId = 'abc123'
/**
* Optional. If set, performs request validation (e.g. permission checks and
* any other type of validation), but do not actually execute the update
* request.
*/
// const validateOnly = true
/**
* 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.
*/
// const allowMissing = true
// Imports the Alloydb library
const {AlloyDBAdminClient} = require('@google-cloud/alloydb').v1alpha;
// Instantiates a client
const alloydbClient = new AlloyDBAdminClient();
async function callUpdateInstance() {
// Construct request
const request = {
instance,
};
// Run request
const [operation] = await alloydbClient.updateInstance(request);
const [response] = await operation.promise();
console.log(response);
}
callUpdateInstance();
close()
close(): Promise<void>;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns | |
---|---|
Type | Description |
Promise<void> | {Promise} A promise that resolves when the client is closed. |
clusterPath(project, location, cluster)
clusterPath(project: string, location: string, cluster: string): string;
Return a fully-qualified cluster resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
cluster |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
connectionInfoPath(project, location, cluster, instance)
connectionInfoPath(project: string, location: string, cluster: string, instance: string): string;
Return a fully-qualified connectionInfo resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
cluster |
string
|
instance |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
createBackup(request, options)
createBackup(request?: protos.google.cloud.alloydb.v1alpha.ICreateBackupRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.alloydb.v1alpha.IBackup, protos.google.cloud.alloydb.v1alpha.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Creates a new Backup in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
ICreateBackupRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.alloydb.v1alpha.IBackup, protos.google.cloud.alloydb.v1alpha.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Value for parent.
*/
// const parent = 'abc123'
/**
* Required. ID of the requesting object.
*/
// const backupId = 'abc123'
/**
* Required. The resource being created
*/
// const backup = {}
/**
* Optional. An optional request ID to identify requests. Specify a unique
* request ID so that if you must retry your request, the server will know to
* ignore the request if it has already been completed. The server will
* guarantee 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 original operation with the same request ID
* was received, and if so, will ignore 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).
*/
// const requestId = 'abc123'
/**
* Optional. If set, the backend validates the request, but doesn't actually
* execute it.
*/
// const validateOnly = true
// Imports the Alloydb library
const {AlloyDBAdminClient} = require('@google-cloud/alloydb').v1alpha;
// Instantiates a client
const alloydbClient = new AlloyDBAdminClient();
async function callCreateBackup() {
// Construct request
const request = {
parent,
backupId,
backup,
};
// Run request
const [operation] = await alloydbClient.createBackup(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateBackup();
createBackup(request, options, callback)
createBackup(request: protos.google.cloud.alloydb.v1alpha.ICreateBackupRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.alloydb.v1alpha.IBackup, protos.google.cloud.alloydb.v1alpha.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ICreateBackupRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.alloydb.v1alpha.IBackup, protos.google.cloud.alloydb.v1alpha.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
createBackup(request, callback)
createBackup(request: protos.google.cloud.alloydb.v1alpha.ICreateBackupRequest, callback: Callback<LROperation<protos.google.cloud.alloydb.v1alpha.IBackup, protos.google.cloud.alloydb.v1alpha.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ICreateBackupRequest
|
callback |
Callback<LROperation<protos.google.cloud.alloydb.v1alpha.IBackup, protos.google.cloud.alloydb.v1alpha.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
createCluster(request, options)
createCluster(request?: protos.google.cloud.alloydb.v1alpha.ICreateClusterRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.alloydb.v1alpha.ICluster, protos.google.cloud.alloydb.v1alpha.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Creates a new Cluster in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
ICreateClusterRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.alloydb.v1alpha.ICluster, protos.google.cloud.alloydb.v1alpha.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The location of the new cluster. For the required format, see the
* comment on the Cluster.name field.
*/
// const parent = 'abc123'
/**
* Required. ID of the requesting object.
*/
// const clusterId = 'abc123'
/**
* Required. The resource being created
*/
// const cluster = {}
/**
* Optional. An optional request ID to identify requests. Specify a unique
* request ID so that if you must retry your request, the server will know to
* ignore the request if it has already been completed. The server will
* guarantee 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 original operation with the same request ID
* was received, and if so, will ignore 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).
*/
// const requestId = 'abc123'
/**
* Optional. If set, performs request validation (e.g. permission checks and
* any other type of validation), but do not actually execute the create
* request.
*/
// const validateOnly = true
// Imports the Alloydb library
const {AlloyDBAdminClient} = require('@google-cloud/alloydb').v1alpha;
// Instantiates a client
const alloydbClient = new AlloyDBAdminClient();
async function callCreateCluster() {
// Construct request
const request = {
parent,
clusterId,
cluster,
};
// Run request
const [operation] = await alloydbClient.createCluster(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateCluster();
createCluster(request, options, callback)
createCluster(request: protos.google.cloud.alloydb.v1alpha.ICreateClusterRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.alloydb.v1alpha.ICluster, protos.google.cloud.alloydb.v1alpha.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ICreateClusterRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.alloydb.v1alpha.ICluster, protos.google.cloud.alloydb.v1alpha.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
createCluster(request, callback)
createCluster(request: protos.google.cloud.alloydb.v1alpha.ICreateClusterRequest, callback: Callback<LROperation<protos.google.cloud.alloydb.v1alpha.ICluster, protos.google.cloud.alloydb.v1alpha.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ICreateClusterRequest
|
callback |
Callback<LROperation<protos.google.cloud.alloydb.v1alpha.ICluster, protos.google.cloud.alloydb.v1alpha.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
createInstance(request, options)
createInstance(request?: protos.google.cloud.alloydb.v1alpha.ICreateInstanceRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.alloydb.v1alpha.IInstance, protos.google.cloud.alloydb.v1alpha.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Creates a new Instance in a given project and location.
Parameters | |
---|---|
Name | Description |
request |
ICreateInstanceRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.alloydb.v1alpha.IInstance, protos.google.cloud.alloydb.v1alpha.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the parent resource. For the required format, see the
* comment on the Instance.name field.
*/
// const parent = 'abc123'
/**
* Required. ID of the requesting object.
*/
// const instanceId = 'abc123'
/**
* Required. The resource being created
*/
// const instance = {}
/**
* Optional. An optional request ID to identify requests. Specify a unique
* request ID so that if you must retry your request, the server will know to
* ignore the request if it has already been completed. The server will
* guarantee 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 original operation with the same request ID
* was received, and if so, will ignore 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).
*/
// const requestId = 'abc123'
/**
* Optional. If set, performs request validation (e.g. permission checks and
* any other type of validation), but do not actually execute the create
* request.
*/
// const validateOnly = true
// Imports the Alloydb library
const {AlloyDBAdminClient} = require('@google-cloud/alloydb').v1alpha;
// Instantiates a client
const alloydbClient = new AlloyDBAdminClient();
async function callCreateInstance() {
// Construct request
const request = {
parent,
instanceId,
instance,
};
// Run request
const [operation] = await alloydbClient.createInstance(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateInstance();
createInstance(request, options, callback)
createInstance(request: protos.google.cloud.alloydb.v1alpha.ICreateInstanceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.alloydb.v1alpha.IInstance, protos.google.cloud.alloydb.v1alpha.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ICreateInstanceRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.alloydb.v1alpha.IInstance, protos.google.cloud.alloydb.v1alpha.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
createInstance(request, callback)
createInstance(request: protos.google.cloud.alloydb.v1alpha.ICreateInstanceRequest, callback: Callback<LROperation<protos.google.cloud.alloydb.v1alpha.IInstance, protos.google.cloud.alloydb.v1alpha.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ICreateInstanceRequest
|
callback |
Callback<LROperation<protos.google.cloud.alloydb.v1alpha.IInstance, protos.google.cloud.alloydb.v1alpha.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
createSecondaryCluster(request, options)
createSecondaryCluster(request?: protos.google.cloud.alloydb.v1alpha.ICreateSecondaryClusterRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.alloydb.v1alpha.ICluster, protos.google.cloud.alloydb.v1alpha.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.
Parameters | |
---|---|
Name | Description |
request |
ICreateSecondaryClusterRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.alloydb.v1alpha.ICluster, protos.google.cloud.alloydb.v1alpha.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The location of the new cluster. For the required
* format, see the comment on the Cluster.name field.
*/
// const parent = 'abc123'
/**
* Required. ID of the requesting object (the secondary cluster).
*/
// const clusterId = 'abc123'
/**
* Required. Configuration of the requesting object (the secondary cluster).
*/
// const cluster = {}
/**
* Optional. An optional request ID to identify requests. Specify a unique
* request ID so that if you must retry your request, the server will know to
* ignore the request if it has already been completed. The server will
* guarantee 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 original operation with the same request ID
* was received, and if so, will ignore 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).
*/
// const requestId = 'abc123'
/**
* Optional. If set, performs request validation (e.g. permission checks and
* any other type of validation), but do not actually execute the create
* request.
*/
// const validateOnly = true
// Imports the Alloydb library
const {AlloyDBAdminClient} = require('@google-cloud/alloydb').v1alpha;
// Instantiates a client
const alloydbClient = new AlloyDBAdminClient();
async function callCreateSecondaryCluster() {
// Construct request
const request = {
parent,
clusterId,
cluster,
};
// Run request
const [operation] = await alloydbClient.createSecondaryCluster(request);
const [response] = await operation.promise();
console.log(response);
}
callCreateSecondaryCluster();
createSecondaryCluster(request, options, callback)
createSecondaryCluster(request: protos.google.cloud.alloydb.v1alpha.ICreateSecondaryClusterRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.alloydb.v1alpha.ICluster, protos.google.cloud.alloydb.v1alpha.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ICreateSecondaryClusterRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.alloydb.v1alpha.ICluster, protos.google.cloud.alloydb.v1alpha.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
createSecondaryCluster(request, callback)
createSecondaryCluster(request: protos.google.cloud.alloydb.v1alpha.ICreateSecondaryClusterRequest, callback: Callback<LROperation<protos.google.cloud.alloydb.v1alpha.ICluster, protos.google.cloud.alloydb.v1alpha.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;