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

Class BatchChannelMemberships

java.lang.Object

software.amazon.awssdk.services.chimesdkmessaging.model.BatchChannelMemberships

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<BatchChannelMemberships.Builder,BatchChannelMemberships>

@Generated("software.amazon.awssdk:codegen")
public final class BatchChannelMemberships
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<BatchChannelMemberships.Builder,BatchChannelMemberships>

The membership information, including member ARNs, the channel ARN, and membership types.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BatchChannelMemberships.Builder

Method Summary

Modifier and Type	Method	Description
static BatchChannelMemberships.Builder	builder()
String	channelArn()	The ARN of the channel to which you're adding members.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMembers()	For responses, this returns true if the service returned a value for the Members property.
Identity	invitedBy()	The identifier of the member who invited another member.
List<Identity>	members()	The users successfully added to the request.
List<SdkField<?>>	sdkFields()
static Class<? extends BatchChannelMemberships.Builder>	serializableBuilderClass()
String	subChannelId()	The ID of the SubChannel.
BatchChannelMemberships.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ChannelMembershipType	type()	The membership types set for the channel members.
String	typeAsString()	The membership types set for the channel members.

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

invitedBy

public final Identity invitedBy()

The identifier of the member who invited another member.

Returns:

The identifier of the member who invited another member.

type

public final ChannelMembershipType type()

The membership types set for the channel members.

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 types set for the channel members.

See Also:

ChannelMembershipType

typeAsString

public final String typeAsString()

The membership types set for the channel members.

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 types set for the channel members.

See Also:

ChannelMembershipType

hasMembers

public final boolean hasMembers()

For responses, this returns true if the service returned a value for the Members 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.

members

public final List<Identity> members()

The users successfully added to the request.

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 hasMembers() method.

Returns:

The users successfully added to the request.

channelArn

public final String channelArn()

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

Returns:

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

subChannelId

public final String subChannelId()

The ID of the SubChannel.

Returns:

The ID of the SubChannel.

toBuilder

public BatchChannelMemberships.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchChannelMemberships.Builder,BatchChannelMemberships>

builder

public static BatchChannelMemberships.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo