software.amazon.awssdk.services.iot.model

Class SnsAction

java.lang.Object

software.amazon.awssdk.services.iot.model.SnsAction

All Implemented Interfaces:

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

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

Describes an action to publish to an Amazon SNS topic.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SnsAction.Builder

Method Summary

Modifier and Type	Method and Description
static SnsAction.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
MessageFormat	messageFormat() (Optional) The message format of the message to publish.
String	messageFormatAsString() (Optional) The message format of the message to publish.
String	roleArn() The ARN of the IAM role that grants access.
List<SdkField<?>>	sdkFields()
static Class<? extends SnsAction.Builder>	serializableBuilderClass()
String	targetArn() The ARN of the SNS topic.
SnsAction.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

targetArn

public String targetArn()

The ARN of the SNS topic.

Returns:

The ARN of the SNS topic.

roleArn

public String roleArn()

The ARN of the IAM role that grants access.

Returns:

The ARN of the IAM role that grants access.

messageFormat

public MessageFormat messageFormat()

(Optional) The message format of the message to publish. 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 http://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.

If the service returns an enum value that is not available in the current SDK version, messageFormat will return MessageFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageFormatAsString().

Returns:

(Optional) The message format of the message to publish. 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 http://docs.aws. amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.

See Also:

MessageFormat

messageFormatAsString

public String messageFormatAsString()

(Optional) The message format of the message to publish. 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 http://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.

If the service returns an enum value that is not available in the current SDK version, messageFormat will return MessageFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageFormatAsString().

Returns:

(Optional) The message format of the message to publish. 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 http://docs.aws. amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.

See Also:

MessageFormat

toBuilder

public SnsAction.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<SnsAction.Builder,SnsAction>

Returns:

a builder for type T

builder

public static SnsAction.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.