Class ReplicationTask

java.lang.Object
software.amazon.awssdk.services.databasemigration.model.ReplicationTask
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ReplicationTask.Builder,ReplicationTask>
@Generated("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:

  • Method Details

    • 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:

    • 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:

    • 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:

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

    • 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 NORMAL" – The task completed successfully with no additional information returned.

      • "Stop Reason RECOVERABLE_ERROR"

      • "Stop Reason FATAL_ERROR"

      • "Stop Reason FULL_LOAD_ONLY_FINISHED" – The task completed the full load phase. DMS applied cached changes if you set StopTaskCachedChangesApplied to true.

      • "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" – The task completed successfully with no additional information returned.

      • "Stop Reason RECOVERABLE_ERROR"

      • "Stop Reason FATAL_ERROR"

      • "Stop Reason FULL_LOAD_ONLY_FINISHED" – The task completed the full load phase. DMS applied cached changes if you set StopTaskCachedChangesApplied to true.

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

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

      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()
      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 interface ToCopyableBuilder<ReplicationTask.Builder,ReplicationTask>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.