Send feedback
Class v1.DataMigrationServiceClient (1.0.5) Stay organized with collections
Save and categorize content based on your preferences.
Version 1.0.5 keyboard_arrow_down
Database Migration service v1
Package
@google-cloud/dms!
Constructors
(constructor)(opts)
constructor
(
opts
?:
ClientOptions
);
Construct an instance of DataMigrationServiceClient.
Parameter
Properties
apiEndpoint
static
get
apiEndpoint
()
:
string
;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
Property Value
auth
auth
:
gax
.
GoogleAuth
;
Property Value
dataMigrationServiceStub
dataMigrationServiceStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
Property Value
descriptors
descriptors
:
Descriptors
;
Property Value
innerApiCalls
innerApiCalls
:
{
[
name
:
string
]
:
Function
;
};
Property Value
operationsClient
operationsClient
:
gax
.
OperationsClient
;
Property Value
pathTemplates
pathTemplates
:
{
[
name
:
string
]
:
gax
.
PathTemplate
;
};
Property Value
port
static
get
port
()
:
number
;
The port for this API service.
Property Value
scopes
static
get
scopes
()
:
string
[];
The scopes needed to make gRPC calls for every method defined in this service.
Property Value
servicePath
static
get
servicePath
()
:
string
;
The DNS address for this API service.
Property Value
warn
warn
:
(
code
:
string
,
message
:
string
,
warnType
?:
string
)
=
> void
;
Property Value
Methods
checkCreateConnectionProfileProgress(name)
checkCreateConnectionProfileProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
ConnectionProfile
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by createConnectionProfile()
.
Parameter Name
Description
name
string
The operation name that will be passed.
Returns Type
Description
Promise
< LROperation
<protos. google.cloud.clouddms.v1.ConnectionProfile
, protos. google.cloud.clouddms.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
checkCreateMigrationJobProgress(name)
checkCreateMigrationJobProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
MigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by createMigrationJob()
.
Parameter Name
Description
name
string
The operation name that will be passed.
Returns Type
Description
Promise
< LROperation
<protos. google.cloud.clouddms.v1.MigrationJob
, protos. google.cloud.clouddms.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
checkDeleteConnectionProfileProgress(name)
checkDeleteConnectionProfileProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by deleteConnectionProfile()
.
Parameter Name
Description
name
string
The operation name that will be passed.
Returns Type
Description
Promise
< LROperation
<protos. google.protobuf.Empty
, protos. google.cloud.clouddms.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
checkDeleteMigrationJobProgress(name)
checkDeleteMigrationJobProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by deleteMigrationJob()
.
Parameter Name
Description
name
string
The operation name that will be passed.
Returns Type
Description
Promise
< LROperation
<protos. google.protobuf.Empty
, protos. google.cloud.clouddms.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
checkPromoteMigrationJobProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
MigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by promoteMigrationJob()
.
Parameter Name
Description
name
string
The operation name that will be passed.
Returns Type
Description
Promise
< LROperation
<protos. google.cloud.clouddms.v1.MigrationJob
, protos. google.cloud.clouddms.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
checkRestartMigrationJobProgress(name)
checkRestartMigrationJobProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
MigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by restartMigrationJob()
.
Parameter Name
Description
name
string
The operation name that will be passed.
Returns Type
Description
Promise
< LROperation
<protos. google.cloud.clouddms.v1.MigrationJob
, protos. google.cloud.clouddms.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
checkResumeMigrationJobProgress(name)
checkResumeMigrationJobProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
MigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by resumeMigrationJob()
.
Parameter Name
Description
name
string
The operation name that will be passed.
Returns Type
Description
Promise
< LROperation
<protos. google.cloud.clouddms.v1.MigrationJob
, protos. google.cloud.clouddms.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
checkStartMigrationJobProgress(name)
checkStartMigrationJobProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
MigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by startMigrationJob()
.
Parameter Name
Description
name
string
The operation name that will be passed.
Returns Type
Description
Promise
< LROperation
<protos. google.cloud.clouddms.v1.MigrationJob
, protos. google.cloud.clouddms.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
checkStopMigrationJobProgress(name)
checkStopMigrationJobProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
MigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by stopMigrationJob()
.
Parameter Name
Description
name
string
The operation name that will be passed.
Returns Type
Description
Promise
< LROperation
<protos. google.cloud.clouddms.v1.MigrationJob
, protos. google.cloud.clouddms.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
checkUpdateConnectionProfileProgress(name)
checkUpdateConnectionProfileProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
ConnectionProfile
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by updateConnectionProfile()
.
Parameter Name
Description
name
string
The operation name that will be passed.
Returns Type
Description
Promise
< LROperation
<protos. google.cloud.clouddms.v1.ConnectionProfile
, protos. google.cloud.clouddms.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
checkUpdateMigrationJobProgress(name)
checkUpdateMigrationJobProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
MigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by updateMigrationJob()
.
Parameter Name
Description
name
string
The operation name that will be passed.
Returns Type
Description
Promise
< LROperation
<protos. google.cloud.clouddms.v1.MigrationJob
, protos. google.cloud.clouddms.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
checkVerifyMigrationJobProgress(name)
checkVerifyMigrationJobProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
MigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by verifyMigrationJob()
.
Parameter Name
Description
name
string
The operation name that will be passed.
Returns Type
Description
Promise
< LROperation
<protos. google.cloud.clouddms.v1.MigrationJob
, protos. google.cloud.clouddms.v1.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
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.
connectionProfilePath(project, location, connectionProfile)
connectionProfilePath
(
project
:
string
,
location
:
string
,
connectionProfile
:
string
)
:
string
;
Return a fully-qualified connectionProfile resource name string.
Parameters
Returns Type
Description
string
{string} Resource name string.
createConnectionProfile(request, options)
createConnectionProfile
(
request
?:
protos
.
google
.
cloud
.
clouddms
.
v1
.
ICreateConnectionProfileRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
IConnectionProfile
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.ICreateConnectionProfileRequest
options
CallOptions
Returns
createConnectionProfile(request, options, callback)
createConnectionProfile
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
ICreateConnectionProfileRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
IConnectionProfile
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.ICreateConnectionProfileRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.clouddms.v1.IConnectionProfile
, protos. google.cloud.clouddms.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
createConnectionProfile(request, callback)
createConnectionProfile
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
ICreateConnectionProfileRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
IConnectionProfile
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.ICreateConnectionProfileRequest
callback
Callback
< LROperation
<protos. google.cloud.clouddms.v1.IConnectionProfile
, protos. google.cloud.clouddms.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
createMigrationJob(request, options)
createMigrationJob
(
request
?:
protos
.
google
.
cloud
.
clouddms
.
v1
.
ICreateMigrationJobRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
IMigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.ICreateMigrationJobRequest
options
CallOptions
Returns
createMigrationJob(request, options, callback)
createMigrationJob
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
ICreateMigrationJobRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
IMigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.ICreateMigrationJobRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.clouddms.v1.IMigrationJob
, protos. google.cloud.clouddms.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
createMigrationJob(request, callback)
createMigrationJob
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
ICreateMigrationJobRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
IMigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.ICreateMigrationJobRequest
callback
Callback
< LROperation
<protos. google.cloud.clouddms.v1.IMigrationJob
, protos. google.cloud.clouddms.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
deleteConnectionProfile(request, options)
deleteConnectionProfile
(
request
?:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IDeleteConnectionProfileRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IDeleteConnectionProfileRequest
options
CallOptions
Returns
deleteConnectionProfile(request, options, callback)
deleteConnectionProfile
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IDeleteConnectionProfileRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IDeleteConnectionProfileRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.clouddms.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
deleteConnectionProfile(request, callback)
deleteConnectionProfile
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IDeleteConnectionProfileRequest
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IDeleteConnectionProfileRequest
callback
Callback
< LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.clouddms.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
deleteMigrationJob(request, options)
deleteMigrationJob
(
request
?:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IDeleteMigrationJobRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IDeleteMigrationJobRequest
options
CallOptions
Returns
deleteMigrationJob(request, options, callback)
deleteMigrationJob
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IDeleteMigrationJobRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IDeleteMigrationJobRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.clouddms.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
deleteMigrationJob(request, callback)
deleteMigrationJob
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IDeleteMigrationJobRequest
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IDeleteMigrationJobRequest
callback
Callback
< LROperation
<protos. google.protobuf.IEmpty
, protos. google.cloud.clouddms.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
generateSshScript(request, options)
generateSshScript
(
request
?:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IGenerateSshScriptRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
clouddms
.
v1
.
ISshScript
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IGenerateSshScriptRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IGenerateSshScriptRequest
options
CallOptions
Returns
generateSshScript(request, options, callback)
generateSshScript
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IGenerateSshScriptRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
clouddms
.
v1
.
ISshScript
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IGenerateSshScriptRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IGenerateSshScriptRequest
options
CallOptions
callback
Callback
<protos. google.cloud.clouddms.v1.ISshScript
, protos. google.cloud.clouddms.v1.IGenerateSshScriptRequest
| null | undefined, {} | null | undefined>
Returns
generateSshScript(request, callback)
generateSshScript
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IGenerateSshScriptRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
clouddms
.
v1
.
ISshScript
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IGenerateSshScriptRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IGenerateSshScriptRequest
callback
Callback
<protos. google.cloud.clouddms.v1.ISshScript
, protos. google.cloud.clouddms.v1.IGenerateSshScriptRequest
| null | undefined, {} | null | undefined>
Returns
getConnectionProfile(request, options)
getConnectionProfile
(
request
?:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IGetConnectionProfileRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
clouddms
.
v1
.
IConnectionProfile
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IGetConnectionProfileRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IGetConnectionProfileRequest
options
CallOptions
Returns
getConnectionProfile(request, options, callback)
getConnectionProfile
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IGetConnectionProfileRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
clouddms
.
v1
.
IConnectionProfile
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IGetConnectionProfileRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IGetConnectionProfileRequest
options
CallOptions
callback
Callback
<protos. google.cloud.clouddms.v1.IConnectionProfile
, protos. google.cloud.clouddms.v1.IGetConnectionProfileRequest
| null | undefined, {} | null | undefined>
Returns
getConnectionProfile(request, callback)
getConnectionProfile
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IGetConnectionProfileRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
clouddms
.
v1
.
IConnectionProfile
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IGetConnectionProfileRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IGetConnectionProfileRequest
callback
Callback
<protos. google.cloud.clouddms.v1.IConnectionProfile
, protos. google.cloud.clouddms.v1.IGetConnectionProfileRequest
| null | undefined, {} | null | undefined>
Returns
getMigrationJob(request, options)
getMigrationJob
(
request
?:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IGetMigrationJobRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
clouddms
.
v1
.
IMigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IGetMigrationJobRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IGetMigrationJobRequest
options
CallOptions
Returns
getMigrationJob(request, options, callback)
getMigrationJob
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IGetMigrationJobRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
clouddms
.
v1
.
IMigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IGetMigrationJobRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IGetMigrationJobRequest
options
CallOptions
callback
Callback
<protos. google.cloud.clouddms.v1.IMigrationJob
, protos. google.cloud.clouddms.v1.IGetMigrationJobRequest
| null | undefined, {} | null | undefined>
Returns
getMigrationJob(request, callback)
getMigrationJob
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IGetMigrationJobRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
clouddms
.
v1
.
IMigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IGetMigrationJobRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IGetMigrationJobRequest
callback
Callback
<protos. google.cloud.clouddms.v1.IMigrationJob
, protos. google.cloud.clouddms.v1.IGetMigrationJobRequest
| null | undefined, {} | null | undefined>
Returns
getProjectId()
getProjectId
()
:
Promise<string>
;
Returns
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
Parameter Name
Description
callback
Callback
<string, undefined, undefined>
Returns
initialize()
initialize
()
:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Returns Type
Description
Promise
<{
[name: string]: Function
;
}>
{Promise} A promise that resolves to an authenticated service stub.
listConnectionProfiles(request, options)
listConnectionProfiles
(
request
?:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IListConnectionProfilesRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
clouddms
.
v1
.
IConnectionProfile
[],
protos
.
google
.
cloud
.
clouddms
.
v1
.
IListConnectionProfilesRequest
|
null
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IListConnectionProfilesResponse
]>;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IListConnectionProfilesRequest
options
CallOptions
Returns
listConnectionProfiles(request, options, callback)
listConnectionProfiles
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IListConnectionProfilesRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
clouddms
.
v1
.
IListConnectionProfilesRequest
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IListConnectionProfilesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IConnectionProfile
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IListConnectionProfilesRequest
options
CallOptions
callback
PaginationCallback
<protos. google.cloud.clouddms.v1.IListConnectionProfilesRequest
, protos. google.cloud.clouddms.v1.IListConnectionProfilesResponse
| null | undefined, protos. google.cloud.clouddms.v1.IConnectionProfile
>
Returns
listConnectionProfiles(request, callback)
listConnectionProfiles
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IListConnectionProfilesRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
clouddms
.
v1
.
IListConnectionProfilesRequest
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IListConnectionProfilesResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IConnectionProfile
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IListConnectionProfilesRequest
callback
PaginationCallback
<protos. google.cloud.clouddms.v1.IListConnectionProfilesRequest
, protos. google.cloud.clouddms.v1.IListConnectionProfilesResponse
| null | undefined, protos. google.cloud.clouddms.v1.IConnectionProfile
>
Returns
listConnectionProfilesAsync(request, options)
listConnectionProfilesAsync
(
request
?:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IListConnectionProfilesRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
clouddms
.
v1
.
IConnectionProfile
> ;
Equivalent to listConnectionProfiles
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IListConnectionProfilesRequest
The request object that will be sent.
options
CallOptions
Call options. See CallOptions
for more details.
Returns Type
Description
AsyncIterable
<protos. google.cloud.clouddms.v1.IConnectionProfile
>
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [ConnectionProfile]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
listConnectionProfilesStream(request, options)
listConnectionProfilesStream
(
request
?:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IListConnectionProfilesRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IListConnectionProfilesRequest
The request object that will be sent.
options
CallOptions
Call options. See CallOptions
for more details.
Returns Type
Description
Transform
{Stream} An object stream which emits an object representing [ConnectionProfile] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listConnectionProfilesAsync()
method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
listMigrationJobs(request, options)
listMigrationJobs
(
request
?:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IListMigrationJobsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
clouddms
.
v1
.
IMigrationJob
[],
protos
.
google
.
cloud
.
clouddms
.
v1
.
IListMigrationJobsRequest
|
null
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IListMigrationJobsResponse
]>;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IListMigrationJobsRequest
options
CallOptions
Returns
listMigrationJobs(request, options, callback)
listMigrationJobs
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IListMigrationJobsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
clouddms
.
v1
.
IListMigrationJobsRequest
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IListMigrationJobsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IMigrationJob
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IListMigrationJobsRequest
options
CallOptions
callback
PaginationCallback
<protos. google.cloud.clouddms.v1.IListMigrationJobsRequest
, protos. google.cloud.clouddms.v1.IListMigrationJobsResponse
| null | undefined, protos. google.cloud.clouddms.v1.IMigrationJob
>
Returns
listMigrationJobs(request, callback)
listMigrationJobs
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IListMigrationJobsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
clouddms
.
v1
.
IListMigrationJobsRequest
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IListMigrationJobsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IMigrationJob
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IListMigrationJobsRequest
callback
PaginationCallback
<protos. google.cloud.clouddms.v1.IListMigrationJobsRequest
, protos. google.cloud.clouddms.v1.IListMigrationJobsResponse
| null | undefined, protos. google.cloud.clouddms.v1.IMigrationJob
>
Returns
listMigrationJobsAsync(request, options)
listMigrationJobsAsync
(
request
?:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IListMigrationJobsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
clouddms
.
v1
.
IMigrationJob
> ;
Equivalent to listMigrationJobs
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IListMigrationJobsRequest
The request object that will be sent.
options
CallOptions
Call options. See CallOptions
for more details.
Returns Type
Description
AsyncIterable
<protos. google.cloud.clouddms.v1.IMigrationJob
>
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [MigrationJob]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
listMigrationJobsStream(request, options)
listMigrationJobsStream
(
request
?:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IListMigrationJobsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IListMigrationJobsRequest
The request object that will be sent.
options
CallOptions
Call options. See CallOptions
for more details.
Returns Type
Description
Transform
{Stream} An object stream which emits an object representing [MigrationJob] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listMigrationJobsAsync()
method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
locationPath(project, location)
locationPath
(
project
:
string
,
location
:
string
)
:
string
;
Return a fully-qualified location resource name string.
Parameters
Returns Type
Description
string
{string} Resource name string.
matchConnectionProfileFromConnectionProfileName(connectionProfileName)
matchConnectionProfileFromConnectionProfileName
(
connectionProfileName
:
string
)
:
string
|
number
;
Parse the connection_profile from ConnectionProfile resource.
Parameter Name
Description
connectionProfileName
string
A fully-qualified path representing ConnectionProfile resource.
Returns Type
Description
string | number
{string} A string representing the connection_profile.
matchLocationFromConnectionProfileName(connectionProfileName)
matchLocationFromConnectionProfileName
(
connectionProfileName
:
string
)
:
string
|
number
;
Parse the location from ConnectionProfile resource.
Parameter Name
Description
connectionProfileName
string
A fully-qualified path representing ConnectionProfile resource.
Returns Type
Description
string | number
{string} A string representing the location.
matchLocationFromLocationName(locationName)
matchLocationFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the location from Location resource.
Parameter Name
Description
locationName
string
A fully-qualified path representing Location resource.
Returns Type
Description
string | number
{string} A string representing the location.
matchLocationFromMigrationJobName(migrationJobName)
matchLocationFromMigrationJobName
(
migrationJobName
:
string
)
:
string
|
number
;
Parse the location from MigrationJob resource.
Parameter Name
Description
migrationJobName
string
A fully-qualified path representing MigrationJob resource.
Returns Type
Description
string | number
{string} A string representing the location.
matchMigrationJobFromMigrationJobName(migrationJobName)
matchMigrationJobFromMigrationJobName
(
migrationJobName
:
string
)
:
string
|
number
;
Parse the migration_job from MigrationJob resource.
Parameter Name
Description
migrationJobName
string
A fully-qualified path representing MigrationJob resource.
Returns Type
Description
string | number
{string} A string representing the migration_job.
matchProjectFromConnectionProfileName(connectionProfileName)
matchProjectFromConnectionProfileName
(
connectionProfileName
:
string
)
:
string
|
number
;
Parse the project from ConnectionProfile resource.
Parameter Name
Description
connectionProfileName
string
A fully-qualified path representing ConnectionProfile resource.
Returns Type
Description
string | number
{string} A string representing the project.
matchProjectFromLocationName(locationName)
matchProjectFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the project from Location resource.
Parameter Name
Description
locationName
string
A fully-qualified path representing Location resource.
Returns Type
Description
string | number
{string} A string representing the project.
matchProjectFromMigrationJobName(migrationJobName)
matchProjectFromMigrationJobName
(
migrationJobName
:
string
)
:
string
|
number
;
Parse the project from MigrationJob resource.
Parameter Name
Description
migrationJobName
string
A fully-qualified path representing MigrationJob resource.
Returns Type
Description
string | number
{string} A string representing the project.
matchProjectFromProjectName(projectName)
matchProjectFromProjectName
(
projectName
:
string
)
:
string
|
number
;
Parse the project from Project resource.
Parameter Name
Description
projectName
string
A fully-qualified path representing Project resource.
Returns Type
Description
string | number
{string} A string representing the project.
migrationJobPath(project, location, migrationJob)
migrationJobPath
(
project
:
string
,
location
:
string
,
migrationJob
:
string
)
:
string
;
Return a fully-qualified migrationJob resource name string.
Parameters
Returns Type
Description
string
{string} Resource name string.
projectPath(project)
projectPath
(
project
:
string
)
:
string
;
Return a fully-qualified project resource name string.
Parameter
Returns Type
Description
string
{string} Resource name string.
promoteMigrationJob
(
request
?:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IPromoteMigrationJobRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
IMigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IPromoteMigrationJobRequest
options
CallOptions
Returns
promoteMigrationJob
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IPromoteMigrationJobRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
IMigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IPromoteMigrationJobRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.clouddms.v1.IMigrationJob
, protos. google.cloud.clouddms.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
promoteMigrationJob
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IPromoteMigrationJobRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
IMigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IPromoteMigrationJobRequest
callback
Callback
< LROperation
<protos. google.cloud.clouddms.v1.IMigrationJob
, protos. google.cloud.clouddms.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
restartMigrationJob(request, options)
restartMigrationJob
(
request
?:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IRestartMigrationJobRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
IMigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IRestartMigrationJobRequest
options
CallOptions
Returns
restartMigrationJob(request, options, callback)
restartMigrationJob
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IRestartMigrationJobRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
IMigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IRestartMigrationJobRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.clouddms.v1.IMigrationJob
, protos. google.cloud.clouddms.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
restartMigrationJob(request, callback)
restartMigrationJob
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IRestartMigrationJobRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
IMigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IRestartMigrationJobRequest
callback
Callback
< LROperation
<protos. google.cloud.clouddms.v1.IMigrationJob
, protos. google.cloud.clouddms.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
resumeMigrationJob(request, options)
resumeMigrationJob
(
request
?:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IResumeMigrationJobRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
IMigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IResumeMigrationJobRequest
options
CallOptions
Returns
resumeMigrationJob(request, options, callback)
resumeMigrationJob
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IResumeMigrationJobRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
IMigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IResumeMigrationJobRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.clouddms.v1.IMigrationJob
, protos. google.cloud.clouddms.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
resumeMigrationJob(request, callback)
resumeMigrationJob
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IResumeMigrationJobRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
IMigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IResumeMigrationJobRequest
callback
Callback
< LROperation
<protos. google.cloud.clouddms.v1.IMigrationJob
, protos. google.cloud.clouddms.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
startMigrationJob(request, options)
startMigrationJob
(
request
?:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IStartMigrationJobRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
IMigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IStartMigrationJobRequest
options
CallOptions
Returns
startMigrationJob(request, options, callback)
startMigrationJob
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IStartMigrationJobRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
IMigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IStartMigrationJobRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.clouddms.v1.IMigrationJob
, protos. google.cloud.clouddms.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
startMigrationJob(request, callback)
startMigrationJob
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IStartMigrationJobRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
IMigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IStartMigrationJobRequest
callback
Callback
< LROperation
<protos. google.cloud.clouddms.v1.IMigrationJob
, protos. google.cloud.clouddms.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
stopMigrationJob(request, options)
stopMigrationJob
(
request
?:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IStopMigrationJobRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
IMigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IStopMigrationJobRequest
options
CallOptions
Returns
stopMigrationJob(request, options, callback)
stopMigrationJob
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IStopMigrationJobRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
IMigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IStopMigrationJobRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.clouddms.v1.IMigrationJob
, protos. google.cloud.clouddms.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
stopMigrationJob(request, callback)
stopMigrationJob
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IStopMigrationJobRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
IMigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IStopMigrationJobRequest
callback
Callback
< LROperation
<protos. google.cloud.clouddms.v1.IMigrationJob
, protos. google.cloud.clouddms.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
updateConnectionProfile(request, options)
updateConnectionProfile
(
request
?:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IUpdateConnectionProfileRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
IConnectionProfile
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IUpdateConnectionProfileRequest
options
CallOptions
Returns
updateConnectionProfile(request, options, callback)
updateConnectionProfile
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IUpdateConnectionProfileRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
IConnectionProfile
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IUpdateConnectionProfileRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.clouddms.v1.IConnectionProfile
, protos. google.cloud.clouddms.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
updateConnectionProfile(request, callback)
updateConnectionProfile
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IUpdateConnectionProfileRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
IConnectionProfile
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IUpdateConnectionProfileRequest
callback
Callback
< LROperation
<protos. google.cloud.clouddms.v1.IConnectionProfile
, protos. google.cloud.clouddms.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
updateMigrationJob(request, options)
updateMigrationJob
(
request
?:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IUpdateMigrationJobRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
IMigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IUpdateMigrationJobRequest
options
CallOptions
Returns
updateMigrationJob(request, options, callback)
updateMigrationJob
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IUpdateMigrationJobRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
IMigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IUpdateMigrationJobRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.clouddms.v1.IMigrationJob
, protos. google.cloud.clouddms.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
updateMigrationJob(request, callback)
updateMigrationJob
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IUpdateMigrationJobRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
IMigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IUpdateMigrationJobRequest
callback
Callback
< LROperation
<protos. google.cloud.clouddms.v1.IMigrationJob
, protos. google.cloud.clouddms.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
verifyMigrationJob(request, options)
verifyMigrationJob
(
request
?:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IVerifyMigrationJobRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
IMigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IVerifyMigrationJobRequest
options
CallOptions
Returns
verifyMigrationJob(request, options, callback)
verifyMigrationJob
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IVerifyMigrationJobRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
IMigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IVerifyMigrationJobRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.clouddms.v1.IMigrationJob
, protos. google.cloud.clouddms.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
verifyMigrationJob(request, callback)
verifyMigrationJob
(
request
:
protos
.
google
.
cloud
.
clouddms
.
v1
.
IVerifyMigrationJobRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
clouddms
.
v1
.
IMigrationJob
,
protos
.
google
.
cloud
.
clouddms
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.clouddms.v1.IVerifyMigrationJobRequest
callback
Callback
< LROperation
<protos. google.cloud.clouddms.v1.IMigrationJob
, protos. google.cloud.clouddms.v1.IOperationMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
Returns
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-04 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,[]]
