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

Class SearchChannelsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SearchChannelsRequest.Builder,SearchChannelsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SearchChannelsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static SearchChannelsRequest.Builder	builder()
String	chimeBearer()	The AppInstanceUserArn of the user making the API call.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<SearchField>	fields()	A list of the Field objects in the channel being searched.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFields()	For responses, this returns true if the service returned a value for the Fields property.
int	hashCode()
Integer	maxResults()	The maximum number of channels that you want returned.
String	nextToken()	The token returned from previous API requests until the number of channels is reached.
List<SdkField<?>>	sdkFields()
static Class<? extends SearchChannelsRequest.Builder>	serializableBuilderClass()
SearchChannelsRequest.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

chimeBearer

public final String chimeBearer()

The AppInstanceUserArn of the user making the API call.

Returns:

The AppInstanceUserArn of the user making the API call.

hasFields

public final boolean hasFields()

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

fields

public final List<SearchField> fields()

A list of the Field objects in the channel being searched.

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

Returns:

A list of the Field objects in the channel being searched.

maxResults

public final Integer maxResults()

The maximum number of channels that you want returned.

Returns:

The maximum number of channels that you want returned.

nextToken

public final String nextToken()

The token returned from previous API requests until the number of channels is reached.

Returns:

The token returned from previous API requests until the number of channels is reached.

toBuilder

public SearchChannelsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchChannelsRequest.Builder,SearchChannelsRequest>

Specified by:

toBuilder in class ChimeSdkMessagingRequest

builder

public static SearchChannelsRequest.Builder builder()

serializableBuilderClass

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