Class Trigger
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Trigger.Builder,
Trigger>
Defines a condition that can automatically trigger the execution of a Region switch plan.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal WorkflowTargetAction
action()
The action to perform when the trigger fires.final String
The action to perform when the trigger fires.static Trigger.Builder
builder()
final List
<TriggerCondition> The conditions that must be met for the trigger to fire.final String
The description for a trigger.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.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 Conditions property.final int
hashCode()
final Integer
The minimum time, in minutes, that must elapse between automatic executions of the plan.static Class
<? extends Trigger.Builder> final String
The Amazon Web Services Region for a 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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
description
The description for a trigger.
- Returns:
- The description for a trigger.
-
targetRegion
The Amazon Web Services Region for a trigger.
- Returns:
- The Amazon Web Services Region for a trigger.
-
action
The action to perform when the trigger fires. Valid values include ACTIVATE and DEACTIVATE.
If the service returns an enum value that is not available in the current SDK version,
action
will returnWorkflowTargetAction.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactionAsString()
.- Returns:
- The action to perform when the trigger fires. Valid values include ACTIVATE and DEACTIVATE.
- See Also:
-
actionAsString
The action to perform when the trigger fires. Valid values include ACTIVATE and DEACTIVATE.
If the service returns an enum value that is not available in the current SDK version,
action
will returnWorkflowTargetAction.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromactionAsString()
.- Returns:
- The action to perform when the trigger fires. Valid values include ACTIVATE and DEACTIVATE.
- See Also:
-
hasConditions
public final boolean hasConditions()For responses, this returns true if the service returned a value for the Conditions 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. -
conditions
The conditions that must be met for the trigger to fire.
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
hasConditions()
method.- Returns:
- The conditions that must be met for the trigger to fire.
-
minDelayMinutesBetweenExecutions
The minimum time, in minutes, that must elapse between automatic executions of the plan.
- Returns:
- The minimum time, in minutes, that must elapse between automatic executions of the plan.
-
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
-
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
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-