/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include namespace Aws { namespace LexModelsV2 { namespace Model { /** */ class ListSessionAnalyticsDataRequest : public LexModelsV2Request { public: AWS_LEXMODELSV2_API ListSessionAnalyticsDataRequest(); // 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 "ListSessionAnalyticsData"; } AWS_LEXMODELSV2_API Aws::String SerializePayload() const override; /** *

The identifier for the bot for which you want to retrieve session * analytics.

*/ inline const Aws::String& GetBotId() const{ return m_botId; } /** *

The identifier for the bot for which you want to retrieve session * analytics.

*/ inline bool BotIdHasBeenSet() const { return m_botIdHasBeenSet; } /** *

The identifier for the bot for which you want to retrieve session * analytics.

*/ inline void SetBotId(const Aws::String& value) { m_botIdHasBeenSet = true; m_botId = value; } /** *

The identifier for the bot for which you want to retrieve session * analytics.

*/ inline void SetBotId(Aws::String&& value) { m_botIdHasBeenSet = true; m_botId = std::move(value); } /** *

The identifier for the bot for which you want to retrieve session * analytics.

*/ inline void SetBotId(const char* value) { m_botIdHasBeenSet = true; m_botId.assign(value); } /** *

The identifier for the bot for which you want to retrieve session * analytics.

*/ inline ListSessionAnalyticsDataRequest& WithBotId(const Aws::String& value) { SetBotId(value); return *this;} /** *

The identifier for the bot for which you want to retrieve session * analytics.

*/ inline ListSessionAnalyticsDataRequest& WithBotId(Aws::String&& value) { SetBotId(std::move(value)); return *this;} /** *

The identifier for the bot for which you want to retrieve session * analytics.

*/ inline ListSessionAnalyticsDataRequest& WithBotId(const char* value) { SetBotId(value); return *this;} /** *

The date and time that marks the beginning of the range of time for which you * want to see session analytics.

*/ inline const Aws::Utils::DateTime& GetStartDateTime() const{ return m_startDateTime; } /** *

The date and time that marks the beginning of the range of time for which you * want to see session analytics.

*/ inline bool StartDateTimeHasBeenSet() const { return m_startDateTimeHasBeenSet; } /** *

The date and time that marks the beginning of the range of time for which you * want to see session analytics.

*/ inline void SetStartDateTime(const Aws::Utils::DateTime& value) { m_startDateTimeHasBeenSet = true; m_startDateTime = value; } /** *

The date and time that marks the beginning of the range of time for which you * want to see session analytics.

*/ inline void SetStartDateTime(Aws::Utils::DateTime&& value) { m_startDateTimeHasBeenSet = true; m_startDateTime = std::move(value); } /** *

The date and time that marks the beginning of the range of time for which you * want to see session analytics.

*/ inline ListSessionAnalyticsDataRequest& WithStartDateTime(const Aws::Utils::DateTime& value) { SetStartDateTime(value); return *this;} /** *

The date and time that marks the beginning of the range of time for which you * want to see session analytics.

*/ inline ListSessionAnalyticsDataRequest& WithStartDateTime(Aws::Utils::DateTime&& value) { SetStartDateTime(std::move(value)); return *this;} /** *

The date and time that marks the end of the range of time for which you want * to see session analytics.

*/ inline const Aws::Utils::DateTime& GetEndDateTime() const{ return m_endDateTime; } /** *

The date and time that marks the end of the range of time for which you want * to see session analytics.

*/ inline bool EndDateTimeHasBeenSet() const { return m_endDateTimeHasBeenSet; } /** *

The date and time that marks the end of the range of time for which you want * to see session analytics.

*/ inline void SetEndDateTime(const Aws::Utils::DateTime& value) { m_endDateTimeHasBeenSet = true; m_endDateTime = value; } /** *

The date and time that marks the end of the range of time for which you want * to see session analytics.

*/ inline void SetEndDateTime(Aws::Utils::DateTime&& value) { m_endDateTimeHasBeenSet = true; m_endDateTime = std::move(value); } /** *

The date and time that marks the end of the range of time for which you want * to see session analytics.

*/ inline ListSessionAnalyticsDataRequest& WithEndDateTime(const Aws::Utils::DateTime& value) { SetEndDateTime(value); return *this;} /** *

The date and time that marks the end of the range of time for which you want * to see session analytics.

*/ inline ListSessionAnalyticsDataRequest& WithEndDateTime(Aws::Utils::DateTime&& value) { SetEndDateTime(std::move(value)); return *this;} /** *

An object specifying the measure and method by which to sort the session * analytics data.

*/ inline const SessionDataSortBy& GetSortBy() const{ return m_sortBy; } /** *

An object specifying the measure and method by which to sort the session * analytics data.

*/ inline bool SortByHasBeenSet() const { return m_sortByHasBeenSet; } /** *

An object specifying the measure and method by which to sort the session * analytics data.

*/ inline void SetSortBy(const SessionDataSortBy& value) { m_sortByHasBeenSet = true; m_sortBy = value; } /** *

An object specifying the measure and method by which to sort the session * analytics data.

*/ inline void SetSortBy(SessionDataSortBy&& value) { m_sortByHasBeenSet = true; m_sortBy = std::move(value); } /** *

An object specifying the measure and method by which to sort the session * analytics data.

*/ inline ListSessionAnalyticsDataRequest& WithSortBy(const SessionDataSortBy& value) { SetSortBy(value); return *this;} /** *

An object specifying the measure and method by which to sort the session * analytics data.

*/ inline ListSessionAnalyticsDataRequest& WithSortBy(SessionDataSortBy&& value) { SetSortBy(std::move(value)); return *this;} /** *

A list of objects, each of which describes a condition by which you want to * filter the results.

*/ inline const Aws::Vector& GetFilters() const{ return m_filters; } /** *

A list of objects, each of which describes a condition by which you want to * filter the results.

*/ inline bool FiltersHasBeenSet() const { return m_filtersHasBeenSet; } /** *

A list of objects, each of which describes a condition by which you want to * filter the results.

*/ inline void SetFilters(const Aws::Vector& value) { m_filtersHasBeenSet = true; m_filters = value; } /** *

A list of objects, each of which describes a condition by which you want to * filter the results.

*/ inline void SetFilters(Aws::Vector&& value) { m_filtersHasBeenSet = true; m_filters = std::move(value); } /** *

A list of objects, each of which describes a condition by which you want to * filter the results.

*/ inline ListSessionAnalyticsDataRequest& WithFilters(const Aws::Vector& value) { SetFilters(value); return *this;} /** *

A list of objects, each of which describes a condition by which you want to * filter the results.

*/ inline ListSessionAnalyticsDataRequest& WithFilters(Aws::Vector&& value) { SetFilters(std::move(value)); return *this;} /** *

A list of objects, each of which describes a condition by which you want to * filter the results.

*/ inline ListSessionAnalyticsDataRequest& AddFilters(const AnalyticsSessionFilter& value) { m_filtersHasBeenSet = true; m_filters.push_back(value); return *this; } /** *

A list of objects, each of which describes a condition by which you want to * filter the results.

*/ inline ListSessionAnalyticsDataRequest& AddFilters(AnalyticsSessionFilter&& value) { m_filtersHasBeenSet = true; m_filters.push_back(std::move(value)); return *this; } /** *

The maximum number of results to return in each page of results. If there are * fewer results than the maximum page size, only the actual number of results are * returned.

*/ inline int GetMaxResults() const{ return m_maxResults; } /** *

The maximum number of results to return in each page of results. If there are * fewer results than the maximum page size, only the actual number of results are * returned.

*/ inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; } /** *

The maximum number of results to return in each page of results. If there are * fewer results than the maximum page size, only the actual number of results are * returned.

*/ inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; } /** *

The maximum number of results to return in each page of results. If there are * fewer results than the maximum page size, only the actual number of results are * returned.

*/ inline ListSessionAnalyticsDataRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} /** *

If the response from the ListSessionAnalyticsData operation contains more * results than specified in the maxResults parameter, a token is returned in the * response.

Use the returned token in the nextToken parameter of a * ListSessionAnalyticsData request to return the next page of results. For a * complete set of results, call the ListSessionAnalyticsData operation until the * nextToken returned in the response is null.

*/ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** *

If the response from the ListSessionAnalyticsData operation contains more * results than specified in the maxResults parameter, a token is returned in the * response.

Use the returned token in the nextToken parameter of a * ListSessionAnalyticsData request to return the next page of results. For a * complete set of results, call the ListSessionAnalyticsData operation until the * nextToken returned in the response is null.

*/ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

If the response from the ListSessionAnalyticsData operation contains more * results than specified in the maxResults parameter, a token is returned in the * response.

Use the returned token in the nextToken parameter of a * ListSessionAnalyticsData request to return the next page of results. For a * complete set of results, call the ListSessionAnalyticsData operation until the * nextToken returned in the response is null.

*/ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *

If the response from the ListSessionAnalyticsData operation contains more * results than specified in the maxResults parameter, a token is returned in the * response.

Use the returned token in the nextToken parameter of a * ListSessionAnalyticsData request to return the next page of results. For a * complete set of results, call the ListSessionAnalyticsData operation until the * nextToken returned in the response is null.

*/ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *

If the response from the ListSessionAnalyticsData operation contains more * results than specified in the maxResults parameter, a token is returned in the * response.

Use the returned token in the nextToken parameter of a * ListSessionAnalyticsData request to return the next page of results. For a * complete set of results, call the ListSessionAnalyticsData operation until the * nextToken returned in the response is null.

*/ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *

If the response from the ListSessionAnalyticsData operation contains more * results than specified in the maxResults parameter, a token is returned in the * response.

Use the returned token in the nextToken parameter of a * ListSessionAnalyticsData request to return the next page of results. For a * complete set of results, call the ListSessionAnalyticsData operation until the * nextToken returned in the response is null.

*/ inline ListSessionAnalyticsDataRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

If the response from the ListSessionAnalyticsData operation contains more * results than specified in the maxResults parameter, a token is returned in the * response.

Use the returned token in the nextToken parameter of a * ListSessionAnalyticsData request to return the next page of results. For a * complete set of results, call the ListSessionAnalyticsData operation until the * nextToken returned in the response is null.

*/ inline ListSessionAnalyticsDataRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

If the response from the ListSessionAnalyticsData operation contains more * results than specified in the maxResults parameter, a token is returned in the * response.

Use the returned token in the nextToken parameter of a * ListSessionAnalyticsData request to return the next page of results. For a * complete set of results, call the ListSessionAnalyticsData operation until the * nextToken returned in the response is null.

*/ inline ListSessionAnalyticsDataRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} private: Aws::String m_botId; bool m_botIdHasBeenSet = false; Aws::Utils::DateTime m_startDateTime; bool m_startDateTimeHasBeenSet = false; Aws::Utils::DateTime m_endDateTime; bool m_endDateTimeHasBeenSet = false; SessionDataSortBy m_sortBy; bool m_sortByHasBeenSet = false; Aws::Vector m_filters; bool m_filtersHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; }; } // namespace Model } // namespace LexModelsV2 } // namespace Aws