Aws::kendra::Model::Highlight Class Reference

#include <Highlight.h>

Public Member Functions
	Highlight ()
	Highlight (Aws::Utils::Json::JsonView jsonValue)
Highlight &	operator= (Aws::Utils::Json::JsonView jsonValue)
Aws::Utils::Json::JsonValue	Jsonize () const
int	GetBeginOffset () const
bool	BeginOffsetHasBeenSet () const
void	SetBeginOffset (int value)
Highlight &	WithBeginOffset (int value)
int	GetEndOffset () const
bool	EndOffsetHasBeenSet () const
void	SetEndOffset (int value)
Highlight &	WithEndOffset (int value)
bool	GetTopAnswer () const
bool	TopAnswerHasBeenSet () const
void	SetTopAnswer (bool value)
Highlight &	WithTopAnswer (bool value)
const HighlightType &	GetType () const
bool	TypeHasBeenSet () const
void	SetType (const HighlightType &value)
void	SetType (HighlightType &&value)
Highlight &	WithType (const HighlightType &value)
Highlight &	WithType (HighlightType &&value)

Detailed Description

Provides information that you can use to highlight a search result so that your users can quickly identify terms in the response.

See Also:

AWS API Reference

Definition at line 32 of file Highlight.h.

Constructor & Destructor Documentation

Highlight() [1/2]

Aws::kendra::Model::Highlight::Highlight

(

)

Highlight() [2/2]

Aws::kendra::Model::Highlight::Highlight

(

Aws::Utils::Json::JsonView

jsonValue

)

Member Function Documentation

BeginOffsetHasBeenSet()

bool Aws::kendra::Model::Highlight::BeginOffsetHasBeenSet ( ) const

inline

The zero-based location in the response string where the highlight starts.

Definition at line 51 of file Highlight.h.

EndOffsetHasBeenSet()

bool Aws::kendra::Model::Highlight::EndOffsetHasBeenSet ( ) const

inline

The zero-based location in the response string where the highlight ends.

Definition at line 74 of file Highlight.h.

GetBeginOffset()

int Aws::kendra::Model::Highlight::GetBeginOffset ( ) const

inline

The zero-based location in the response string where the highlight starts.

Definition at line 45 of file Highlight.h.

GetEndOffset()

int Aws::kendra::Model::Highlight::GetEndOffset ( ) const

inline

The zero-based location in the response string where the highlight ends.

Definition at line 69 of file Highlight.h.

GetTopAnswer()

bool Aws::kendra::Model::Highlight::GetTopAnswer ( ) const

inline

Indicates whether the response is the best response. True if this is the best response; otherwise, false.

Definition at line 91 of file Highlight.h.

GetType()

const HighlightType& Aws::kendra::Model::Highlight::GetType ( ) const

inline

The highlight type.

Definition at line 115 of file Highlight.h.

Jsonize()

Aws::Utils::Json::JsonValue Aws::kendra::Model::Highlight::Jsonize

(

)

const

operator=()

Highlight& Aws::kendra::Model::Highlight::operator=

(

Aws::Utils::Json::JsonView

jsonValue

)

SetBeginOffset()

void Aws::kendra::Model::Highlight::SetBeginOffset ( int  value )

inline

The zero-based location in the response string where the highlight starts.

Definition at line 57 of file Highlight.h.

SetEndOffset()

void Aws::kendra::Model::Highlight::SetEndOffset ( int  value )

inline

The zero-based location in the response string where the highlight ends.

Definition at line 79 of file Highlight.h.

SetTopAnswer()

void Aws::kendra::Model::Highlight::SetTopAnswer ( bool  value )

inline

Indicates whether the response is the best response. True if this is the best response; otherwise, false.

Definition at line 103 of file Highlight.h.

SetType() [1/2]

void Aws::kendra::Model::Highlight::SetType ( const HighlightType &  value )

inline

The highlight type.

Definition at line 125 of file Highlight.h.

SetType() [2/2]

void Aws::kendra::Model::Highlight::SetType ( HighlightType &&  value )

inline

The highlight type.

Definition at line 130 of file Highlight.h.

TopAnswerHasBeenSet()

bool Aws::kendra::Model::Highlight::TopAnswerHasBeenSet ( ) const

inline

Indicates whether the response is the best response. True if this is the best response; otherwise, false.

Definition at line 97 of file Highlight.h.

TypeHasBeenSet()

bool Aws::kendra::Model::Highlight::TypeHasBeenSet ( ) const

inline

The highlight type.

Definition at line 120 of file Highlight.h.

WithBeginOffset()

Highlight& Aws::kendra::Model::Highlight::WithBeginOffset ( int  value )

inline

The zero-based location in the response string where the highlight starts.

Definition at line 63 of file Highlight.h.

WithEndOffset()

Highlight& Aws::kendra::Model::Highlight::WithEndOffset ( int  value )

inline

The zero-based location in the response string where the highlight ends.

Definition at line 84 of file Highlight.h.

WithTopAnswer()

Highlight& Aws::kendra::Model::Highlight::WithTopAnswer ( bool  value )

inline

Indicates whether the response is the best response. True if this is the best response; otherwise, false.

Definition at line 109 of file Highlight.h.

WithType() [1/2]

Highlight& Aws::kendra::Model::Highlight::WithType ( const HighlightType &  value )

inline

The highlight type.

Definition at line 135 of file Highlight.h.

WithType() [2/2]

Highlight& Aws::kendra::Model::Highlight::WithType ( HighlightType &&  value )

inline

The highlight type.

Definition at line 140 of file Highlight.h.

---

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

• aws-cpp-sdk-kendra/include/aws/kendra/model/Highlight.h