Class AttributeSuggestionsGetConfig

java.lang.Object
software.amazon.awssdk.services.kendra.model.AttributeSuggestionsGetConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AttributeSuggestionsGetConfig.Builder,AttributeSuggestionsGetConfig>
@Generated("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:

  • Method Details

    • 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()
      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<AttributeSuggestionsGetConfig.Builder,AttributeSuggestionsGetConfig>
      Returns:
      a builder for type T

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.