Reference documentation and code samples for the Google Cloud Dms V1 Client class MigrationJob.
Represents a Database Migration Service migration job object.
Generated from protobuf message google.cloud.clouddms.v1.MigrationJob
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/instances/{instance}.
↳ create_time
Google\Protobuf\Timestamp
Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
↳ update_time
Google\Protobuf\Timestamp
Output only. The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
↳ labels
array| Google\Protobuf\Internal\MapField
The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }
.
↳ display_name
string
The migration job display name.
↳ state
int
The current migration job state.
↳ phase
int
Output only. The current migration job phase.
↳ type
int
Required. The migration job type.
↳ dump_path
string
The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]).
↳ source
string
Required. The resource name (URI) of the source connection profile.
↳ destination
string
Required. The resource name (URI) of the destination connection profile.
↳ reverse_ssh_connectivity
Google\Cloud\CloudDms\V1\ReverseSshConnectivity
The details needed to communicate to the source over Reverse SSH tunnel connectivity.
↳ vpc_peering_connectivity
Google\Cloud\CloudDms\V1\VpcPeeringConnectivity
The details of the VPC network that the source database is located in.
↳ static_ip_connectivity
Google\Cloud\CloudDms\V1\StaticIpConnectivity
static ip connectivity data (default, no additional details needed).
↳ duration
Google\Protobuf\Duration
Output only. The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
↳ error
↳ source_database
↳ destination_database
↳ end_time
Google\Protobuf\Timestamp
Output only. If the migration job is completed, the time when it was completed.
getName
The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/instances/{instance}.
string
setName
The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/instances/{instance}.
var
string
$this
getCreateTime
Output only. The timestamp when the migration job resource was created.
A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
hasCreateTime
clearCreateTime
setCreateTime
Output only. The timestamp when the migration job resource was created.
A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
$this
getUpdateTime
Output only. The timestamp when the migration job resource was last updated.
A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The timestamp when the migration job resource was last updated.
A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".
$this
getLabels
The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs.
Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }
.
setLabels
The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs.
Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }
.
$this
getDisplayName
The migration job display name.
string
setDisplayName
The migration job display name.
var
string
$this
getState
The current migration job state.
int
setState
The current migration job state.
var
int
$this
getPhase
Output only. The current migration job phase.
int
setPhase
Output only. The current migration job phase.
var
int
$this
getType
Required. The migration job type.
int
setType
Required. The migration job type.
var
int
$this
getDumpPath
The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]).
string
setDumpPath
The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]).
var
string
$this
getSource
Required. The resource name (URI) of the source connection profile.
string
setSource
Required. The resource name (URI) of the source connection profile.
var
string
$this
getDestination
Required. The resource name (URI) of the destination connection profile.
string
setDestination
Required. The resource name (URI) of the destination connection profile.
var
string
$this
getReverseSshConnectivity
The details needed to communicate to the source over Reverse SSH tunnel connectivity.
hasReverseSshConnectivity
setReverseSshConnectivity
The details needed to communicate to the source over Reverse SSH tunnel connectivity.
$this
getVpcPeeringConnectivity
The details of the VPC network that the source database is located in.
hasVpcPeeringConnectivity
setVpcPeeringConnectivity
The details of the VPC network that the source database is located in.
$this
getStaticIpConnectivity
static ip connectivity data (default, no additional details needed).
hasStaticIpConnectivity
setStaticIpConnectivity
static ip connectivity data (default, no additional details needed).
$this
getDuration
Output only. The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
hasDuration
clearDuration
setDuration
Output only. The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s".
$this
getError
Output only. The error details in case of state FAILED.
hasError
clearError
setError
Output only. The error details in case of state FAILED.
$this
getSourceDatabase
The database engine type and provider of the source.
hasSourceDatabase
clearSourceDatabase
setSourceDatabase
The database engine type and provider of the source.
$this
getDestinationDatabase
The database engine type and provider of the destination.
hasDestinationDatabase
clearDestinationDatabase
setDestinationDatabase
The database engine type and provider of the destination.
$this
getEndTime
Output only. If the migration job is completed, the time when it was completed.
hasEndTime
clearEndTime
setEndTime
Output only. If the migration job is completed, the time when it was completed.
$this
getConnectivity
string