Package software.amazon.awssdk.services.cloudsearchdomain.model

Class SuggestRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

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

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<SuggestRequest.Builder,SuggestRequest>

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

Container for the parameters to the Suggest request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SuggestRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static SuggestRequest.Builder	builder()
boolean	equals(Object obj)
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.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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>

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