Package software.amazon.awssdk.services.iotdataplane.model

Interface GetRetainedMessageResponse.Builder

    • Method Detail

      • topic

        GetRetainedMessageResponse.Builder topic​(String topic)

        The topic name to which the retained message was published.

        Parameters:
        topic - The topic name to which the retained message was published.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • payload

        GetRetainedMessageResponse.Builder payload​(SdkBytes payload)

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

        Parameters:
        payload - The Base64-encoded message payload of the retained message body.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • qos

        GetRetainedMessageResponse.Builder qos​(Integer qos)

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

        Parameters:
        qos - The quality of service (QoS) level used to publish the retained message.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lastModifiedTime

        GetRetainedMessageResponse.Builder lastModifiedTime​(Long lastModifiedTime)

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

        Parameters:
        lastModifiedTime - The Epoch date and time, in milliseconds, when the retained message was stored by IoT.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • userProperties

        GetRetainedMessageResponse.Builder userProperties​(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"}]

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.