QueryResultItem.h

 
#pragma once
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/core/utils/memory/stl/AWSVector.h>
#include <aws/kendra/Kendra_EXPORTS.h>
#include <aws/kendra/model/AdditionalResultAttribute.h>
#include <aws/kendra/model/CollapsedResultDetail.h>
#include <aws/kendra/model/DocumentAttribute.h>
#include <aws/kendra/model/QueryResultFormat.h>
#include <aws/kendra/model/QueryResultType.h>
#include <aws/kendra/model/ScoreAttributes.h>
#include <aws/kendra/model/TableExcerpt.h>
#include <aws/kendra/model/TextWithHighlights.h>
 
#include <utility>
 
namespace Aws {
namespace Utils {
namespace Json {
class JsonValue;
class JsonView;
}  // namespace Json
}  // namespace Utils
namespace kendra {
namespace Model {
 
class QueryResultItem {
 public:
  AWS_KENDRA_API QueryResultItem() = default;
  AWS_KENDRA_API QueryResultItem(Aws::Utils::Json::JsonView jsonValue);
  AWS_KENDRA_API QueryResultItem& operator=(Aws::Utils::Json::JsonView jsonValue);
  AWS_KENDRA_API Aws::Utils::Json::JsonValue Jsonize() const;
 
 
  inline const Aws::String& GetId() const { return m_id; }
  inline bool IdHasBeenSet() const { return m_idHasBeenSet; }
  template <typename IdT = Aws::String>
  void SetId(IdT&& value) {
    m_idHasBeenSet = true;
    m_id = std::forward<IdT>(value);
  }
  template <typename IdT = Aws::String>
  QueryResultItem& WithId(IdT&& value) {
    SetId(std::forward<IdT>(value));
    return *this;
  }
 
 
  inline QueryResultType GetType() const { return m_type; }
  inline bool TypeHasBeenSet() const { return m_typeHasBeenSet; }
  inline void SetType(QueryResultType value) {
    m_typeHasBeenSet = true;
    m_type = value;
  }
  inline QueryResultItem& WithType(QueryResultType value) {
    SetType(value);
    return *this;
  }
 
 
  inline QueryResultFormat GetFormat() const { return m_format; }
  inline bool FormatHasBeenSet() const { return m_formatHasBeenSet; }
  inline void SetFormat(QueryResultFormat value) {
    m_formatHasBeenSet = true;
    m_format = value;
  }
  inline QueryResultItem& WithFormat(QueryResultFormat value) {
    SetFormat(value);
    return *this;
  }
 
 
  inline const Aws::Vector<AdditionalResultAttribute>& GetAdditionalAttributes() const { return m_additionalAttributes; }
  inline bool AdditionalAttributesHasBeenSet() const { return m_additionalAttributesHasBeenSet; }
  template <typename AdditionalAttributesT = Aws::Vector<AdditionalResultAttribute>>
  void SetAdditionalAttributes(AdditionalAttributesT&& value) {
    m_additionalAttributesHasBeenSet = true;
    m_additionalAttributes = std::forward<AdditionalAttributesT>(value);
  }
  template <typename AdditionalAttributesT = Aws::Vector<AdditionalResultAttribute>>
  QueryResultItem& WithAdditionalAttributes(AdditionalAttributesT&& value) {
    SetAdditionalAttributes(std::forward<AdditionalAttributesT>(value));
    return *this;
  }
  template <typename AdditionalAttributesT = AdditionalResultAttribute>
  QueryResultItem& AddAdditionalAttributes(AdditionalAttributesT&& value) {
    m_additionalAttributesHasBeenSet = true;
    m_additionalAttributes.emplace_back(std::forward<AdditionalAttributesT>(value));
    return *this;
  }
 
 
  inline const Aws::String& GetDocumentId() const { return m_documentId; }
  inline bool DocumentIdHasBeenSet() const { return m_documentIdHasBeenSet; }
  template <typename DocumentIdT = Aws::String>
  void SetDocumentId(DocumentIdT&& value) {
    m_documentIdHasBeenSet = true;
    m_documentId = std::forward<DocumentIdT>(value);
  }
  template <typename DocumentIdT = Aws::String>
  QueryResultItem& WithDocumentId(DocumentIdT&& value) {
    SetDocumentId(std::forward<DocumentIdT>(value));
    return *this;
  }
 
 
  inline const TextWithHighlights& GetDocumentTitle() const { return m_documentTitle; }
  inline bool DocumentTitleHasBeenSet() const { return m_documentTitleHasBeenSet; }
  template <typename DocumentTitleT = TextWithHighlights>
  void SetDocumentTitle(DocumentTitleT&& value) {
    m_documentTitleHasBeenSet = true;
    m_documentTitle = std::forward<DocumentTitleT>(value);
  }
  template <typename DocumentTitleT = TextWithHighlights>
  QueryResultItem& WithDocumentTitle(DocumentTitleT&& value) {
    SetDocumentTitle(std::forward<DocumentTitleT>(value));
    return *this;
  }
 
 
  inline const TextWithHighlights& GetDocumentExcerpt() const { return m_documentExcerpt; }
  inline bool DocumentExcerptHasBeenSet() const { return m_documentExcerptHasBeenSet; }
  template <typename DocumentExcerptT = TextWithHighlights>
  void SetDocumentExcerpt(DocumentExcerptT&& value) {
    m_documentExcerptHasBeenSet = true;
    m_documentExcerpt = std::forward<DocumentExcerptT>(value);
  }
  template <typename DocumentExcerptT = TextWithHighlights>
  QueryResultItem& WithDocumentExcerpt(DocumentExcerptT&& value) {
    SetDocumentExcerpt(std::forward<DocumentExcerptT>(value));
    return *this;
  }
 
 
  inline const Aws::String& GetDocumentURI() const { return m_documentURI; }
  inline bool DocumentURIHasBeenSet() const { return m_documentURIHasBeenSet; }
  template <typename DocumentURIT = Aws::String>
  void SetDocumentURI(DocumentURIT&& value) {
    m_documentURIHasBeenSet = true;
    m_documentURI = std::forward<DocumentURIT>(value);
  }
  template <typename DocumentURIT = Aws::String>
  QueryResultItem& WithDocumentURI(DocumentURIT&& value) {
    SetDocumentURI(std::forward<DocumentURIT>(value));
    return *this;
  }
 
 
  inline const Aws::Vector<DocumentAttribute>& GetDocumentAttributes() const { return m_documentAttributes; }
  inline bool DocumentAttributesHasBeenSet() const { return m_documentAttributesHasBeenSet; }
  template <typename DocumentAttributesT = Aws::Vector<DocumentAttribute>>
  void SetDocumentAttributes(DocumentAttributesT&& value) {
    m_documentAttributesHasBeenSet = true;
    m_documentAttributes = std::forward<DocumentAttributesT>(value);
  }
  template <typename DocumentAttributesT = Aws::Vector<DocumentAttribute>>
  QueryResultItem& WithDocumentAttributes(DocumentAttributesT&& value) {
    SetDocumentAttributes(std::forward<DocumentAttributesT>(value));
    return *this;
  }
  template <typename DocumentAttributesT = DocumentAttribute>
  QueryResultItem& AddDocumentAttributes(DocumentAttributesT&& value) {
    m_documentAttributesHasBeenSet = true;
    m_documentAttributes.emplace_back(std::forward<DocumentAttributesT>(value));
    return *this;
  }
 
 
  inline const ScoreAttributes& GetScoreAttributes() const { return m_scoreAttributes; }
  inline bool ScoreAttributesHasBeenSet() const { return m_scoreAttributesHasBeenSet; }
  template <typename ScoreAttributesT = ScoreAttributes>
  void SetScoreAttributes(ScoreAttributesT&& value) {
    m_scoreAttributesHasBeenSet = true;
    m_scoreAttributes = std::forward<ScoreAttributesT>(value);
  }
  template <typename ScoreAttributesT = ScoreAttributes>
  QueryResultItem& WithScoreAttributes(ScoreAttributesT&& value) {
    SetScoreAttributes(std::forward<ScoreAttributesT>(value));
    return *this;
  }
 
 
  inline const Aws::String& GetFeedbackToken() const { return m_feedbackToken; }
  inline bool FeedbackTokenHasBeenSet() const { return m_feedbackTokenHasBeenSet; }
  template <typename FeedbackTokenT = Aws::String>
  void SetFeedbackToken(FeedbackTokenT&& value) {
    m_feedbackTokenHasBeenSet = true;
    m_feedbackToken = std::forward<FeedbackTokenT>(value);
  }
  template <typename FeedbackTokenT = Aws::String>
  QueryResultItem& WithFeedbackToken(FeedbackTokenT&& value) {
    SetFeedbackToken(std::forward<FeedbackTokenT>(value));
    return *this;
  }
 
 
  inline const TableExcerpt& GetTableExcerpt() const { return m_tableExcerpt; }
  inline bool TableExcerptHasBeenSet() const { return m_tableExcerptHasBeenSet; }
  template <typename TableExcerptT = TableExcerpt>
  void SetTableExcerpt(TableExcerptT&& value) {
    m_tableExcerptHasBeenSet = true;
    m_tableExcerpt = std::forward<TableExcerptT>(value);
  }
  template <typename TableExcerptT = TableExcerpt>
  QueryResultItem& WithTableExcerpt(TableExcerptT&& value) {
    SetTableExcerpt(std::forward<TableExcerptT>(value));
    return *this;
  }
 
 
  inline const CollapsedResultDetail& GetCollapsedResultDetail() const { return m_collapsedResultDetail; }
  inline bool CollapsedResultDetailHasBeenSet() const { return m_collapsedResultDetailHasBeenSet; }
  template <typename CollapsedResultDetailT = CollapsedResultDetail>
  void SetCollapsedResultDetail(CollapsedResultDetailT&& value) {
    m_collapsedResultDetailHasBeenSet = true;
    m_collapsedResultDetail = std::forward<CollapsedResultDetailT>(value);
  }
  template <typename CollapsedResultDetailT = CollapsedResultDetail>
  QueryResultItem& WithCollapsedResultDetail(CollapsedResultDetailT&& value) {
    SetCollapsedResultDetail(std::forward<CollapsedResultDetailT>(value));
    return *this;
  }
 private:
  Aws::String m_id;
 
  QueryResultType m_type{QueryResultType::NOT_SET};
 
  QueryResultFormat m_format{QueryResultFormat::NOT_SET};
 
  Aws::Vector<AdditionalResultAttribute> m_additionalAttributes;
 
  Aws::String m_documentId;
 
  TextWithHighlights m_documentTitle;
 
  TextWithHighlights m_documentExcerpt;
 
  Aws::String m_documentURI;
 
  Aws::Vector<DocumentAttribute> m_documentAttributes;
 
  ScoreAttributes m_scoreAttributes;
 
  Aws::String m_feedbackToken;
 
  TableExcerpt m_tableExcerpt;
 
  CollapsedResultDetail m_collapsedResultDetail;
  bool m_idHasBeenSet = false;
  bool m_typeHasBeenSet = false;
  bool m_formatHasBeenSet = false;
  bool m_additionalAttributesHasBeenSet = false;
  bool m_documentIdHasBeenSet = false;
  bool m_documentTitleHasBeenSet = false;
  bool m_documentExcerptHasBeenSet = false;
  bool m_documentURIHasBeenSet = false;
  bool m_documentAttributesHasBeenSet = false;
  bool m_scoreAttributesHasBeenSet = false;
  bool m_feedbackTokenHasBeenSet = false;
  bool m_tableExcerptHasBeenSet = false;
  bool m_collapsedResultDetailHasBeenSet = false;
};
 
}  // namespace Model
}  // namespace kendra
}  // namespace Aws