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>

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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	lastFailureMessage() The last error (failure) message generated for the replication instance.
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 Amazon Resource Name (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) string 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 Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
ReplicationTask.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

replicationTaskIdentifier

public String replicationTaskIdentifier()

The user-assigned replication task identifier or name.

Constraints:

• Must contain from 1 to 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 from 1 to 255 alphanumeric characters or hyphens.

• First character must be a letter.

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

sourceEndpointArn

public String sourceEndpointArn()

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

Returns:

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

targetEndpointArn

public String targetEndpointArn()

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

Returns:

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

replicationInstanceArn

public String replicationInstanceArn()

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

Returns:

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

migrationType

public 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 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 String tableMappings()

Table mappings specified in the task.

Returns:

Table mappings specified in the task.

replicationTaskSettings

public String replicationTaskSettings()

The settings for the replication task.

Returns:

The settings for the replication task.

status

public String status()

The status of the replication task.

Returns:

The status of the replication task.

lastFailureMessage

public String lastFailureMessage()

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

Returns:

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

stopReason

public String stopReason()

The reason the replication task was stopped.

Returns:

The reason the replication task was stopped.

replicationTaskCreationDate

public Instant replicationTaskCreationDate()

The date the replication task was created.

Returns:

The date the replication task was created.

replicationTaskStartDate

public Instant replicationTaskStartDate()

The date the replication task is scheduled to start.

Returns:

The date the replication task is scheduled to start.

cdcStartPosition

public String cdcStartPosition()

Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a 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 a 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 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:3018-02-09T12:12:12”

Commit time example: --cdc-stop-position “commit_time: 3018-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:3018-02-09T12:12:12”

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

recoveryCheckpoint

public 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 String replicationTaskArn()

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

Returns:

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

replicationTaskStats

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

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

sdkFields

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