@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.
Modifier and Type | Class and Description |
---|---|
static interface |
ScheduledTriggerProperties.Builder |
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()
Returns the value of the FirstExecutionFrom property for this object.
|
<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.
|
copy
public final String scheduleExpression()
The scheduling expression that determines the rate at which the schedule will run, for example
rate(5minutes)
.
rate(5minutes)
.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()
.
DataPullMode
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()
.
DataPullMode
public final Instant scheduleStartTime()
Specifies the scheduled start time for a schedule-triggered flow.
public final Instant scheduleEndTime()
Specifies the scheduled end time for a schedule-triggered flow.
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
.
America/New_York
.public final Long scheduleOffset()
Specifies the optional offset that is added to the time interval for a schedule-triggered flow.
public final Instant firstExecutionFrom()
public ScheduledTriggerProperties.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<ScheduledTriggerProperties.Builder,ScheduledTriggerProperties>
public static ScheduledTriggerProperties.Builder builder()
public static Class<? extends ScheduledTriggerProperties.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.