Class MigrationJob (0.16.0)

public final class MigrationJob extends GeneratedMessageV3 implements MigrationJobOrBuilder

Represents a Database Migration Service migration job object.

Protobuf type google.events.cloud.clouddms.v1.MigrationJob

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESTINATION_DATABASE_FIELD_NUMBER

public static final int DESTINATION_DATABASE_FIELD_NUMBER
Field Value
Type Description
int

DESTINATION_FIELD_NUMBER

public static final int DESTINATION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

DUMP_FLAGS_FIELD_NUMBER

public static final int DUMP_FLAGS_FIELD_NUMBER
Field Value
Type Description
int

DUMP_PATH_FIELD_NUMBER

public static final int DUMP_PATH_FIELD_NUMBER
Field Value
Type Description
int

DURATION_FIELD_NUMBER

public static final int DURATION_FIELD_NUMBER
Field Value
Type Description
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
Type Description
int

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PHASE_FIELD_NUMBER

public static final int PHASE_FIELD_NUMBER
Field Value
Type Description
int

REVERSE_SSH_CONNECTIVITY_FIELD_NUMBER

public static final int REVERSE_SSH_CONNECTIVITY_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_DATABASE_FIELD_NUMBER

public static final int SOURCE_DATABASE_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_FIELD_NUMBER

public static final int SOURCE_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

STATIC_IP_CONNECTIVITY_FIELD_NUMBER

public static final int STATIC_IP_CONNECTIVITY_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

VPC_PEERING_CONNECTIVITY_FIELD_NUMBER

public static final int VPC_PEERING_CONNECTIVITY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static MigrationJob getDefaultInstance()
Returns
Type Description
MigrationJob

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static MigrationJob.Builder newBuilder()
Returns
Type Description
MigrationJob.Builder

newBuilder(MigrationJob prototype)

public static MigrationJob.Builder newBuilder(MigrationJob prototype)
Parameter
Name Description
prototype MigrationJob
Returns
Type Description
MigrationJob.Builder

parseDelimitedFrom(InputStream input)

public static MigrationJob parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MigrationJob
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MigrationJob parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MigrationJob
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static MigrationJob parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
MigrationJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static MigrationJob parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MigrationJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static MigrationJob parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
MigrationJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static MigrationJob parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MigrationJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static MigrationJob parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
MigrationJob
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static MigrationJob parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MigrationJob
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static MigrationJob parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MigrationJob
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MigrationJob parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MigrationJob
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static MigrationJob parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
MigrationJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static MigrationJob parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MigrationJob
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<MigrationJob> parser()
Returns
Type Description
Parser<MigrationJob>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

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" }.

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getConnectivityCase()

public MigrationJob.ConnectivityCase getConnectivityCase()
Returns
Type Description
MigrationJob.ConnectivityCase

getCreateTime()

public Timestamp 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".

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

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".

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public MigrationJob getDefaultInstanceForType()
Returns
Type Description
MigrationJob

getDestination()

public String getDestination()

Required. The resource name (URI) of the destination connection profile.

string destination = 11;

Returns
Type Description
String

The destination.

getDestinationBytes()

public ByteString getDestinationBytes()

Required. The resource name (URI) of the destination connection profile.

string destination = 11;

Returns
Type Description
ByteString

The bytes for destination.

getDestinationDatabase()

public DatabaseType getDestinationDatabase()

The database engine type and provider of the destination.

.google.events.cloud.clouddms.v1.DatabaseType destination_database = 15;

Returns
Type Description
DatabaseType

The destinationDatabase.

getDestinationDatabaseOrBuilder()

public DatabaseTypeOrBuilder getDestinationDatabaseOrBuilder()

The database engine type and provider of the destination.

.google.events.cloud.clouddms.v1.DatabaseType destination_database = 15;

Returns
Type Description
DatabaseTypeOrBuilder

getDisplayName()

public String getDisplayName()

The migration job display name.

string display_name = 5;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The migration job display name.

string display_name = 5;

Returns
Type Description
ByteString

The bytes for displayName.

getDumpFlags()

public MigrationJob.DumpFlags getDumpFlags()

The initial dump flags. This field and the "dump_path" field are mutually exclusive.

.google.events.cloud.clouddms.v1.MigrationJob.DumpFlags dump_flags = 17;

Returns
Type Description
MigrationJob.DumpFlags

The dumpFlags.

getDumpFlagsOrBuilder()

public MigrationJob.DumpFlagsOrBuilder getDumpFlagsOrBuilder()

The initial dump flags. This field and the "dump_path" field are mutually exclusive.

.google.events.cloud.clouddms.v1.MigrationJob.DumpFlags dump_flags = 17;

Returns
Type Description
MigrationJob.DumpFlagsOrBuilder

getDumpPath()

public String getDumpPath()

The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). This field and the "dump_flags" field are mutually exclusive.

string dump_path = 9;

Returns
Type Description
String

The dumpPath.

getDumpPathBytes()

public ByteString getDumpPathBytes()

The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). This field and the "dump_flags" field are mutually exclusive.

string dump_path = 9;

Returns
Type Description
ByteString

The bytes for dumpPath.

getDuration()

public Duration 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".

.google.protobuf.Duration duration = 12;

Returns
Type Description
Duration

The duration.

getDurationOrBuilder()

public DurationOrBuilder getDurationOrBuilder()

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".

.google.protobuf.Duration duration = 12;

Returns
Type Description
DurationOrBuilder

getEndTime()

public Timestamp getEndTime()

Output only. If the migration job is completed, the time when it was completed.

.google.protobuf.Timestamp end_time = 16;

Returns
Type Description
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

Output only. If the migration job is completed, the time when it was completed.

.google.protobuf.Timestamp end_time = 16;

Returns
Type Description
TimestampOrBuilder

getError()

public Status getError()

Output only. The error details in case of state FAILED.

.google.rpc.Status error = 13;

Returns
Type Description
com.google.rpc.Status

The error.

getErrorOrBuilder()

public StatusOrBuilder getErrorOrBuilder()

Output only. The error details in case of state FAILED.

.google.rpc.Status error = 13;

Returns
Type Description
com.google.rpc.StatusOrBuilder

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

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" }.

map<string, string> labels = 4;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

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" }.

map<string, string> labels = 4;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

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" }.

map<string, string> labels = 4;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

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" }.

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public String getName()

The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<MigrationJob> getParserForType()
Returns
Type Description
Parser<MigrationJob>
Overrides

getPhase()

public MigrationJob.Phase getPhase()

Output only. The current migration job phase.

.google.events.cloud.clouddms.v1.MigrationJob.Phase phase = 7;

Returns
Type Description
MigrationJob.Phase

The phase.

getPhaseValue()

public int getPhaseValue()

Output only. The current migration job phase.

.google.events.cloud.clouddms.v1.MigrationJob.Phase phase = 7;

Returns
Type Description
int

The enum numeric value on the wire for phase.

getReverseSshConnectivity()

public ReverseSshConnectivity getReverseSshConnectivity()

The details needed to communicate to the source over Reverse SSH tunnel connectivity.

.google.events.cloud.clouddms.v1.ReverseSshConnectivity reverse_ssh_connectivity = 101;

Returns
Type Description
ReverseSshConnectivity

The reverseSshConnectivity.

getReverseSshConnectivityOrBuilder()

public ReverseSshConnectivityOrBuilder getReverseSshConnectivityOrBuilder()

The details needed to communicate to the source over Reverse SSH tunnel connectivity.

.google.events.cloud.clouddms.v1.ReverseSshConnectivity reverse_ssh_connectivity = 101;

Returns
Type Description
ReverseSshConnectivityOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSource()

public String getSource()

Required. The resource name (URI) of the source connection profile.

string source = 10;

Returns
Type Description
String

The source.

getSourceBytes()

public ByteString getSourceBytes()

Required. The resource name (URI) of the source connection profile.

string source = 10;

Returns
Type Description
ByteString

The bytes for source.

getSourceDatabase()

public DatabaseType getSourceDatabase()

The database engine type and provider of the source.

.google.events.cloud.clouddms.v1.DatabaseType source_database = 14;

Returns
Type Description
DatabaseType

The sourceDatabase.

getSourceDatabaseOrBuilder()

public DatabaseTypeOrBuilder getSourceDatabaseOrBuilder()

The database engine type and provider of the source.

.google.events.cloud.clouddms.v1.DatabaseType source_database = 14;

Returns
Type Description
DatabaseTypeOrBuilder

getState()

public MigrationJob.State getState()

The current migration job state.

.google.events.cloud.clouddms.v1.MigrationJob.State state = 6;

Returns
Type Description
MigrationJob.State

The state.

getStateValue()

public int getStateValue()

The current migration job state.

.google.events.cloud.clouddms.v1.MigrationJob.State state = 6;

Returns
Type Description
int

The enum numeric value on the wire for state.

getStaticIpConnectivity()

public StaticIpConnectivity getStaticIpConnectivity()

static ip connectivity data (default, no additional details needed).

.google.events.cloud.clouddms.v1.StaticIpConnectivity static_ip_connectivity = 103;

Returns
Type Description
StaticIpConnectivity

The staticIpConnectivity.

getStaticIpConnectivityOrBuilder()

public StaticIpConnectivityOrBuilder getStaticIpConnectivityOrBuilder()

static ip connectivity data (default, no additional details needed).

.google.events.cloud.clouddms.v1.StaticIpConnectivity static_ip_connectivity = 103;

Returns
Type Description
StaticIpConnectivityOrBuilder

getType()

public MigrationJob.Type getType()

Required. The migration job type.

.google.events.cloud.clouddms.v1.MigrationJob.Type type = 8;

Returns
Type Description
MigrationJob.Type

The type.

getTypeValue()

public int getTypeValue()

Required. The migration job type.

.google.events.cloud.clouddms.v1.MigrationJob.Type type = 8;

Returns
Type Description
int

The enum numeric value on the wire for type.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

getUpdateTime()

public Timestamp 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".

.google.protobuf.Timestamp update_time = 3;

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

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".

.google.protobuf.Timestamp update_time = 3;

Returns
Type Description
TimestampOrBuilder

getVpcPeeringConnectivity()

public VpcPeeringConnectivity getVpcPeeringConnectivity()

The details of the VPC network that the source database is located in.

.google.events.cloud.clouddms.v1.VpcPeeringConnectivity vpc_peering_connectivity = 102;

Returns
Type Description
VpcPeeringConnectivity

The vpcPeeringConnectivity.

getVpcPeeringConnectivityOrBuilder()

public VpcPeeringConnectivityOrBuilder getVpcPeeringConnectivityOrBuilder()

The details of the VPC network that the source database is located in.

.google.events.cloud.clouddms.v1.VpcPeeringConnectivity vpc_peering_connectivity = 102;

Returns
Type Description
VpcPeeringConnectivityOrBuilder

hasCreateTime()

public boolean hasCreateTime()

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".

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
boolean

Whether the createTime field is set.

hasDestinationDatabase()

public boolean hasDestinationDatabase()

The database engine type and provider of the destination.

.google.events.cloud.clouddms.v1.DatabaseType destination_database = 15;

Returns
Type Description
boolean

Whether the destinationDatabase field is set.

hasDumpFlags()

public boolean hasDumpFlags()

The initial dump flags. This field and the "dump_path" field are mutually exclusive.

.google.events.cloud.clouddms.v1.MigrationJob.DumpFlags dump_flags = 17;

Returns
Type Description
boolean

Whether the dumpFlags field is set.

hasDuration()

public boolean hasDuration()

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".

.google.protobuf.Duration duration = 12;

Returns
Type Description
boolean

Whether the duration field is set.

hasEndTime()

public boolean hasEndTime()

Output only. If the migration job is completed, the time when it was completed.

.google.protobuf.Timestamp end_time = 16;

Returns
Type Description
boolean

Whether the endTime field is set.

hasError()

public boolean hasError()

Output only. The error details in case of state FAILED.

.google.rpc.Status error = 13;

Returns
Type Description
boolean

Whether the error field is set.

hasReverseSshConnectivity()

public boolean hasReverseSshConnectivity()

The details needed to communicate to the source over Reverse SSH tunnel connectivity.

.google.events.cloud.clouddms.v1.ReverseSshConnectivity reverse_ssh_connectivity = 101;

Returns
Type Description
boolean

Whether the reverseSshConnectivity field is set.

hasSourceDatabase()

public boolean hasSourceDatabase()

The database engine type and provider of the source.

.google.events.cloud.clouddms.v1.DatabaseType source_database = 14;

Returns
Type Description
boolean

Whether the sourceDatabase field is set.

hasStaticIpConnectivity()

public boolean hasStaticIpConnectivity()

static ip connectivity data (default, no additional details needed).

.google.events.cloud.clouddms.v1.StaticIpConnectivity static_ip_connectivity = 103;

Returns
Type Description
boolean

Whether the staticIpConnectivity field is set.

hasUpdateTime()

public boolean hasUpdateTime()

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".

.google.protobuf.Timestamp update_time = 3;

Returns
Type Description
boolean

Whether the updateTime field is set.

hasVpcPeeringConnectivity()

public boolean hasVpcPeeringConnectivity()

The details of the VPC network that the source database is located in.

.google.events.cloud.clouddms.v1.VpcPeeringConnectivity vpc_peering_connectivity = 102;

Returns
Type Description
boolean

Whether the vpcPeeringConnectivity field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public MigrationJob.Builder newBuilderForType()
Returns
Type Description
MigrationJob.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected MigrationJob.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
MigrationJob.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public MigrationJob.Builder toBuilder()
Returns
Type Description
MigrationJob.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException