Interface AlarmSummary.Builder

All Superinterfaces:
Buildable, CopyableBuilder<AlarmSummary.Builder,AlarmSummary>, SdkBuilder<AlarmSummary.Builder,AlarmSummary>, SdkPojo
Enclosing class:
AlarmSummary
public static interface AlarmSummary.Builder extends SdkPojo, CopyableBuilder<AlarmSummary.Builder,AlarmSummary>

  • Method Details

    • alarmModelName

      AlarmSummary.Builder alarmModelName(String alarmModelName)

      The name of the alarm model.

      Parameters:
      alarmModelName - The name of the alarm model.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • alarmModelVersion

      AlarmSummary.Builder alarmModelVersion(String alarmModelVersion)

      The version of the alarm model.

      Parameters:
      alarmModelVersion - The version of the alarm model.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • keyValue

      AlarmSummary.Builder keyValue(String keyValue)

      The value of the key used as a filter to select only the alarms associated with the key.

      Parameters:
      keyValue - The value of the key used as a filter to select only the alarms associated with the key.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stateName

      AlarmSummary.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

      AlarmSummary.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:

    • creationTime

      AlarmSummary.Builder creationTime(Instant creationTime)

      The time the alarm was created, in the Unix epoch format.

      Parameters:
      creationTime - The time the alarm was created, in the Unix epoch format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastUpdateTime

      AlarmSummary.Builder lastUpdateTime(Instant lastUpdateTime)

      The time the alarm was last updated, in the Unix epoch format.

      Parameters:
      lastUpdateTime - The time the alarm was last updated, in the Unix epoch format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.