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

Class SuggestModel

java.lang.Object

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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SuggestModel.Builder,SuggestModel>

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

Container for the suggestion information returned in a SuggestResponse.

See Also:

Serialized Form

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)
boolean	equalsBySdkFields(Object obj)
Long	found()	The number of documents that were found to match the query string.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSuggestions()	For responses, this returns true if the service returned a value for the Suggestions property.
String	query()	The query string specified in the suggest request.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SuggestModel.Builder>	serializableBuilderClass()
List<SuggestionMatch>	suggestions()	The documents that match the query string.
SuggestModel.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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()

The query string specified in the suggest request.

Returns:

The query string specified in the suggest request.

found

public final 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.

hasSuggestions

public final boolean hasSuggestions()

For responses, this returns true if the service returned a value for the Suggestions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

suggestions

public final List<SuggestionMatch> suggestions()

The documents that match the query string.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSuggestions() method.

Returns:

The documents that match the query string.

toBuilder

public SuggestModel.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SuggestModel.Builder,SuggestModel>

builder

public static SuggestModel.Builder builder()

serializableBuilderClass

public static Class<? extends SuggestModel.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

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