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

Class SuggestModel

java.lang.Object

software.amazon.awssdk.services.cloudsearchdomain.model.SuggestModel

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<SuggestModel.Builder,SuggestModel>

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

Container for the suggestion information returned in a SuggestResponse.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SuggestModel.Builder

Method Summary

Modifier and Type	Method	Description
static SuggestModel.Builder	builder()
boolean	equals(Object obj)
Long	found()	The number of documents that were found to match the query string.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
String	query()	The query string specified in the suggest request.
static Class<? extends SuggestModel.Builder>	serializableBuilderClass()
List<SuggestionMatch>	suggestions()	The documents that match the query string.
SuggestModel.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 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

query

public String query()

The query string specified in the suggest request.

Returns:

The query string specified in the suggest request.

found

public Long found()

The number of documents that were found to match the query string.

Returns:

The number of documents that were found to match the query string.

suggestions

public List<SuggestionMatch> suggestions()

The documents that match the query string.

Returns:

The documents that match the query string.

toBuilder

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

Returns:

a builder for type T

builder

public static SuggestModel.Builder builder()

serializableBuilderClass

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

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.