Interface AlarmState.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<AlarmState.Builder,AlarmState>,SdkBuilder<AlarmState.Builder,AlarmState>,SdkPojo
- Enclosing class:
- AlarmState
public static interface AlarmState.Builder extends SdkPojo, CopyableBuilder<AlarmState.Builder,AlarmState>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default AlarmState.BuildercustomerAction(Consumer<CustomerAction.Builder> customerAction)Contains information about the action that you can take to respond to the alarm.AlarmState.BuildercustomerAction(CustomerAction customerAction)Contains information about the action that you can take to respond to the alarm.default AlarmState.BuilderruleEvaluation(Consumer<RuleEvaluation.Builder> ruleEvaluation)Information needed to evaluate data.AlarmState.BuilderruleEvaluation(RuleEvaluation ruleEvaluation)Information needed to evaluate data.AlarmState.BuilderstateName(String stateName)The name of the alarm state.AlarmState.BuilderstateName(AlarmStateName stateName)The name of the alarm state.default AlarmState.BuildersystemEvent(Consumer<SystemEvent.Builder> systemEvent)Contains information about alarm state changes.AlarmState.BuildersystemEvent(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 Detail
-
stateName
AlarmState.Builder stateName(String stateName)
The name of the alarm state. The state name can be one of the following values:
-
DISABLED- When the alarm is in theDISABLEDstate, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to theNORMALstate. -
NORMAL- When the alarm is in theNORMALstate, it's ready to evaluate data. -
ACTIVE- If the alarm is in theACTIVEstate, the alarm is invoked. -
ACKNOWLEDGED- When the alarm is in theACKNOWLEDGEDstate, the alarm was invoked and you acknowledged the alarm. -
SNOOZE_DISABLED- When the alarm is in theSNOOZE_DISABLEDstate, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to theNORMALstate. -
LATCHED- When the alarm is in theLATCHEDstate, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to theNORMALstate, 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 theDISABLEDstate, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to theNORMALstate. -
NORMAL- When the alarm is in theNORMALstate, it's ready to evaluate data. -
ACTIVE- If the alarm is in theACTIVEstate, the alarm is invoked. -
ACKNOWLEDGED- When the alarm is in theACKNOWLEDGEDstate, the alarm was invoked and you acknowledged the alarm. -
SNOOZE_DISABLED- When the alarm is in theSNOOZE_DISABLEDstate, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to theNORMALstate. -
LATCHED- When the alarm is in theLATCHEDstate, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to theNORMALstate, you must acknowledge the alarm.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
AlarmStateName,AlarmStateName
-
-
stateName
AlarmState.Builder stateName(AlarmStateName stateName)
The name of the alarm state. The state name can be one of the following values:
-
DISABLED- When the alarm is in theDISABLEDstate, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to theNORMALstate. -
NORMAL- When the alarm is in theNORMALstate, it's ready to evaluate data. -
ACTIVE- If the alarm is in theACTIVEstate, the alarm is invoked. -
ACKNOWLEDGED- When the alarm is in theACKNOWLEDGEDstate, the alarm was invoked and you acknowledged the alarm. -
SNOOZE_DISABLED- When the alarm is in theSNOOZE_DISABLEDstate, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to theNORMALstate. -
LATCHED- When the alarm is in theLATCHEDstate, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to theNORMALstate, 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 theDISABLEDstate, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to theNORMALstate. -
NORMAL- When the alarm is in theNORMALstate, it's ready to evaluate data. -
ACTIVE- If the alarm is in theACTIVEstate, the alarm is invoked. -
ACKNOWLEDGED- When the alarm is in theACKNOWLEDGEDstate, the alarm was invoked and you acknowledged the alarm. -
SNOOZE_DISABLED- When the alarm is in theSNOOZE_DISABLEDstate, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to theNORMALstate. -
LATCHED- When the alarm is in theLATCHEDstate, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to theNORMALstate, you must acknowledge the alarm.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
AlarmStateName,AlarmStateName
-
-
ruleEvaluation
AlarmState.Builder ruleEvaluation(RuleEvaluation 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
default AlarmState.Builder ruleEvaluation(Consumer<RuleEvaluation.Builder> ruleEvaluation)
Information needed to evaluate data.
This is a convenience method that creates an instance of theRuleEvaluation.Builderavoiding the need to create one manually viaRuleEvaluation.builder().When the
Consumercompletes,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:
ruleEvaluation(RuleEvaluation)
-
customerAction
AlarmState.Builder customerAction(CustomerAction 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
default AlarmState.Builder customerAction(Consumer<CustomerAction.Builder> 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.Builderavoiding the need to create one manually viaCustomerAction.builder().When the
Consumercompletes,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:
customerAction(CustomerAction)
-
systemEvent
AlarmState.Builder systemEvent(SystemEvent 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
default AlarmState.Builder systemEvent(Consumer<SystemEvent.Builder> systemEvent)
Contains information about alarm state changes.
This is a convenience method that creates an instance of theSystemEvent.Builderavoiding the need to create one manually viaSystemEvent.builder().When the
Consumercompletes,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:
systemEvent(SystemEvent)
-
-