Class protos.google.cloud.alloydb.v1.AlloyDBAdmin (1.10.1)

Represents an AlloyDBAdmin

Inheritance

$protobuf.rpc.Service > protos.google.cloud.alloydb.v1.AlloyDBAdmin

Package

@google-cloud/alloydb

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new AlloyDBAdmin service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

batchCreateInstances(request, callback)

public batchCreateInstances(request: google.cloud.alloydb.v1.IBatchCreateInstancesRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.BatchCreateInstancesCallback): void;

Calls BatchCreateInstances.

Parameters
Name Description
request IBatchCreateInstancesRequest

BatchCreateInstancesRequest message or plain object
callback BatchCreateInstancesCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

batchCreateInstances(request)

public batchCreateInstances(request: google.cloud.alloydb.v1.IBatchCreateInstancesRequest): Promise<google.longrunning.Operation>;

Calls BatchCreateInstances.

Parameter
Name Description
request IBatchCreateInstancesRequest

BatchCreateInstancesRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): AlloyDBAdmin;

Creates new AlloyDBAdmin service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
AlloyDBAdmin

RPC service. Useful where requests and/or responses are streamed.

createBackup(request, callback)

public createBackup(request: google.cloud.alloydb.v1.ICreateBackupRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.CreateBackupCallback): void;

Calls CreateBackup.

Parameters
Name Description
request ICreateBackupRequest

CreateBackupRequest message or plain object
callback CreateBackupCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

createBackup(request)

public createBackup(request: google.cloud.alloydb.v1.ICreateBackupRequest): Promise<google.longrunning.Operation>;

Calls CreateBackup.

Parameter
Name Description
request ICreateBackupRequest

CreateBackupRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

createCluster(request, callback)

public createCluster(request: google.cloud.alloydb.v1.ICreateClusterRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.CreateClusterCallback): void;

Calls CreateCluster.

Parameters
Name Description
request ICreateClusterRequest

CreateClusterRequest message or plain object
callback CreateClusterCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

createCluster(request)

public createCluster(request: google.cloud.alloydb.v1.ICreateClusterRequest): Promise<google.longrunning.Operation>;

Calls CreateCluster.

Parameter
Name Description
request ICreateClusterRequest

CreateClusterRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

createInstance(request, callback)

public createInstance(request: google.cloud.alloydb.v1.ICreateInstanceRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.CreateInstanceCallback): void;

Calls CreateInstance.

Parameters
Name Description
request ICreateInstanceRequest

CreateInstanceRequest message or plain object
callback CreateInstanceCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

createInstance(request)

public createInstance(request: google.cloud.alloydb.v1.ICreateInstanceRequest): Promise<google.longrunning.Operation>;

Calls CreateInstance.

Parameter
Name Description
request ICreateInstanceRequest

CreateInstanceRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

createSecondaryCluster(request, callback)

public createSecondaryCluster(request: google.cloud.alloydb.v1.ICreateSecondaryClusterRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.CreateSecondaryClusterCallback): void;

Calls CreateSecondaryCluster.

Parameters
Name Description
request ICreateSecondaryClusterRequest

CreateSecondaryClusterRequest message or plain object
callback CreateSecondaryClusterCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

createSecondaryCluster(request)

public createSecondaryCluster(request: google.cloud.alloydb.v1.ICreateSecondaryClusterRequest): Promise<google.longrunning.Operation>;

Calls CreateSecondaryCluster.

Parameter
Name Description
request ICreateSecondaryClusterRequest

CreateSecondaryClusterRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

createSecondaryInstance(request, callback)

public createSecondaryInstance(request: google.cloud.alloydb.v1.ICreateSecondaryInstanceRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.CreateSecondaryInstanceCallback): void;

Calls CreateSecondaryInstance.

Parameters
Name Description
request ICreateSecondaryInstanceRequest

CreateSecondaryInstanceRequest message or plain object
callback CreateSecondaryInstanceCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

createSecondaryInstance(request)

public createSecondaryInstance(request: google.cloud.alloydb.v1.ICreateSecondaryInstanceRequest): Promise<google.longrunning.Operation>;

Calls CreateSecondaryInstance.

Parameter
Name Description
request ICreateSecondaryInstanceRequest

CreateSecondaryInstanceRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

createUser(request, callback)

public createUser(request: google.cloud.alloydb.v1.ICreateUserRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.CreateUserCallback): void;

Calls CreateUser.

Parameters
Name Description
request ICreateUserRequest

CreateUserRequest message or plain object
callback CreateUserCallback

Node-style callback called with the error, if any, and User
Returns
Type Description
void

createUser(request)

public createUser(request: google.cloud.alloydb.v1.ICreateUserRequest): Promise<google.cloud.alloydb.v1.User>;

Calls CreateUser.

Parameter
Name Description
request ICreateUserRequest

CreateUserRequest message or plain object
Returns
Type Description
Promise<google.cloud.alloydb.v1.User>

Promise

deleteBackup(request, callback)

public deleteBackup(request: google.cloud.alloydb.v1.IDeleteBackupRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.DeleteBackupCallback): void;

Calls DeleteBackup.

Parameters
Name Description
request IDeleteBackupRequest

DeleteBackupRequest message or plain object
callback DeleteBackupCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deleteBackup(request)

public deleteBackup(request: google.cloud.alloydb.v1.IDeleteBackupRequest): Promise<google.longrunning.Operation>;

Calls DeleteBackup.

Parameter
Name Description
request IDeleteBackupRequest

DeleteBackupRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

deleteCluster(request, callback)

public deleteCluster(request: google.cloud.alloydb.v1.IDeleteClusterRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.DeleteClusterCallback): void;

Calls DeleteCluster.

Parameters
Name Description
request IDeleteClusterRequest

DeleteClusterRequest message or plain object
callback DeleteClusterCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deleteCluster(request)

public deleteCluster(request: google.cloud.alloydb.v1.IDeleteClusterRequest): Promise<google.longrunning.Operation>;

Calls DeleteCluster.

Parameter
Name Description
request IDeleteClusterRequest

DeleteClusterRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

deleteInstance(request, callback)

public deleteInstance(request: google.cloud.alloydb.v1.IDeleteInstanceRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.DeleteInstanceCallback): void;

Calls DeleteInstance.

Parameters
Name Description
request IDeleteInstanceRequest

DeleteInstanceRequest message or plain object
callback DeleteInstanceCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deleteInstance(request)

public deleteInstance(request: google.cloud.alloydb.v1.IDeleteInstanceRequest): Promise<google.longrunning.Operation>;

Calls DeleteInstance.

Parameter
Name Description
request IDeleteInstanceRequest

DeleteInstanceRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

deleteUser(request, callback)

public deleteUser(request: google.cloud.alloydb.v1.IDeleteUserRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.DeleteUserCallback): void;

Calls DeleteUser.

Parameters
Name Description
request IDeleteUserRequest

DeleteUserRequest message or plain object
callback DeleteUserCallback

Node-style callback called with the error, if any, and Empty
Returns
Type Description
void

deleteUser(request)

public deleteUser(request: google.cloud.alloydb.v1.IDeleteUserRequest): Promise<google.protobuf.Empty>;

Calls DeleteUser.

Parameter
Name Description
request IDeleteUserRequest

DeleteUserRequest message or plain object
Returns
Type Description
Promise<google.protobuf.Empty>

Promise

executeSql(request, callback)

public executeSql(request: google.cloud.alloydb.v1.IExecuteSqlRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.ExecuteSqlCallback): void;

Calls ExecuteSql.

Parameters
Name Description
request IExecuteSqlRequest

ExecuteSqlRequest message or plain object
callback ExecuteSqlCallback

Node-style callback called with the error, if any, and ExecuteSqlResponse
Returns
Type Description
void

executeSql(request)

public executeSql(request: google.cloud.alloydb.v1.IExecuteSqlRequest): Promise<google.cloud.alloydb.v1.ExecuteSqlResponse>;

Calls ExecuteSql.

Parameter
Name Description
request IExecuteSqlRequest

ExecuteSqlRequest message or plain object
Returns
Type Description
Promise<google.cloud.alloydb.v1.ExecuteSqlResponse>

Promise

failoverInstance(request, callback)

public failoverInstance(request: google.cloud.alloydb.v1.IFailoverInstanceRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.FailoverInstanceCallback): void;

Calls FailoverInstance.

Parameters
Name Description
request IFailoverInstanceRequest

FailoverInstanceRequest message or plain object
callback FailoverInstanceCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

failoverInstance(request)

public failoverInstance(request: google.cloud.alloydb.v1.IFailoverInstanceRequest): Promise<google.longrunning.Operation>;

Calls FailoverInstance.

Parameter
Name Description
request IFailoverInstanceRequest

FailoverInstanceRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

generateClientCertificate(request, callback)

public generateClientCertificate(request: google.cloud.alloydb.v1.IGenerateClientCertificateRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.GenerateClientCertificateCallback): void;

Calls GenerateClientCertificate.

Parameters
Name Description
request IGenerateClientCertificateRequest

GenerateClientCertificateRequest message or plain object
callback GenerateClientCertificateCallback

Node-style callback called with the error, if any, and GenerateClientCertificateResponse
Returns
Type Description
void

generateClientCertificate(request)

public generateClientCertificate(request: google.cloud.alloydb.v1.IGenerateClientCertificateRequest): Promise<google.cloud.alloydb.v1.GenerateClientCertificateResponse>;

Calls GenerateClientCertificate.

Parameter
Name Description
request IGenerateClientCertificateRequest

GenerateClientCertificateRequest message or plain object
Returns
Type Description
Promise<google.cloud.alloydb.v1.GenerateClientCertificateResponse>

Promise

getBackup(request, callback)

public getBackup(request: google.cloud.alloydb.v1.IGetBackupRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.GetBackupCallback): void;

Calls GetBackup.

Parameters
Name Description
request IGetBackupRequest

GetBackupRequest message or plain object
callback GetBackupCallback

Node-style callback called with the error, if any, and Backup
Returns
Type Description
void

getBackup(request)

public getBackup(request: google.cloud.alloydb.v1.IGetBackupRequest): Promise<google.cloud.alloydb.v1.Backup>;

Calls GetBackup.

Parameter
Name Description
request IGetBackupRequest

GetBackupRequest message or plain object
Returns
Type Description
Promise<google.cloud.alloydb.v1.Backup>

Promise

getCluster(request, callback)

public getCluster(request: google.cloud.alloydb.v1.IGetClusterRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.GetClusterCallback): void;

Calls GetCluster.

Parameters
Name Description
request IGetClusterRequest

GetClusterRequest message or plain object
callback GetClusterCallback

Node-style callback called with the error, if any, and Cluster
Returns
Type Description
void

getCluster(request)

public getCluster(request: google.cloud.alloydb.v1.IGetClusterRequest): Promise<google.cloud.alloydb.v1.Cluster>;

Calls GetCluster.

Parameter
Name Description
request IGetClusterRequest

GetClusterRequest message or plain object
Returns
Type Description
Promise<google.cloud.alloydb.v1.Cluster>

Promise

getConnectionInfo(request, callback)

public getConnectionInfo(request: google.cloud.alloydb.v1.IGetConnectionInfoRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.GetConnectionInfoCallback): void;

Calls GetConnectionInfo.

Parameters
Name Description
request IGetConnectionInfoRequest

GetConnectionInfoRequest message or plain object
callback GetConnectionInfoCallback

Node-style callback called with the error, if any, and ConnectionInfo
Returns
Type Description
void

getConnectionInfo(request)

public getConnectionInfo(request: google.cloud.alloydb.v1.IGetConnectionInfoRequest): Promise<google.cloud.alloydb.v1.ConnectionInfo>;

Calls GetConnectionInfo.

Parameter
Name Description
request IGetConnectionInfoRequest

GetConnectionInfoRequest message or plain object
Returns
Type Description
Promise<google.cloud.alloydb.v1.ConnectionInfo>

Promise

getInstance(request, callback)

public getInstance(request: google.cloud.alloydb.v1.IGetInstanceRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.GetInstanceCallback): void;

Calls GetInstance.

Parameters
Name Description
request IGetInstanceRequest

GetInstanceRequest message or plain object
callback GetInstanceCallback

Node-style callback called with the error, if any, and Instance
Returns
Type Description
void

getInstance(request)

public getInstance(request: google.cloud.alloydb.v1.IGetInstanceRequest): Promise<google.cloud.alloydb.v1.Instance>;

Calls GetInstance.

Parameter
Name Description
request IGetInstanceRequest

GetInstanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.alloydb.v1.Instance>

Promise

getUser(request, callback)

public getUser(request: google.cloud.alloydb.v1.IGetUserRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.GetUserCallback): void;

Calls GetUser.

Parameters
Name Description
request IGetUserRequest

GetUserRequest message or plain object
callback GetUserCallback

Node-style callback called with the error, if any, and User
Returns
Type Description
void

getUser(request)

public getUser(request: google.cloud.alloydb.v1.IGetUserRequest): Promise<google.cloud.alloydb.v1.User>;

Calls GetUser.

Parameter
Name Description
request IGetUserRequest

GetUserRequest message or plain object
Returns
Type Description
Promise<google.cloud.alloydb.v1.User>

Promise

injectFault(request, callback)

public injectFault(request: google.cloud.alloydb.v1.IInjectFaultRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.InjectFaultCallback): void;

Calls InjectFault.

Parameters
Name Description
request IInjectFaultRequest

InjectFaultRequest message or plain object
callback InjectFaultCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

injectFault(request)

public injectFault(request: google.cloud.alloydb.v1.IInjectFaultRequest): Promise<google.longrunning.Operation>;

Calls InjectFault.

Parameter
Name Description
request IInjectFaultRequest

InjectFaultRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

listBackups(request, callback)

public listBackups(request: google.cloud.alloydb.v1.IListBackupsRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.ListBackupsCallback): void;

Calls ListBackups.

Parameters
Name Description
request IListBackupsRequest

ListBackupsRequest message or plain object
callback ListBackupsCallback

Node-style callback called with the error, if any, and ListBackupsResponse
Returns
Type Description
void

listBackups(request)

public listBackups(request: google.cloud.alloydb.v1.IListBackupsRequest): Promise<google.cloud.alloydb.v1.ListBackupsResponse>;

Calls ListBackups.

Parameter
Name Description
request IListBackupsRequest

ListBackupsRequest message or plain object
Returns
Type Description
Promise<google.cloud.alloydb.v1.ListBackupsResponse>

Promise

listClusters(request, callback)

public listClusters(request: google.cloud.alloydb.v1.IListClustersRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.ListClustersCallback): void;

Calls ListClusters.

Parameters
Name Description
request IListClustersRequest

ListClustersRequest message or plain object
callback ListClustersCallback

Node-style callback called with the error, if any, and ListClustersResponse
Returns
Type Description
void

listClusters(request)

public listClusters(request: google.cloud.alloydb.v1.IListClustersRequest): Promise<google.cloud.alloydb.v1.ListClustersResponse>;

Calls ListClusters.

Parameter
Name Description
request IListClustersRequest

ListClustersRequest message or plain object
Returns
Type Description
Promise<google.cloud.alloydb.v1.ListClustersResponse>

Promise

listDatabases(request, callback)

public listDatabases(request: google.cloud.alloydb.v1.IListDatabasesRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.ListDatabasesCallback): void;

Calls ListDatabases.

Parameters
Name Description
request IListDatabasesRequest

ListDatabasesRequest message or plain object
callback ListDatabasesCallback

Node-style callback called with the error, if any, and ListDatabasesResponse
Returns
Type Description
void

listDatabases(request)

public listDatabases(request: google.cloud.alloydb.v1.IListDatabasesRequest): Promise<google.cloud.alloydb.v1.ListDatabasesResponse>;

Calls ListDatabases.

Parameter
Name Description
request IListDatabasesRequest

ListDatabasesRequest message or plain object
Returns
Type Description
Promise<google.cloud.alloydb.v1.ListDatabasesResponse>

Promise

listInstances(request, callback)

public listInstances(request: google.cloud.alloydb.v1.IListInstancesRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.ListInstancesCallback): void;

Calls ListInstances.

Parameters
Name Description
request IListInstancesRequest

ListInstancesRequest message or plain object
callback ListInstancesCallback

Node-style callback called with the error, if any, and ListInstancesResponse
Returns
Type Description
void

listInstances(request)

public listInstances(request: google.cloud.alloydb.v1.IListInstancesRequest): Promise<google.cloud.alloydb.v1.ListInstancesResponse>;

Calls ListInstances.

Parameter
Name Description
request IListInstancesRequest

ListInstancesRequest message or plain object
Returns
Type Description
Promise<google.cloud.alloydb.v1.ListInstancesResponse>

Promise

listSupportedDatabaseFlags(request, callback)

public listSupportedDatabaseFlags(request: google.cloud.alloydb.v1.IListSupportedDatabaseFlagsRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.ListSupportedDatabaseFlagsCallback): void;

Calls ListSupportedDatabaseFlags.

Parameters
Name Description
request IListSupportedDatabaseFlagsRequest

ListSupportedDatabaseFlagsRequest message or plain object
callback ListSupportedDatabaseFlagsCallback

Node-style callback called with the error, if any, and ListSupportedDatabaseFlagsResponse
Returns
Type Description
void

listSupportedDatabaseFlags(request)

public listSupportedDatabaseFlags(request: google.cloud.alloydb.v1.IListSupportedDatabaseFlagsRequest): Promise<google.cloud.alloydb.v1.ListSupportedDatabaseFlagsResponse>;

Calls ListSupportedDatabaseFlags.

Parameter
Name Description
request IListSupportedDatabaseFlagsRequest

ListSupportedDatabaseFlagsRequest message or plain object
Returns
Type Description
Promise<google.cloud.alloydb.v1.ListSupportedDatabaseFlagsResponse>

Promise

listUsers(request, callback)

public listUsers(request: google.cloud.alloydb.v1.IListUsersRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.ListUsersCallback): void;

Calls ListUsers.

Parameters
Name Description
request IListUsersRequest

ListUsersRequest message or plain object
callback ListUsersCallback

Node-style callback called with the error, if any, and ListUsersResponse
Returns
Type Description
void

listUsers(request)

public listUsers(request: google.cloud.alloydb.v1.IListUsersRequest): Promise<google.cloud.alloydb.v1.ListUsersResponse>;

Calls ListUsers.

Parameter
Name Description
request IListUsersRequest

ListUsersRequest message or plain object
Returns
Type Description
Promise<google.cloud.alloydb.v1.ListUsersResponse>

Promise

promoteCluster(request, callback)

public promoteCluster(request: google.cloud.alloydb.v1.IPromoteClusterRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.PromoteClusterCallback): void;

Calls PromoteCluster.

Parameters
Name Description
request IPromoteClusterRequest

PromoteClusterRequest message or plain object
callback PromoteClusterCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

promoteCluster(request)

public promoteCluster(request: google.cloud.alloydb.v1.IPromoteClusterRequest): Promise<google.longrunning.Operation>;

Calls PromoteCluster.

Parameter
Name Description
request IPromoteClusterRequest

PromoteClusterRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

restartInstance(request, callback)

public restartInstance(request: google.cloud.alloydb.v1.IRestartInstanceRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.RestartInstanceCallback): void;

Calls RestartInstance.

Parameters
Name Description
request IRestartInstanceRequest

RestartInstanceRequest message or plain object
callback RestartInstanceCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

restartInstance(request)

public restartInstance(request: google.cloud.alloydb.v1.IRestartInstanceRequest): Promise<google.longrunning.Operation>;

Calls RestartInstance.

Parameter
Name Description
request IRestartInstanceRequest

RestartInstanceRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

restoreCluster(request, callback)

public restoreCluster(request: google.cloud.alloydb.v1.IRestoreClusterRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.RestoreClusterCallback): void;

Calls RestoreCluster.

Parameters
Name Description
request IRestoreClusterRequest

RestoreClusterRequest message or plain object
callback RestoreClusterCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

restoreCluster(request)

public restoreCluster(request: google.cloud.alloydb.v1.IRestoreClusterRequest): Promise<google.longrunning.Operation>;

Calls RestoreCluster.

Parameter
Name Description
request IRestoreClusterRequest

RestoreClusterRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

switchoverCluster(request, callback)

public switchoverCluster(request: google.cloud.alloydb.v1.ISwitchoverClusterRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.SwitchoverClusterCallback): void;

Calls SwitchoverCluster.

Parameters
Name Description
request ISwitchoverClusterRequest

SwitchoverClusterRequest message or plain object
callback SwitchoverClusterCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

switchoverCluster(request)

public switchoverCluster(request: google.cloud.alloydb.v1.ISwitchoverClusterRequest): Promise<google.longrunning.Operation>;

Calls SwitchoverCluster.

Parameter
Name Description
request ISwitchoverClusterRequest

SwitchoverClusterRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

updateBackup(request, callback)

public updateBackup(request: google.cloud.alloydb.v1.IUpdateBackupRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.UpdateBackupCallback): void;

Calls UpdateBackup.

Parameters
Name Description
request IUpdateBackupRequest

UpdateBackupRequest message or plain object
callback UpdateBackupCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

updateBackup(request)

public updateBackup(request: google.cloud.alloydb.v1.IUpdateBackupRequest): Promise<google.longrunning.Operation>;

Calls UpdateBackup.

Parameter
Name Description
request IUpdateBackupRequest

UpdateBackupRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

updateCluster(request, callback)

public updateCluster(request: google.cloud.alloydb.v1.IUpdateClusterRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.UpdateClusterCallback): void;

Calls UpdateCluster.

Parameters
Name Description
request IUpdateClusterRequest

UpdateClusterRequest message or plain object
callback UpdateClusterCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

updateCluster(request)

public updateCluster(request: google.cloud.alloydb.v1.IUpdateClusterRequest): Promise<google.longrunning.Operation>;

Calls UpdateCluster.

Parameter
Name Description
request IUpdateClusterRequest

UpdateClusterRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

updateInstance(request, callback)

public updateInstance(request: google.cloud.alloydb.v1.IUpdateInstanceRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.UpdateInstanceCallback): void;

Calls UpdateInstance.

Parameters
Name Description
request IUpdateInstanceRequest

UpdateInstanceRequest message or plain object
callback UpdateInstanceCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

updateInstance(request)

public updateInstance(request: google.cloud.alloydb.v1.IUpdateInstanceRequest): Promise<google.longrunning.Operation>;

Calls UpdateInstance.

Parameter
Name Description
request IUpdateInstanceRequest

UpdateInstanceRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

updateUser(request, callback)

public updateUser(request: google.cloud.alloydb.v1.IUpdateUserRequest, callback: google.cloud.alloydb.v1.AlloyDBAdmin.UpdateUserCallback): void;

Calls UpdateUser.

Parameters
Name Description
request IUpdateUserRequest

UpdateUserRequest message or plain object
callback UpdateUserCallback

Node-style callback called with the error, if any, and User
Returns
Type Description
void

updateUser(request)

public updateUser(request: google.cloud.alloydb.v1.IUpdateUserRequest): Promise<google.cloud.alloydb.v1.User>;

Calls UpdateUser.

Parameter
Name Description
request IUpdateUserRequest

UpdateUserRequest message or plain object
Returns
Type Description
Promise<google.cloud.alloydb.v1.User>

Promise