com.amazonaws.services.kendra.model

Class ExpandConfiguration

java.lang.Object

com.amazonaws.services.kendra.model.ExpandConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ExpandConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExpandConfiguration()

Method Summary

Modifier and Type	Method and Description
ExpandConfiguration	clone()
boolean	equals(Object obj)
Integer	getMaxExpandedResultsPerItem() The number of expanded results to show per collapsed primary document.
Integer	getMaxResultItemsToExpand() The number of collapsed search result groups to expand.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setMaxExpandedResultsPerItem(Integer maxExpandedResultsPerItem) The number of expanded results to show per collapsed primary document.
void	setMaxResultItemsToExpand(Integer maxResultItemsToExpand) The number of collapsed search result groups to expand.
String	toString() Returns a string representation of this object.
ExpandConfiguration	withMaxExpandedResultsPerItem(Integer maxExpandedResultsPerItem) The number of expanded results to show per collapsed primary document.
ExpandConfiguration	withMaxResultItemsToExpand(Integer maxResultItemsToExpand) The number of collapsed search result groups to expand.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ExpandConfiguration

public ExpandConfiguration()

Method Detail

setMaxResultItemsToExpand

public void setMaxResultItemsToExpand(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.

Parameters:

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.

getMaxResultItemsToExpand

public Integer getMaxResultItemsToExpand()

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.

withMaxResultItemsToExpand

public ExpandConfiguration withMaxResultItemsToExpand(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setMaxExpandedResultsPerItem

public void setMaxExpandedResultsPerItem(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.

Parameters:

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.

getMaxExpandedResultsPerItem

public Integer getMaxExpandedResultsPerItem()

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.

withMaxExpandedResultsPerItem

public ExpandConfiguration withMaxExpandedResultsPerItem(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.

Parameters:

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:

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 ExpandConfiguration 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.