Package software.amazon.awssdk.services.chimesdkmessaging.model

Class BatchCreateChannelMembershipRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.chimesdkmessaging.model.ChimeSdkMessagingRequest

software.amazon.awssdk.services.chimesdkmessaging.model.BatchCreateChannelMembershipRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<BatchCreateChannelMembershipRequest.Builder,BatchCreateChannelMembershipRequest>

@Generated("software.amazon.awssdk:codegen")
public final class BatchCreateChannelMembershipRequest
extends ChimeSdkMessagingRequest
implements ToCopyableBuilder<BatchCreateChannelMembershipRequest.Builder,BatchCreateChannelMembershipRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BatchCreateChannelMembershipRequest.Builder

Method Summary

Modifier and Type	Method	Description
static BatchCreateChannelMembershipRequest.Builder	builder()
String	channelArn()	The ARN of the channel to which you're adding users or bots.
String	chimeBearer()	The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMemberArns()	For responses, this returns true if the service returned a value for the MemberArns property.
List<String>	memberArns()	The ARNs of the members you want to add to the channel.
List<SdkField<?>>	sdkFields()
static Class<? extends BatchCreateChannelMembershipRequest.Builder>	serializableBuilderClass()
String	subChannelId()	The ID of the SubChannel in the request.
BatchCreateChannelMembershipRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ChannelMembershipType	type()	The membership type of a user, DEFAULT or HIDDEN.
String	typeAsString()	The membership type of a user, DEFAULT or HIDDEN.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

channelArn

public final String channelArn()

The ARN of the channel to which you're adding users or bots.

Returns:

The ARN of the channel to which you're adding users or bots.

type

public final 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.

If the service returns an enum value that is not available in the current SDK version, type will return ChannelMembershipType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

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.

See Also:

ChannelMembershipType

typeAsString

public final String typeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, type will return ChannelMembershipType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

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.

See Also:

ChannelMembershipType

hasMemberArns

public final boolean hasMemberArns()

For responses, this returns true if the service returned a value for the MemberArns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

memberArns

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMemberArns() method.

Returns:

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

chimeBearer

public final String chimeBearer()

The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

Returns:

The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

subChannelId

public final 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.

Returns:

The ID of the SubChannel in the request.

Only required when creating membership in a SubChannel for a moderator in an elastic channel.

toBuilder

public BatchCreateChannelMembershipRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchCreateChannelMembershipRequest.Builder,BatchCreateChannelMembershipRequest>

Specified by:

toBuilder in class ChimeSdkMessagingRequest

builder

public static BatchCreateChannelMembershipRequest.Builder builder()

serializableBuilderClass

public static Class<? extends BatchCreateChannelMembershipRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo