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 Details

    • 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 the DISABLED state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the NORMAL state.

      • NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data.

      • ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked.

      • ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and you acknowledged the alarm.

      • SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL state.

      • LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the NORMAL 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 the DISABLED state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the NORMAL state.

      • NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data.

      • ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked.

      • ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and you acknowledged the alarm.

      • SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL state.

      • LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the NORMAL state, you must acknowledge the alarm.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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 the DISABLED state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the NORMAL state.

      • NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data.

      • ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked.

      • ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and you acknowledged the alarm.

      • SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL state.

      • LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the NORMAL 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 the DISABLED state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the NORMAL state.

      • NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data.

      • ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked.

      • ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and you acknowledged the alarm.

      • SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL state.

      • LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the NORMAL state, you must acknowledge the alarm.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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 the RuleEvaluation.Builder avoiding the need to create one manually via RuleEvaluation.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ruleEvaluation(RuleEvaluation).

      Parameters:
      ruleEvaluation - a consumer that will call methods on RuleEvaluation.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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 the CustomerAction.Builder avoiding the need to create one manually via CustomerAction.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customerAction(CustomerAction).

      Parameters:
      customerAction - a consumer that will call methods on CustomerAction.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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 the SystemEvent.Builder avoiding the need to create one manually via SystemEvent.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to systemEvent(SystemEvent).

      Parameters:
      systemEvent - a consumer that will call methods on SystemEvent.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: