com.amazonaws.services.iotevents.model

Class Payload

java.lang.Object

com.amazonaws.services.iotevents.model.Payload

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Payload()

Method Summary

Modifier and Type	Method and Description
Payload	clone()
boolean	equals(Object obj)
String	getContentExpression() The content of the payload.
String	getType() The value of the payload type can be either STRING or JSON.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setContentExpression(String contentExpression) The content of the payload.
void	setType(String type) The value of the payload type can be either STRING or JSON.
String	toString() Returns a string representation of this object.
Payload	withContentExpression(String contentExpression) The content of the payload.
Payload	withType(PayloadType type) The value of the payload type can be either STRING or JSON.
Payload	withType(String type) The value of the payload type can be either STRING or JSON.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Payload

public Payload()

Method Detail

setContentExpression

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

Parameters:

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.

getContentExpression

public String getContentExpression()

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.

withContentExpression

public Payload withContentExpression(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.

Parameters:

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:

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

setType

public void setType(String type)

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

Parameters:

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

See Also:

PayloadType

getType

public String getType()

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

Returns:

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

See Also:

PayloadType

withType

public Payload withType(String type)

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

Parameters:

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

Returns:

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

See Also:

PayloadType

withType

public Payload withType(PayloadType type)

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

Parameters:

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

Returns:

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

See Also:

PayloadType

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 Payload clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.