software.amazon.awssdk.services.iotevents.model

Class DescribeAlarmModelResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.iotevents.model.IotEventsResponse

software.amazon.awssdk.services.iotevents.model.DescribeAlarmModelResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeAlarmModelResponse.Builder,DescribeAlarmModelResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeAlarmModelResponse
extends IotEventsResponse
implements ToCopyableBuilder<DescribeAlarmModelResponse.Builder,DescribeAlarmModelResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeAlarmModelResponse.Builder

Method Summary

Modifier and Type	Method and Description
AlarmCapabilities	alarmCapabilities() Contains the configuration information of alarm state changes.
AlarmEventActions	alarmEventActions() Contains information about one or more alarm actions.
String	alarmModelArn() The ARN of the alarm model.
String	alarmModelDescription() The description of the alarm model.
String	alarmModelName() The name of the alarm model.
String	alarmModelVersion() The version of the alarm model.
AlarmNotification	alarmNotification() Contains information about one or more notification actions.
AlarmRule	alarmRule() Defines when your alarm is invoked.
static DescribeAlarmModelResponse.Builder	builder()
Instant	creationTime() The time the alarm model was created, in the Unix epoch format.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	key() An input attribute used as a key to create an alarm.
Instant	lastUpdateTime() The time the alarm model was last updated, in the Unix epoch format.
String	roleArn() The ARN of the IAM role that allows the alarm to perform actions and access AWS resources.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeAlarmModelResponse.Builder>	serializableBuilderClass()
Integer	severity() A non-negative integer that reflects the severity level of the alarm.
AlarmModelVersionStatus	status() The status of the alarm model.
String	statusAsString() The status of the alarm model.
String	statusMessage() Contains information about the status of the alarm model.
DescribeAlarmModelResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.iotevents.model.IotEventsResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

creationTime

public final Instant creationTime()

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

Returns:

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

alarmModelArn

public final String alarmModelArn()

The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.

Returns:

The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.

alarmModelVersion

public final String alarmModelVersion()

The version of the alarm model.

Returns:

The version of the alarm model.

lastUpdateTime

public final Instant lastUpdateTime()

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

Returns:

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

status

public final AlarmModelVersionStatus status()

The status of the alarm model. The status can be one of the following values:

• ACTIVE - The alarm model is active and it's ready to evaluate data.

• ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes.

• INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model.

• FAILED - You couldn't create or update the alarm model. Check your alarm model information and try again.

If the service returns an enum value that is not available in the current SDK version, status will return AlarmModelVersionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the alarm model. The status can be one of the following values:

• ACTIVE - The alarm model is active and it's ready to evaluate data.

• ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes.

• INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model.

• FAILED - You couldn't create or update the alarm model. Check your alarm model information and try again.

See Also:

AlarmModelVersionStatus

statusAsString

public final String statusAsString()

The status of the alarm model. The status can be one of the following values:

• ACTIVE - The alarm model is active and it's ready to evaluate data.

• ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes.

• INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model.

• FAILED - You couldn't create or update the alarm model. Check your alarm model information and try again.

If the service returns an enum value that is not available in the current SDK version, status will return AlarmModelVersionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the alarm model. The status can be one of the following values:

• ACTIVE - The alarm model is active and it's ready to evaluate data.

• ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes.

• INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model.

• FAILED - You couldn't create or update the alarm model. Check your alarm model information and try again.

See Also:

AlarmModelVersionStatus

statusMessage

public final String statusMessage()

Contains information about the status of the alarm model.

Returns:

Contains information about the status of the alarm model.

alarmModelName

public final String alarmModelName()

The name of the alarm model.

Returns:

The name of the alarm model.

alarmModelDescription

public final String alarmModelDescription()

The description of the alarm model.

Returns:

The description of the alarm model.

roleArn

public final String roleArn()

The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.

Returns:

The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.

key

public final String key()

An input attribute used as a key to create an alarm. AWS IoT Events routes inputs associated with this key to the alarm.

Returns:

An input attribute used as a key to create an alarm. AWS IoT Events routes inputs associated with this key to the alarm.

severity

public final Integer severity()

A non-negative integer that reflects the severity level of the alarm.

Returns:

A non-negative integer that reflects the severity level of the alarm.

alarmRule

public final AlarmRule alarmRule()

Defines when your alarm is invoked.

Returns:

Defines when your alarm is invoked.

alarmNotification

public final AlarmNotification alarmNotification()

Contains information about one or more notification actions.

Returns:

Contains information about one or more notification actions.

alarmEventActions

public final AlarmEventActions alarmEventActions()

Contains information about one or more alarm actions.

Returns:

Contains information about one or more alarm actions.

alarmCapabilities

public final AlarmCapabilities alarmCapabilities()

Contains the configuration information of alarm state changes.

Returns:

Contains the configuration information of alarm state changes.

toBuilder

public DescribeAlarmModelResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeAlarmModelResponse.Builder,DescribeAlarmModelResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeAlarmModelResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeAlarmModelResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo