Class protos.google.spanner.admin.database.v1.DatabaseAdmin

Represents a DatabaseAdmin

Inheritance

$protobuf.rpc.Service > protos.google.spanner.admin.database.v1.DatabaseAdmin

Package

@google-cloud/spanner!

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new DatabaseAdmin service.

Parameters
Type Name Description
$protobuf.RPCImpl rpcImpl

RPC implementation
boolean requestDelimited

Whether requests are length-delimited
boolean responseDelimited

Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

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

Creates new DatabaseAdmin service using the specified rpc implementation.

Parameters
Type Name Description
$protobuf.RPCImpl rpcImpl

RPC implementation
boolean requestDelimited

Whether requests are length-delimited
boolean responseDelimited

Whether responses are length-delimited
Returns
Type Description
DatabaseAdmin

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

createBackup(request, callback)

public createBackup(request: google.spanner.admin.database.v1.ICreateBackupRequest, callback: google.spanner.admin.database.v1.DatabaseAdmin.CreateBackupCallback): void;

Calls CreateBackup.

Parameters
Type Name Description
ICreateBackupRequest request

CreateBackupRequest message or plain object
google.spanner.admin.database.v1.DatabaseAdmin.CreateBackupCallback callback

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

createBackup(request)

public createBackup(request: google.spanner.admin.database.v1.ICreateBackupRequest): Promise<google.longrunning.Operation>;

Calls CreateBackup.

Parameter
Type Name Description
ICreateBackupRequest request

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

Promise

createDatabase(request, callback)

public createDatabase(request: google.spanner.admin.database.v1.ICreateDatabaseRequest, callback: google.spanner.admin.database.v1.DatabaseAdmin.CreateDatabaseCallback): void;

Calls CreateDatabase.

Parameters
Type Name Description
google.spanner.admin.database.v1.ICreateDatabaseRequest request

CreateDatabaseRequest message or plain object
google.spanner.admin.database.v1.DatabaseAdmin.CreateDatabaseCallback callback

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

createDatabase(request)

public createDatabase(request: google.spanner.admin.database.v1.ICreateDatabaseRequest): Promise<google.longrunning.Operation>;

Calls CreateDatabase.

Parameter
Type Name Description
google.spanner.admin.database.v1.ICreateDatabaseRequest request

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

Promise

deleteBackup(request, callback)

public deleteBackup(request: google.spanner.admin.database.v1.IDeleteBackupRequest, callback: google.spanner.admin.database.v1.DatabaseAdmin.DeleteBackupCallback): void;

Calls DeleteBackup.

Parameters
Type Name Description
google.spanner.admin.database.v1.IDeleteBackupRequest request

DeleteBackupRequest message or plain object
google.spanner.admin.database.v1.DatabaseAdmin.DeleteBackupCallback callback

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

deleteBackup(request)

public deleteBackup(request: google.spanner.admin.database.v1.IDeleteBackupRequest): Promise<google.protobuf.Empty>;

Calls DeleteBackup.

Parameter
Type Name Description
google.spanner.admin.database.v1.IDeleteBackupRequest request

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

Promise

dropDatabase(request, callback)

public dropDatabase(request: google.spanner.admin.database.v1.IDropDatabaseRequest, callback: google.spanner.admin.database.v1.DatabaseAdmin.DropDatabaseCallback): void;

Calls DropDatabase.

Parameters
Type Name Description
google.spanner.admin.database.v1.IDropDatabaseRequest request

DropDatabaseRequest message or plain object
google.spanner.admin.database.v1.DatabaseAdmin.DropDatabaseCallback callback

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

dropDatabase(request)

public dropDatabase(request: google.spanner.admin.database.v1.IDropDatabaseRequest): Promise<google.protobuf.Empty>;

Calls DropDatabase.

Parameter
Type Name Description
google.spanner.admin.database.v1.IDropDatabaseRequest request

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

Promise

getBackup(request, callback)

public getBackup(request: google.spanner.admin.database.v1.IGetBackupRequest, callback: google.spanner.admin.database.v1.DatabaseAdmin.GetBackupCallback): void;

Calls GetBackup.

Parameters
Type Name Description
IGetBackupRequest request

GetBackupRequest message or plain object
google.spanner.admin.database.v1.DatabaseAdmin.GetBackupCallback callback

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

getBackup(request)

public getBackup(request: google.spanner.admin.database.v1.IGetBackupRequest): Promise<google.spanner.admin.database.v1.Backup>;

Calls GetBackup.

Parameter
Type Name Description
IGetBackupRequest request

GetBackupRequest message or plain object
Returns
Type Description
Promise<google.spanner.admin.database.v1.Backup>

Promise

getDatabase(request, callback)

public getDatabase(request: google.spanner.admin.database.v1.IGetDatabaseRequest, callback: google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseCallback): void;

Calls GetDatabase.

Parameters
Type Name Description
google.spanner.admin.database.v1.IGetDatabaseRequest request

GetDatabaseRequest message or plain object
google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseCallback callback

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

getDatabase(request)

public getDatabase(request: google.spanner.admin.database.v1.IGetDatabaseRequest): Promise<google.spanner.admin.database.v1.Database>;

Calls GetDatabase.

Parameter
Type Name Description
google.spanner.admin.database.v1.IGetDatabaseRequest request

GetDatabaseRequest message or plain object
Returns
Type Description
Promise<google.spanner.admin.database.v1.Database>

Promise

getDatabaseDdl(request, callback)

public getDatabaseDdl(request: google.spanner.admin.database.v1.IGetDatabaseDdlRequest, callback: google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdlCallback): void;

Calls GetDatabaseDdl.

Parameters
Type Name Description
IGetDatabaseDdlRequest request

GetDatabaseDdlRequest message or plain object
google.spanner.admin.database.v1.DatabaseAdmin.GetDatabaseDdlCallback callback

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

getDatabaseDdl(request)

public getDatabaseDdl(request: google.spanner.admin.database.v1.IGetDatabaseDdlRequest): Promise<google.spanner.admin.database.v1.GetDatabaseDdlResponse>;

Calls GetDatabaseDdl.

Parameter
Type Name Description
IGetDatabaseDdlRequest request

GetDatabaseDdlRequest message or plain object
Returns
Type Description
Promise<google.spanner.admin.database.v1.GetDatabaseDdlResponse>

Promise

getIamPolicy(request, callback)

public getIamPolicy(request: google.iam.v1.IGetIamPolicyRequest, callback: google.spanner.admin.database.v1.DatabaseAdmin.GetIamPolicyCallback): void;

Calls GetIamPolicy.

Parameters
Type Name Description
google.iam.v1.IGetIamPolicyRequest request

GetIamPolicyRequest message or plain object
google.spanner.admin.database.v1.DatabaseAdmin.GetIamPolicyCallback callback

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

getIamPolicy(request)

public getIamPolicy(request: google.iam.v1.IGetIamPolicyRequest): Promise<google.iam.v1.Policy>;

Calls GetIamPolicy.

Parameter
Type Name Description
google.iam.v1.IGetIamPolicyRequest request

GetIamPolicyRequest message or plain object
Returns
Type Description
Promise<google.iam.v1.Policy>

Promise

listBackupOperations(request, callback)

public listBackupOperations(request: google.spanner.admin.database.v1.IListBackupOperationsRequest, callback: google.spanner.admin.database.v1.DatabaseAdmin.ListBackupOperationsCallback): void;

Calls ListBackupOperations.

Parameters
Type Name Description
IListBackupOperationsRequest request

ListBackupOperationsRequest message or plain object
google.spanner.admin.database.v1.DatabaseAdmin.ListBackupOperationsCallback callback

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

listBackupOperations(request)

public listBackupOperations(request: google.spanner.admin.database.v1.IListBackupOperationsRequest): Promise<google.spanner.admin.database.v1.ListBackupOperationsResponse>;

Calls ListBackupOperations.

Parameter
Type Name Description
IListBackupOperationsRequest request

ListBackupOperationsRequest message or plain object
Returns
Type Description
Promise<google.spanner.admin.database.v1.ListBackupOperationsResponse>

Promise

listBackups(request, callback)

public listBackups(request: google.spanner.admin.database.v1.IListBackupsRequest, callback: google.spanner.admin.database.v1.DatabaseAdmin.ListBackupsCallback): void;

Calls ListBackups.

Parameters
Type Name Description
google.spanner.admin.database.v1.IListBackupsRequest request

ListBackupsRequest message or plain object
google.spanner.admin.database.v1.DatabaseAdmin.ListBackupsCallback callback

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

listBackups(request)

public listBackups(request: google.spanner.admin.database.v1.IListBackupsRequest): Promise<google.spanner.admin.database.v1.ListBackupsResponse>;

Calls ListBackups.

Parameter
Type Name Description
google.spanner.admin.database.v1.IListBackupsRequest request

ListBackupsRequest message or plain object
Returns
Type Description
Promise<google.spanner.admin.database.v1.ListBackupsResponse>

Promise

listDatabaseOperations(request, callback)

public listDatabaseOperations(request: google.spanner.admin.database.v1.IListDatabaseOperationsRequest, callback: google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseOperationsCallback): void;

Calls ListDatabaseOperations.

Parameters
Type Name Description
google.spanner.admin.database.v1.IListDatabaseOperationsRequest request

ListDatabaseOperationsRequest message or plain object
google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseOperationsCallback callback

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

listDatabaseOperations(request)

public listDatabaseOperations(request: google.spanner.admin.database.v1.IListDatabaseOperationsRequest): Promise<google.spanner.admin.database.v1.ListDatabaseOperationsResponse>;

Calls ListDatabaseOperations.

Parameter
Type Name Description
google.spanner.admin.database.v1.IListDatabaseOperationsRequest request

ListDatabaseOperationsRequest message or plain object
Returns
Type Description
Promise<google.spanner.admin.database.v1.ListDatabaseOperationsResponse>

Promise

listDatabases(request, callback)

public listDatabases(request: google.spanner.admin.database.v1.IListDatabasesRequest, callback: google.spanner.admin.database.v1.DatabaseAdmin.ListDatabasesCallback): void;

Calls ListDatabases.

Parameters
Type Name Description
google.spanner.admin.database.v1.IListDatabasesRequest request

ListDatabasesRequest message or plain object
google.spanner.admin.database.v1.DatabaseAdmin.ListDatabasesCallback callback

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

listDatabases(request)

public listDatabases(request: google.spanner.admin.database.v1.IListDatabasesRequest): Promise<google.spanner.admin.database.v1.ListDatabasesResponse>;

Calls ListDatabases.

Parameter
Type Name Description
google.spanner.admin.database.v1.IListDatabasesRequest request

ListDatabasesRequest message or plain object
Returns
Type Description
Promise<google.spanner.admin.database.v1.ListDatabasesResponse>

Promise

restoreDatabase(request, callback)

public restoreDatabase(request: google.spanner.admin.database.v1.IRestoreDatabaseRequest, callback: google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabaseCallback): void;

Calls RestoreDatabase.

Parameters
Type Name Description
IRestoreDatabaseRequest request

RestoreDatabaseRequest message or plain object
google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabaseCallback callback

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

restoreDatabase(request)

public restoreDatabase(request: google.spanner.admin.database.v1.IRestoreDatabaseRequest): Promise<google.longrunning.Operation>;

Calls RestoreDatabase.

Parameter
Type Name Description
IRestoreDatabaseRequest request

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

Promise

setIamPolicy(request, callback)

public setIamPolicy(request: google.iam.v1.ISetIamPolicyRequest, callback: google.spanner.admin.database.v1.DatabaseAdmin.SetIamPolicyCallback): void;

Calls SetIamPolicy.

Parameters
Type Name Description
google.iam.v1.ISetIamPolicyRequest request

SetIamPolicyRequest message or plain object
google.spanner.admin.database.v1.DatabaseAdmin.SetIamPolicyCallback callback

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

setIamPolicy(request)

public setIamPolicy(request: google.iam.v1.ISetIamPolicyRequest): Promise<google.iam.v1.Policy>;

Calls SetIamPolicy.

Parameter
Type Name Description
google.iam.v1.ISetIamPolicyRequest request

SetIamPolicyRequest message or plain object
Returns
Type Description
Promise<google.iam.v1.Policy>

Promise

testIamPermissions(request, callback)

public testIamPermissions(request: google.iam.v1.ITestIamPermissionsRequest, callback: google.spanner.admin.database.v1.DatabaseAdmin.TestIamPermissionsCallback): void;

Calls TestIamPermissions.

Parameters
Type Name Description
google.iam.v1.ITestIamPermissionsRequest request

TestIamPermissionsRequest message or plain object
google.spanner.admin.database.v1.DatabaseAdmin.TestIamPermissionsCallback callback

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

testIamPermissions(request)

public testIamPermissions(request: google.iam.v1.ITestIamPermissionsRequest): Promise<google.iam.v1.TestIamPermissionsResponse>;

Calls TestIamPermissions.

Parameter
Type Name Description
google.iam.v1.ITestIamPermissionsRequest request

TestIamPermissionsRequest message or plain object
Returns
Type Description
Promise<google.iam.v1.TestIamPermissionsResponse>

Promise

updateBackup(request, callback)

public updateBackup(request: google.spanner.admin.database.v1.IUpdateBackupRequest, callback: google.spanner.admin.database.v1.DatabaseAdmin.UpdateBackupCallback): void;

Calls UpdateBackup.

Parameters
Type Name Description
IUpdateBackupRequest request

UpdateBackupRequest message or plain object
google.spanner.admin.database.v1.DatabaseAdmin.UpdateBackupCallback callback

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

updateBackup(request)

public updateBackup(request: google.spanner.admin.database.v1.IUpdateBackupRequest): Promise<google.spanner.admin.database.v1.Backup>;

Calls UpdateBackup.

Parameter
Type Name Description
IUpdateBackupRequest request

UpdateBackupRequest message or plain object
Returns
Type Description
Promise<google.spanner.admin.database.v1.Backup>

Promise

updateDatabaseDdl(request, callback)

public updateDatabaseDdl(request: google.spanner.admin.database.v1.IUpdateDatabaseDdlRequest, callback: google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdlCallback): void;

Calls UpdateDatabaseDdl.

Parameters
Type Name Description
google.spanner.admin.database.v1.IUpdateDatabaseDdlRequest request

UpdateDatabaseDdlRequest message or plain object
google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseDdlCallback callback

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

updateDatabaseDdl(request)

public updateDatabaseDdl(request: google.spanner.admin.database.v1.IUpdateDatabaseDdlRequest): Promise<google.longrunning.Operation>;

Calls UpdateDatabaseDdl.

Parameter
Type Name Description
google.spanner.admin.database.v1.IUpdateDatabaseDdlRequest request

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

Promise