software.amazon.awssdk.services.databasemigration.model

Class ReplicationTask

java.lang.Object

software.amazon.awssdk.services.databasemigration.model.ReplicationTask

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ReplicationTask.Builder,ReplicationTask>

@Generated(value="software.amazon.awssdk:codegen")
public final class ReplicationTask
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ReplicationTask.Builder,ReplicationTask>

Provides information that describes a replication task created by the CreateReplicationTask operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ReplicationTask.Builder

Method Summary

Modifier and Type	Method and Description
static ReplicationTask.Builder	builder()
String	cdcStartPosition() Indicates when you want a change data capture (CDC) operation to start.
String	cdcStopPosition() Indicates when you want a change data capture (CDC) operation to stop.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	lastFailureMessage() The last error (failure) message generated for the replication task.
MigrationTypeValue	migrationType() The type of migration.
String	migrationTypeAsString() The type of migration.
String	recoveryCheckpoint() Indicates the last checkpoint that occurred during a change data capture (CDC) operation.
String	replicationInstanceArn() The ARN of the replication instance.
String	replicationTaskArn() The Amazon Resource Name (ARN) of the replication task.
Instant	replicationTaskCreationDate() The date the replication task was created.
String	replicationTaskIdentifier() The user-assigned replication task identifier or name.
String	replicationTaskSettings() The settings for the replication task.
Instant	replicationTaskStartDate() The date the replication task is scheduled to start.
ReplicationTaskStats	replicationTaskStats() The statistics for the task, including elapsed time, tables loaded, and table errors.
List<SdkField<?>>	sdkFields()
static Class<? extends ReplicationTask.Builder>	serializableBuilderClass()
String	sourceEndpointArn() The Amazon Resource Name (ARN) that uniquely identifies the endpoint.
String	status() The status of the replication task.
String	stopReason() The reason the replication task was stopped.
String	tableMappings() Table mappings specified in the task.
String	targetEndpointArn() The ARN that uniquely identifies the endpoint.
String	targetReplicationInstanceArn() The ARN of the replication instance to which this task is moved in response to running the MoveReplicationTask operation.
String	taskData() Supplemental information that the task requires to migrate the data for certain source and target endpoints.
ReplicationTask.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

replicationTaskIdentifier

public final String replicationTaskIdentifier()

The user-assigned replication task identifier or name.

Constraints:

• Must contain 1-255 alphanumeric characters or hyphens.

• First character must be a letter.

• Cannot end with a hyphen or contain two consecutive hyphens.

Returns:

The user-assigned replication task identifier or name.

Constraints:

• Must contain 1-255 alphanumeric characters or hyphens.

• First character must be a letter.

• Cannot end with a hyphen or contain two consecutive hyphens.

sourceEndpointArn

public final String sourceEndpointArn()

The Amazon Resource Name (ARN) that uniquely identifies the endpoint.

Returns:

The Amazon Resource Name (ARN) that uniquely identifies the endpoint.

targetEndpointArn

public final String targetEndpointArn()

The ARN that uniquely identifies the endpoint.

Returns:

The ARN that uniquely identifies the endpoint.

replicationInstanceArn

public final String replicationInstanceArn()

The ARN of the replication instance.

Returns:

The ARN of the replication instance.

migrationType

public final MigrationTypeValue migrationType()

The type of migration.

If the service returns an enum value that is not available in the current SDK version, migrationType will return MigrationTypeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from migrationTypeAsString().

Returns:

The type of migration.

See Also:

MigrationTypeValue

migrationTypeAsString

public final String migrationTypeAsString()

The type of migration.

If the service returns an enum value that is not available in the current SDK version, migrationType will return MigrationTypeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from migrationTypeAsString().

Returns:

The type of migration.

See Also:

MigrationTypeValue

tableMappings

public final String tableMappings()

Table mappings specified in the task.

Returns:

Table mappings specified in the task.

replicationTaskSettings

public final String replicationTaskSettings()

The settings for the replication task.

Returns:

The settings for the replication task.

status

public final String status()

The status of the replication task. This response parameter can return one of the following values:

• "moving" – The task is being moved in response to running the MoveReplicationTask operation.

• "creating" – The task is being created in response to running the CreateReplicationTask operation.

• "deleting" – The task is being deleted in response to running the DeleteReplicationTask operation.

• "failed" – The task failed to successfully complete the database migration in response to running the StartReplicationTask operation.

• "failed-move" – The task failed to move in response to running the MoveReplicationTask operation.

• "modifying" – The task definition is being modified in response to running the ModifyReplicationTask operation.

• "ready" – The task is in a ready state where it can respond to other task operations, such as StartReplicationTask or DeleteReplicationTask .

• "running" – The task is performing a database migration in response to running the StartReplicationTask operation.

• "starting" – The task is preparing to perform a database migration in response to running the StartReplicationTask operation.

• "stopped" – The task has stopped in response to running the StopReplicationTask operation.

• "stopping" – The task is preparing to stop in response to running the StopReplicationTask operation.

• "testing" – The database migration specified for this task is being tested in response to running either the StartReplicationTaskAssessmentRun or the StartReplicationTaskAssessment operation.

  StartReplicationTaskAssessmentRun is an improved premigration task assessment operation. The StartReplicationTaskAssessment operation assesses data type compatibility only between the source and target database of a given migration task. In contrast, StartReplicationTaskAssessmentRun enables you to specify a variety of premigration task assessments in addition to data type compatibility. These assessments include ones for the validity of primary key definitions and likely issues with database migration performance, among others.

Returns:

The status of the replication task. This response parameter can return one of the following values:

• "moving" – The task is being moved in response to running the MoveReplicationTask operation.

• "creating" – The task is being created in response to running the CreateReplicationTask operation.

• "deleting" – The task is being deleted in response to running the DeleteReplicationTask operation.

• "failed" – The task failed to successfully complete the database migration in response to running the StartReplicationTask operation.

• "failed-move" – The task failed to move in response to running the MoveReplicationTask operation.

• "modifying" – The task definition is being modified in response to running the ModifyReplicationTask operation.

• "ready" – The task is in a ready state where it can respond to other task operations, such as StartReplicationTask or DeleteReplicationTask .

• "running" – The task is performing a database migration in response to running the StartReplicationTask operation.

• "starting" – The task is preparing to perform a database migration in response to running the StartReplicationTask operation.

• "stopped" – The task has stopped in response to running the StopReplicationTask operation.

• "stopping" – The task is preparing to stop in response to running the StopReplicationTask operation.

• "testing" – The database migration specified for this task is being tested in response to running either the StartReplicationTaskAssessmentRun or the StartReplicationTaskAssessment operation.

  StartReplicationTaskAssessmentRun is an improved premigration task assessment operation. The StartReplicationTaskAssessment operation assesses data type compatibility only between the source and target database of a given migration task. In contrast, StartReplicationTaskAssessmentRun enables you to specify a variety of premigration task assessments in addition to data type compatibility. These assessments include ones for the validity of primary key definitions and likely issues with database migration performance, among others.

lastFailureMessage

public final String lastFailureMessage()

The last error (failure) message generated for the replication task.

Returns:

The last error (failure) message generated for the replication task.

stopReason

public final String stopReason()

The reason the replication task was stopped. This response parameter can return one of the following values:

• "STOP_REASON_FULL_LOAD_COMPLETED" – Full-load migration completed.

• "STOP_REASON_CACHED_CHANGES_APPLIED" – Change data capture (CDC) load completed.

• "STOP_REASON_CACHED_CHANGES_NOT_APPLIED" – In a full-load and CDC migration, the full load stopped as specified before starting the CDC migration.

• "STOP_REASON_SERVER_TIME" – The migration stopped at the specified server time.

Returns:

The reason the replication task was stopped. This response parameter can return one of the following values:

• "STOP_REASON_FULL_LOAD_COMPLETED" – Full-load migration completed.

• "STOP_REASON_CACHED_CHANGES_APPLIED" – Change data capture (CDC) load completed.

• "STOP_REASON_CACHED_CHANGES_NOT_APPLIED" – In a full-load and CDC migration, the full load stopped as specified before starting the CDC migration.

• "STOP_REASON_SERVER_TIME" – The migration stopped at the specified server time.

replicationTaskCreationDate

public final Instant replicationTaskCreationDate()

The date the replication task was created.

Returns:

The date the replication task was created.

replicationTaskStartDate

public final Instant replicationTaskStartDate()

The date the replication task is scheduled to start.

Returns:

The date the replication task is scheduled to start.

cdcStartPosition

public final String cdcStartPosition()

Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want the CDC operation to start. Specifying both values results in an error.

The value can be in date, checkpoint, or LSN/SCN format.

Date Example: --cdc-start-position “2018-03-08T12:12:12”

Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"

LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”

Returns:

Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want the CDC operation to start. Specifying both values results in an error.

The value can be in date, checkpoint, or LSN/SCN format.

Date Example: --cdc-start-position “2018-03-08T12:12:12”

Checkpoint Example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"

LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”

cdcStopPosition

public final String cdcStopPosition()

Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”

Commit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12 “

Returns:

Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

Server time example: --cdc-stop-position “server_time:2018-02-09T12:12:12”

Commit time example: --cdc-stop-position “commit_time: 2018-02-09T12:12:12 “

recoveryCheckpoint

public final String recoveryCheckpoint()

Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this value to the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.

Returns:

Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this value to the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.

replicationTaskArn

public final String replicationTaskArn()

The Amazon Resource Name (ARN) of the replication task.

Returns:

The Amazon Resource Name (ARN) of the replication task.

replicationTaskStats

public final ReplicationTaskStats replicationTaskStats()

The statistics for the task, including elapsed time, tables loaded, and table errors.

Returns:

The statistics for the task, including elapsed time, tables loaded, and table errors.

taskData

public final String taskData()

Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the AWS Database Migration Service User Guide.

Returns:

Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the AWS Database Migration Service User Guide.

targetReplicationInstanceArn

public final String targetReplicationInstanceArn()

The ARN of the replication instance to which this task is moved in response to running the MoveReplicationTask operation. Otherwise, this response parameter isn't a member of the ReplicationTask object.

Returns:

The ARN of the replication instance to which this task is moved in response to running the MoveReplicationTask operation. Otherwise, this response parameter isn't a member of the ReplicationTask object.

toBuilder

public ReplicationTask.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ReplicationTask.Builder,ReplicationTask>

builder

public static ReplicationTask.Builder builder()

serializableBuilderClass

public static Class<? extends ReplicationTask.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo