software.amazon.awssdk.services.alexaforbusiness.model

Class SearchAddressBooksRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SearchAddressBooksRequest.Builder,SearchAddressBooksRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SearchAddressBooksRequest.Builder

Method Summary

Modifier and Type	Method and Description
static SearchAddressBooksRequest.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) Used to retrieve the value of a field from any class that extends SdkRequest.
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 SearchAddressBooksRequest.Builder>	serializableBuilderClass()
List<Sort>	sortCriteria() The sort order to use in listing the specified set of address books.
SearchAddressBooksRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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 key is AddressBookName.

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 key is AddressBookName.

sortCriteria

public List<Sort> sortCriteria()

The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.

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 address books. The supported sort key is AddressBookName.

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 SearchAddressBooksRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<SearchAddressBooksRequest.Builder,SearchAddressBooksRequest>

Specified by:

toBuilder in class AlexaForBusinessRequest

Returns:

a builder for type T

builder

public static SearchAddressBooksRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SearchAddressBooksRequest.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()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.