Interface BatchCreateChannelMembershipRequest.Builder

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

  • Method Details

    • channelArn

      BatchCreateChannelMembershipRequest.Builder channelArn(String 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

      BatchCreateChannelMembershipRequest.Builder type(String type)

      The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.

      Parameters:
      type - The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. 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

      BatchCreateChannelMembershipRequest.Builder type(ChannelMembershipType type)

      The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.

      Parameters:
      type - The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. 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

      BatchCreateChannelMembershipRequest.Builder memberArns(Collection<String> memberArns)

      The ARNs of the members you want to add to the channel. Only AppInstanceUsers and AppInstanceBots can be added as a channel member.

      Parameters:
      memberArns - The ARNs of the members you want to add to the channel. Only AppInstanceUsers and AppInstanceBots can be added as a channel member.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • memberArns

      BatchCreateChannelMembershipRequest.Builder memberArns(String... memberArns)

      The ARNs of the members you want to add to the channel. Only AppInstanceUsers and AppInstanceBots can be added as a channel member.

      Parameters:
      memberArns - The ARNs of the members you want to add to the channel. Only AppInstanceUsers and AppInstanceBots can be added as a channel member.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • chimeBearer

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

    • subChannelId

      BatchCreateChannelMembershipRequest.Builder subChannelId(String 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 interface AwsRequest.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 interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.