Package 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:

SdkPojo, ToCopyableBuilder<SuggestRequest.Builder,SuggestRequest>

@Generated("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	Description
static interface	SuggestRequest.Builder

Method Summary

Modifier and Type	Method	Description
static SuggestRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	query()	Specifies the string for which you want to get suggestions.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
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()
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

query

public final 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 final 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 final Long size()

Specifies the maximum number of suggestions to return.

Returns:

Specifies the maximum number of suggestions to return.

toBuilder

public SuggestRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SuggestRequest.Builder,SuggestRequest>

Specified by:

toBuilder in class CloudSearchDomainRequest

builder

public static SuggestRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo