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

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetRetainedMessageResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetRetainedMessageResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Long	lastModifiedTime()	The Epoch date and time, in milliseconds, when the retained message was stored by IoT.
SdkBytes	payload()	The Base64-encoded message payload of the retained message body.
Integer	qos()	The quality of service (QoS) level used to publish the retained message.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetRetainedMessageResponse.Builder>	serializableBuilderClass()
GetRetainedMessageResponse.Builder	toBuilder()
String	topic()	The topic name to which the retained message was published.
String	toString()	Returns a string representation of this object.
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.

Methods inherited from class software.amazon.awssdk.services.iotdataplane.model.IotDataPlaneResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

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

Specified by:

toBuilder in interface ToCopyableBuilder<GetRetainedMessageResponse.Builder,GetRetainedMessageResponse>

Specified by:

toBuilder in class AwsResponse

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)

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo