software.amazon.awssdk.services.cloudsearchdomain.model

Class SuggestRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudsearchdomain.model.CloudSearchDomainRequest

software.amazon.awssdk.services.cloudsearchdomain.model.SuggestRequest

All Implemented Interfaces:

ToCopyableBuilder<SuggestRequest.Builder,SuggestRequest>

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

Container for the parameters to the Suggest request.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SuggestRequest.Builder

Method Summary

Modifier and Type	Method and Description
static SuggestRequest.Builder	builder()
boolean	equals(Object obj)
<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()
String	query() Specifies the string for which you want to get suggestions.
static Class<? extends SuggestRequest.Builder>	serializableBuilderClass()
Long	size() Specifies the maximum number of suggestions to return.
String	suggester() Specifies the name of the suggester to use to find suggested matches.
SuggestRequest.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

query

public String query()

Specifies the string for which you want to get suggestions.

Returns:

Specifies the string for which you want to get suggestions.

suggester

public String suggester()

Specifies the name of the suggester to use to find suggested matches.

Returns:

Specifies the name of the suggester to use to find suggested matches.

size

public Long size()

Specifies the maximum number of suggestions to return.

Returns:

Specifies the maximum number of suggestions to return.

toBuilder

public SuggestRequest.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<SuggestRequest.Builder,SuggestRequest>

Specified by:

toBuilder in class CloudSearchDomainRequest

Returns:

a builder for type T

builder

public static SuggestRequest.Builder builder()

serializableBuilderClass

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