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

Class Payload

java.lang.Object

software.amazon.awssdk.services.iotevents.model.Payload

All Implemented Interfaces:

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

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

Information needed to configure the payload.

By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use contentExpression.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Payload.Builder

Method Summary

Modifier and Type	Method	Description
static Payload.Builder	builder()
String	contentExpression()	The content of the payload.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends Payload.Builder>	serializableBuilderClass()
Payload.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
PayloadType	type()	The value of the payload type can be either STRING or JSON.
String	typeAsString()	The value of the payload type can be either STRING or JSON.

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

contentExpression

public final String contentExpression()

The content of the payload. You can use a string expression that includes quoted strings ( '<string>'), variables ($variable.<variable-name>), input values ( $input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.

Returns:

The content of the payload. You can use a string expression that includes quoted strings ( '<string>'), variables ($variable.<variable-name>), input values ( $input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.

type

public final PayloadType type()

The value of the payload type can be either STRING or JSON.

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

Returns:

The value of the payload type can be either STRING or JSON.

See Also:

PayloadType

typeAsString

public final String typeAsString()

The value of the payload type can be either STRING or JSON.

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

Returns:

The value of the payload type can be either STRING or JSON.

See Also:

PayloadType

toBuilder

public Payload.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Payload.Builder,Payload>

builder

public static Payload.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo