Class AttributeSuggestionsUpdateConfig

java.lang.Object
software.amazon.awssdk.services.kendra.model.AttributeSuggestionsUpdateConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AttributeSuggestionsUpdateConfig.Builder,AttributeSuggestionsUpdateConfig>
@Generated("software.amazon.awssdk:codegen") public final class AttributeSuggestionsUpdateConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AttributeSuggestionsUpdateConfig.Builder,AttributeSuggestionsUpdateConfig>

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

To deactivate using documents fields for query suggestions, set the mode to INACTIVE. You must also set SuggestionTypes as either QUERY or DOCUMENT_ATTRIBUTES and then call GetQuerySuggestions. If you set to QUERY, then Amazon Kendra uses the query history to base suggestions on. If you set to DOCUMENT_ATTRIBUTES, then Amazon Kendra uses the contents of document fields to base suggestions on.

See Also:

  • 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 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.

    • suggestableConfigList

      public final List<SuggestableConfig> 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

      public final AttributeSuggestionsMode attributeSuggestionsMode()

      You can set the mode to ACTIVE or INACTIVE. You must also set SuggestionTypes as either QUERY or DOCUMENT_ATTRIBUTES and then call GetQuerySuggestions. If Mode to use query history is set to ENABLED when calling UpdateQuerySuggestionsConfig and AttributeSuggestionsMode to use fields/attributes is set to ACTIVE, and you haven't set your SuggestionTypes preference to DOCUMENT_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 return AttributeSuggestionsMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from attributeSuggestionsModeAsString().

      Returns:
      You can set the mode to ACTIVE or INACTIVE. You must also set SuggestionTypes as either QUERY or DOCUMENT_ATTRIBUTES and then call GetQuerySuggestions. If Mode to use query history is set to ENABLED when calling UpdateQuerySuggestionsConfig and AttributeSuggestionsMode to use fields/attributes is set to ACTIVE, and you haven't set your SuggestionTypes preference to DOCUMENT_ATTRIBUTES, then Amazon Kendra uses the query history.
      See Also:

    • attributeSuggestionsModeAsString

      public final String attributeSuggestionsModeAsString()

      You can set the mode to ACTIVE or INACTIVE. You must also set SuggestionTypes as either QUERY or DOCUMENT_ATTRIBUTES and then call GetQuerySuggestions. If Mode to use query history is set to ENABLED when calling UpdateQuerySuggestionsConfig and AttributeSuggestionsMode to use fields/attributes is set to ACTIVE, and you haven't set your SuggestionTypes preference to DOCUMENT_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 return AttributeSuggestionsMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from attributeSuggestionsModeAsString().

      Returns:
      You can set the mode to ACTIVE or INACTIVE. You must also set SuggestionTypes as either QUERY or DOCUMENT_ATTRIBUTES and then call GetQuerySuggestions. If Mode to use query history is set to ENABLED when calling UpdateQuerySuggestionsConfig and AttributeSuggestionsMode to use fields/attributes is set to ACTIVE, and you haven't set your SuggestionTypes preference to DOCUMENT_ATTRIBUTES, then Amazon Kendra uses the query history.
      See Also:

    • toBuilder

      public AttributeSuggestionsUpdateConfig.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<AttributeSuggestionsUpdateConfig.Builder,AttributeSuggestionsUpdateConfig>
      Returns:
      a builder for type T

    • builder

      public static AttributeSuggestionsUpdateConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AttributeSuggestionsUpdateConfig.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.