CollapseConfiguration (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.kendra.model.CollapseConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CollapseConfiguration.Builder,CollapseConfiguration>
```
@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CollapseConfiguration.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CollapseConfiguration.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CollapseConfiguration.Builder`	`builder()`
`String`	`documentAttributeKey()` The document attribute used to group search results.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Boolean`	`expand()` Specifies whether to expand the collapsed results.
`ExpandConfiguration`	`expandConfiguration()` Provides configuration information to customize expansion options for a collapsed group.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasSortingConfigurations()` For responses, this returns true if the service returned a value for the SortingConfigurations property.
`MissingAttributeKeyStrategy`	`missingAttributeKeyStrategy()` Specifies the behavior for documents without a value for the collapse attribute.
`String`	`missingAttributeKeyStrategyAsString()` Specifies the behavior for documents without a value for the collapse attribute.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CollapseConfiguration.Builder>`	`serializableBuilderClass()`
`List<SortingConfiguration>`	`sortingConfigurations()` A prioritized list of document attributes/fields that determine the primary document among those in a collapsed group.
`CollapseConfiguration.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    MissingAttributeKeyStrategy
  - 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:
    
    MissingAttributeKeyStrategy
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CollapseConfiguration.Builder,CollapseConfiguration>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class CollapseConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

documentAttributeKey

hasSortingConfigurations

sortingConfigurations

missingAttributeKeyStrategy

missingAttributeKeyStrategyAsString

expand

expandConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields