Class AttributeSuggestionsDescribeConfig
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AttributeSuggestionsDescribeConfig.Builder,
AttributeSuggestionsDescribeConfig>
Gets information on the configuration of document fields/attributes that you want to base query suggestions on. To change your configuration, use AttributeSuggestionsUpdateConfig and then call UpdateQuerySuggestionsConfig.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AttributeSuggestionsMode
The mode is set to eitherACTIVE
orINACTIVE
.final String
The mode is set to eitherACTIVE
orINACTIVE
.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SuggestableConfigList property.static Class
<? extends AttributeSuggestionsDescribeConfig.Builder> final List
<SuggestableConfig> The list of fields/attributes that you want to set as suggestible for query suggestions.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasSuggestableConfigList
public final boolean hasSuggestableConfigList()For responses, this returns true if the service returned a value for the SuggestableConfigList property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
suggestableConfigList
The list of fields/attributes that you want to set as suggestible for query suggestions.
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
hasSuggestableConfigList()
method.- Returns:
- The list of fields/attributes that you want to set as suggestible for query suggestions.
-
attributeSuggestionsMode
The mode is set to either
ACTIVE
orINACTIVE
. If theMode
for query history is set toENABLED
when calling UpdateQuerySuggestionsConfig andAttributeSuggestionsMode
to use fields/attributes is set toACTIVE
, and you haven't set yourSuggestionTypes
preference toDOCUMENT_ATTRIBUTES
, then Amazon Kendra uses the query history.If the service returns an enum value that is not available in the current SDK version,
attributeSuggestionsMode
will returnAttributeSuggestionsMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromattributeSuggestionsModeAsString()
.- Returns:
- The mode is set to either
ACTIVE
orINACTIVE
. If theMode
for query history is set toENABLED
when calling UpdateQuerySuggestionsConfig andAttributeSuggestionsMode
to use fields/attributes is set toACTIVE
, and you haven't set yourSuggestionTypes
preference toDOCUMENT_ATTRIBUTES
, then Amazon Kendra uses the query history. - See Also:
-
attributeSuggestionsModeAsString
The mode is set to either
ACTIVE
orINACTIVE
. If theMode
for query history is set toENABLED
when calling UpdateQuerySuggestionsConfig andAttributeSuggestionsMode
to use fields/attributes is set toACTIVE
, and you haven't set yourSuggestionTypes
preference toDOCUMENT_ATTRIBUTES
, then Amazon Kendra uses the query history.If the service returns an enum value that is not available in the current SDK version,
attributeSuggestionsMode
will returnAttributeSuggestionsMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromattributeSuggestionsModeAsString()
.- Returns:
- The mode is set to either
ACTIVE
orINACTIVE
. If theMode
for query history is set toENABLED
when calling UpdateQuerySuggestionsConfig andAttributeSuggestionsMode
to use fields/attributes is set toACTIVE
, and you haven't set yourSuggestionTypes
preference toDOCUMENT_ATTRIBUTES
, then Amazon Kendra uses the query history. - See Also:
-
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 interfaceToCopyableBuilder<AttributeSuggestionsDescribeConfig.Builder,
AttributeSuggestionsDescribeConfig> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends AttributeSuggestionsDescribeConfig.Builder> serializableBuilderClass() -
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-