Interface AlarmState.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<AlarmState.Builder,
,AlarmState> SdkBuilder<AlarmState.Builder,
,AlarmState> SdkPojo
- Enclosing class:
AlarmState
-
Method Summary
Modifier and TypeMethodDescriptiondefault AlarmState.Builder
customerAction
(Consumer<CustomerAction.Builder> customerAction) Contains information about the action that you can take to respond to the alarm.customerAction
(CustomerAction customerAction) Contains information about the action that you can take to respond to the alarm.default AlarmState.Builder
ruleEvaluation
(Consumer<RuleEvaluation.Builder> ruleEvaluation) Information needed to evaluate data.ruleEvaluation
(RuleEvaluation ruleEvaluation) Information needed to evaluate data.The name of the alarm state.stateName
(AlarmStateName stateName) The name of the alarm state.default AlarmState.Builder
systemEvent
(Consumer<SystemEvent.Builder> systemEvent) Contains information about alarm state changes.systemEvent
(SystemEvent systemEvent) Contains information about alarm state changes.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
stateName
The name of the alarm state. The state name can be one of the following values:
-
DISABLED
- When the alarm is in theDISABLED
state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to theNORMAL
state. -
NORMAL
- When the alarm is in theNORMAL
state, it's ready to evaluate data. -
ACTIVE
- If the alarm is in theACTIVE
state, the alarm is invoked. -
ACKNOWLEDGED
- When the alarm is in theACKNOWLEDGED
state, the alarm was invoked and you acknowledged the alarm. -
SNOOZE_DISABLED
- When the alarm is in theSNOOZE_DISABLED
state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to theNORMAL
state. -
LATCHED
- When the alarm is in theLATCHED
state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to theNORMAL
state, you must acknowledge the alarm.
- Parameters:
stateName
- The name of the alarm state. The state name can be one of the following values:-
DISABLED
- When the alarm is in theDISABLED
state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to theNORMAL
state. -
NORMAL
- When the alarm is in theNORMAL
state, it's ready to evaluate data. -
ACTIVE
- If the alarm is in theACTIVE
state, the alarm is invoked. -
ACKNOWLEDGED
- When the alarm is in theACKNOWLEDGED
state, the alarm was invoked and you acknowledged the alarm. -
SNOOZE_DISABLED
- When the alarm is in theSNOOZE_DISABLED
state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to theNORMAL
state. -
LATCHED
- When the alarm is in theLATCHED
state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to theNORMAL
state, you must acknowledge the alarm.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
stateName
The name of the alarm state. The state name can be one of the following values:
-
DISABLED
- When the alarm is in theDISABLED
state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to theNORMAL
state. -
NORMAL
- When the alarm is in theNORMAL
state, it's ready to evaluate data. -
ACTIVE
- If the alarm is in theACTIVE
state, the alarm is invoked. -
ACKNOWLEDGED
- When the alarm is in theACKNOWLEDGED
state, the alarm was invoked and you acknowledged the alarm. -
SNOOZE_DISABLED
- When the alarm is in theSNOOZE_DISABLED
state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to theNORMAL
state. -
LATCHED
- When the alarm is in theLATCHED
state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to theNORMAL
state, you must acknowledge the alarm.
- Parameters:
stateName
- The name of the alarm state. The state name can be one of the following values:-
DISABLED
- When the alarm is in theDISABLED
state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to theNORMAL
state. -
NORMAL
- When the alarm is in theNORMAL
state, it's ready to evaluate data. -
ACTIVE
- If the alarm is in theACTIVE
state, the alarm is invoked. -
ACKNOWLEDGED
- When the alarm is in theACKNOWLEDGED
state, the alarm was invoked and you acknowledged the alarm. -
SNOOZE_DISABLED
- When the alarm is in theSNOOZE_DISABLED
state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to theNORMAL
state. -
LATCHED
- When the alarm is in theLATCHED
state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to theNORMAL
state, you must acknowledge the alarm.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
ruleEvaluation
Information needed to evaluate data.
- Parameters:
ruleEvaluation
- Information needed to evaluate data.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ruleEvaluation
Information needed to evaluate data.
This is a convenience method that creates an instance of theRuleEvaluation.Builder
avoiding the need to create one manually viaRuleEvaluation.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toruleEvaluation(RuleEvaluation)
.- Parameters:
ruleEvaluation
- a consumer that will call methods onRuleEvaluation.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
customerAction
Contains information about the action that you can take to respond to the alarm.
- Parameters:
customerAction
- Contains information about the action that you can take to respond to the alarm.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
customerAction
Contains information about the action that you can take to respond to the alarm.
This is a convenience method that creates an instance of theCustomerAction.Builder
avoiding the need to create one manually viaCustomerAction.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocustomerAction(CustomerAction)
.- Parameters:
customerAction
- a consumer that will call methods onCustomerAction.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
systemEvent
Contains information about alarm state changes.
- Parameters:
systemEvent
- Contains information about alarm state changes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
systemEvent
Contains information about alarm state changes.
This is a convenience method that creates an instance of theSystemEvent.Builder
avoiding the need to create one manually viaSystemEvent.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosystemEvent(SystemEvent)
.- Parameters:
systemEvent
- a consumer that will call methods onSystemEvent.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-