Package software.amazon.awssdk.services.appflow.model

Class ScheduledTriggerProperties

java.lang.Object

software.amazon.awssdk.services.appflow.model.ScheduledTriggerProperties

All Implemented Interfaces:

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

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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ScheduledTriggerProperties.Builder

Method Summary

Modifier and Type	Method	Description
static ScheduledTriggerProperties.Builder	builder()
DataPullMode	dataPullMode()	Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.
String	dataPullModeAsString()	Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Instant	firstExecutionFrom()	Specifies the date range for the records to import from the connector in the first flow run.
Integer	flowErrorDeactivationThreshold()	Defines how many times a scheduled flow fails consecutively before Amazon AppFlow deactivates it.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	scheduleEndTime()	The time at which the scheduled flow ends.
String	scheduleExpression()	The scheduling expression that determines the rate at which the schedule will run, for example rate(5minutes).
Long	scheduleOffset()	Specifies the optional offset that is added to the time interval for a schedule-triggered flow.
Instant	scheduleStartTime()	The time at which the scheduled flow starts.
List<SdkField<?>>	sdkFields()
static Class<? extends ScheduledTriggerProperties.Builder>	serializableBuilderClass()
String	timezone()	Specifies the time zone used when referring to the dates and times of a scheduled flow, such as America/New_York.
ScheduledTriggerProperties.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

scheduleExpression

public final String scheduleExpression()

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

dataPullMode

public final DataPullMode dataPullMode()

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

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

Returns:

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

See Also:

DataPullMode

dataPullModeAsString

public final String dataPullModeAsString()

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

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

Returns:

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

See Also:

DataPullMode

scheduleStartTime

public final Instant 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:

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.

scheduleEndTime

public final Instant 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:

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.

timezone

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

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.

scheduleOffset

public final Long scheduleOffset()

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.

firstExecutionFrom

public final Instant firstExecutionFrom()

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.

flowErrorDeactivationThreshold

public final Integer flowErrorDeactivationThreshold()

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.

toBuilder

public ScheduledTriggerProperties.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ScheduledTriggerProperties.Builder,ScheduledTriggerProperties>

builder

public static ScheduledTriggerProperties.Builder builder()

serializableBuilderClass

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