Package software.amazon.awssdk.services.connect.model

Class SearchUsersRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.connect.model.ConnectRequest

software.amazon.awssdk.services.connect.model.SearchUsersRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SearchUsersRequest.Builder,SearchUsersRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SearchUsersRequest.Builder

Method Summary

Modifier and Type	Method	Description
static SearchUsersRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	instanceId()	The identifier of the Amazon Connect instance.
Integer	maxResults()	The maximum number of results to return per page.
String	nextToken()	The token for the next set of results.
List<SdkField<?>>	sdkFields()
UserSearchCriteria	searchCriteria()	Returns the value of the SearchCriteria property for this object.
UserSearchFilter	searchFilter()	Filters to be applied to search results.
static Class<? extends SearchUsersRequest.Builder>	serializableBuilderClass()
SearchUsersRequest.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

instanceId

public final String instanceId()

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

InstanceID is a required field. The "Required: No" below is incorrect.

Returns:

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

InstanceID is a required field. The "Required: No" below is incorrect.

nextToken

public final String nextToken()

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

maxResults

public final Integer maxResults()

The maximum number of results to return per page.

Returns:

The maximum number of results to return per page.

searchFilter

public final UserSearchFilter searchFilter()

Filters to be applied to search results.

Returns:

Filters to be applied to search results.

searchCriteria

public final UserSearchCriteria searchCriteria()

Returns the value of the SearchCriteria property for this object.

Returns:

The value of the SearchCriteria property for this object.

toBuilder

public SearchUsersRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchUsersRequest.Builder,SearchUsersRequest>

Specified by:

toBuilder in class ConnectRequest

builder

public static SearchUsersRequest.Builder builder()

serializableBuilderClass

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