Class SnsAction
- java.lang.Object
-
- com.amazonaws.services.iot.model.SnsAction
-
- All Implemented Interfaces:
Serializable
,Cloneable
public class SnsAction extends Object implements Serializable, Cloneable
Describes an action to publish to an Amazon SNS topic.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description SnsAction()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SnsAction
clone()
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.
-
-
-
Method Detail
-
setTargetArn
public void setTargetArn(String targetArn)
The ARN of the SNS topic.
- Parameters:
targetArn
- The ARN of the SNS topic.
-
getTargetArn
public String getTargetArn()
The ARN of the SNS topic.
- Returns:
- The ARN of the SNS topic.
-
withTargetArn
public SnsAction withTargetArn(String targetArn)
The ARN of the SNS topic.
- Parameters:
targetArn
- The ARN of the SNS topic.- 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 grants access.
- Parameters:
roleArn
- The ARN of the IAM role that grants access.
-
getRoleArn
public String getRoleArn()
The ARN of the IAM role that grants access.
- Returns:
- The ARN of the IAM role that grants access.
-
withRoleArn
public SnsAction withRoleArn(String roleArn)
The ARN of the IAM role that grants access.
- Parameters:
roleArn
- The ARN of the IAM role that grants access.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- 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
-
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.
- 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
-
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.
- 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:
- Returns a reference to this 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.
- 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.
- 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:
- Returns a reference to this 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
-