software.amazon.awssdk.services.kendra.model

Class AttributeSuggestionsGetConfig

java.lang.Object

software.amazon.awssdk.services.kendra.model.AttributeSuggestionsGetConfig

All Implemented Interfaces:

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

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

Provides the configuration information for the document fields/attributes that you want to base query suggestions on.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AttributeSuggestionsGetConfig.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	additionalResponseAttributes() The list of additional document field/attribute keys or field names to include in the response.
AttributeFilter	attributeFilter() Filters the search results based on document fields/attributes.
static AttributeSuggestionsGetConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAdditionalResponseAttributes() For responses, this returns true if the service returned a value for the AdditionalResponseAttributes property.
int	hashCode()
boolean	hasSuggestionAttributes() For responses, this returns true if the service returned a value for the SuggestionAttributes property.
List<SdkField<?>>	sdkFields()
static Class<? extends AttributeSuggestionsGetConfig.Builder>	serializableBuilderClass()
List<String>	suggestionAttributes() The list of document field/attribute keys or field names to use for query suggestions.
AttributeSuggestionsGetConfig.Builder	toBuilder()
String	toString() Returns a string representation of this object.
UserContext	userContext() Applies user context filtering so that only users who are given access to certain documents see these document in their search results.

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

hasSuggestionAttributes

public final boolean hasSuggestionAttributes()

For responses, this returns true if the service returned a value for the SuggestionAttributes 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.

suggestionAttributes

public final List<String> suggestionAttributes()

The list of document field/attribute keys or field names to use for query suggestions. If the content within any of the fields match what your user starts typing as their query, then the field content is returned as a query suggestion.

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 hasSuggestionAttributes() method.

Returns:

The list of document field/attribute keys or field names to use for query suggestions. If the content within any of the fields match what your user starts typing as their query, then the field content is returned as a query suggestion.

hasAdditionalResponseAttributes

public final boolean hasAdditionalResponseAttributes()

For responses, this returns true if the service returned a value for the AdditionalResponseAttributes 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.

additionalResponseAttributes

public final List<String> additionalResponseAttributes()

The list of additional document field/attribute keys or field names to include in the response. You can use additional fields to provide extra information in the response. Additional fields are not used to based suggestions on.

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 hasAdditionalResponseAttributes() method.

Returns:

The list of additional document field/attribute keys or field names to include in the response. You can use additional fields to provide extra information in the response. Additional fields are not used to based suggestions on.

attributeFilter

public final AttributeFilter attributeFilter()

Filters the search results based on document fields/attributes.

Returns:

Filters the search results based on document fields/attributes.

userContext

public final UserContext userContext()

Applies user context filtering so that only users who are given access to certain documents see these document in their search results.

Returns:

Applies user context filtering so that only users who are given access to certain documents see these document in their search results.

toBuilder

public AttributeSuggestionsGetConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AttributeSuggestionsGetConfig.Builder,AttributeSuggestionsGetConfig>

builder

public static AttributeSuggestionsGetConfig.Builder builder()

serializableBuilderClass

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