Package software.amazon.awssdk.services.iotevents.model

Class CreateAlarmModelRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iotevents.model.IotEventsRequest

software.amazon.awssdk.services.iotevents.model.CreateAlarmModelRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateAlarmModelRequest.Builder,CreateAlarmModelRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateAlarmModelRequest
extends IotEventsRequest
implements ToCopyableBuilder<CreateAlarmModelRequest.Builder,CreateAlarmModelRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateAlarmModelRequest.Builder

Method Summary

Modifier and Type	Method	Description
AlarmCapabilities	alarmCapabilities()	Contains the configuration information of alarm state changes.
AlarmEventActions	alarmEventActions()	Contains information about one or more alarm actions.
String	alarmModelDescription()	A description that tells you what the alarm model detects.
String	alarmModelName()	A unique name that helps you identify the alarm model.
AlarmNotification	alarmNotification()	Contains information about one or more notification actions.
AlarmRule	alarmRule()	Defines when your alarm is invoked.
static CreateAlarmModelRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	key()	An input attribute used as a key to create an alarm.
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 CreateAlarmModelRequest.Builder>	serializableBuilderClass()
Integer	severity()	A non-negative integer that reflects the severity level of the alarm.
List<Tag>	tags()	A list of key-value pairs that contain metadata for the alarm model.
CreateAlarmModelRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

alarmModelName

public final String alarmModelName()

A unique name that helps you identify the alarm model. You can't change this name after you create the alarm model.

Returns:

A unique name that helps you identify the alarm model. You can't change this name after you create the alarm model.

alarmModelDescription

public final String alarmModelDescription()

A description that tells you what the alarm model detects.

Returns:

A description that tells you what the alarm model detects.

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.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

A list of key-value pairs that contain metadata for the alarm model. The tags help you manage the alarm model. For more information, see Tagging your AWS IoT Events resources in the AWS IoT Events Developer Guide.

You can create up to 50 tags for one alarm model.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

A list of key-value pairs that contain metadata for the alarm model. The tags help you manage the alarm model. For more information, see Tagging your AWS IoT Events resources in the AWS IoT Events Developer Guide.

You can create up to 50 tags for one alarm model.

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 CreateAlarmModelRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateAlarmModelRequest.Builder,CreateAlarmModelRequest>

Specified by:

toBuilder in class IotEventsRequest

builder

public static CreateAlarmModelRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo