Interface CreateChannelMembershipRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,ChimeSdkMessagingRequest.Builder
,CopyableBuilder<CreateChannelMembershipRequest.Builder,
,CreateChannelMembershipRequest> SdkBuilder<CreateChannelMembershipRequest.Builder,
,CreateChannelMembershipRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateChannelMembershipRequest
-
Method Summary
Modifier and TypeMethodDescriptionchannelArn
(String channelArn) The ARN of the channel to which you're adding users.chimeBearer
(String chimeBearer) The ARN of theAppInstanceUser
orAppInstanceBot
that makes the API call.TheAppInstanceUserArn
of the member 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.
- Parameters:
channelArn
- The ARN of the channel to which you're adding users.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
memberArn
The
AppInstanceUserArn
of the member you want to add to the channel.- Parameters:
memberArn
- TheAppInstanceUserArn
of the member you want to add to the channel.- 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:
-
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
CreateChannelMembershipRequest.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
CreateChannelMembershipRequest.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.
-