com.amazonaws.services.kendra.model

Class SortingConfiguration

java.lang.Object

com.amazonaws.services.kendra.model.SortingConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

Specifies the document attribute to use to sort the response to a Amazon Kendra query. You can specify a single attribute for sorting. The attribute must have the Sortable flag set to true, otherwise Amazon Kendra returns an exception.

You can sort attributes of the following types.

• Date value

• Long value

• String value

You can't sort attributes of the following type.

• String list value

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SortingConfiguration()

Method Summary

Modifier and Type	Method and Description
SortingConfiguration	clone()
boolean	equals(Object obj)
String	getDocumentAttributeKey() The name of the document attribute used to sort the response.
String	getSortOrder() The order that the results should be returned in.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setDocumentAttributeKey(String documentAttributeKey) The name of the document attribute used to sort the response.
void	setSortOrder(String sortOrder) The order that the results should be returned in.
String	toString() Returns a string representation of this object.
SortingConfiguration	withDocumentAttributeKey(String documentAttributeKey) The name of the document attribute used to sort the response.
SortingConfiguration	withSortOrder(SortOrder sortOrder) The order that the results should be returned in.
SortingConfiguration	withSortOrder(String sortOrder) The order that the results should be returned in.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SortingConfiguration

public SortingConfiguration()

Method Detail

setDocumentAttributeKey

public void setDocumentAttributeKey(String documentAttributeKey)

The name of the document attribute used to sort the response. You can use any field 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 name of the document attribute used to sort the response. You can use any field 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 name of the document attribute used to sort the response. You can use any field 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 name of the document attribute used to sort the response. You can use any field 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 SortingConfiguration withDocumentAttributeKey(String documentAttributeKey)

The name of the document attribute used to sort the response. You can use any field 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 name of the document attribute used to sort the response. You can use any field 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.

setSortOrder

public void setSortOrder(String sortOrder)

The order that the results should be returned in. In case of ties, the relevance assigned to the result by Amazon Kendra is used as the tie-breaker.

Parameters:

sortOrder - The order that the results should be returned in. In case of ties, the relevance assigned to the result by Amazon Kendra is used as the tie-breaker.

See Also:

SortOrder

getSortOrder

public String getSortOrder()

The order that the results should be returned in. In case of ties, the relevance assigned to the result by Amazon Kendra is used as the tie-breaker.

Returns:

The order that the results should be returned in. In case of ties, the relevance assigned to the result by Amazon Kendra is used as the tie-breaker.

See Also:

SortOrder

withSortOrder

public SortingConfiguration withSortOrder(String sortOrder)

The order that the results should be returned in. In case of ties, the relevance assigned to the result by Amazon Kendra is used as the tie-breaker.

Parameters:

sortOrder - The order that the results should be returned in. In case of ties, the relevance assigned to the result by Amazon Kendra is used as the tie-breaker.

Returns:

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

See Also:

SortOrder

withSortOrder

public SortingConfiguration withSortOrder(SortOrder sortOrder)

The order that the results should be returned in. In case of ties, the relevance assigned to the result by Amazon Kendra is used as the tie-breaker.

Parameters:

sortOrder - The order that the results should be returned in. In case of ties, the relevance assigned to the result by Amazon Kendra is used as the tie-breaker.

Returns:

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

See Also:

SortOrder

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