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

Class ListChannelMembershipsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListChannelMembershipsRequest.Builder,ListChannelMembershipsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListChannelMembershipsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListChannelMembershipsRequest.Builder	builder()
String	channelArn()	The maximum number of channel memberships that you want returned.
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()
Integer	maxResults()	The maximum number of channel memberships that you want returned.
String	nextToken()	The token passed by previous API calls until all requested channel memberships are returned.
List<SdkField<?>>	sdkFields()
static Class<? extends ListChannelMembershipsRequest.Builder>	serializableBuilderClass()
String	subChannelId()	The ID of the SubChannel in the request.
ListChannelMembershipsRequest.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 maximum number of channel memberships that you want returned.

Returns:

The maximum number of channel memberships that you want returned.

type

public final ChannelMembershipType type()

The membership type of a user, DEFAULT or HIDDEN. Default members are returned as part of ListChannelMemberships if no type is specified. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN.

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 returned as part of ListChannelMemberships if no type is specified. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN.

See Also:

ChannelMembershipType

typeAsString

public final String typeAsString()

The membership type of a user, DEFAULT or HIDDEN. Default members are returned as part of ListChannelMemberships if no type is specified. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN.

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 returned as part of ListChannelMemberships if no type is specified. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN.

See Also:

ChannelMembershipType

maxResults

public final Integer maxResults()

The maximum number of channel memberships that you want returned.

Returns:

The maximum number of channel memberships that you want returned.

nextToken

public final String nextToken()

The token passed by previous API calls until all requested channel memberships are returned.

Returns:

The token passed by previous API calls until all requested channel memberships are returned.

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 listing a user's memberships in a particular sub-channel of an elastic channel.

Returns:

The ID of the SubChannel in the request.

Only required when listing a user's memberships in a particular sub-channel of an elastic channel.

toBuilder

public ListChannelMembershipsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListChannelMembershipsRequest.Builder,ListChannelMembershipsRequest>

Specified by:

toBuilder in class ChimeSdkMessagingRequest

builder

public static ListChannelMembershipsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListChannelMembershipsRequest.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