Interface CreateChannelRequest.Builder

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

  • Method Details

    • appInstanceArn

      CreateChannelRequest.Builder appInstanceArn(String appInstanceArn)

      The ARN of the channel request.

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

    • name

      CreateChannelRequest.Builder name(String name)

      The name of the channel.

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

    • mode

      CreateChannelRequest.Builder mode(String mode)

      The channel mode: UNRESTRICTED or RESTRICTED. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.

      Parameters:
      mode - The channel mode: UNRESTRICTED or RESTRICTED. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • mode

      CreateChannelRequest.Builder mode(ChannelMode mode)

      The channel mode: UNRESTRICTED or RESTRICTED. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.

      Parameters:
      mode - The channel mode: UNRESTRICTED or RESTRICTED. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • privacy

      CreateChannelRequest.Builder privacy(String privacy)

      The channel's privacy level: PUBLIC or PRIVATE. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the AppInstance.

      Parameters:
      privacy - The channel's privacy level: PUBLIC or PRIVATE. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the AppInstance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • privacy

      CreateChannelRequest.Builder privacy(ChannelPrivacy privacy)

      The channel's privacy level: PUBLIC or PRIVATE. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the AppInstance.

      Parameters:
      privacy - The channel's privacy level: PUBLIC or PRIVATE. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the AppInstance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • metadata

      CreateChannelRequest.Builder metadata(String metadata)

      The metadata of the creation request. Limited to 1KB and UTF-8.

      Parameters:
      metadata - The metadata of the creation request. Limited to 1KB and UTF-8.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientRequestToken

      CreateChannelRequest.Builder clientRequestToken(String clientRequestToken)

      The client token for the request. An Idempotency token.

      Parameters:
      clientRequestToken - The client token for the request. An Idempotency token.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateChannelRequest.Builder tags(Collection<Tag> tags)

      The tags for the creation request.

      Parameters:
      tags - The tags for the creation request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateChannelRequest.Builder tags(Tag... tags)

      The tags for the creation request.

      Parameters:
      tags - The tags for the creation request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateChannelRequest.Builder tags(Consumer<Tag.Builder>... tags)

      The tags for the creation request.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • chimeBearer

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

    • channelId

      CreateChannelRequest.Builder channelId(String channelId)

      The ID of the channel in the request.

      Parameters:
      channelId - The ID of the channel in the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • memberArns

      CreateChannelRequest.Builder memberArns(Collection<String> memberArns)

      The ARNs of the channel members in the request.

      Parameters:
      memberArns - The ARNs of the channel members in the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • memberArns

      CreateChannelRequest.Builder memberArns(String... memberArns)

      The ARNs of the channel members in the request.

      Parameters:
      memberArns - The ARNs of the channel members in the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • moderatorArns

      CreateChannelRequest.Builder moderatorArns(Collection<String> moderatorArns)

      The ARNs of the channel moderators in the request.

      Parameters:
      moderatorArns - The ARNs of the channel moderators in the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • moderatorArns

      CreateChannelRequest.Builder moderatorArns(String... moderatorArns)

      The ARNs of the channel moderators in the request.

      Parameters:
      moderatorArns - The ARNs of the channel moderators in the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • elasticChannelConfiguration

      CreateChannelRequest.Builder elasticChannelConfiguration(ElasticChannelConfiguration elasticChannelConfiguration)

      The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million users, excluding moderators.

      Parameters:
      elasticChannelConfiguration - The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million users, excluding moderators.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • elasticChannelConfiguration

      default CreateChannelRequest.Builder elasticChannelConfiguration(Consumer<ElasticChannelConfiguration.Builder> elasticChannelConfiguration)

      The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million users, excluding moderators.

      This is a convenience method that creates an instance of the ElasticChannelConfiguration.Builder avoiding the need to create one manually via ElasticChannelConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to elasticChannelConfiguration(ElasticChannelConfiguration).

      Parameters:
      elasticChannelConfiguration - a consumer that will call methods on ElasticChannelConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • expirationSettings

      CreateChannelRequest.Builder expirationSettings(ExpirationSettings expirationSettings)

      Settings that control the interval after which the channel is automatically deleted.

      Parameters:
      expirationSettings - Settings that control the interval after which the channel is automatically deleted.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • expirationSettings

      default CreateChannelRequest.Builder expirationSettings(Consumer<ExpirationSettings.Builder> expirationSettings)

      Settings that control the interval after which the channel is automatically deleted.

      This is a convenience method that creates an instance of the ExpirationSettings.Builder avoiding the need to create one manually via ExpirationSettings.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to expirationSettings(ExpirationSettings).

      Parameters:
      expirationSettings - a consumer that will call methods on ExpirationSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

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

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