com.amazonaws.services.kendra.model

Class FacetResult

java.lang.Object

com.amazonaws.services.kendra.model.FacetResult

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

The facet values for the documents in the response.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
FacetResult()

Method Summary

Modifier and Type	Method and Description
FacetResult	clone()
boolean	equals(Object obj)
String	getDocumentAttributeKey() The key for the facet values.
List<DocumentAttributeValueCountPair>	getDocumentAttributeValueCountPairs() An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setDocumentAttributeKey(String documentAttributeKey) The key for the facet values.
void	setDocumentAttributeValueCountPairs(Collection<DocumentAttributeValueCountPair> documentAttributeValueCountPairs) An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.
String	toString() Returns a string representation of this object.
FacetResult	withDocumentAttributeKey(String documentAttributeKey) The key for the facet values.
FacetResult	withDocumentAttributeValueCountPairs(Collection<DocumentAttributeValueCountPair> documentAttributeValueCountPairs) An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.
FacetResult	withDocumentAttributeValueCountPairs(DocumentAttributeValueCountPair... documentAttributeValueCountPairs) An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FacetResult

public FacetResult()

Method Detail

setDocumentAttributeKey

public void setDocumentAttributeKey(String documentAttributeKey)

The key for the facet values. This is the same as the DocumentAttributeKey provided in the query.

Parameters:

documentAttributeKey - The key for the facet values. This is the same as the DocumentAttributeKey provided in the query.

getDocumentAttributeKey

public String getDocumentAttributeKey()

The key for the facet values. This is the same as the DocumentAttributeKey provided in the query.

Returns:

The key for the facet values. This is the same as the DocumentAttributeKey provided in the query.

withDocumentAttributeKey

public FacetResult withDocumentAttributeKey(String documentAttributeKey)

The key for the facet values. This is the same as the DocumentAttributeKey provided in the query.

Parameters:

documentAttributeKey - The key for the facet values. This is the same as the DocumentAttributeKey provided in the query.

Returns:

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

getDocumentAttributeValueCountPairs

public List<DocumentAttributeValueCountPair> getDocumentAttributeValueCountPairs()

An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.

Returns:

An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.

setDocumentAttributeValueCountPairs

public void setDocumentAttributeValueCountPairs(Collection<DocumentAttributeValueCountPair> documentAttributeValueCountPairs)

An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.

Parameters:

documentAttributeValueCountPairs - An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.

withDocumentAttributeValueCountPairs

public FacetResult withDocumentAttributeValueCountPairs(DocumentAttributeValueCountPair... documentAttributeValueCountPairs)

An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.

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

Parameters:

documentAttributeValueCountPairs - An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.

Returns:

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

withDocumentAttributeValueCountPairs

public FacetResult withDocumentAttributeValueCountPairs(Collection<DocumentAttributeValueCountPair> documentAttributeValueCountPairs)

An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.

Parameters:

documentAttributeValueCountPairs - An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.

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