Interface ListChannelsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, ChimeSdkMessagingRequest.Builder, CopyableBuilder<ListChannelsRequest.Builder,ListChannelsRequest>, SdkBuilder<ListChannelsRequest.Builder,ListChannelsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ListChannelsRequest
public static interface ListChannelsRequest.Builder extends ChimeSdkMessagingRequest.Builder, SdkPojo, CopyableBuilder<ListChannelsRequest.Builder,ListChannelsRequest>

  • Method Details

    • appInstanceArn

      ListChannelsRequest.Builder appInstanceArn(String appInstanceArn)

      The ARN of the AppInstance.

      Parameters:
      appInstanceArn - The ARN of the AppInstance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • privacy

      ListChannelsRequest.Builder privacy(String privacy)

      The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.

      Parameters:
      privacy - The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • privacy

      ListChannelsRequest.Builder privacy(ChannelPrivacy privacy)

      The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.

      Parameters:
      privacy - The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxResults

      ListChannelsRequest.Builder maxResults(Integer maxResults)

      The maximum number of channels that you want to return.

      Parameters:
      maxResults - The maximum number of channels that you want to return.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      ListChannelsRequest.Builder nextToken(String nextToken)

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

      Parameters:
      nextToken - The token passed by previous API calls until all requested channels are returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • chimeBearer

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

    • overrideConfiguration

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

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