com.amazonaws.services.kendra.model

Class CollapsedResultDetail

java.lang.Object

com.amazonaws.services.kendra.model.CollapsedResultDetail

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Provides details about a collapsed group of search results.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
CollapsedResultDetail()

Method Summary

Modifier and Type	Method and Description
CollapsedResultDetail	clone()
boolean	equals(Object obj)
DocumentAttribute	getDocumentAttribute() The value of the document attribute that results are collapsed on.
List<ExpandedResultItem>	getExpandedResults() A list of results in the collapsed group.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setDocumentAttribute(DocumentAttribute documentAttribute) The value of the document attribute that results are collapsed on.
void	setExpandedResults(Collection<ExpandedResultItem> expandedResults) A list of results in the collapsed group.
String	toString() Returns a string representation of this object.
CollapsedResultDetail	withDocumentAttribute(DocumentAttribute documentAttribute) The value of the document attribute that results are collapsed on.
CollapsedResultDetail	withExpandedResults(Collection<ExpandedResultItem> expandedResults) A list of results in the collapsed group.
CollapsedResultDetail	withExpandedResults(ExpandedResultItem... expandedResults) A list of results in the collapsed group.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CollapsedResultDetail

public CollapsedResultDetail()

Method Detail

setDocumentAttribute

public void setDocumentAttribute(DocumentAttribute documentAttribute)

The value of the document attribute that results are collapsed on.

Parameters:

documentAttribute - The value of the document attribute that results are collapsed on.

getDocumentAttribute

public DocumentAttribute getDocumentAttribute()

The value of the document attribute that results are collapsed on.

Returns:

The value of the document attribute that results are collapsed on.

withDocumentAttribute

public CollapsedResultDetail withDocumentAttribute(DocumentAttribute documentAttribute)

The value of the document attribute that results are collapsed on.

Parameters:

documentAttribute - The value of the document attribute that results are collapsed on.

Returns:

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

getExpandedResults

public List<ExpandedResultItem> getExpandedResults()

A list of results in the collapsed group.

Returns:

A list of results in the collapsed group.

setExpandedResults

public void setExpandedResults(Collection<ExpandedResultItem> expandedResults)

A list of results in the collapsed group.

Parameters:

expandedResults - A list of results in the collapsed group.

withExpandedResults

public CollapsedResultDetail withExpandedResults(ExpandedResultItem... expandedResults)

A list of results in the collapsed group.

NOTE: This method appends the values to the existing list (if any). Use setExpandedResults(java.util.Collection) or withExpandedResults(java.util.Collection) if you want to override the existing values.

Parameters:

expandedResults - A list of results in the collapsed group.

Returns:

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

withExpandedResults

public CollapsedResultDetail withExpandedResults(Collection<ExpandedResultItem> expandedResults)

A list of results in the collapsed group.

Parameters:

expandedResults - A list of results in the 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 CollapsedResultDetail 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.