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

Class ListChannelMessagesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.chimesdkmessaging.model.ChimeSdkMessagingRequest

software.amazon.awssdk.services.chimesdkmessaging.model.ListChannelMessagesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListChannelMessagesRequest.Builder,ListChannelMessagesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListChannelMessagesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListChannelMessagesRequest.Builder	builder()
String	channelArn()	The ARN of the channel.
String	chimeBearer()	The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	The maximum number of messages that you want returned.
String	nextToken()	The token passed by previous API calls until all requested messages are returned.
Instant	notAfter()	The final or ending time stamp for your requested messages.
Instant	notBefore()	The initial or starting time stamp for your requested messages.
List<SdkField<?>>	sdkFields()
static Class<? extends ListChannelMessagesRequest.Builder>	serializableBuilderClass()
SortOrder	sortOrder()	The order in which you want messages sorted.
String	sortOrderAsString()	The order in which you want messages sorted.
String	subChannelId()	The ID of the SubChannel in the request.
ListChannelMessagesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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.

Returns:

The ARN of the channel.

sortOrder

public final SortOrder sortOrder()

The order in which you want messages sorted. Default is Descending, based on time created.

If the service returns an enum value that is not available in the current SDK version, sortOrder will return SortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().

Returns:

The order in which you want messages sorted. Default is Descending, based on time created.

See Also:

SortOrder

sortOrderAsString

public final String sortOrderAsString()

The order in which you want messages sorted. Default is Descending, based on time created.

If the service returns an enum value that is not available in the current SDK version, sortOrder will return SortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().

Returns:

The order in which you want messages sorted. Default is Descending, based on time created.

See Also:

SortOrder

notBefore

public final Instant notBefore()

The initial or starting time stamp for your requested messages.

Returns:

The initial or starting time stamp for your requested messages.

notAfter

public final Instant notAfter()

The final or ending time stamp for your requested messages.

Returns:

The final or ending time stamp for your requested messages.

maxResults

public final Integer maxResults()

The maximum number of messages that you want returned.

Returns:

The maximum number of messages that you want returned.

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.

chimeBearer

public final String chimeBearer()

The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

Returns:

The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

subChannelId

public final String subChannelId()

The ID of the SubChannel in the request.

Only required when listing the messages in a SubChannel that the user belongs to.

Returns:

The ID of the SubChannel in the request.

Only required when listing the messages in a SubChannel that the user belongs to.

toBuilder

public ListChannelMessagesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListChannelMessagesRequest.Builder,ListChannelMessagesRequest>

Specified by:

toBuilder in class ChimeSdkMessagingRequest

builder

public static ListChannelMessagesRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo