com.amazonaws.services.appflow.model

Class ScheduledTriggerProperties

java.lang.Object

com.amazonaws.services.appflow.model.ScheduledTriggerProperties

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Specifies the configuration details of a schedule-triggered flow as defined by the user. Currently, these settings only apply to the Scheduled trigger type.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ScheduledTriggerProperties()

Method Summary

Modifier and Type	Method and Description
ScheduledTriggerProperties	clone()
boolean	equals(Object obj)
String	getDataPullMode() Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.
Date	getFirstExecutionFrom() Specifies the date range for the records to import from the connector in the first flow run.
Integer	getFlowErrorDeactivationThreshold() Defines how many times a scheduled flow fails consecutively before Amazon AppFlow deactivates it.
Date	getScheduleEndTime() The time at which the scheduled flow ends.
String	getScheduleExpression() The scheduling expression that determines the rate at which the schedule will run, for example rate(5minutes).
Long	getScheduleOffset() Specifies the optional offset that is added to the time interval for a schedule-triggered flow.
Date	getScheduleStartTime() The time at which the scheduled flow starts.
String	getTimezone() Specifies the time zone used when referring to the dates and times of a scheduled flow, such as America/New_York.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setDataPullMode(String dataPullMode) Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.
void	setFirstExecutionFrom(Date firstExecutionFrom) Specifies the date range for the records to import from the connector in the first flow run.
void	setFlowErrorDeactivationThreshold(Integer flowErrorDeactivationThreshold) Defines how many times a scheduled flow fails consecutively before Amazon AppFlow deactivates it.
void	setScheduleEndTime(Date scheduleEndTime) The time at which the scheduled flow ends.
void	setScheduleExpression(String scheduleExpression) The scheduling expression that determines the rate at which the schedule will run, for example rate(5minutes).
void	setScheduleOffset(Long scheduleOffset) Specifies the optional offset that is added to the time interval for a schedule-triggered flow.
void	setScheduleStartTime(Date scheduleStartTime) The time at which the scheduled flow starts.
void	setTimezone(String timezone) Specifies the time zone used when referring to the dates and times of a scheduled flow, such as America/New_York.
String	toString() Returns a string representation of this object.
ScheduledTriggerProperties	withDataPullMode(DataPullMode dataPullMode) Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.
ScheduledTriggerProperties	withDataPullMode(String dataPullMode) Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.
ScheduledTriggerProperties	withFirstExecutionFrom(Date firstExecutionFrom) Specifies the date range for the records to import from the connector in the first flow run.
ScheduledTriggerProperties	withFlowErrorDeactivationThreshold(Integer flowErrorDeactivationThreshold) Defines how many times a scheduled flow fails consecutively before Amazon AppFlow deactivates it.
ScheduledTriggerProperties	withScheduleEndTime(Date scheduleEndTime) The time at which the scheduled flow ends.
ScheduledTriggerProperties	withScheduleExpression(String scheduleExpression) The scheduling expression that determines the rate at which the schedule will run, for example rate(5minutes).
ScheduledTriggerProperties	withScheduleOffset(Long scheduleOffset) Specifies the optional offset that is added to the time interval for a schedule-triggered flow.
ScheduledTriggerProperties	withScheduleStartTime(Date scheduleStartTime) The time at which the scheduled flow starts.
ScheduledTriggerProperties	withTimezone(String timezone) Specifies the time zone used when referring to the dates and times of a scheduled flow, such as America/New_York.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ScheduledTriggerProperties

public ScheduledTriggerProperties()

Method Detail

setScheduleExpression

public void setScheduleExpression(String scheduleExpression)

The scheduling expression that determines the rate at which the schedule will run, for example rate(5minutes).

Parameters:

scheduleExpression - The scheduling expression that determines the rate at which the schedule will run, for example rate(5minutes).

getScheduleExpression

public String getScheduleExpression()

The scheduling expression that determines the rate at which the schedule will run, for example rate(5minutes).

Returns:

The scheduling expression that determines the rate at which the schedule will run, for example rate(5minutes).

withScheduleExpression

public ScheduledTriggerProperties withScheduleExpression(String scheduleExpression)

The scheduling expression that determines the rate at which the schedule will run, for example rate(5minutes).

Parameters:

scheduleExpression - The scheduling expression that determines the rate at which the schedule will run, for example rate(5minutes).

Returns:

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

setDataPullMode

public void setDataPullMode(String dataPullMode)

Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.

Parameters:

dataPullMode - Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.

See Also:

DataPullMode

getDataPullMode

public String getDataPullMode()

Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.

Returns:

Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.

See Also:

DataPullMode

withDataPullMode

public ScheduledTriggerProperties withDataPullMode(String dataPullMode)

Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.

Parameters:

dataPullMode - Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.

Returns:

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

See Also:

DataPullMode

withDataPullMode

public ScheduledTriggerProperties withDataPullMode(DataPullMode dataPullMode)

Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.

Parameters:

dataPullMode - Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.

Returns:

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

See Also:

DataPullMode

setScheduleStartTime

public void setScheduleStartTime(Date scheduleStartTime)

The time at which the scheduled flow starts. The time is formatted as a timestamp that follows the ISO 8601 standard, such as 2022-04-26T13:00:00-07:00.

Parameters:

scheduleStartTime - The time at which the scheduled flow starts. The time is formatted as a timestamp that follows the ISO 8601 standard, such as 2022-04-26T13:00:00-07:00.

getScheduleStartTime

public Date getScheduleStartTime()

The time at which the scheduled flow starts. The time is formatted as a timestamp that follows the ISO 8601 standard, such as 2022-04-26T13:00:00-07:00.

Returns:

The time at which the scheduled flow starts. The time is formatted as a timestamp that follows the ISO 8601 standard, such as 2022-04-26T13:00:00-07:00.

withScheduleStartTime

public ScheduledTriggerProperties withScheduleStartTime(Date scheduleStartTime)

The time at which the scheduled flow starts. The time is formatted as a timestamp that follows the ISO 8601 standard, such as 2022-04-26T13:00:00-07:00.

Parameters:

scheduleStartTime - The time at which the scheduled flow starts. The time is formatted as a timestamp that follows the ISO 8601 standard, such as 2022-04-26T13:00:00-07:00.

Returns:

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

setScheduleEndTime

public void setScheduleEndTime(Date scheduleEndTime)

The time at which the scheduled flow ends. The time is formatted as a timestamp that follows the ISO 8601 standard, such as 2022-04-27T13:00:00-07:00.

Parameters:

scheduleEndTime - The time at which the scheduled flow ends. The time is formatted as a timestamp that follows the ISO 8601 standard, such as 2022-04-27T13:00:00-07:00.

getScheduleEndTime

public Date getScheduleEndTime()

The time at which the scheduled flow ends. The time is formatted as a timestamp that follows the ISO 8601 standard, such as 2022-04-27T13:00:00-07:00.

Returns:

The time at which the scheduled flow ends. The time is formatted as a timestamp that follows the ISO 8601 standard, such as 2022-04-27T13:00:00-07:00.

withScheduleEndTime

public ScheduledTriggerProperties withScheduleEndTime(Date scheduleEndTime)

The time at which the scheduled flow ends. The time is formatted as a timestamp that follows the ISO 8601 standard, such as 2022-04-27T13:00:00-07:00.

Parameters:

scheduleEndTime - The time at which the scheduled flow ends. The time is formatted as a timestamp that follows the ISO 8601 standard, such as 2022-04-27T13:00:00-07:00.

Returns:

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

setTimezone

public void setTimezone(String timezone)

Specifies the time zone used when referring to the dates and times of a scheduled flow, such as America/New_York. This time zone is only a descriptive label. It doesn't affect how Amazon AppFlow interprets the timestamps that you specify to schedule the flow.

If you want to schedule a flow by using times in a particular time zone, indicate the time zone as a UTC offset in your timestamps. For example, the UTC offsets for the America/New_York timezone are -04:00 EDT and -05:00 EST.

Parameters:

timezone - Specifies the time zone used when referring to the dates and times of a scheduled flow, such as America/New_York. This time zone is only a descriptive label. It doesn't affect how Amazon AppFlow interprets the timestamps that you specify to schedule the flow.

If you want to schedule a flow by using times in a particular time zone, indicate the time zone as a UTC offset in your timestamps. For example, the UTC offsets for the America/New_York timezone are -04:00 EDT and -05:00 EST.

getTimezone

public String getTimezone()

Specifies the time zone used when referring to the dates and times of a scheduled flow, such as America/New_York. This time zone is only a descriptive label. It doesn't affect how Amazon AppFlow interprets the timestamps that you specify to schedule the flow.

If you want to schedule a flow by using times in a particular time zone, indicate the time zone as a UTC offset in your timestamps. For example, the UTC offsets for the America/New_York timezone are -04:00 EDT and -05:00 EST.

Returns:

Specifies the time zone used when referring to the dates and times of a scheduled flow, such as America/New_York. This time zone is only a descriptive label. It doesn't affect how Amazon AppFlow interprets the timestamps that you specify to schedule the flow.

If you want to schedule a flow by using times in a particular time zone, indicate the time zone as a UTC offset in your timestamps. For example, the UTC offsets for the America/New_York timezone are -04:00 EDT and -05:00 EST.

withTimezone

public ScheduledTriggerProperties withTimezone(String timezone)

Specifies the time zone used when referring to the dates and times of a scheduled flow, such as America/New_York. This time zone is only a descriptive label. It doesn't affect how Amazon AppFlow interprets the timestamps that you specify to schedule the flow.

If you want to schedule a flow by using times in a particular time zone, indicate the time zone as a UTC offset in your timestamps. For example, the UTC offsets for the America/New_York timezone are -04:00 EDT and -05:00 EST.

Parameters:

timezone - Specifies the time zone used when referring to the dates and times of a scheduled flow, such as America/New_York. This time zone is only a descriptive label. It doesn't affect how Amazon AppFlow interprets the timestamps that you specify to schedule the flow.

If you want to schedule a flow by using times in a particular time zone, indicate the time zone as a UTC offset in your timestamps. For example, the UTC offsets for the America/New_York timezone are -04:00 EDT and -05:00 EST.

Returns:

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

setScheduleOffset

public void setScheduleOffset(Long scheduleOffset)

Specifies the optional offset that is added to the time interval for a schedule-triggered flow.

Parameters:

scheduleOffset - Specifies the optional offset that is added to the time interval for a schedule-triggered flow.

getScheduleOffset

public Long getScheduleOffset()

Specifies the optional offset that is added to the time interval for a schedule-triggered flow.

Returns:

Specifies the optional offset that is added to the time interval for a schedule-triggered flow.

withScheduleOffset

public ScheduledTriggerProperties withScheduleOffset(Long scheduleOffset)

Specifies the optional offset that is added to the time interval for a schedule-triggered flow.

Parameters:

scheduleOffset - Specifies the optional offset that is added to the time interval for a schedule-triggered flow.

Returns:

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

setFirstExecutionFrom

public void setFirstExecutionFrom(Date firstExecutionFrom)

Specifies the date range for the records to import from the connector in the first flow run.

Parameters:

firstExecutionFrom - Specifies the date range for the records to import from the connector in the first flow run.

getFirstExecutionFrom

public Date getFirstExecutionFrom()

Specifies the date range for the records to import from the connector in the first flow run.

Returns:

Specifies the date range for the records to import from the connector in the first flow run.

withFirstExecutionFrom

public ScheduledTriggerProperties withFirstExecutionFrom(Date firstExecutionFrom)

Specifies the date range for the records to import from the connector in the first flow run.

Parameters:

firstExecutionFrom - Specifies the date range for the records to import from the connector in the first flow run.

Returns:

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

setFlowErrorDeactivationThreshold

public void setFlowErrorDeactivationThreshold(Integer flowErrorDeactivationThreshold)

Defines how many times a scheduled flow fails consecutively before Amazon AppFlow deactivates it.

Parameters:

flowErrorDeactivationThreshold - Defines how many times a scheduled flow fails consecutively before Amazon AppFlow deactivates it.

getFlowErrorDeactivationThreshold

public Integer getFlowErrorDeactivationThreshold()

Defines how many times a scheduled flow fails consecutively before Amazon AppFlow deactivates it.

Returns:

Defines how many times a scheduled flow fails consecutively before Amazon AppFlow deactivates it.

withFlowErrorDeactivationThreshold

public ScheduledTriggerProperties withFlowErrorDeactivationThreshold(Integer flowErrorDeactivationThreshold)

Defines how many times a scheduled flow fails consecutively before Amazon AppFlow deactivates it.

Parameters:

flowErrorDeactivationThreshold - Defines how many times a scheduled flow fails consecutively before Amazon AppFlow deactivates it.

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