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:

  • Method Details

    • 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:

    • 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:

    • toBuilder

      public Payload.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<Payload.Builder,Payload>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.