AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::kendra::Model::SortingConfiguration Class Reference

#include <SortingConfiguration.h>

Public Member Functions

 SortingConfiguration ()
 
 SortingConfiguration (Aws::Utils::Json::JsonView jsonValue)
 
SortingConfigurationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetDocumentAttributeKey () const
 
bool DocumentAttributeKeyHasBeenSet () const
 
void SetDocumentAttributeKey (const Aws::String &value)
 
void SetDocumentAttributeKey (Aws::String &&value)
 
void SetDocumentAttributeKey (const char *value)
 
SortingConfigurationWithDocumentAttributeKey (const Aws::String &value)
 
SortingConfigurationWithDocumentAttributeKey (Aws::String &&value)
 
SortingConfigurationWithDocumentAttributeKey (const char *value)
 
const SortOrderGetSortOrder () const
 
bool SortOrderHasBeenSet () const
 
void SetSortOrder (const SortOrder &value)
 
void SetSortOrder (SortOrder &&value)
 
SortingConfigurationWithSortOrder (const SortOrder &value)
 
SortingConfigurationWithSortOrder (SortOrder &&value)
 

Detailed Description

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.

You can't sort attributes of the following type.

See Also:

AWS API Reference

Definition at line 39 of file SortingConfiguration.h.

Constructor & Destructor Documentation

◆ SortingConfiguration() [1/2]

Aws::kendra::Model::SortingConfiguration::SortingConfiguration ( )

◆ SortingConfiguration() [2/2]

Aws::kendra::Model::SortingConfiguration::SortingConfiguration ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ DocumentAttributeKeyHasBeenSet()

bool Aws::kendra::Model::SortingConfiguration::DocumentAttributeKeyHasBeenSet ( ) const
inline

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

Definition at line 64 of file SortingConfiguration.h.

◆ GetDocumentAttributeKey()

const Aws::String& Aws::kendra::Model::SortingConfiguration::GetDocumentAttributeKey ( ) const
inline

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

Definition at line 55 of file SortingConfiguration.h.

◆ GetSortOrder()

const SortOrder& Aws::kendra::Model::SortingConfiguration::GetSortOrder ( ) const
inline

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.

Definition at line 126 of file SortingConfiguration.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::kendra::Model::SortingConfiguration::Jsonize ( ) const

◆ operator=()

SortingConfiguration& Aws::kendra::Model::SortingConfiguration::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetDocumentAttributeKey() [1/3]

void Aws::kendra::Model::SortingConfiguration::SetDocumentAttributeKey ( const Aws::String value)
inline

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

Definition at line 73 of file SortingConfiguration.h.

◆ SetDocumentAttributeKey() [2/3]

void Aws::kendra::Model::SortingConfiguration::SetDocumentAttributeKey ( Aws::String &&  value)
inline

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

Definition at line 82 of file SortingConfiguration.h.

◆ SetDocumentAttributeKey() [3/3]

void Aws::kendra::Model::SortingConfiguration::SetDocumentAttributeKey ( const char *  value)
inline

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

Definition at line 91 of file SortingConfiguration.h.

◆ SetSortOrder() [1/2]

void Aws::kendra::Model::SortingConfiguration::SetSortOrder ( const SortOrder value)
inline

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.

Definition at line 140 of file SortingConfiguration.h.

◆ SetSortOrder() [2/2]

void Aws::kendra::Model::SortingConfiguration::SetSortOrder ( SortOrder &&  value)
inline

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.

Definition at line 147 of file SortingConfiguration.h.

◆ SortOrderHasBeenSet()

bool Aws::kendra::Model::SortingConfiguration::SortOrderHasBeenSet ( ) const
inline

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.

Definition at line 133 of file SortingConfiguration.h.

◆ WithDocumentAttributeKey() [1/3]

SortingConfiguration& Aws::kendra::Model::SortingConfiguration::WithDocumentAttributeKey ( const Aws::String value)
inline

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

Definition at line 100 of file SortingConfiguration.h.

◆ WithDocumentAttributeKey() [2/3]

SortingConfiguration& Aws::kendra::Model::SortingConfiguration::WithDocumentAttributeKey ( Aws::String &&  value)
inline

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

Definition at line 109 of file SortingConfiguration.h.

◆ WithDocumentAttributeKey() [3/3]

SortingConfiguration& Aws::kendra::Model::SortingConfiguration::WithDocumentAttributeKey ( const char *  value)
inline

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

Definition at line 118 of file SortingConfiguration.h.

◆ WithSortOrder() [1/2]

SortingConfiguration& Aws::kendra::Model::SortingConfiguration::WithSortOrder ( const SortOrder value)
inline

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.

Definition at line 154 of file SortingConfiguration.h.

◆ WithSortOrder() [2/2]

SortingConfiguration& Aws::kendra::Model::SortingConfiguration::WithSortOrder ( SortOrder &&  value)
inline

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.

Definition at line 161 of file SortingConfiguration.h.


The documentation for this class was generated from the following file: