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

Class SearchContactsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SearchContactsRequest.Builder,SearchContactsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SearchContactsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static SearchContactsRequest.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 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()
SearchCriteria	searchCriteria()	The search criteria to be used to return contacts.
static Class<? extends SearchContactsRequest.Builder>	serializableBuilderClass()
Sort	sort()	Specifies a field to sort by and a sort order.
SearchContactsTimeRange	timeRange()	Time range that you want to search results.
SearchContactsRequest.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 Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

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

timeRange

public final SearchContactsTimeRange timeRange()

Time range that you want to search results.

Returns:

Time range that you want to search results.

searchCriteria

public final SearchCriteria searchCriteria()

The search criteria to be used to return contacts.

Returns:

The search criteria to be used to return contacts.

maxResults

public final Integer maxResults()

The maximum number of results to return per page.

Returns:

The maximum number of results to return per page.

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.

sort

public final Sort sort()

Specifies a field to sort by and a sort order.

Returns:

Specifies a field to sort by and a sort order.

toBuilder

public SearchContactsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchContactsRequest.Builder,SearchContactsRequest>

Specified by:

toBuilder in class ConnectRequest

builder

public static SearchContactsRequest.Builder builder()

serializableBuilderClass

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