Class ExpandConfiguration

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

Specifies the configuration information needed to customize how collapsed search result groups expand.

See Also:

  • Method Details

    • maxResultItemsToExpand

      public final Integer maxResultItemsToExpand()

      The number of collapsed search result groups to expand. If you set this value to 10, for example, only the first 10 out of 100 result groups will have expand functionality.

      Returns:
      The number of collapsed search result groups to expand. If you set this value to 10, for example, only the first 10 out of 100 result groups will have expand functionality.

    • maxExpandedResultsPerItem

      public final Integer maxExpandedResultsPerItem()

      The number of expanded results to show per collapsed primary document. For instance, if you set this value to 3, then at most 3 results per collapsed group will be displayed.

      Returns:
      The number of expanded results to show per collapsed primary document. For instance, if you set this value to 3, then at most 3 results per collapsed group will be displayed.

    • toBuilder

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

    • builder

      public static ExpandConfiguration.Builder builder()

    • serializableBuilderClass

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