Class Trigger
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Trigger.Builder,
Trigger>
Information about a specific trigger.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionactions()
The actions initiated by this trigger.static Trigger.Builder
builder()
final String
A description of this trigger.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final EventBatchingCondition
Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Actions property.final int
hashCode()
final String
id()
Reserved for future use.final String
name()
The name of the trigger.final Predicate
The predicate of this trigger, which defines when it will fire.final String
schedule()
Acron
expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers.static Class
<? extends Trigger.Builder> final TriggerState
state()
The current state of the trigger.final String
The current state of the trigger.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final TriggerType
type()
The type of trigger that this is.final String
The type of trigger that this is.final String
The name of the workflow associated with the trigger.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the trigger.
- Returns:
- The name of the trigger.
-
workflowName
The name of the workflow associated with the trigger.
- Returns:
- The name of the workflow associated with the trigger.
-
id
Reserved for future use.
- Returns:
- Reserved for future use.
-
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 returnTriggerType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of trigger that this is.
- See Also:
-
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 returnTriggerType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of trigger that this is.
- See Also:
-
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 returnTriggerState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state of the trigger.
- See Also:
-
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 returnTriggerState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state of the trigger.
- See Also:
-
description
A description of this trigger.
- Returns:
- A description of this trigger.
-
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 * * ? *)
.- Returns:
- 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 * * ? *)
.
-
hasActions
public final boolean hasActions()For responses, this returns true if the service returned a value for the Actions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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.- Returns:
- The actions initiated by this trigger.
-
predicate
The predicate of this trigger, which defines when it will fire.
- Returns:
- The predicate of this trigger, which defines when it will fire.
-
eventBatchingCondition
Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
- Returns:
- Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
-
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 interfaceToCopyableBuilder<Trigger.Builder,
Trigger> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-