software.amazon.awssdk.services.alexaforbusiness.model

Class SearchContactsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.alexaforbusiness.model.AlexaForBusinessRequest

software.amazon.awssdk.services.alexaforbusiness.model.SearchContactsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SearchContactsRequest.Builder,SearchContactsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SearchContactsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static SearchContactsRequest.Builder	builder()
boolean	equals(Object obj)
List<Filter>	filters() The filters to use to list a specified set of address books.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults() The maximum number of results to include in the response.
String	nextToken() An optional token returned from a prior request.
List<SdkField<?>>	sdkFields()
static Class<? extends SearchContactsRequest.Builder>	serializableBuilderClass()
List<Sort>	sortCriteria() The sort order to use in listing the specified set of contacts.
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

filters

public List<Filter> filters()

The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.

sortCriteria

public List<Sort> sortCriteria()

The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.

nextToken

public String nextToken()

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.

Returns:

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.

maxResults

public Integer maxResults()

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Returns:

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

toBuilder

public SearchContactsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchContactsRequest.Builder,SearchContactsRequest>

Specified by:

toBuilder in class AlexaForBusinessRequest

builder

public static SearchContactsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SearchContactsRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo