software.amazon.awssdk.services.chime.model

Class BatchCreateChannelMembershipRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.chime.model.ChimeRequest

software.amazon.awssdk.services.chime.model.BatchCreateChannelMembershipRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<BatchCreateChannelMembershipRequest.Builder,BatchCreateChannelMembershipRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BatchCreateChannelMembershipRequest.Builder

Method Summary

Modifier and Type	Method and Description
static BatchCreateChannelMembershipRequest.Builder	builder()
String	channelArn() The ARN of the channel to which you're adding users.
String	chimeBearer() The AppInstanceUserArn of the user 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() Returns true if the MemberArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<String>	memberArns() The ARNs of the members you want to add to the channel.
List<SdkField<?>>	sdkFields()
static Class<? extends BatchCreateChannelMembershipRequest.Builder>	serializableBuilderClass()
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.

Returns:

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

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

Returns true if the MemberArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

memberArns

public final List<String> memberArns()

The ARNs of the members you want to add to the channel.

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

You can use hasMemberArns() to see if a value was sent in this field.

Returns:

The ARNs of the members you want to add to the channel.

chimeBearer

public final String chimeBearer()

The AppInstanceUserArn of the user that makes the API call.

Returns:

The AppInstanceUserArn of the user that makes the API call.

toBuilder

public BatchCreateChannelMembershipRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchCreateChannelMembershipRequest.Builder,BatchCreateChannelMembershipRequest>

Specified by:

toBuilder in class ChimeRequest

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