com.amazonaws.services.ioteventsdata.model.AlarmSummary Maven / Gradle / Ivy
/*
* Copyright 2020-2025 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.ioteventsdata.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Contains a summary of an alarm.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class AlarmSummary implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the alarm model.
*
*/
private String alarmModelName;
/**
*
* The version of the alarm model.
*
*/
private String alarmModelVersion;
/**
*
* The value of the key used as a filter to select only the alarms associated with the key.
*
*/
private String keyValue;
/**
*
* 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.
*
*
*
*/
private String stateName;
/**
*
* The time the alarm was created, in the Unix epoch format.
*
*/
private java.util.Date creationTime;
/**
*
* The time the alarm was last updated, in the Unix epoch format.
*
*/
private java.util.Date lastUpdateTime;
/**
*
* The name of the alarm model.
*
*
* @param alarmModelName
* The name of the alarm model.
*/
public void setAlarmModelName(String alarmModelName) {
this.alarmModelName = alarmModelName;
}
/**
*
* The name of the alarm model.
*
*
* @return The name of the alarm model.
*/
public String getAlarmModelName() {
return this.alarmModelName;
}
/**
*
* The name of the alarm model.
*
*
* @param alarmModelName
* The name of the alarm model.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AlarmSummary withAlarmModelName(String alarmModelName) {
setAlarmModelName(alarmModelName);
return this;
}
/**
*
* The version of the alarm model.
*
*
* @param alarmModelVersion
* The version of the alarm model.
*/
public void setAlarmModelVersion(String alarmModelVersion) {
this.alarmModelVersion = alarmModelVersion;
}
/**
*
* The version of the alarm model.
*
*
* @return The version of the alarm model.
*/
public String getAlarmModelVersion() {
return this.alarmModelVersion;
}
/**
*
* The version of the alarm model.
*
*
* @param alarmModelVersion
* The version of the alarm model.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AlarmSummary withAlarmModelVersion(String alarmModelVersion) {
setAlarmModelVersion(alarmModelVersion);
return this;
}
/**
*
* The value of the key used as a filter to select only the alarms associated with the key.
*
*
* @param keyValue
* The value of the key used as a filter to select only the alarms associated with the key.
*/
public void setKeyValue(String keyValue) {
this.keyValue = keyValue;
}
/**
*
* The value of the key used as a filter to select only the alarms associated with the key.
*
*
* @return The value of the key used as a filter to select only the alarms associated with the key.
*/
public String getKeyValue() {
return this.keyValue;
}
/**
*
* The value of the key used as a filter to select only the alarms associated with the key.
*
*
* @param keyValue
* The value of the key used as a filter to select only the alarms associated with the key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AlarmSummary withKeyValue(String keyValue) {
setKeyValue(keyValue);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @see AlarmStateName
*/
public void setStateName(String stateName) {
this.stateName = 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.
*
*
*
*
* @return 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.
*
*
* @see AlarmStateName
*/
public String getStateName() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see AlarmStateName
*/
public AlarmSummary withStateName(String stateName) {
setStateName(stateName);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see AlarmStateName
*/
public AlarmSummary withStateName(AlarmStateName stateName) {
this.stateName = stateName.toString();
return this;
}
/**
*
* The time the alarm was created, in the Unix epoch format.
*
*
* @param creationTime
* The time the alarm was created, in the Unix epoch format.
*/
public void setCreationTime(java.util.Date creationTime) {
this.creationTime = creationTime;
}
/**
*
* The time the alarm was created, in the Unix epoch format.
*
*
* @return The time the alarm was created, in the Unix epoch format.
*/
public java.util.Date getCreationTime() {
return this.creationTime;
}
/**
*
* The time the alarm was created, in the Unix epoch format.
*
*
* @param creationTime
* The time the alarm was created, in the Unix epoch format.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AlarmSummary withCreationTime(java.util.Date creationTime) {
setCreationTime(creationTime);
return this;
}
/**
*
* The time the alarm was last updated, in the Unix epoch format.
*
*
* @param lastUpdateTime
* The time the alarm was last updated, in the Unix epoch format.
*/
public void setLastUpdateTime(java.util.Date lastUpdateTime) {
this.lastUpdateTime = lastUpdateTime;
}
/**
*
* The time the alarm was last updated, in the Unix epoch format.
*
*
* @return The time the alarm was last updated, in the Unix epoch format.
*/
public java.util.Date getLastUpdateTime() {
return this.lastUpdateTime;
}
/**
*
* The time the alarm was last updated, in the Unix epoch format.
*
*
* @param lastUpdateTime
* The time the alarm was last updated, in the Unix epoch format.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AlarmSummary withLastUpdateTime(java.util.Date lastUpdateTime) {
setLastUpdateTime(lastUpdateTime);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getAlarmModelName() != null)
sb.append("AlarmModelName: ").append(getAlarmModelName()).append(",");
if (getAlarmModelVersion() != null)
sb.append("AlarmModelVersion: ").append(getAlarmModelVersion()).append(",");
if (getKeyValue() != null)
sb.append("KeyValue: ").append(getKeyValue()).append(",");
if (getStateName() != null)
sb.append("StateName: ").append(getStateName()).append(",");
if (getCreationTime() != null)
sb.append("CreationTime: ").append(getCreationTime()).append(",");
if (getLastUpdateTime() != null)
sb.append("LastUpdateTime: ").append(getLastUpdateTime());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof AlarmSummary == false)
return false;
AlarmSummary other = (AlarmSummary) obj;
if (other.getAlarmModelName() == null ^ this.getAlarmModelName() == null)
return false;
if (other.getAlarmModelName() != null && other.getAlarmModelName().equals(this.getAlarmModelName()) == false)
return false;
if (other.getAlarmModelVersion() == null ^ this.getAlarmModelVersion() == null)
return false;
if (other.getAlarmModelVersion() != null && other.getAlarmModelVersion().equals(this.getAlarmModelVersion()) == false)
return false;
if (other.getKeyValue() == null ^ this.getKeyValue() == null)
return false;
if (other.getKeyValue() != null && other.getKeyValue().equals(this.getKeyValue()) == false)
return false;
if (other.getStateName() == null ^ this.getStateName() == null)
return false;
if (other.getStateName() != null && other.getStateName().equals(this.getStateName()) == false)
return false;
if (other.getCreationTime() == null ^ this.getCreationTime() == null)
return false;
if (other.getCreationTime() != null && other.getCreationTime().equals(this.getCreationTime()) == false)
return false;
if (other.getLastUpdateTime() == null ^ this.getLastUpdateTime() == null)
return false;
if (other.getLastUpdateTime() != null && other.getLastUpdateTime().equals(this.getLastUpdateTime()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAlarmModelName() == null) ? 0 : getAlarmModelName().hashCode());
hashCode = prime * hashCode + ((getAlarmModelVersion() == null) ? 0 : getAlarmModelVersion().hashCode());
hashCode = prime * hashCode + ((getKeyValue() == null) ? 0 : getKeyValue().hashCode());
hashCode = prime * hashCode + ((getStateName() == null) ? 0 : getStateName().hashCode());
hashCode = prime * hashCode + ((getCreationTime() == null) ? 0 : getCreationTime().hashCode());
hashCode = prime * hashCode + ((getLastUpdateTime() == null) ? 0 : getLastUpdateTime().hashCode());
return hashCode;
}
@Override
public AlarmSummary clone() {
try {
return (AlarmSummary) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.ioteventsdata.model.transform.AlarmSummaryMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}