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(value="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 and Description
static interface	ScheduledTriggerProperties.Builder

Method Summary

Modifier and Type	Method and 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) Indicates whether some other object is "equal to" this one by SDK fields.
Instant	firstExecutionFrom() Specifies the date range for the records to import from the connector in the first flow run.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	scheduleEndTime() Specifies the scheduled end time for a schedule-triggered flow.
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() Specifies the scheduled start time for a schedule-triggered flow.
List<SdkField<?>>	sdkFields()
static Class<? extends ScheduledTriggerProperties.Builder>	serializableBuilderClass()
String	timezone() Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as America/New_York.
ScheduledTriggerProperties.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Specifies the scheduled start time for a schedule-triggered flow.

Returns:

Specifies the scheduled start time for a schedule-triggered flow.

scheduleEndTime

public final Instant scheduleEndTime()

Specifies the scheduled end time for a schedule-triggered flow.

Returns:

Specifies the scheduled end time for a schedule-triggered flow.

timezone

public final String timezone()

Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as America/New_York.

Returns:

Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as America/New_York.

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.

toBuilder

public ScheduledTriggerProperties.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ScheduledTriggerProperties.Builder,ScheduledTriggerProperties>

Returns:

a builder for type T

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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.