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

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 Details

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

      Parameters:
      sortOrder - The order in which you want messages sorted. Default is Descending, based on time created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sortOrder

      ListChannelMessagesRequest.Builder sortOrder(SortOrder sortOrder)

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

      Parameters:
      sortOrder - The order in which you want messages sorted. Default is Descending, based on time created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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 AppInstanceUser or AppInstanceBot that makes the API call.

      Parameters:
      chimeBearer - The ARN of the AppInstanceUser or AppInstanceBot that 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)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ListChannelMessagesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.