com.amazonaws.services.iotevents.model

Class CreateAlarmModelRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iotevents.model.CreateAlarmModelRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateAlarmModelRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateAlarmModelRequest()

Method Summary

Modifier and Type	Method and Description
CreateAlarmModelRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
AlarmCapabilities	getAlarmCapabilities() Contains the configuration information of alarm state changes.
AlarmEventActions	getAlarmEventActions() Contains information about one or more alarm actions.
String	getAlarmModelDescription() A description that tells you what the alarm model detects.
String	getAlarmModelName() A unique name that helps you identify the alarm model.
AlarmNotification	getAlarmNotification() Contains information about one or more notification actions.
AlarmRule	getAlarmRule() Defines when your alarm is invoked.
String	getKey() An input attribute used as a key to create an alarm.
String	getRoleArn() The ARN of the IAM role that allows the alarm to perform actions and access AWS resources.
Integer	getSeverity() A non-negative integer that reflects the severity level of the alarm.
List<Tag>	getTags() A list of key-value pairs that contain metadata for the alarm model.
int	hashCode()
void	setAlarmCapabilities(AlarmCapabilities alarmCapabilities) Contains the configuration information of alarm state changes.
void	setAlarmEventActions(AlarmEventActions alarmEventActions) Contains information about one or more alarm actions.
void	setAlarmModelDescription(String alarmModelDescription) A description that tells you what the alarm model detects.
void	setAlarmModelName(String alarmModelName) A unique name that helps you identify the alarm model.
void	setAlarmNotification(AlarmNotification alarmNotification) Contains information about one or more notification actions.
void	setAlarmRule(AlarmRule alarmRule) Defines when your alarm is invoked.
void	setKey(String key) An input attribute used as a key to create an alarm.
void	setRoleArn(String roleArn) The ARN of the IAM role that allows the alarm to perform actions and access AWS resources.
void	setSeverity(Integer severity) A non-negative integer that reflects the severity level of the alarm.
void	setTags(Collection<Tag> tags) A list of key-value pairs that contain metadata for the alarm model.
String	toString() Returns a string representation of this object.
CreateAlarmModelRequest	withAlarmCapabilities(AlarmCapabilities alarmCapabilities) Contains the configuration information of alarm state changes.
CreateAlarmModelRequest	withAlarmEventActions(AlarmEventActions alarmEventActions) Contains information about one or more alarm actions.
CreateAlarmModelRequest	withAlarmModelDescription(String alarmModelDescription) A description that tells you what the alarm model detects.
CreateAlarmModelRequest	withAlarmModelName(String alarmModelName) A unique name that helps you identify the alarm model.
CreateAlarmModelRequest	withAlarmNotification(AlarmNotification alarmNotification) Contains information about one or more notification actions.
CreateAlarmModelRequest	withAlarmRule(AlarmRule alarmRule) Defines when your alarm is invoked.
CreateAlarmModelRequest	withKey(String key) An input attribute used as a key to create an alarm.
CreateAlarmModelRequest	withRoleArn(String roleArn) The ARN of the IAM role that allows the alarm to perform actions and access AWS resources.
CreateAlarmModelRequest	withSeverity(Integer severity) A non-negative integer that reflects the severity level of the alarm.
CreateAlarmModelRequest	withTags(Collection<Tag> tags) A list of key-value pairs that contain metadata for the alarm model.
CreateAlarmModelRequest	withTags(Tag... tags) A list of key-value pairs that contain metadata for the alarm model.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateAlarmModelRequest

public CreateAlarmModelRequest()

Method Detail

setAlarmModelName

public void setAlarmModelName(String alarmModelName)

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

Parameters:

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

getAlarmModelName

public String getAlarmModelName()

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.

withAlarmModelName

public CreateAlarmModelRequest withAlarmModelName(String alarmModelName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setAlarmModelDescription

public void setAlarmModelDescription(String alarmModelDescription)

A description that tells you what the alarm model detects.

Parameters:

alarmModelDescription - A description that tells you what the alarm model detects.

getAlarmModelDescription

public String getAlarmModelDescription()

A description that tells you what the alarm model detects.

Returns:

A description that tells you what the alarm model detects.

withAlarmModelDescription

public CreateAlarmModelRequest withAlarmModelDescription(String alarmModelDescription)

A description that tells you what the alarm model detects.

Parameters:

alarmModelDescription - A description that tells you what the alarm model detects.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRoleArn

public void setRoleArn(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.

Parameters:

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.

getRoleArn

public String getRoleArn()

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.

withRoleArn

public CreateAlarmModelRequest withRoleArn(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

getTags

public List<Tag> getTags()

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.

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.

setTags

public void setTags(Collection<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.

Parameters:

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.

withTags

public CreateAlarmModelRequest withTags(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.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public CreateAlarmModelRequest withTags(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setKey

public void setKey(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.

Parameters:

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

getKey

public String getKey()

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.

withKey

public CreateAlarmModelRequest withKey(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setSeverity

public void setSeverity(Integer severity)

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

Parameters:

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

getSeverity

public Integer getSeverity()

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.

withSeverity

public CreateAlarmModelRequest withSeverity(Integer severity)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setAlarmRule

public void setAlarmRule(AlarmRule alarmRule)

Defines when your alarm is invoked.

Parameters:

alarmRule - Defines when your alarm is invoked.

getAlarmRule

public AlarmRule getAlarmRule()

Defines when your alarm is invoked.

Returns:

Defines when your alarm is invoked.

withAlarmRule

public CreateAlarmModelRequest withAlarmRule(AlarmRule alarmRule)

Defines when your alarm is invoked.

Parameters:

alarmRule - Defines when your alarm is invoked.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAlarmNotification

public void setAlarmNotification(AlarmNotification alarmNotification)

Contains information about one or more notification actions.

Parameters:

alarmNotification - Contains information about one or more notification actions.

getAlarmNotification

public AlarmNotification getAlarmNotification()

Contains information about one or more notification actions.

Returns:

Contains information about one or more notification actions.

withAlarmNotification

public CreateAlarmModelRequest withAlarmNotification(AlarmNotification alarmNotification)

Contains information about one or more notification actions.

Parameters:

alarmNotification - Contains information about one or more notification actions.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAlarmEventActions

public void setAlarmEventActions(AlarmEventActions alarmEventActions)

Contains information about one or more alarm actions.

Parameters:

alarmEventActions - Contains information about one or more alarm actions.

getAlarmEventActions

public AlarmEventActions getAlarmEventActions()

Contains information about one or more alarm actions.

Returns:

Contains information about one or more alarm actions.

withAlarmEventActions

public CreateAlarmModelRequest withAlarmEventActions(AlarmEventActions alarmEventActions)

Contains information about one or more alarm actions.

Parameters:

alarmEventActions - Contains information about one or more alarm actions.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAlarmCapabilities

public void setAlarmCapabilities(AlarmCapabilities alarmCapabilities)

Contains the configuration information of alarm state changes.

Parameters:

alarmCapabilities - Contains the configuration information of alarm state changes.

getAlarmCapabilities

public AlarmCapabilities getAlarmCapabilities()

Contains the configuration information of alarm state changes.

Returns:

Contains the configuration information of alarm state changes.

withAlarmCapabilities

public CreateAlarmModelRequest withAlarmCapabilities(AlarmCapabilities alarmCapabilities)

Contains the configuration information of alarm state changes.

Parameters:

alarmCapabilities - Contains the configuration information of alarm state changes.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateAlarmModelRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()