Class GetRetainedMessageResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.iotdataplane.model.IotDataPlaneResponse
software.amazon.awssdk.services.iotdataplane.model.GetRetainedMessageResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetRetainedMessageResponse.Builder,GetRetainedMessageResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetRetainedMessageResponse extends IotDataPlaneResponse implements ToCopyableBuilder<GetRetainedMessageResponse.Builder,GetRetainedMessageResponse>

The output from the GetRetainedMessage operation.

  • Method Details

    • topic

      public final String topic()

      The topic name to which the retained message was published.

      Returns:
      The topic name to which the retained message was published.

    • payload

      public final SdkBytes payload()

      The Base64-encoded message payload of the retained message body.

      Returns:
      The Base64-encoded message payload of the retained message body.

    • qos

      public final Integer qos()

      The quality of service (QoS) level used to publish the retained message.

      Returns:
      The quality of service (QoS) level used to publish the retained message.

    • lastModifiedTime

      public final Long lastModifiedTime()

      The Epoch date and time, in milliseconds, when the retained message was stored by IoT.

      Returns:
      The Epoch date and time, in milliseconds, when the retained message was stored by IoT.

    • userProperties

      public final SdkBytes userProperties()

      A base64-encoded JSON string that includes an array of JSON objects, or null if the retained message doesn't include any user properties.

      The following example userProperties parameter is a JSON string that represents two user properties. Note that it will be base64-encoded:

      [{"deviceName": "alpha"}, {"deviceCnt": "45"}]

      Returns:
      A base64-encoded JSON string that includes an array of JSON objects, or null if the retained message doesn't include any user properties.

      The following example userProperties parameter is a JSON string that represents two user properties. Note that it will be base64-encoded:

      [{"deviceName": "alpha"}, {"deviceCnt": "45"}]

    • toBuilder

      public GetRetainedMessageResponse.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<GetRetainedMessageResponse.Builder,GetRetainedMessageResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetRetainedMessageResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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