Package software.amazon.awssdk.services.iotsitewise.model

Class Alarms

java.lang.Object

software.amazon.awssdk.services.iotsitewise.model.Alarms

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Alarms.Builder,Alarms>

@Generated("software.amazon.awssdk:codegen")
public final class Alarms
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Alarms.Builder,Alarms>

Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see Monitoring with alarms in the IoT SiteWise Application Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Alarms.Builder

Method Summary

Modifier and Type	Method	Description
String	alarmRoleArn()	The ARN of the IAM role that allows the alarm to perform actions and access Amazon Web Services resources and services, such as IoT Events.
static Alarms.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	notificationLambdaArn()	The ARN of the Lambda function that manages alarm notifications.
List<SdkField<?>>	sdkFields()
static Class<? extends Alarms.Builder>	serializableBuilderClass()
Alarms.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

alarmRoleArn

public final String alarmRoleArn()

The ARN of the IAM role that allows the alarm to perform actions and access Amazon Web Services resources and services, such as IoT Events.

Returns:

The ARN of the IAM role that allows the alarm to perform actions and access Amazon Web Services resources and services, such as IoT Events.

notificationLambdaArn

public final String notificationLambdaArn()

The ARN of the Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the IoT Events Developer Guide.

Returns:

The ARN of the Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the IoT Events Developer Guide.

toBuilder

public Alarms.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Alarms.Builder,Alarms>

builder

public static Alarms.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo