CollapseConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kendra.model.CollapseConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CollapseConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CollapseConfiguration()

Constructors
Constructor and Description
`CollapseConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CollapseConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDocumentAttributeKey()` The document attribute used to group search results.
`Boolean`	`getExpand()` Specifies whether to expand the collapsed results.
`ExpandConfiguration`	`getExpandConfiguration()` Provides configuration information to customize expansion options for a collapsed group.
`String`	`getMissingAttributeKeyStrategy()` Specifies the behavior for documents without a value for the collapse attribute.
`List<SortingConfiguration>`	`getSortingConfigurations()` A prioritized list of document attributes/fields that determine the primary document among those in a collapsed group.
`int`	`hashCode()`
`Boolean`	`isExpand()` Specifies whether to expand the collapsed results.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDocumentAttributeKey(String documentAttributeKey)` The document attribute used to group search results.
`void`	`setExpand(Boolean expand)` Specifies whether to expand the collapsed results.
`void`	`setExpandConfiguration(ExpandConfiguration expandConfiguration)` Provides configuration information to customize expansion options for a collapsed group.
`void`	`setMissingAttributeKeyStrategy(String missingAttributeKeyStrategy)` Specifies the behavior for documents without a value for the collapse attribute.
`void`	`setSortingConfigurations(Collection<SortingConfiguration> sortingConfigurations)` A prioritized list of document attributes/fields that determine the primary document among those in a collapsed group.
`String`	`toString()` Returns a string representation of this object.
`CollapseConfiguration`	`withDocumentAttributeKey(String documentAttributeKey)` The document attribute used to group search results.
`CollapseConfiguration`	`withExpand(Boolean expand)` Specifies whether to expand the collapsed results.
`CollapseConfiguration`	`withExpandConfiguration(ExpandConfiguration expandConfiguration)` Provides configuration information to customize expansion options for a collapsed group.
`CollapseConfiguration`	`withMissingAttributeKeyStrategy(MissingAttributeKeyStrategy missingAttributeKeyStrategy)` Specifies the behavior for documents without a value for the collapse attribute.
`CollapseConfiguration`	`withMissingAttributeKeyStrategy(String missingAttributeKeyStrategy)` Specifies the behavior for documents without a value for the collapse attribute.
`CollapseConfiguration`	`withSortingConfigurations(Collection<SortingConfiguration> sortingConfigurations)` A prioritized list of document attributes/fields that determine the primary document among those in a collapsed group.
`CollapseConfiguration`	`withSortingConfigurations(SortingConfiguration... sortingConfigurations)` A prioritized list of document attributes/fields that determine the primary document among those in a collapsed group.

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

- Constructor Detail
  - CollapseConfiguration
```
public CollapseConfiguration()
```
- Method Detail
  - setDocumentAttributeKey
```
public void setDocumentAttributeKey(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".
    
    Parameters:
    
    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".
  - getDocumentAttributeKey
```
public String getDocumentAttributeKey()
```
    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".
  - withDocumentAttributeKey
```
public CollapseConfiguration withDocumentAttributeKey(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".
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSortingConfigurations
```
public List<SortingConfiguration> getSortingConfigurations()
```
    A prioritized list of document attributes/fields that determine the primary document among those in a collapsed group.
    
    Returns:
    
    A prioritized list of document attributes/fields that determine the primary document among those in a collapsed group.
  - setSortingConfigurations
```
public void setSortingConfigurations(Collection<SortingConfiguration> sortingConfigurations)
```
    A prioritized list of document attributes/fields that determine the primary document among those in a collapsed group.
    
    Parameters:
    
    sortingConfigurations - A prioritized list of document attributes/fields that determine the primary document among those in a collapsed group.
  - withSortingConfigurations
```
public CollapseConfiguration withSortingConfigurations(SortingConfiguration... sortingConfigurations)
```
    A prioritized list of document attributes/fields that determine the primary document among those in a collapsed group.
    
    NOTE: This method appends the values to the existing list (if any). Use setSortingConfigurations(java.util.Collection) or withSortingConfigurations(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    sortingConfigurations - A prioritized list of document attributes/fields that determine the primary document among those in a collapsed group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSortingConfigurations
```
public CollapseConfiguration withSortingConfigurations(Collection<SortingConfiguration> sortingConfigurations)
```
    A prioritized list of document attributes/fields that determine the primary document among those in a collapsed group.
    
    Parameters:
    
    sortingConfigurations - A prioritized list of document attributes/fields that determine the primary document among those in a collapsed group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMissingAttributeKeyStrategy
```
public void setMissingAttributeKeyStrategy(String 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.
    Parameters:
    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.
    See Also:
    
    MissingAttributeKeyStrategy
  - getMissingAttributeKeyStrategy
```
public String getMissingAttributeKeyStrategy()
```
    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.
    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
  - withMissingAttributeKeyStrategy
```
public CollapseConfiguration withMissingAttributeKeyStrategy(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MissingAttributeKeyStrategy
  - withMissingAttributeKeyStrategy
```
public CollapseConfiguration withMissingAttributeKeyStrategy(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MissingAttributeKeyStrategy
  - setExpand
```
public void setExpand(Boolean expand)
```
    Specifies whether to expand the collapsed results.
    
    Parameters:
    
    expand - Specifies whether to expand the collapsed results.
  - getExpand
```
public Boolean getExpand()
```
    Specifies whether to expand the collapsed results.
    
    Returns:
    
    Specifies whether to expand the collapsed results.
  - withExpand
```
public CollapseConfiguration withExpand(Boolean expand)
```
    Specifies whether to expand the collapsed results.
    
    Parameters:
    
    expand - Specifies whether to expand the collapsed results.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isExpand
```
public Boolean isExpand()
```
    Specifies whether to expand the collapsed results.
    
    Returns:
    
    Specifies whether to expand the collapsed results.
  - setExpandConfiguration
```
public void setExpandConfiguration(ExpandConfiguration expandConfiguration)
```
    Provides configuration information to customize expansion options for a collapsed group.
    
    Parameters:
    
    expandConfiguration - Provides configuration information to customize expansion options for a collapsed group.
  - getExpandConfiguration
```
public ExpandConfiguration getExpandConfiguration()
```
    Provides configuration information to customize expansion options for a collapsed group.
    
    Returns:
    
    Provides configuration information to customize expansion options for a collapsed group.
  - withExpandConfiguration
```
public CollapseConfiguration withExpandConfiguration(ExpandConfiguration expandConfiguration)
```
    Provides configuration information to customize expansion options for a collapsed group.
    
    Parameters:
    
    expandConfiguration - Provides configuration information to customize expansion options for a collapsed group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CollapseConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.793

Class CollapseConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CollapseConfiguration

Method Detail

setDocumentAttributeKey

getDocumentAttributeKey

withDocumentAttributeKey

getSortingConfigurations

setSortingConfigurations

withSortingConfigurations

withSortingConfigurations

setMissingAttributeKeyStrategy

getMissingAttributeKeyStrategy

withMissingAttributeKeyStrategy

withMissingAttributeKeyStrategy

setExpand

getExpand

withExpand

isExpand

setExpandConfiguration

getExpandConfiguration

withExpandConfiguration

toString

equals

hashCode

clone

marshall