QueryRequest.h

 
#pragma once
#include <aws/kendra/Kendra_EXPORTS.h>
#include <aws/kendra/KendraRequest.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/kendra/model/AttributeFilter.h>
#include <aws/core/utils/memory/stl/AWSVector.h>
#include <aws/kendra/model/QueryResultType.h>
#include <aws/kendra/model/SortingConfiguration.h>
#include <aws/kendra/model/UserContext.h>
#include <aws/kendra/model/SpellCorrectionConfiguration.h>
#include <aws/kendra/model/CollapseConfiguration.h>
#include <aws/kendra/model/Facet.h>
#include <aws/kendra/model/DocumentRelevanceConfiguration.h>
#include <utility>
 
namespace Aws
{
namespace kendra
{
namespace Model
{
 
  class QueryRequest : public KendraRequest
  {
  public:
    AWS_KENDRA_API QueryRequest() = default;
 
    // Service request name is the Operation name which will send this request out,
    // each operation should has unique request name, so that we can get operation's name from this request.
    // Note: this is not true for response, multiple operations may have the same response name,
    // so we can not get operation's name from response.
    inline virtual const char* GetServiceRequestName() const override { return "Query"; }
 
    AWS_KENDRA_API Aws::String SerializePayload() const override;
 
    AWS_KENDRA_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
 
 
 
    inline const Aws::String& GetIndexId() const { return m_indexId; }
    inline bool IndexIdHasBeenSet() const { return m_indexIdHasBeenSet; }
    template<typename IndexIdT = Aws::String>
    void SetIndexId(IndexIdT&& value) { m_indexIdHasBeenSet = true; m_indexId = std::forward<IndexIdT>(value); }
    template<typename IndexIdT = Aws::String>
    QueryRequest& WithIndexId(IndexIdT&& value) { SetIndexId(std::forward<IndexIdT>(value)); return *this;}
 
 
    inline const Aws::String& GetQueryText() const { return m_queryText; }
    inline bool QueryTextHasBeenSet() const { return m_queryTextHasBeenSet; }
    template<typename QueryTextT = Aws::String>
    void SetQueryText(QueryTextT&& value) { m_queryTextHasBeenSet = true; m_queryText = std::forward<QueryTextT>(value); }
    template<typename QueryTextT = Aws::String>
    QueryRequest& WithQueryText(QueryTextT&& value) { SetQueryText(std::forward<QueryTextT>(value)); return *this;}
 
 
    inline const AttributeFilter& GetAttributeFilter() const { return m_attributeFilter; }
    inline bool AttributeFilterHasBeenSet() const { return m_attributeFilterHasBeenSet; }
    template<typename AttributeFilterT = AttributeFilter>
    void SetAttributeFilter(AttributeFilterT&& value) { m_attributeFilterHasBeenSet = true; m_attributeFilter = std::forward<AttributeFilterT>(value); }
    template<typename AttributeFilterT = AttributeFilter>
    QueryRequest& WithAttributeFilter(AttributeFilterT&& value) { SetAttributeFilter(std::forward<AttributeFilterT>(value)); return *this;}
 
 
    inline const Aws::Vector<Facet>& GetFacets() const { return m_facets; }
    inline bool FacetsHasBeenSet() const { return m_facetsHasBeenSet; }
    template<typename FacetsT = Aws::Vector<Facet>>
    void SetFacets(FacetsT&& value) { m_facetsHasBeenSet = true; m_facets = std::forward<FacetsT>(value); }
    template<typename FacetsT = Aws::Vector<Facet>>
    QueryRequest& WithFacets(FacetsT&& value) { SetFacets(std::forward<FacetsT>(value)); return *this;}
    template<typename FacetsT = Facet>
    QueryRequest& AddFacets(FacetsT&& value) { m_facetsHasBeenSet = true; m_facets.emplace_back(std::forward<FacetsT>(value)); return *this; }
 
 
    inline const Aws::Vector<Aws::String>& GetRequestedDocumentAttributes() const { return m_requestedDocumentAttributes; }
    inline bool RequestedDocumentAttributesHasBeenSet() const { return m_requestedDocumentAttributesHasBeenSet; }
    template<typename RequestedDocumentAttributesT = Aws::Vector<Aws::String>>
    void SetRequestedDocumentAttributes(RequestedDocumentAttributesT&& value) { m_requestedDocumentAttributesHasBeenSet = true; m_requestedDocumentAttributes = std::forward<RequestedDocumentAttributesT>(value); }
    template<typename RequestedDocumentAttributesT = Aws::Vector<Aws::String>>
    QueryRequest& WithRequestedDocumentAttributes(RequestedDocumentAttributesT&& value) { SetRequestedDocumentAttributes(std::forward<RequestedDocumentAttributesT>(value)); return *this;}
    template<typename RequestedDocumentAttributesT = Aws::String>
    QueryRequest& AddRequestedDocumentAttributes(RequestedDocumentAttributesT&& value) { m_requestedDocumentAttributesHasBeenSet = true; m_requestedDocumentAttributes.emplace_back(std::forward<RequestedDocumentAttributesT>(value)); return *this; }
 
 
    inline QueryResultType GetQueryResultTypeFilter() const { return m_queryResultTypeFilter; }
    inline bool QueryResultTypeFilterHasBeenSet() const { return m_queryResultTypeFilterHasBeenSet; }
    inline void SetQueryResultTypeFilter(QueryResultType value) { m_queryResultTypeFilterHasBeenSet = true; m_queryResultTypeFilter = value; }
    inline QueryRequest& WithQueryResultTypeFilter(QueryResultType value) { SetQueryResultTypeFilter(value); return *this;}
 
 
    inline const Aws::Vector<DocumentRelevanceConfiguration>& GetDocumentRelevanceOverrideConfigurations() const { return m_documentRelevanceOverrideConfigurations; }
    inline bool DocumentRelevanceOverrideConfigurationsHasBeenSet() const { return m_documentRelevanceOverrideConfigurationsHasBeenSet; }
    template<typename DocumentRelevanceOverrideConfigurationsT = Aws::Vector<DocumentRelevanceConfiguration>>
    void SetDocumentRelevanceOverrideConfigurations(DocumentRelevanceOverrideConfigurationsT&& value) { m_documentRelevanceOverrideConfigurationsHasBeenSet = true; m_documentRelevanceOverrideConfigurations = std::forward<DocumentRelevanceOverrideConfigurationsT>(value); }
    template<typename DocumentRelevanceOverrideConfigurationsT = Aws::Vector<DocumentRelevanceConfiguration>>
    QueryRequest& WithDocumentRelevanceOverrideConfigurations(DocumentRelevanceOverrideConfigurationsT&& value) { SetDocumentRelevanceOverrideConfigurations(std::forward<DocumentRelevanceOverrideConfigurationsT>(value)); return *this;}
    template<typename DocumentRelevanceOverrideConfigurationsT = DocumentRelevanceConfiguration>
    QueryRequest& AddDocumentRelevanceOverrideConfigurations(DocumentRelevanceOverrideConfigurationsT&& value) { m_documentRelevanceOverrideConfigurationsHasBeenSet = true; m_documentRelevanceOverrideConfigurations.emplace_back(std::forward<DocumentRelevanceOverrideConfigurationsT>(value)); return *this; }
 
 
    inline int GetPageNumber() const { return m_pageNumber; }
    inline bool PageNumberHasBeenSet() const { return m_pageNumberHasBeenSet; }
    inline void SetPageNumber(int value) { m_pageNumberHasBeenSet = true; m_pageNumber = value; }
    inline QueryRequest& WithPageNumber(int value) { SetPageNumber(value); return *this;}
 
 
    inline int GetPageSize() const { return m_pageSize; }
    inline bool PageSizeHasBeenSet() const { return m_pageSizeHasBeenSet; }
    inline void SetPageSize(int value) { m_pageSizeHasBeenSet = true; m_pageSize = value; }
    inline QueryRequest& WithPageSize(int value) { SetPageSize(value); return *this;}
 
 
    inline const SortingConfiguration& GetSortingConfiguration() const { return m_sortingConfiguration; }
    inline bool SortingConfigurationHasBeenSet() const { return m_sortingConfigurationHasBeenSet; }
    template<typename SortingConfigurationT = SortingConfiguration>
    void SetSortingConfiguration(SortingConfigurationT&& value) { m_sortingConfigurationHasBeenSet = true; m_sortingConfiguration = std::forward<SortingConfigurationT>(value); }
    template<typename SortingConfigurationT = SortingConfiguration>
    QueryRequest& WithSortingConfiguration(SortingConfigurationT&& value) { SetSortingConfiguration(std::forward<SortingConfigurationT>(value)); return *this;}
 
 
    inline const Aws::Vector<SortingConfiguration>& GetSortingConfigurations() const { return m_sortingConfigurations; }
    inline bool SortingConfigurationsHasBeenSet() const { return m_sortingConfigurationsHasBeenSet; }
    template<typename SortingConfigurationsT = Aws::Vector<SortingConfiguration>>
    void SetSortingConfigurations(SortingConfigurationsT&& value) { m_sortingConfigurationsHasBeenSet = true; m_sortingConfigurations = std::forward<SortingConfigurationsT>(value); }
    template<typename SortingConfigurationsT = Aws::Vector<SortingConfiguration>>
    QueryRequest& WithSortingConfigurations(SortingConfigurationsT&& value) { SetSortingConfigurations(std::forward<SortingConfigurationsT>(value)); return *this;}
    template<typename SortingConfigurationsT = SortingConfiguration>
    QueryRequest& AddSortingConfigurations(SortingConfigurationsT&& value) { m_sortingConfigurationsHasBeenSet = true; m_sortingConfigurations.emplace_back(std::forward<SortingConfigurationsT>(value)); return *this; }
 
 
    inline const UserContext& GetUserContext() const { return m_userContext; }
    inline bool UserContextHasBeenSet() const { return m_userContextHasBeenSet; }
    template<typename UserContextT = UserContext>
    void SetUserContext(UserContextT&& value) { m_userContextHasBeenSet = true; m_userContext = std::forward<UserContextT>(value); }
    template<typename UserContextT = UserContext>
    QueryRequest& WithUserContext(UserContextT&& value) { SetUserContext(std::forward<UserContextT>(value)); return *this;}
 
 
    inline const Aws::String& GetVisitorId() const { return m_visitorId; }
    inline bool VisitorIdHasBeenSet() const { return m_visitorIdHasBeenSet; }
    template<typename VisitorIdT = Aws::String>
    void SetVisitorId(VisitorIdT&& value) { m_visitorIdHasBeenSet = true; m_visitorId = std::forward<VisitorIdT>(value); }
    template<typename VisitorIdT = Aws::String>
    QueryRequest& WithVisitorId(VisitorIdT&& value) { SetVisitorId(std::forward<VisitorIdT>(value)); return *this;}
 
 
    inline const SpellCorrectionConfiguration& GetSpellCorrectionConfiguration() const { return m_spellCorrectionConfiguration; }
    inline bool SpellCorrectionConfigurationHasBeenSet() const { return m_spellCorrectionConfigurationHasBeenSet; }
    template<typename SpellCorrectionConfigurationT = SpellCorrectionConfiguration>
    void SetSpellCorrectionConfiguration(SpellCorrectionConfigurationT&& value) { m_spellCorrectionConfigurationHasBeenSet = true; m_spellCorrectionConfiguration = std::forward<SpellCorrectionConfigurationT>(value); }
    template<typename SpellCorrectionConfigurationT = SpellCorrectionConfiguration>
    QueryRequest& WithSpellCorrectionConfiguration(SpellCorrectionConfigurationT&& value) { SetSpellCorrectionConfiguration(std::forward<SpellCorrectionConfigurationT>(value)); return *this;}
 
 
    inline const CollapseConfiguration& GetCollapseConfiguration() const { return m_collapseConfiguration; }
    inline bool CollapseConfigurationHasBeenSet() const { return m_collapseConfigurationHasBeenSet; }
    template<typename CollapseConfigurationT = CollapseConfiguration>
    void SetCollapseConfiguration(CollapseConfigurationT&& value) { m_collapseConfigurationHasBeenSet = true; m_collapseConfiguration = std::forward<CollapseConfigurationT>(value); }
    template<typename CollapseConfigurationT = CollapseConfiguration>
    QueryRequest& WithCollapseConfiguration(CollapseConfigurationT&& value) { SetCollapseConfiguration(std::forward<CollapseConfigurationT>(value)); return *this;}
  private:
 
    Aws::String m_indexId;
    bool m_indexIdHasBeenSet = false;
 
    Aws::String m_queryText;
    bool m_queryTextHasBeenSet = false;
 
    AttributeFilter m_attributeFilter;
    bool m_attributeFilterHasBeenSet = false;
 
    Aws::Vector<Facet> m_facets;
    bool m_facetsHasBeenSet = false;
 
    Aws::Vector<Aws::String> m_requestedDocumentAttributes;
    bool m_requestedDocumentAttributesHasBeenSet = false;
 
    QueryResultType m_queryResultTypeFilter{QueryResultType::NOT_SET};
    bool m_queryResultTypeFilterHasBeenSet = false;
 
    Aws::Vector<DocumentRelevanceConfiguration> m_documentRelevanceOverrideConfigurations;
    bool m_documentRelevanceOverrideConfigurationsHasBeenSet = false;
 
    int m_pageNumber{0};
    bool m_pageNumberHasBeenSet = false;
 
    int m_pageSize{0};
    bool m_pageSizeHasBeenSet = false;
 
    SortingConfiguration m_sortingConfiguration;
    bool m_sortingConfigurationHasBeenSet = false;
 
    Aws::Vector<SortingConfiguration> m_sortingConfigurations;
    bool m_sortingConfigurationsHasBeenSet = false;
 
    UserContext m_userContext;
    bool m_userContextHasBeenSet = false;
 
    Aws::String m_visitorId;
    bool m_visitorIdHasBeenSet = false;
 
    SpellCorrectionConfiguration m_spellCorrectionConfiguration;
    bool m_spellCorrectionConfigurationHasBeenSet = false;
 
    CollapseConfiguration m_collapseConfiguration;
    bool m_collapseConfigurationHasBeenSet = false;
  };
 
} // namespace Model
} // namespace kendra
} // namespace Aws