Class protos.google.spanner.admin.database.v1.DatabaseAdmin (7.5.0)

Represents a DatabaseAdmin

Inheritance

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

Package

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new DatabaseAdmin service.

Parameters
Name	Description
`rpcImpl`	`$protobuf.RPCImpl` RPC implementation
`requestDelimited`	`boolean` Whether requests are length-delimited
`responseDelimited`	`boolean` Whether responses are length-delimited

Methods

copyBackup(request, callback)

public copyBackup(request: google.spanner.admin.database.v1.ICopyBackupRequest, callback: google.spanner.admin.database.v1.DatabaseAdmin.CopyBackupCallback): void;

Calls CopyBackup.

Parameters
Name	Description
`request`	`ICopyBackupRequest` CopyBackupRequest message or plain object
`callback`	`CopyBackupCallback` Node-style callback called with the error, if any, and Operation

Returns
Type	Description
`void`

copyBackup(request)

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

Calls CopyBackup.

Parameter
Name	Description
`request`	`ICopyBackupRequest` CopyBackupRequest 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): DatabaseAdmin;

Creates new DatabaseAdmin 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
`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
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.spanner.admin.database.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

createDatabase(request, callback)

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

Calls CreateDatabase.

Parameters
Name	Description
`request`	`ICreateDatabaseRequest` CreateDatabaseRequest message or plain object
`callback`	`CreateDatabaseCallback` 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
Name	Description
`request`	`ICreateDatabaseRequest` 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
Name	Description
`request`	`IDeleteBackupRequest` DeleteBackupRequest message or plain object
`callback`	`DeleteBackupCallback` 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
Name	Description
`request`	`IDeleteBackupRequest` 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
Name	Description
`request`	`IDropDatabaseRequest` DropDatabaseRequest message or plain object
`callback`	`DropDatabaseCallback` 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
Name	Description
`request`	`IDropDatabaseRequest` 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
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.spanner.admin.database.v1.IGetBackupRequest): Promise<google.spanner.admin.database.v1.Backup>;

Calls GetBackup.

Parameter
Name	Description
`request`	`IGetBackupRequest` 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
Name	Description
`request`	`IGetDatabaseRequest` GetDatabaseRequest message or plain object
`callback`	`GetDatabaseCallback` 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
Name	Description
`request`	`IGetDatabaseRequest` 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
Name	Description
`request`	`IGetDatabaseDdlRequest` GetDatabaseDdlRequest message or plain object
`callback`	`GetDatabaseDdlCallback` 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
Name	Description
`request`	`IGetDatabaseDdlRequest` 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
Name	Description
`request`	`IGetIamPolicyRequest` GetIamPolicyRequest message or plain object
`callback`	`GetIamPolicyCallback` 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
Name	Description
`request`	`IGetIamPolicyRequest` 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
Name	Description
`request`	`IListBackupOperationsRequest` ListBackupOperationsRequest message or plain object
`callback`	`ListBackupOperationsCallback` 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
Name	Description
`request`	`IListBackupOperationsRequest` 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
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.spanner.admin.database.v1.IListBackupsRequest): Promise<google.spanner.admin.database.v1.ListBackupsResponse>;

Calls ListBackups.

Parameter
Name	Description
`request`	`IListBackupsRequest` 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
Name	Description
`request`	`IListDatabaseOperationsRequest` ListDatabaseOperationsRequest message or plain object
`callback`	`ListDatabaseOperationsCallback` 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
Name	Description
`request`	`IListDatabaseOperationsRequest` ListDatabaseOperationsRequest message or plain object

Returns
Type	Description
`Promise<google.spanner.admin.database.v1.ListDatabaseOperationsResponse>`	Promise

listDatabaseRoles(request, callback)

public listDatabaseRoles(request: google.spanner.admin.database.v1.IListDatabaseRolesRequest, callback: google.spanner.admin.database.v1.DatabaseAdmin.ListDatabaseRolesCallback): void;

Calls ListDatabaseRoles.

Parameters
Name	Description
`request`	`IListDatabaseRolesRequest` ListDatabaseRolesRequest message or plain object
`callback`	`ListDatabaseRolesCallback` Node-style callback called with the error, if any, and ListDatabaseRolesResponse

Returns
Type	Description
`void`

listDatabaseRoles(request)

public listDatabaseRoles(request: google.spanner.admin.database.v1.IListDatabaseRolesRequest): Promise<google.spanner.admin.database.v1.ListDatabaseRolesResponse>;

Calls ListDatabaseRoles.

Parameter
Name	Description
`request`	`IListDatabaseRolesRequest` ListDatabaseRolesRequest message or plain object

Returns
Type	Description
`Promise<google.spanner.admin.database.v1.ListDatabaseRolesResponse>`	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
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.spanner.admin.database.v1.IListDatabasesRequest): Promise<google.spanner.admin.database.v1.ListDatabasesResponse>;

Calls ListDatabases.

Parameter
Name	Description
`request`	`IListDatabasesRequest` 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
Name	Description
`request`	`IRestoreDatabaseRequest` RestoreDatabaseRequest message or plain object
`callback`	`RestoreDatabaseCallback` 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
Name	Description
`request`	`IRestoreDatabaseRequest` 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
Name	Description
`request`	`ISetIamPolicyRequest` SetIamPolicyRequest message or plain object
`callback`	`SetIamPolicyCallback` 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
Name	Description
`request`	`ISetIamPolicyRequest` 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
Name	Description
`request`	`ITestIamPermissionsRequest` TestIamPermissionsRequest message or plain object
`callback`	`TestIamPermissionsCallback` 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
Name	Description
`request`	`ITestIamPermissionsRequest` 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
Name	Description
`request`	`IUpdateBackupRequest` UpdateBackupRequest message or plain object
`callback`	`UpdateBackupCallback` 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
Name	Description
`request`	`IUpdateBackupRequest` UpdateBackupRequest message or plain object

Returns
Type	Description
`Promise<google.spanner.admin.database.v1.Backup>`	Promise

updateDatabase(request, callback)

public updateDatabase(request: google.spanner.admin.database.v1.IUpdateDatabaseRequest, callback: google.spanner.admin.database.v1.DatabaseAdmin.UpdateDatabaseCallback): void;

Calls UpdateDatabase.

Parameters
Name	Description
`request`	`IUpdateDatabaseRequest` UpdateDatabaseRequest message or plain object
`callback`	`UpdateDatabaseCallback` Node-style callback called with the error, if any, and Operation

Returns
Type	Description
`void`

updateDatabase(request)

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

Calls UpdateDatabase.

Parameter
Name	Description
`request`	`IUpdateDatabaseRequest` UpdateDatabaseRequest message or plain object

Returns
Type	Description
`Promise<google.longrunning.Operation>`	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
Name	Description
`request`	`IUpdateDatabaseDdlRequest` UpdateDatabaseDdlRequest message or plain object
`callback`	`UpdateDatabaseDdlCallback` 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
Name	Description
`request`	`IUpdateDatabaseDdlRequest` UpdateDatabaseDdlRequest message or plain object

Returns
Type	Description
`Promise<google.longrunning.Operation>`	Promise