software.amazon.awssdk.services.iotdataplane.model

Class ListRetainedMessagesResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListRetainedMessagesResponse.Builder,ListRetainedMessagesResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class ListRetainedMessagesResponse
extends IotDataPlaneResponse
implements ToCopyableBuilder<ListRetainedMessagesResponse.Builder,ListRetainedMessagesResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListRetainedMessagesResponse.Builder

Method Summary

Modifier and Type	Method and Description
static ListRetainedMessagesResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRetainedTopics() For responses, this returns true if the service returned a value for the RetainedTopics property.
String	nextToken() The token for the next set of results, or null if there are no additional results.
List<RetainedMessageSummary>	retainedTopics() A summary list the account's retained messages.
List<SdkField<?>>	sdkFields()
static Class<? extends ListRetainedMessagesResponse.Builder>	serializableBuilderClass()
ListRetainedMessagesResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

hasRetainedTopics

public final boolean hasRetainedTopics()

For responses, this returns true if the service returned a value for the RetainedTopics property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

retainedTopics

public final List<RetainedMessageSummary> retainedTopics()

A summary list the account's retained messages. The information returned doesn't include the message payloads of the retained messages.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRetainedTopics() method.

Returns:

A summary list the account's retained messages. The information returned doesn't include the message payloads of the retained messages.

nextToken

public final String nextToken()

The token for the next set of results, or null if there are no additional results.

Returns:

The token for the next set of results, or null if there are no additional results.

toBuilder

public ListRetainedMessagesResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListRetainedMessagesResponse.Builder,ListRetainedMessagesResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static ListRetainedMessagesResponse.Builder builder()

serializableBuilderClass

public static Class<? extends ListRetainedMessagesResponse.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