Class ReplicationTask
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ReplicationTask.Builder,
ReplicationTask>
Provides information that describes a replication task created by the CreateReplicationTask
operation.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ReplicationTask.Builder
builder()
final String
Indicates when you want a change data capture (CDC) operation to start.final String
Indicates when you want a change data capture (CDC) operation to stop.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
The last error (failure) message generated for the replication task.final MigrationTypeValue
The type of migration.final String
The type of migration.final String
Indicates the last checkpoint that occurred during a change data capture (CDC) operation.final String
The ARN of the replication instance.final String
The Amazon Resource Name (ARN) of the replication task.final Instant
The date the replication task was created.final String
The user-assigned replication task identifier or name.final String
The settings for the replication task.final Instant
The date the replication task is scheduled to start.final ReplicationTaskStats
The statistics for the task, including elapsed time, tables loaded, and table errors.static Class
<? extends ReplicationTask.Builder> final String
The Amazon Resource Name (ARN) that uniquely identifies the endpoint.final String
status()
The status of the replication task.final String
The reason the replication task was stopped.final String
Table mappings specified in the task.final String
The ARN that uniquely identifies the endpoint.final String
The ARN of the replication instance to which this task is moved in response to running theMoveReplicationTask
operation.final String
taskData()
Supplemental information that the task requires to migrate the data for certain source and target endpoints.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The Amazon Resource Name (ARN) that uniquely identifies the endpoint.
- Returns:
- The Amazon Resource Name (ARN) that uniquely identifies the endpoint.
-
targetEndpointArn
The ARN that uniquely identifies the endpoint.
- Returns:
- The ARN that uniquely identifies the endpoint.
-
replicationInstanceArn
The ARN of the replication instance.
- Returns:
- The ARN of the replication instance.
-
migrationType
The type of migration.
If the service returns an enum value that is not available in the current SDK version,
migrationType
will returnMigrationTypeValue.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommigrationTypeAsString()
.- Returns:
- The type of migration.
- See Also:
-
migrationTypeAsString
The type of migration.
If the service returns an enum value that is not available in the current SDK version,
migrationType
will returnMigrationTypeValue.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommigrationTypeAsString()
.- Returns:
- The type of migration.
- See Also:
-
tableMappings
Table mappings specified in the task.
- Returns:
- Table mappings specified in the task.
-
replicationTaskSettings
The settings for the replication task.
- Returns:
- The settings for the replication task.
-
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 theMoveReplicationTask
operation. -
"creating"
– The task is being created in response to running theCreateReplicationTask
operation. -
"deleting"
– The task is being deleted in response to running theDeleteReplicationTask
operation. -
"failed"
– The task failed to successfully complete the database migration in response to running theStartReplicationTask
operation. -
"failed-move"
– The task failed to move in response to running theMoveReplicationTask
operation. -
"modifying"
– The task definition is being modified in response to running theModifyReplicationTask
operation. -
"ready"
– The task is in aready
state where it can respond to other task operations, such asStartReplicationTask
orDeleteReplicationTask
. -
"running"
– The task is performing a database migration in response to running theStartReplicationTask
operation. -
"starting"
– The task is preparing to perform a database migration in response to running theStartReplicationTask
operation. -
"stopped"
– The task has stopped in response to running theStopReplicationTask
operation. -
"stopping"
– The task is preparing to stop in response to running theStopReplicationTask
operation. -
"testing"
– The database migration specified for this task is being tested in response to running either theStartReplicationTaskAssessmentRun
or theStartReplicationTaskAssessment
operation.StartReplicationTaskAssessmentRun
is an improved premigration task assessment operation. TheStartReplicationTaskAssessment
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 theMoveReplicationTask
operation. -
"creating"
– The task is being created in response to running theCreateReplicationTask
operation. -
"deleting"
– The task is being deleted in response to running theDeleteReplicationTask
operation. -
"failed"
– The task failed to successfully complete the database migration in response to running theStartReplicationTask
operation. -
"failed-move"
– The task failed to move in response to running theMoveReplicationTask
operation. -
"modifying"
– The task definition is being modified in response to running theModifyReplicationTask
operation. -
"ready"
– The task is in aready
state where it can respond to other task operations, such asStartReplicationTask
orDeleteReplicationTask
. -
"running"
– The task is performing a database migration in response to running theStartReplicationTask
operation. -
"starting"
– The task is preparing to perform a database migration in response to running theStartReplicationTask
operation. -
"stopped"
– The task has stopped in response to running theStopReplicationTask
operation. -
"stopping"
– The task is preparing to stop in response to running theStopReplicationTask
operation. -
"testing"
– The database migration specified for this task is being tested in response to running either theStartReplicationTaskAssessmentRun
or theStartReplicationTaskAssessment
operation.StartReplicationTaskAssessmentRun
is an improved premigration task assessment operation. TheStartReplicationTaskAssessment
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
The last error (failure) message generated for the replication task.
- Returns:
- The last error (failure) message generated for the replication task.
-
stopReason
The reason the replication task was stopped. This response parameter can return one of the following values:
-
"Stop Reason NORMAL"
-
"Stop Reason RECOVERABLE_ERROR"
-
"Stop Reason FATAL_ERROR"
-
"Stop Reason FULL_LOAD_ONLY_FINISHED"
-
"Stop Reason STOPPED_AFTER_FULL_LOAD"
– Full load completed, with cached changes not applied -
"Stop Reason STOPPED_AFTER_CACHED_EVENTS"
– Full load completed, with cached changes applied -
"Stop Reason EXPRESS_LICENSE_LIMITS_REACHED"
-
"Stop Reason STOPPED_AFTER_DDL_APPLY"
– User-defined stop task after DDL applied -
"Stop Reason STOPPED_DUE_TO_LOW_MEMORY"
-
"Stop Reason STOPPED_DUE_TO_LOW_DISK"
-
"Stop Reason STOPPED_AT_SERVER_TIME"
– User-defined server time for stopping task -
"Stop Reason STOPPED_AT_COMMIT_TIME"
– User-defined commit time for stopping task -
"Stop Reason RECONFIGURATION_RESTART"
-
"Stop Reason RECYCLE_TASK"
- Returns:
- The reason the replication task was stopped. This response parameter can return one of the following
values:
-
"Stop Reason NORMAL"
-
"Stop Reason RECOVERABLE_ERROR"
-
"Stop Reason FATAL_ERROR"
-
"Stop Reason FULL_LOAD_ONLY_FINISHED"
-
"Stop Reason STOPPED_AFTER_FULL_LOAD"
– Full load completed, with cached changes not applied -
"Stop Reason STOPPED_AFTER_CACHED_EVENTS"
– Full load completed, with cached changes applied -
"Stop Reason EXPRESS_LICENSE_LIMITS_REACHED"
-
"Stop Reason STOPPED_AFTER_DDL_APPLY"
– User-defined stop task after DDL applied -
"Stop Reason STOPPED_DUE_TO_LOW_MEMORY"
-
"Stop Reason STOPPED_DUE_TO_LOW_DISK"
-
"Stop Reason STOPPED_AT_SERVER_TIME"
– User-defined server time for stopping task -
"Stop Reason STOPPED_AT_COMMIT_TIME"
– User-defined commit time for stopping task -
"Stop Reason RECONFIGURATION_RESTART"
-
"Stop Reason RECYCLE_TASK"
-
-
-
replicationTaskCreationDate
The date the replication task was created.
- Returns:
- The date the replication task was created.
-
replicationTaskStartDate
The date the replication task is scheduled to start.
- Returns:
- The date the replication task is scheduled to start.
-
cdcStartPosition
Indicates when you want a change data capture (CDC) operation to start. Use either
CdcStartPosition
orCdcStartTime
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
orCdcStartTime
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
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
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
The Amazon Resource Name (ARN) of the replication task.
- Returns:
- The Amazon Resource Name (ARN) of the replication task.
-
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
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 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 Database Migration Service User Guide.
-
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 theReplicationTask
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 theReplicationTask
object.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ReplicationTask.Builder,
ReplicationTask> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-