Interface ListChannelMessagesRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,ChimeSdkMessagingRequest.Builder,CopyableBuilder<ListChannelMessagesRequest.Builder,ListChannelMessagesRequest>,SdkBuilder<ListChannelMessagesRequest.Builder,ListChannelMessagesRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- ListChannelMessagesRequest
public static interface ListChannelMessagesRequest.Builder extends ChimeSdkMessagingRequest.Builder, SdkPojo, CopyableBuilder<ListChannelMessagesRequest.Builder,ListChannelMessagesRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ListChannelMessagesRequest.BuilderchannelArn(String channelArn)The ARN of the channel.ListChannelMessagesRequest.BuilderchimeBearer(String chimeBearer)The ARN of theAppInstanceUserorAppInstanceBotthat makes the API call.ListChannelMessagesRequest.BuildermaxResults(Integer maxResults)The maximum number of messages that you want returned.ListChannelMessagesRequest.BuildernextToken(String nextToken)The token passed by previous API calls until all requested messages are returned.ListChannelMessagesRequest.BuildernotAfter(Instant notAfter)The final or ending time stamp for your requested messages.ListChannelMessagesRequest.BuildernotBefore(Instant notBefore)The initial or starting time stamp for your requested messages.ListChannelMessagesRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)ListChannelMessagesRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)ListChannelMessagesRequest.BuildersortOrder(String sortOrder)The order in which you want messages sorted.ListChannelMessagesRequest.BuildersortOrder(SortOrder sortOrder)The order in which you want messages sorted.ListChannelMessagesRequest.BuildersubChannelId(String subChannelId)The ID of the SubChannel in the request.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.services.chimesdkmessaging.model.ChimeSdkMessagingRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
channelArn
ListChannelMessagesRequest.Builder channelArn(String channelArn)
The ARN of the channel.
- Parameters:
channelArn- The ARN of the channel.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sortOrder
ListChannelMessagesRequest.Builder sortOrder(String sortOrder)
The order in which you want messages sorted. Default is Descending, based on time created.
-
sortOrder
ListChannelMessagesRequest.Builder sortOrder(SortOrder sortOrder)
The order in which you want messages sorted. Default is Descending, based on time created.
-
notBefore
ListChannelMessagesRequest.Builder notBefore(Instant notBefore)
The initial or starting time stamp for your requested messages.
- Parameters:
notBefore- The initial or starting time stamp for your requested messages.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
notAfter
ListChannelMessagesRequest.Builder notAfter(Instant notAfter)
The final or ending time stamp for your requested messages.
- Parameters:
notAfter- The final or ending time stamp for your requested messages.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
ListChannelMessagesRequest.Builder maxResults(Integer maxResults)
The maximum number of messages that you want returned.
- Parameters:
maxResults- The maximum number of messages that you want returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
ListChannelMessagesRequest.Builder nextToken(String nextToken)
The token passed by previous API calls until all requested messages are returned.
- Parameters:
nextToken- The token passed by previous API calls until all requested messages are returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
chimeBearer
ListChannelMessagesRequest.Builder chimeBearer(String chimeBearer)
The ARN of the
AppInstanceUserorAppInstanceBotthat makes the API call.- Parameters:
chimeBearer- The ARN of theAppInstanceUserorAppInstanceBotthat makes the API call.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subChannelId
ListChannelMessagesRequest.Builder subChannelId(String subChannelId)
The ID of the SubChannel in the request.
Only required when listing the messages in a SubChannel that the user belongs to.
- Parameters:
subChannelId- The ID of the SubChannel in the request.Only required when listing the messages in a SubChannel that the user belongs to.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ListChannelMessagesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
ListChannelMessagesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-