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

Class ListChannelsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListChannelsRequest.Builder,ListChannelsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListChannelsRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	appInstanceArn()	The ARN of the AppInstance.
static ListChannelsRequest.Builder	builder()
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 channels that you want to return.
String	nextToken()	The token passed by previous API calls until all requested channels are returned.
ChannelPrivacy	privacy()	The privacy setting.
String	privacyAsString()	The privacy setting.
List<SdkField<?>>	sdkFields()
static Class<? extends ListChannelsRequest.Builder>	serializableBuilderClass()
ListChannelsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

appInstanceArn

public final String appInstanceArn()

The ARN of the AppInstance.

Returns:

The ARN of the AppInstance.

privacy

public final ChannelPrivacy privacy()

The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.

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

Returns:

The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.

See Also:

ChannelPrivacy

privacyAsString

public final String privacyAsString()

The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.

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

Returns:

The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.

See Also:

ChannelPrivacy

maxResults

public final Integer maxResults()

The maximum number of channels that you want to return.

Returns:

The maximum number of channels that you want to return.

nextToken

public final String nextToken()

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

Returns:

The token passed by previous API calls until all requested channels 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.

toBuilder

public ListChannelsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListChannelsRequest.Builder,ListChannelsRequest>

Specified by:

toBuilder in class ChimeSdkMessagingRequest

builder

public static ListChannelsRequest.Builder builder()

serializableBuilderClass

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