Class CollapseConfiguration

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

Specifies how to group results by document attribute value, and how to display them collapsed/expanded under a designated primary document for each group.

See Also:

  • Method Details

    • documentAttributeKey

      public final String documentAttributeKey()

      The document attribute used to group search results. You can use any attribute that has the Sortable flag set to true. You can also sort by any of the following built-in attributes:"_category","_created_at", "_last_updated_at", "_version", "_view_count".

      Returns:
      The document attribute used to group search results. You can use any attribute that has the Sortable flag set to true. You can also sort by any of the following built-in attributes:"_category","_created_at", "_last_updated_at", "_version", "_view_count".

    • hasSortingConfigurations

      public final boolean hasSortingConfigurations()
      For responses, this returns true if the service returned a value for the SortingConfigurations 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.

    • sortingConfigurations

      public final List<SortingConfiguration> sortingConfigurations()

      A prioritized list of document attributes/fields that determine the primary document among those in a collapsed group.

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

      Returns:
      A prioritized list of document attributes/fields that determine the primary document among those in a collapsed group.

    • missingAttributeKeyStrategy

      public final MissingAttributeKeyStrategy missingAttributeKeyStrategy()

      Specifies the behavior for documents without a value for the collapse attribute.

      Amazon Kendra offers three customization options:

      • Choose to COLLAPSE all documents with null or missing values in one group. This is the default configuration.

      • Choose to IGNORE documents with null or missing values. Ignored documents will not appear in query results.

      • Choose to EXPAND each document with a null or missing value into a group of its own.

      If the service returns an enum value that is not available in the current SDK version, missingAttributeKeyStrategy will return MissingAttributeKeyStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from missingAttributeKeyStrategyAsString().

      Returns:
      Specifies the behavior for documents without a value for the collapse attribute.

      Amazon Kendra offers three customization options:

      • Choose to COLLAPSE all documents with null or missing values in one group. This is the default configuration.

      • Choose to IGNORE documents with null or missing values. Ignored documents will not appear in query results.

      • Choose to EXPAND each document with a null or missing value into a group of its own.

      See Also:

    • missingAttributeKeyStrategyAsString

      public final String missingAttributeKeyStrategyAsString()

      Specifies the behavior for documents without a value for the collapse attribute.

      Amazon Kendra offers three customization options:

      • Choose to COLLAPSE all documents with null or missing values in one group. This is the default configuration.

      • Choose to IGNORE documents with null or missing values. Ignored documents will not appear in query results.

      • Choose to EXPAND each document with a null or missing value into a group of its own.

      If the service returns an enum value that is not available in the current SDK version, missingAttributeKeyStrategy will return MissingAttributeKeyStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from missingAttributeKeyStrategyAsString().

      Returns:
      Specifies the behavior for documents without a value for the collapse attribute.

      Amazon Kendra offers three customization options:

      • Choose to COLLAPSE all documents with null or missing values in one group. This is the default configuration.

      • Choose to IGNORE documents with null or missing values. Ignored documents will not appear in query results.

      • Choose to EXPAND each document with a null or missing value into a group of its own.

      See Also:

    • expand

      public final Boolean expand()

      Specifies whether to expand the collapsed results.

      Returns:
      Specifies whether to expand the collapsed results.

    • expandConfiguration

      public final ExpandConfiguration expandConfiguration()

      Provides configuration information to customize expansion options for a collapsed group.

      Returns:
      Provides configuration information to customize expansion options for a collapsed group.

    • toBuilder

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

    • builder

      public static CollapseConfiguration.Builder builder()

    • serializableBuilderClass

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