@Generated(value="software.amazon.awssdk:codegen") public final class Trigger extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Trigger.Builder,Trigger>
Information about a specific trigger.
| Modifier and Type | Class and Description |
|---|---|
static interface |
Trigger.Builder |
| Modifier and Type | Method and Description |
|---|---|
List<Action> |
actions()
The actions initiated by this trigger.
|
static Trigger.Builder |
builder() |
String |
description()
A description of this trigger.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
EventBatchingCondition |
eventBatchingCondition()
Batch condition that must be met (specified number of events received or batch time window expired) before
EventBridge event trigger fires.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasActions()
For responses, this returns true if the service returned a value for the Actions property.
|
int |
hashCode() |
String |
id()
Reserved for future use.
|
String |
name()
The name of the trigger.
|
Predicate |
predicate()
The predicate of this trigger, which defines when it will fire.
|
String |
schedule()
A
cron expression used to specify the schedule (see Time-Based Schedules for
Jobs and Crawlers. |
List<SdkField<?>> |
sdkFields() |
static Class<? extends Trigger.Builder> |
serializableBuilderClass() |
TriggerState |
state()
The current state of the trigger.
|
String |
stateAsString()
The current state of the trigger.
|
Trigger.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
TriggerType |
type()
The type of trigger that this is.
|
String |
typeAsString()
The type of trigger that this is.
|
String |
workflowName()
The name of the workflow associated with the trigger.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String name()
The name of the trigger.
public final String workflowName()
The name of the workflow associated with the trigger.
public final String id()
Reserved for future use.
public final TriggerType type()
The type of trigger that this is.
If the service returns an enum value that is not available in the current SDK version, type will return
TriggerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
typeAsString().
TriggerTypepublic final String typeAsString()
The type of trigger that this is.
If the service returns an enum value that is not available in the current SDK version, type will return
TriggerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
typeAsString().
TriggerTypepublic final TriggerState state()
The current state of the trigger.
If the service returns an enum value that is not available in the current SDK version, state will return
TriggerState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
stateAsString().
TriggerStatepublic final String stateAsString()
The current state of the trigger.
If the service returns an enum value that is not available in the current SDK version, state will return
TriggerState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
stateAsString().
TriggerStatepublic final String description()
A description of this trigger.
public final String schedule()
A cron expression used to specify the schedule (see Time-Based Schedules for
Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify:
cron(15 12 * * ? *).
cron expression used to specify the schedule (see Time-Based
Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would
specify: cron(15 12 * * ? *).public final boolean hasActions()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<Action> actions()
The actions initiated by this trigger.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasActions() method.
public final Predicate predicate()
The predicate of this trigger, which defines when it will fire.
public final EventBatchingCondition eventBatchingCondition()
Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
public Trigger.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<Trigger.Builder,Trigger>public static Trigger.Builder builder()
public static Class<? extends Trigger.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
Copyright © 2023. All rights reserved.