software.amazon.awssdk.services.chimesdkmessaging.model

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 Summary

Modifier and Type	Method and Description
CreateChannelRequest.Builder	appInstanceArn(String appInstanceArn) The ARN of the channel request.
CreateChannelRequest.Builder	channelId(String channelId) The ID of the channel in the request.
CreateChannelRequest.Builder	chimeBearer(String chimeBearer) The AppInstanceUserArn of the user that makes the API call.
CreateChannelRequest.Builder	clientRequestToken(String clientRequestToken) The client token for the request.
default CreateChannelRequest.Builder	elasticChannelConfiguration(Consumer<ElasticChannelConfiguration.Builder> elasticChannelConfiguration) The attributes required to configure and create an elastic channel.
CreateChannelRequest.Builder	elasticChannelConfiguration(ElasticChannelConfiguration elasticChannelConfiguration) The attributes required to configure and create an elastic channel.
CreateChannelRequest.Builder	memberArns(Collection<String> memberArns) The ARNs of the channel members in the request.
CreateChannelRequest.Builder	memberArns(String... memberArns) The ARNs of the channel members in the request.
CreateChannelRequest.Builder	metadata(String metadata) The metadata of the creation request.
CreateChannelRequest.Builder	mode(ChannelMode mode) The channel mode: UNRESTRICTED or RESTRICTED.
CreateChannelRequest.Builder	mode(String mode) The channel mode: UNRESTRICTED or RESTRICTED.
CreateChannelRequest.Builder	moderatorArns(Collection<String> moderatorArns) The ARNs of the channel moderators in the request.
CreateChannelRequest.Builder	moderatorArns(String... moderatorArns) The ARNs of the channel moderators in the request.
CreateChannelRequest.Builder	name(String name) The name of the channel.
CreateChannelRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateChannelRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateChannelRequest.Builder	privacy(ChannelPrivacy privacy) The channel's privacy level: PUBLIC or PRIVATE.
CreateChannelRequest.Builder	privacy(String privacy) The channel's privacy level: PUBLIC or PRIVATE.
CreateChannelRequest.Builder	tags(Collection<Tag> tags) The tags for the creation request.
CreateChannelRequest.Builder	tags(Consumer<Tag.Builder>... tags) The tags for the creation request.
CreateChannelRequest.Builder	tags(Tag... tags) The tags for the creation request.

Methods inherited from interface software.amazon.awssdk.services.chimesdkmessaging.model.ChimeSdkMessagingRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

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:

ChannelMode, ChannelMode

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:

ChannelMode, ChannelMode

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:

ChannelPrivacy, ChannelPrivacy

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:

ChannelPrivacy, ChannelPrivacy

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

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:

#tags(java.util.Collection)

chimeBearer

CreateChannelRequest.Builder chimeBearer(String chimeBearer)

The AppInstanceUserArn of the user that makes the API call.

Parameters:

chimeBearer - The AppInstanceUserArn of the user 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:

elasticChannelConfiguration(ElasticChannelConfiguration)

overrideConfiguration

CreateChannelRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateChannelRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder