software.amazon.awssdk.services.kendra.model

Class GetQuerySuggestionsResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.kendra.model.KendraResponse

software.amazon.awssdk.services.kendra.model.GetQuerySuggestionsResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetQuerySuggestionsResponse.Builder,GetQuerySuggestionsResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetQuerySuggestionsResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetQuerySuggestionsResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<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	querySuggestionsId() The identifier for a list of query suggestions for an index.
List<SdkField<?>>	sdkFields()
static Class<? extends GetQuerySuggestionsResponse.Builder>	serializableBuilderClass()
List<Suggestion>	suggestions() A list of query suggestions for an index.
GetQuerySuggestionsResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.kendra.model.KendraResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

querySuggestionsId

public final String querySuggestionsId()

The identifier for a list of query suggestions for an index.

Returns:

The identifier for a list of query suggestions for an index.

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

A list of query suggestions for an index.

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:

A list of query suggestions for an index.

toBuilder

public GetQuerySuggestionsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetQuerySuggestionsResponse.Builder,GetQuerySuggestionsResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetQuerySuggestionsResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo