All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartReplicationTaskRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable 

See Also:

AWS API Documentation, Serialized Form

• Field Summary

  • Fields inherited from class com.amazonaws.AmazonWebServiceRequest

    NOOP

• Constructor Summary

  Constructors

  Constructor and Description
  StartReplicationTaskRequest ()

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  StartReplicationTaskRequest	clone () Creates a shallow clone of this object for all fields except the handler context.
  boolean	equals (Object obj)
  String	getCdcStartPosition () Indicates when you want a change data capture (CDC) operation to start.
  Date	getCdcStartTime () Indicates the start time for a change data capture (CDC) operation.
  String	getCdcStopPosition () Indicates when you want a change data capture (CDC) operation to stop.
  String	getReplicationTaskArn () The Amazon Resource Name (ARN) of the replication task to be started.
  String	getStartReplicationTaskType () The type of replication task to start.
  int	hashCode ()
  void	setCdcStartPosition (String cdcStartPosition) Indicates when you want a change data capture (CDC) operation to start.
  void	setCdcStartTime (Date cdcStartTime) Indicates the start time for a change data capture (CDC) operation.
  void	setCdcStopPosition (String cdcStopPosition) Indicates when you want a change data capture (CDC) operation to stop.
  void	setReplicationTaskArn (String replicationTaskArn) The Amazon Resource Name (ARN) of the replication task to be started.
  void	setStartReplicationTaskType (StartReplicationTaskTypeValue startReplicationTaskType) The type of replication task to start.
  void	setStartReplicationTaskType (String startReplicationTaskType) The type of replication task to start.
  String	toString () Returns a string representation of this object.
  StartReplicationTaskRequest	withCdcStartPosition (String cdcStartPosition) Indicates when you want a change data capture (CDC) operation to start.
  StartReplicationTaskRequest	withCdcStartTime (Date cdcStartTime) Indicates the start time for a change data capture (CDC) operation.
  StartReplicationTaskRequest	withCdcStopPosition (String cdcStopPosition) Indicates when you want a change data capture (CDC) operation to stop.
  StartReplicationTaskRequest	withReplicationTaskArn (String replicationTaskArn) The Amazon Resource Name (ARN) of the replication task to be started.
  StartReplicationTaskRequest	withStartReplicationTaskType (StartReplicationTaskTypeValue startReplicationTaskType) The type of replication task to start.
  StartReplicationTaskRequest	withStartReplicationTaskType (String startReplicationTaskType) The type of replication task to start.

  • Methods inherited from class com.amazonaws.AmazonWebServiceRequest

    addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

  • Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

• Constructor Detail

  • StartReplicationTaskRequest

    public StartReplicationTaskRequest()

• Method Detail

  • setReplicationTaskArn

    public void setReplicationTaskArn(String replicationTaskArn)

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

    Parameters:

    replicationTaskArn - The Amazon Resource Name (ARN) of the replication task to be started.

  • getReplicationTaskArn

    public String getReplicationTaskArn()

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

    Returns:

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

  • withReplicationTaskArn

    public StartReplicationTaskRequest withReplicationTaskArn(String replicationTaskArn)

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

    Parameters:

    replicationTaskArn - The Amazon Resource Name (ARN) of the replication task to be started.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setStartReplicationTaskType

    public void setStartReplicationTaskType(String startReplicationTaskType)

    The type of replication task to start.

    When the migration type is full-load or full-load-and-cdc, the only valid value for the first run of the task is start-replication. This option will start the migration.

    You can also use ReloadTables to reload specific tables that failed during migration instead of restarting the task.

    The resume-processing option isn't applicable for a full-load task, because you can't resume partially loaded tables during the full load phase.

    For a full-load-and-cdc task, DMS migrates table data, and then applies data changes that occur on the source. To load all the tables again, and start capturing source changes, use reload-target. Otherwise use resume-processing, to replicate the changes from the last stop position.

    Parameters:

    startReplicationTaskType - The type of replication task to start.

    When the migration type is full-load or full-load-and-cdc, the only valid value for the first run of the task is start-replication. This option will start the migration.

    You can also use ReloadTables to reload specific tables that failed during migration instead of restarting the task.

    The resume-processing option isn't applicable for a full-load task, because you can't resume partially loaded tables during the full load phase.

    For a full-load-and-cdc task, DMS migrates table data, and then applies data changes that occur on the source. To load all the tables again, and start capturing source changes, use reload-target. Otherwise use resume-processing, to replicate the changes from the last stop position.

    See Also:

    StartReplicationTaskTypeValue

  • getStartReplicationTaskType

    public String getStartReplicationTaskType()

    The type of replication task to start.

    When the migration type is full-load or full-load-and-cdc, the only valid value for the first run of the task is start-replication. This option will start the migration.

    You can also use ReloadTables to reload specific tables that failed during migration instead of restarting the task.

    The resume-processing option isn't applicable for a full-load task, because you can't resume partially loaded tables during the full load phase.

    For a full-load-and-cdc task, DMS migrates table data, and then applies data changes that occur on the source. To load all the tables again, and start capturing source changes, use reload-target. Otherwise use resume-processing, to replicate the changes from the last stop position.

    Returns:

    The type of replication task to start.

    When the migration type is full-load or full-load-and-cdc, the only valid value for the first run of the task is start-replication. This option will start the migration.

    You can also use ReloadTables to reload specific tables that failed during migration instead of restarting the task.

    The resume-processing option isn't applicable for a full-load task, because you can't resume partially loaded tables during the full load phase.

    For a full-load-and-cdc task, DMS migrates table data, and then applies data changes that occur on the source. To load all the tables again, and start capturing source changes, use reload-target. Otherwise use resume-processing, to replicate the changes from the last stop position.

    See Also:

    StartReplicationTaskTypeValue

  • withStartReplicationTaskType

    public StartReplicationTaskRequest withStartReplicationTaskType(String startReplicationTaskType)

    The type of replication task to start.

    When the migration type is full-load or full-load-and-cdc, the only valid value for the first run of the task is start-replication. This option will start the migration.

    You can also use ReloadTables to reload specific tables that failed during migration instead of restarting the task.

    The resume-processing option isn't applicable for a full-load task, because you can't resume partially loaded tables during the full load phase.

    For a full-load-and-cdc task, DMS migrates table data, and then applies data changes that occur on the source. To load all the tables again, and start capturing source changes, use reload-target. Otherwise use resume-processing, to replicate the changes from the last stop position.

    Parameters:

    startReplicationTaskType - The type of replication task to start.

    When the migration type is full-load or full-load-and-cdc, the only valid value for the first run of the task is start-replication. This option will start the migration.

    You can also use ReloadTables to reload specific tables that failed during migration instead of restarting the task.

    The resume-processing option isn't applicable for a full-load task, because you can't resume partially loaded tables during the full load phase.

    For a full-load-and-cdc task, DMS migrates table data, and then applies data changes that occur on the source. To load all the tables again, and start capturing source changes, use reload-target. Otherwise use resume-processing, to replicate the changes from the last stop position.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

    See Also:

    StartReplicationTaskTypeValue

  • setStartReplicationTaskType

    public void setStartReplicationTaskType(StartReplicationTaskTypeValue startReplicationTaskType)

    The type of replication task to start.

    When the migration type is full-load or full-load-and-cdc, the only valid value for the first run of the task is start-replication. This option will start the migration.

    You can also use ReloadTables to reload specific tables that failed during migration instead of restarting the task.

    The resume-processing option isn't applicable for a full-load task, because you can't resume partially loaded tables during the full load phase.

    For a full-load-and-cdc task, DMS migrates table data, and then applies data changes that occur on the source. To load all the tables again, and start capturing source changes, use reload-target. Otherwise use resume-processing, to replicate the changes from the last stop position.

    Parameters:

    startReplicationTaskType - The type of replication task to start.

    When the migration type is full-load or full-load-and-cdc, the only valid value for the first run of the task is start-replication. This option will start the migration.

    You can also use ReloadTables to reload specific tables that failed during migration instead of restarting the task.

    The resume-processing option isn't applicable for a full-load task, because you can't resume partially loaded tables during the full load phase.

    For a full-load-and-cdc task, DMS migrates table data, and then applies data changes that occur on the source. To load all the tables again, and start capturing source changes, use reload-target. Otherwise use resume-processing, to replicate the changes from the last stop position.

    See Also:

    StartReplicationTaskTypeValue

  • withStartReplicationTaskType

    public StartReplicationTaskRequest withStartReplicationTaskType(StartReplicationTaskTypeValue startReplicationTaskType)

    The type of replication task to start.

    When the migration type is full-load or full-load-and-cdc, the only valid value for the first run of the task is start-replication. This option will start the migration.

    You can also use ReloadTables to reload specific tables that failed during migration instead of restarting the task.

    The resume-processing option isn't applicable for a full-load task, because you can't resume partially loaded tables during the full load phase.

    For a full-load-and-cdc task, DMS migrates table data, and then applies data changes that occur on the source. To load all the tables again, and start capturing source changes, use reload-target. Otherwise use resume-processing, to replicate the changes from the last stop position.

    Parameters:

    startReplicationTaskType - The type of replication task to start.

    When the migration type is full-load or full-load-and-cdc, the only valid value for the first run of the task is start-replication. This option will start the migration.

    You can also use ReloadTables to reload specific tables that failed during migration instead of restarting the task.

    The resume-processing option isn't applicable for a full-load task, because you can't resume partially loaded tables during the full load phase.

    For a full-load-and-cdc task, DMS migrates table data, and then applies data changes that occur on the source. To load all the tables again, and start capturing source changes, use reload-target. Otherwise use resume-processing, to replicate the changes from the last stop position.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

    See Also:

    StartReplicationTaskTypeValue

  • setCdcStartTime

    public void setCdcStartTime(Date 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.

    Timestamp Example: --cdc-start-time "2018年03月08日T12:12:12"

    Parameters:

    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.

    Timestamp Example: --cdc-start-time "2018年03月08日T12:12:12"

  • getCdcStartTime

    public Date getCdcStartTime()

    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.

    Timestamp Example: --cdc-start-time "2018年03月08日T12:12:12"

    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.

    Timestamp Example: --cdc-start-time "2018年03月08日T12:12:12"

  • withCdcStartTime

    public StartReplicationTaskRequest withCdcStartTime(Date 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.

    Timestamp Example: --cdc-start-time "2018年03月08日T12:12:12"

    Parameters:

    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.

    Timestamp Example: --cdc-start-time "2018年03月08日T12:12:12"

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setCdcStartPosition

    public void setCdcStartPosition(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月08日T12: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"

    When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the slotName extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for DMS.

    Parameters:

    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月08日T12: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"

    When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the slotName extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for DMS.

  • getCdcStartPosition

    public String getCdcStartPosition()

    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月08日T12: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"

    When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the slotName extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for DMS.

    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月08日T12: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"

    When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the slotName extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for DMS.

  • withCdcStartPosition

    public StartReplicationTaskRequest withCdcStartPosition(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月08日T12: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"

    When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the slotName extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for DMS.

    Parameters:

    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月08日T12: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"

    When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the slotName extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for DMS.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setCdcStopPosition

    public void setCdcStopPosition(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月09日T12:12:12"

    Commit time example: --cdc-stop-position "commit_time:2018年02月09日T12:12:12"

    Parameters:

    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月09日T12:12:12"

    Commit time example: --cdc-stop-position "commit_time:2018年02月09日T12:12:12"

  • getCdcStopPosition

    public String getCdcStopPosition()

    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月09日T12:12:12"

    Commit time example: --cdc-stop-position "commit_time:2018年02月09日T12: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月09日T12:12:12"

    Commit time example: --cdc-stop-position "commit_time:2018年02月09日T12:12:12"

  • withCdcStopPosition

    public StartReplicationTaskRequest withCdcStopPosition(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月09日T12:12:12"

    Commit time example: --cdc-stop-position "commit_time:2018年02月09日T12:12:12"

    Parameters:

    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月09日T12:12:12"

    Commit time example: --cdc-stop-position "commit_time:2018年02月09日T12:12:12"

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • toString

    public 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

    Returns:

    A string representation of this object.

    See Also:

    Object.toString()

  • equals

    public boolean equals(Object obj)

    Overrides:

    equals in class Object

  • hashCode

    public int hashCode()

    Overrides:

    hashCode in class Object

  • clone

    public StartReplicationTaskRequest clone()

    Description copied from class: AmazonWebServiceRequest
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

    Overrides:

    clone in class AmazonWebServiceRequest

    See Also:

    Object.clone()