Package software.amazon.awssdk.services.chimesdkmessaging.model

Class ListChannelMessagesResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.chimesdkmessaging.model.ChimeSdkMessagingResponse

software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMessagesResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListChannelMessagesResponse.Builder,ListChannelMessagesResponse>

@Generated("software.amazon.awssdk:codegen")
public final class ListChannelMessagesResponse
extends ChimeSdkMessagingResponse
implements ToCopyableBuilder<ListChannelMessagesResponse.Builder,ListChannelMessagesResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListChannelMessagesResponse.Builder

Method Summary

Modifier and Type	Method	Description
static ListChannelMessagesResponse.Builder	builder()
String	channelArn()	The ARN of the channel containing the requested messages.
List<ChannelMessageSummary>	channelMessages()	The information about, and content of, each requested message.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasChannelMessages()	For responses, this returns true if the service returned a value for the ChannelMessages property.
int	hashCode()
String	nextToken()	The token passed by previous API calls until all requested messages are returned.
List<SdkField<?>>	sdkFields()
static Class<? extends ListChannelMessagesResponse.Builder>	serializableBuilderClass()
String	subChannelId()	The ID of the SubChannel in the response.
ListChannelMessagesResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.chimesdkmessaging.model.ChimeSdkMessagingResponse

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

channelArn

public final String channelArn()

The ARN of the channel containing the requested messages.

Returns:

The ARN of the channel containing the requested messages.

nextToken

public final String nextToken()

The token passed by previous API calls until all requested messages are returned.

Returns:

The token passed by previous API calls until all requested messages are returned.

hasChannelMessages

public final boolean hasChannelMessages()

For responses, this returns true if the service returned a value for the ChannelMessages 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.

channelMessages

public final List<ChannelMessageSummary> channelMessages()

The information about, and content of, each requested message.

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 hasChannelMessages() method.

Returns:

The information about, and content of, each requested message.

subChannelId

public final String subChannelId()

The ID of the SubChannel in the response.

Returns:

The ID of the SubChannel in the response.

toBuilder

public ListChannelMessagesResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListChannelMessagesResponse.Builder,ListChannelMessagesResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static ListChannelMessagesResponse.Builder builder()

serializableBuilderClass

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