Package software.amazon.awssdk.services.databasemigration.model

Class Replication

java.lang.Object

software.amazon.awssdk.services.databasemigration.model.Replication

All Implemented Interfaces:

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

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

Provides information that describes a serverless replication created by the CreateReplication operation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Replication.Builder

Method Summary

Modifier and Type	Method	Description
static Replication.Builder	builder()
String	cdcStartPosition()	Indicates the start time for a change data capture (CDC) operation.
Instant	cdcStartTime()	Indicates the start time for a change data capture (CDC) operation.
String	cdcStopPosition()	Indicates when you want a change data capture (CDC) operation to stop.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	failureMessages()	Error and other information about why a serverless replication failed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFailureMessages()	For responses, this returns true if the service returned a value for the FailureMessages property.
int	hashCode()
ProvisionData	provisionData()	Information about provisioning resources for an DMS serverless replication.
String	recoveryCheckpoint()	Indicates the last checkpoint that occurred during a change data capture (CDC) operation.
String	replicationConfigArn()	The Amazon Resource Name for the ReplicationConfig associated with the replication.
String	replicationConfigIdentifier()	The identifier for the ReplicationConfig associated with the replication.
Instant	replicationCreateTime()	The time the serverless replication was created.
Instant	replicationDeprovisionTime()	The timestamp when DMS will deprovision the replication.
Instant	replicationLastStopTime()	The timestamp when replication was last stopped.
ReplicationStats	replicationStats()	This object provides a collection of statistics about a serverless replication.
MigrationTypeValue	replicationType()	The type of the serverless replication.
String	replicationTypeAsString()	The type of the serverless replication.
Instant	replicationUpdateTime()	The time the serverless replication was updated.
List<SdkField<?>>	sdkFields()
static Class<? extends Replication.Builder>	serializableBuilderClass()
String	sourceEndpointArn()	The Amazon Resource Name for an existing Endpoint the serverless replication uses for its data source.
String	startReplicationType()	The replication type.
String	status()	The current status of the serverless replication.
String	stopReason()	The reason the replication task was stopped.
String	targetEndpointArn()	The Amazon Resource Name for an existing Endpoint the serverless replication uses for its data target.
Replication.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

replicationConfigIdentifier

public final String replicationConfigIdentifier()

The identifier for the ReplicationConfig associated with the replication.

Returns:

The identifier for the ReplicationConfig associated with the replication.

replicationConfigArn

public final String replicationConfigArn()

The Amazon Resource Name for the ReplicationConfig associated with the replication.

Returns:

The Amazon Resource Name for the ReplicationConfig associated with the replication.

sourceEndpointArn

public final String sourceEndpointArn()

The Amazon Resource Name for an existing Endpoint the serverless replication uses for its data source.

Returns:

The Amazon Resource Name for an existing Endpoint the serverless replication uses for its data source.

targetEndpointArn

public final String targetEndpointArn()

The Amazon Resource Name for an existing Endpoint the serverless replication uses for its data target.

Returns:

The Amazon Resource Name for an existing Endpoint the serverless replication uses for its data target.

replicationType

public final MigrationTypeValue replicationType()

The type of the serverless replication.

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

Returns:

The type of the serverless replication.

See Also:

MigrationTypeValue

replicationTypeAsString

public final String replicationTypeAsString()

The type of the serverless replication.

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

Returns:

The type of the serverless replication.

See Also:

MigrationTypeValue

status

public final String status()

The current status of the serverless replication.

Returns:

The current status of the serverless replication.

provisionData

public final ProvisionData provisionData()

Information about provisioning resources for an DMS serverless replication.

Returns:

Information about provisioning resources for an DMS serverless replication.

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"

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

hasFailureMessages

public final boolean hasFailureMessages()

For responses, this returns true if the service returned a value for the FailureMessages property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

failureMessages

public final List<String> failureMessages()

Error and other information about why a serverless replication failed.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFailureMessages() method.

Returns:

Error and other information about why a serverless replication failed.

replicationStats

public final ReplicationStats replicationStats()

This object provides a collection of statistics about a serverless replication.

Returns:

This object provides a collection of statistics about a serverless replication.

startReplicationType

public final String startReplicationType()

The replication type.

Returns:

The replication type.

cdcStartTime

public final Instant cdcStartTime()

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

Returns:

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

cdcStartPosition

public final String cdcStartPosition()

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

Returns:

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

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.

Returns:

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

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.

replicationCreateTime

public final Instant replicationCreateTime()

The time the serverless replication was created.

Returns:

The time the serverless replication was created.

replicationUpdateTime

public final Instant replicationUpdateTime()

The time the serverless replication was updated.

Returns:

The time the serverless replication was updated.

replicationLastStopTime

public final Instant replicationLastStopTime()

The timestamp when replication was last stopped.

Returns:

The timestamp when replication was last stopped.

replicationDeprovisionTime

public final Instant replicationDeprovisionTime()

The timestamp when DMS will deprovision the replication.

Returns:

The timestamp when DMS will deprovision the replication.

toBuilder

public Replication.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Replication.Builder,Replication>

builder

public static Replication.Builder builder()

serializableBuilderClass

public static Class<? extends Replication.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