Class protos.google.cloud.clouddms.v1.DataMigrationService (2.2.2)

Represents a DataMigrationService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.clouddms.v1.DataMigrationService

Package

@google-cloud/dms

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new DataMigrationService service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

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

Creates new DataMigrationService 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
DataMigrationService

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

createConnectionProfile(request, callback)

public createConnectionProfile(request: google.cloud.clouddms.v1.ICreateConnectionProfileRequest, callback: google.cloud.clouddms.v1.DataMigrationService.CreateConnectionProfileCallback): void;

Calls CreateConnectionProfile.

Parameters
Name Description
request ICreateConnectionProfileRequest

CreateConnectionProfileRequest message or plain object
callback google.cloud.clouddms.v1.DataMigrationService.CreateConnectionProfileCallback

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

createConnectionProfile(request)

public createConnectionProfile(request: google.cloud.clouddms.v1.ICreateConnectionProfileRequest): Promise<google.longrunning.Operation>;

Calls CreateConnectionProfile.

Parameter
Name Description
request ICreateConnectionProfileRequest

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

Promise

createMigrationJob(request, callback)

public createMigrationJob(request: google.cloud.clouddms.v1.ICreateMigrationJobRequest, callback: google.cloud.clouddms.v1.DataMigrationService.CreateMigrationJobCallback): void;

Calls CreateMigrationJob.

Parameters
Name Description
request ICreateMigrationJobRequest

CreateMigrationJobRequest message or plain object
callback google.cloud.clouddms.v1.DataMigrationService.CreateMigrationJobCallback

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

createMigrationJob(request)

public createMigrationJob(request: google.cloud.clouddms.v1.ICreateMigrationJobRequest): Promise<google.longrunning.Operation>;

Calls CreateMigrationJob.

Parameter
Name Description
request ICreateMigrationJobRequest

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

Promise

deleteConnectionProfile(request, callback)

public deleteConnectionProfile(request: google.cloud.clouddms.v1.IDeleteConnectionProfileRequest, callback: google.cloud.clouddms.v1.DataMigrationService.DeleteConnectionProfileCallback): void;

Calls DeleteConnectionProfile.

Parameters
Name Description
request google.cloud.clouddms.v1.IDeleteConnectionProfileRequest

DeleteConnectionProfileRequest message or plain object
callback google.cloud.clouddms.v1.DataMigrationService.DeleteConnectionProfileCallback

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

deleteConnectionProfile(request)

public deleteConnectionProfile(request: google.cloud.clouddms.v1.IDeleteConnectionProfileRequest): Promise<google.longrunning.Operation>;

Calls DeleteConnectionProfile.

Parameter
Name Description
request google.cloud.clouddms.v1.IDeleteConnectionProfileRequest

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

Promise

deleteMigrationJob(request, callback)

public deleteMigrationJob(request: google.cloud.clouddms.v1.IDeleteMigrationJobRequest, callback: google.cloud.clouddms.v1.DataMigrationService.DeleteMigrationJobCallback): void;

Calls DeleteMigrationJob.

Parameters
Name Description
request IDeleteMigrationJobRequest

DeleteMigrationJobRequest message or plain object
callback google.cloud.clouddms.v1.DataMigrationService.DeleteMigrationJobCallback

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

deleteMigrationJob(request)

public deleteMigrationJob(request: google.cloud.clouddms.v1.IDeleteMigrationJobRequest): Promise<google.longrunning.Operation>;

Calls DeleteMigrationJob.

Parameter
Name Description
request IDeleteMigrationJobRequest

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

Promise

generateSshScript(request, callback)

public generateSshScript(request: google.cloud.clouddms.v1.IGenerateSshScriptRequest, callback: google.cloud.clouddms.v1.DataMigrationService.GenerateSshScriptCallback): void;

Calls GenerateSshScript.

Parameters
Name Description
request google.cloud.clouddms.v1.IGenerateSshScriptRequest

GenerateSshScriptRequest message or plain object
callback google.cloud.clouddms.v1.DataMigrationService.GenerateSshScriptCallback

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

generateSshScript(request)

public generateSshScript(request: google.cloud.clouddms.v1.IGenerateSshScriptRequest): Promise<google.cloud.clouddms.v1.SshScript>;

Calls GenerateSshScript.

Parameter
Name Description
request google.cloud.clouddms.v1.IGenerateSshScriptRequest

GenerateSshScriptRequest message or plain object
Returns
Type Description
Promise<google.cloud.clouddms.v1.SshScript>

Promise

getConnectionProfile(request, callback)

public getConnectionProfile(request: google.cloud.clouddms.v1.IGetConnectionProfileRequest, callback: google.cloud.clouddms.v1.DataMigrationService.GetConnectionProfileCallback): void;

Calls GetConnectionProfile.

Parameters
Name Description
request IGetConnectionProfileRequest

GetConnectionProfileRequest message or plain object
callback google.cloud.clouddms.v1.DataMigrationService.GetConnectionProfileCallback

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

getConnectionProfile(request)

public getConnectionProfile(request: google.cloud.clouddms.v1.IGetConnectionProfileRequest): Promise<google.cloud.clouddms.v1.ConnectionProfile>;

Calls GetConnectionProfile.

Parameter
Name Description
request IGetConnectionProfileRequest

GetConnectionProfileRequest message or plain object
Returns
Type Description
Promise<google.cloud.clouddms.v1.ConnectionProfile>

Promise

getMigrationJob(request, callback)

public getMigrationJob(request: google.cloud.clouddms.v1.IGetMigrationJobRequest, callback: google.cloud.clouddms.v1.DataMigrationService.GetMigrationJobCallback): void;

Calls GetMigrationJob.

Parameters
Name Description
request google.cloud.clouddms.v1.IGetMigrationJobRequest

GetMigrationJobRequest message or plain object
callback google.cloud.clouddms.v1.DataMigrationService.GetMigrationJobCallback

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

getMigrationJob(request)

public getMigrationJob(request: google.cloud.clouddms.v1.IGetMigrationJobRequest): Promise<google.cloud.clouddms.v1.MigrationJob>;

Calls GetMigrationJob.

Parameter
Name Description
request google.cloud.clouddms.v1.IGetMigrationJobRequest

GetMigrationJobRequest message or plain object
Returns
Type Description
Promise<google.cloud.clouddms.v1.MigrationJob>

Promise

listConnectionProfiles(request, callback)

public listConnectionProfiles(request: google.cloud.clouddms.v1.IListConnectionProfilesRequest, callback: google.cloud.clouddms.v1.DataMigrationService.ListConnectionProfilesCallback): void;

Calls ListConnectionProfiles.

Parameters
Name Description
request google.cloud.clouddms.v1.IListConnectionProfilesRequest

ListConnectionProfilesRequest message or plain object
callback google.cloud.clouddms.v1.DataMigrationService.ListConnectionProfilesCallback

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

listConnectionProfiles(request)

public listConnectionProfiles(request: google.cloud.clouddms.v1.IListConnectionProfilesRequest): Promise<google.cloud.clouddms.v1.ListConnectionProfilesResponse>;

Calls ListConnectionProfiles.

Parameter
Name Description
request google.cloud.clouddms.v1.IListConnectionProfilesRequest

ListConnectionProfilesRequest message or plain object
Returns
Type Description
Promise<google.cloud.clouddms.v1.ListConnectionProfilesResponse>

Promise

listMigrationJobs(request, callback)

public listMigrationJobs(request: google.cloud.clouddms.v1.IListMigrationJobsRequest, callback: google.cloud.clouddms.v1.DataMigrationService.ListMigrationJobsCallback): void;

Calls ListMigrationJobs.

Parameters
Name Description
request IListMigrationJobsRequest

ListMigrationJobsRequest message or plain object
callback google.cloud.clouddms.v1.DataMigrationService.ListMigrationJobsCallback

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

listMigrationJobs(request)

public listMigrationJobs(request: google.cloud.clouddms.v1.IListMigrationJobsRequest): Promise<google.cloud.clouddms.v1.ListMigrationJobsResponse>;

Calls ListMigrationJobs.

Parameter
Name Description
request IListMigrationJobsRequest

ListMigrationJobsRequest message or plain object
Returns
Type Description
Promise<google.cloud.clouddms.v1.ListMigrationJobsResponse>

Promise

promoteMigrationJob(request, callback)

public promoteMigrationJob(request: google.cloud.clouddms.v1.IPromoteMigrationJobRequest, callback: google.cloud.clouddms.v1.DataMigrationService.PromoteMigrationJobCallback): void;

Calls PromoteMigrationJob.

Parameters
Name Description
request IPromoteMigrationJobRequest

PromoteMigrationJobRequest message or plain object
callback google.cloud.clouddms.v1.DataMigrationService.PromoteMigrationJobCallback

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

promoteMigrationJob(request)

public promoteMigrationJob(request: google.cloud.clouddms.v1.IPromoteMigrationJobRequest): Promise<google.longrunning.Operation>;

Calls PromoteMigrationJob.

Parameter
Name Description
request IPromoteMigrationJobRequest

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

Promise

restartMigrationJob(request, callback)

public restartMigrationJob(request: google.cloud.clouddms.v1.IRestartMigrationJobRequest, callback: google.cloud.clouddms.v1.DataMigrationService.RestartMigrationJobCallback): void;

Calls RestartMigrationJob.

Parameters
Name Description
request google.cloud.clouddms.v1.IRestartMigrationJobRequest

RestartMigrationJobRequest message or plain object
callback google.cloud.clouddms.v1.DataMigrationService.RestartMigrationJobCallback

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

restartMigrationJob(request)

public restartMigrationJob(request: google.cloud.clouddms.v1.IRestartMigrationJobRequest): Promise<google.longrunning.Operation>;

Calls RestartMigrationJob.

Parameter
Name Description
request google.cloud.clouddms.v1.IRestartMigrationJobRequest

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

Promise

resumeMigrationJob(request, callback)

public resumeMigrationJob(request: google.cloud.clouddms.v1.IResumeMigrationJobRequest, callback: google.cloud.clouddms.v1.DataMigrationService.ResumeMigrationJobCallback): void;

Calls ResumeMigrationJob.

Parameters
Name Description
request google.cloud.clouddms.v1.IResumeMigrationJobRequest

ResumeMigrationJobRequest message or plain object
callback google.cloud.clouddms.v1.DataMigrationService.ResumeMigrationJobCallback

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

resumeMigrationJob(request)

public resumeMigrationJob(request: google.cloud.clouddms.v1.IResumeMigrationJobRequest): Promise<google.longrunning.Operation>;

Calls ResumeMigrationJob.

Parameter
Name Description
request google.cloud.clouddms.v1.IResumeMigrationJobRequest

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

Promise

startMigrationJob(request, callback)

public startMigrationJob(request: google.cloud.clouddms.v1.IStartMigrationJobRequest, callback: google.cloud.clouddms.v1.DataMigrationService.StartMigrationJobCallback): void;

Calls StartMigrationJob.

Parameters
Name Description
request IStartMigrationJobRequest

StartMigrationJobRequest message or plain object
callback google.cloud.clouddms.v1.DataMigrationService.StartMigrationJobCallback

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

startMigrationJob(request)

public startMigrationJob(request: google.cloud.clouddms.v1.IStartMigrationJobRequest): Promise<google.longrunning.Operation>;

Calls StartMigrationJob.

Parameter
Name Description
request IStartMigrationJobRequest

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

Promise

stopMigrationJob(request, callback)

public stopMigrationJob(request: google.cloud.clouddms.v1.IStopMigrationJobRequest, callback: google.cloud.clouddms.v1.DataMigrationService.StopMigrationJobCallback): void;

Calls StopMigrationJob.

Parameters
Name Description
request IStopMigrationJobRequest

StopMigrationJobRequest message or plain object
callback google.cloud.clouddms.v1.DataMigrationService.StopMigrationJobCallback

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

stopMigrationJob(request)

public stopMigrationJob(request: google.cloud.clouddms.v1.IStopMigrationJobRequest): Promise<google.longrunning.Operation>;

Calls StopMigrationJob.

Parameter
Name Description
request IStopMigrationJobRequest

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

Promise

updateConnectionProfile(request, callback)

public updateConnectionProfile(request: google.cloud.clouddms.v1.IUpdateConnectionProfileRequest, callback: google.cloud.clouddms.v1.DataMigrationService.UpdateConnectionProfileCallback): void;

Calls UpdateConnectionProfile.

Parameters
Name Description
request IUpdateConnectionProfileRequest

UpdateConnectionProfileRequest message or plain object
callback google.cloud.clouddms.v1.DataMigrationService.UpdateConnectionProfileCallback

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

updateConnectionProfile(request)

public updateConnectionProfile(request: google.cloud.clouddms.v1.IUpdateConnectionProfileRequest): Promise<google.longrunning.Operation>;

Calls UpdateConnectionProfile.

Parameter
Name Description
request IUpdateConnectionProfileRequest

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

Promise

updateMigrationJob(request, callback)

public updateMigrationJob(request: google.cloud.clouddms.v1.IUpdateMigrationJobRequest, callback: google.cloud.clouddms.v1.DataMigrationService.UpdateMigrationJobCallback): void;

Calls UpdateMigrationJob.

Parameters
Name Description
request IUpdateMigrationJobRequest

UpdateMigrationJobRequest message or plain object
callback google.cloud.clouddms.v1.DataMigrationService.UpdateMigrationJobCallback

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

updateMigrationJob(request)

public updateMigrationJob(request: google.cloud.clouddms.v1.IUpdateMigrationJobRequest): Promise<google.longrunning.Operation>;

Calls UpdateMigrationJob.

Parameter
Name Description
request IUpdateMigrationJobRequest

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

Promise

verifyMigrationJob(request, callback)

public verifyMigrationJob(request: google.cloud.clouddms.v1.IVerifyMigrationJobRequest, callback: google.cloud.clouddms.v1.DataMigrationService.VerifyMigrationJobCallback): void;

Calls VerifyMigrationJob.

Parameters
Name Description
request google.cloud.clouddms.v1.IVerifyMigrationJobRequest

VerifyMigrationJobRequest message or plain object
callback google.cloud.clouddms.v1.DataMigrationService.VerifyMigrationJobCallback

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

verifyMigrationJob(request)

public verifyMigrationJob(request: google.cloud.clouddms.v1.IVerifyMigrationJobRequest): Promise<google.longrunning.Operation>;

Calls VerifyMigrationJob.

Parameter
Name Description
request google.cloud.clouddms.v1.IVerifyMigrationJobRequest

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

Promise