com.amazonaws.services.iot.model

Class SnsAction

java.lang.Object

com.amazonaws.services.iot.model.SnsAction

All Implemented Interfaces:

Serializable

public class SnsAction
extends Object
implements Serializable

Describes an action to publish to an Amazon SNS topic.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SnsAction()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getMessageFormat() The message format of the message to publish.
String	getRoleArn() The ARN of the IAM role that grants access.
String	getTargetArn() The ARN of the SNS topic.
int	hashCode()
void	setMessageFormat(MessageFormat messageFormat) The message format of the message to publish.
void	setMessageFormat(String messageFormat) The message format of the message to publish.
void	setRoleArn(String roleArn) The ARN of the IAM role that grants access.
void	setTargetArn(String targetArn) The ARN of the SNS topic.
String	toString() Returns a string representation of this object; useful for testing and debugging.
SnsAction	withMessageFormat(MessageFormat messageFormat) The message format of the message to publish.
SnsAction	withMessageFormat(String messageFormat) The message format of the message to publish.
SnsAction	withRoleArn(String roleArn) The ARN of the IAM role that grants access.
SnsAction	withTargetArn(String targetArn) The ARN of the SNS topic.

Methods inherited from class java.lang.Object

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

Constructor Detail

SnsAction

public SnsAction()

Method Detail

getTargetArn

public String getTargetArn()

The ARN of the SNS topic.

Returns:

The ARN of the SNS topic.

setTargetArn

public void setTargetArn(String targetArn)

The ARN of the SNS topic.

Parameters:

targetArn - The ARN of the SNS topic.

withTargetArn

public SnsAction withTargetArn(String targetArn)

The ARN of the SNS topic.

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

Parameters:

targetArn - The ARN of the SNS topic.

Returns:

A reference to this updated object so that method calls can be chained together.

getRoleArn

public String getRoleArn()

The ARN of the IAM role that grants access.

Returns:

The ARN of the IAM role that grants access.

setRoleArn

public void setRoleArn(String roleArn)

The ARN of the IAM role that grants access.

Parameters:

roleArn - The ARN of the IAM role that grants access.

withRoleArn

public SnsAction withRoleArn(String roleArn)

The ARN of the IAM role that grants access.

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

Parameters:

roleArn - The ARN of the IAM role that grants access.

Returns:

A reference to this updated object so that method calls can be chained together.

getMessageFormat

public String getMessageFormat()

The message format of the message to publish. Optional. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see refer to their official documentation.

Constraints:
Allowed Values: RAW, JSON

Returns:

The message format of the message to publish. Optional. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see refer to their official documentation.

See Also:

MessageFormat

setMessageFormat

public void setMessageFormat(String messageFormat)

The message format of the message to publish. Optional. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see refer to their official documentation.

Constraints:
Allowed Values: RAW, JSON

Parameters:

messageFormat - The message format of the message to publish. Optional. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see refer to their official documentation.

See Also:

MessageFormat

withMessageFormat

public SnsAction withMessageFormat(String messageFormat)

The message format of the message to publish. Optional. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see refer to their official documentation.

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

Constraints:
Allowed Values: RAW, JSON

Parameters:

messageFormat - The message format of the message to publish. Optional. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see refer to their official documentation.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

MessageFormat

setMessageFormat

public void setMessageFormat(MessageFormat messageFormat)

The message format of the message to publish. Optional. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see refer to their official documentation.

Constraints:
Allowed Values: RAW, JSON

Parameters:

messageFormat - The message format of the message to publish. Optional. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see refer to their official documentation.

See Also:

MessageFormat

withMessageFormat

public SnsAction withMessageFormat(MessageFormat messageFormat)

The message format of the message to publish. Optional. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see refer to their official documentation.

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

Constraints:
Allowed Values: RAW, JSON

Parameters:

messageFormat - The message format of the message to publish. Optional. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see refer to their official documentation.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

MessageFormat

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object