Class ListChannelMessagesRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListChannelMessagesRequest.Builder,
ListChannelMessagesRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The ARN of the channel.final String
The ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final Integer
The maximum number of messages that you want returned.final String
The token passed by previous API calls until all requested messages are returned.final Instant
notAfter()
The final or ending time stamp for your requested messages.final Instant
The initial or starting time stamp for your requested messages.static Class
<? extends ListChannelMessagesRequest.Builder> final SortOrder
The order in which you want messages sorted.final String
The order in which you want messages sorted.final String
The ID of the SubChannel in the request.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
channelArn
The ARN of the channel.
- Returns:
- The ARN of the channel.
-
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 returnSortOrder.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortOrderAsString()
.- Returns:
- The order in which you want messages sorted. Default is Descending, based on time created.
- See Also:
-
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 returnSortOrder.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsortOrderAsString()
.- Returns:
- The order in which you want messages sorted. Default is Descending, based on time created.
- See Also:
-
notBefore
The initial or starting time stamp for your requested messages.
- Returns:
- The initial or starting time stamp for your requested messages.
-
notAfter
The final or ending time stamp for your requested messages.
- Returns:
- The final or ending time stamp for your requested messages.
-
maxResults
The maximum number of messages that you want returned.
- Returns:
- The maximum number of messages that you want returned.
-
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
The ARN of the
AppInstanceUser
orAppInstanceBot
that makes the API call.- Returns:
- The ARN of the
AppInstanceUser
orAppInstanceBot
that makes the API call.
-
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ListChannelMessagesRequest.Builder,
ListChannelMessagesRequest> - Specified by:
toBuilder
in classChimeSdkMessagingRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-