Interface BatchCreateChannelMembershipRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,ChimeSdkMessagingRequest.Builder
,CopyableBuilder<BatchCreateChannelMembershipRequest.Builder,
,BatchCreateChannelMembershipRequest> SdkBuilder<BatchCreateChannelMembershipRequest.Builder,
,BatchCreateChannelMembershipRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
BatchCreateChannelMembershipRequest
-
Method Summary
Modifier and TypeMethodDescriptionchannelArn
(String channelArn) The ARN of the channel to which you're adding users or bots.chimeBearer
(String chimeBearer) The ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call.memberArns
(String... memberArns) The ARNs of the members you want to add to the channel.memberArns
(Collection<String> memberArns) The ARNs of the members you want to add to the channel.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.subChannelId
(String subChannelId) The ID of the SubChannel in the request.The membership type of a user,DEFAULT
orHIDDEN
.type
(ChannelMembershipType type) The membership type of a user,DEFAULT
orHIDDEN
.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 Details
-
channelArn
The ARN of the channel to which you're adding users or bots.
- Parameters:
channelArn
- The ARN of the channel to which you're adding users or bots.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
type
The membership type of a user,
DEFAULT
orHIDDEN
. Default members are always returned as part ofListChannelMemberships
. Hidden members are only returned if the type filter inListChannelMemberships
equalsHIDDEN
. Otherwise hidden members are not returned. This is only supported by moderators.- Parameters:
type
- The membership type of a user,DEFAULT
orHIDDEN
. Default members are always returned as part ofListChannelMemberships
. Hidden members are only returned if the type filter inListChannelMemberships
equalsHIDDEN
. Otherwise hidden members are not returned. This is only supported by moderators.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
type
The membership type of a user,
DEFAULT
orHIDDEN
. Default members are always returned as part ofListChannelMemberships
. Hidden members are only returned if the type filter inListChannelMemberships
equalsHIDDEN
. Otherwise hidden members are not returned. This is only supported by moderators.- Parameters:
type
- The membership type of a user,DEFAULT
orHIDDEN
. Default members are always returned as part ofListChannelMemberships
. Hidden members are only returned if the type filter inListChannelMemberships
equalsHIDDEN
. Otherwise hidden members are not returned. This is only supported by moderators.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
memberArns
The ARNs of the members you want to add to the channel. Only
AppInstanceUsers
andAppInstanceBots
can be added as a channel member.- Parameters:
memberArns
- The ARNs of the members you want to add to the channel. OnlyAppInstanceUsers
andAppInstanceBots
can be added as a channel member.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
memberArns
The ARNs of the members you want to add to the channel. Only
AppInstanceUsers
andAppInstanceBots
can be added as a channel member.- Parameters:
memberArns
- The ARNs of the members you want to add to the channel. OnlyAppInstanceUsers
andAppInstanceBots
can be added as a channel member.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
chimeBearer
The ARN of the
AppInstanceUser
orAppInstanceBot
that makes the API call.- Parameters:
chimeBearer
- The ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
subChannelId
The ID of the SubChannel in the request.
Only required when creating membership in a SubChannel for a moderator in an elastic channel.
- Parameters:
subChannelId
- The ID of the SubChannel in the request.Only required when creating membership in a SubChannel for a moderator in an elastic channel.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
BatchCreateChannelMembershipRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
BatchCreateChannelMembershipRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-