com.amazonaws.services.datasync.model

Class TaskSchedule

java.lang.Object

com.amazonaws.services.datasync.model.TaskSchedule

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Configures your DataSync task to run on a schedule (at a minimum interval of 1 hour).

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
TaskSchedule()

Method Summary

Modifier and Type	Method and Description
TaskSchedule	clone()
boolean	equals(Object obj)
String	getScheduleExpression() Specifies your task schedule by using a cron expression in UTC time.
String	getStatus() Specifies whether to enable or disable your task schedule.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setScheduleExpression(String scheduleExpression) Specifies your task schedule by using a cron expression in UTC time.
void	setStatus(String status) Specifies whether to enable or disable your task schedule.
String	toString() Returns a string representation of this object.
TaskSchedule	withScheduleExpression(String scheduleExpression) Specifies your task schedule by using a cron expression in UTC time.
TaskSchedule	withStatus(ScheduleStatus status) Specifies whether to enable or disable your task schedule.
TaskSchedule	withStatus(String status) Specifies whether to enable or disable your task schedule.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TaskSchedule

public TaskSchedule()

Method Detail

setScheduleExpression

public void setScheduleExpression(String scheduleExpression)

Specifies your task schedule by using a cron expression in UTC time. For information about cron expression syntax, see the Amazon EventBridge User Guide .

Parameters:

scheduleExpression - Specifies your task schedule by using a cron expression in UTC time. For information about cron expression syntax, see the Amazon EventBridge User Guide .

getScheduleExpression

public String getScheduleExpression()

Specifies your task schedule by using a cron expression in UTC time. For information about cron expression syntax, see the Amazon EventBridge User Guide .

Returns:

Specifies your task schedule by using a cron expression in UTC time. For information about cron expression syntax, see the Amazon EventBridge User Guide .

withScheduleExpression

public TaskSchedule withScheduleExpression(String scheduleExpression)

Specifies your task schedule by using a cron expression in UTC time. For information about cron expression syntax, see the Amazon EventBridge User Guide .

Parameters:

scheduleExpression - Specifies your task schedule by using a cron expression in UTC time. For information about cron expression syntax, see the Amazon EventBridge User Guide .

Returns:

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

setStatus

public void setStatus(String status)

Specifies whether to enable or disable your task schedule. Your schedule is enabled by default, but there can be situations where you need to disable it. For example, you might need to pause a recurring transfer to fix an issue with your task or perform maintenance on your storage system.

DataSync might disable your schedule automatically if your task fails repeatedly with the same error. For more information, see TaskScheduleDetails .

Parameters:

status - Specifies whether to enable or disable your task schedule. Your schedule is enabled by default, but there can be situations where you need to disable it. For example, you might need to pause a recurring transfer to fix an issue with your task or perform maintenance on your storage system.

DataSync might disable your schedule automatically if your task fails repeatedly with the same error. For more information, see TaskScheduleDetails.

See Also:

ScheduleStatus

getStatus

public String getStatus()

Specifies whether to enable or disable your task schedule. Your schedule is enabled by default, but there can be situations where you need to disable it. For example, you might need to pause a recurring transfer to fix an issue with your task or perform maintenance on your storage system.

DataSync might disable your schedule automatically if your task fails repeatedly with the same error. For more information, see TaskScheduleDetails .

Returns:

Specifies whether to enable or disable your task schedule. Your schedule is enabled by default, but there can be situations where you need to disable it. For example, you might need to pause a recurring transfer to fix an issue with your task or perform maintenance on your storage system.

DataSync might disable your schedule automatically if your task fails repeatedly with the same error. For more information, see TaskScheduleDetails.

See Also:

ScheduleStatus

withStatus

public TaskSchedule withStatus(String status)

Specifies whether to enable or disable your task schedule. Your schedule is enabled by default, but there can be situations where you need to disable it. For example, you might need to pause a recurring transfer to fix an issue with your task or perform maintenance on your storage system.

DataSync might disable your schedule automatically if your task fails repeatedly with the same error. For more information, see TaskScheduleDetails .

Parameters:

status - Specifies whether to enable or disable your task schedule. Your schedule is enabled by default, but there can be situations where you need to disable it. For example, you might need to pause a recurring transfer to fix an issue with your task or perform maintenance on your storage system.

DataSync might disable your schedule automatically if your task fails repeatedly with the same error. For more information, see TaskScheduleDetails.

Returns:

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

See Also:

ScheduleStatus

withStatus

public TaskSchedule withStatus(ScheduleStatus status)

Specifies whether to enable or disable your task schedule. Your schedule is enabled by default, but there can be situations where you need to disable it. For example, you might need to pause a recurring transfer to fix an issue with your task or perform maintenance on your storage system.

DataSync might disable your schedule automatically if your task fails repeatedly with the same error. For more information, see TaskScheduleDetails .

Parameters:

status - Specifies whether to enable or disable your task schedule. Your schedule is enabled by default, but there can be situations where you need to disable it. For example, you might need to pause a recurring transfer to fix an issue with your task or perform maintenance on your storage system.

DataSync might disable your schedule automatically if your task fails repeatedly with the same error. For more information, see TaskScheduleDetails.

Returns:

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

See Also:

ScheduleStatus

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 TaskSchedule clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.