/** * 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 namespace Aws { namespace Http { class URI; } //namespace Http namespace CodeGuruProfiler { namespace Model { /** *

The structure representing the listProfileTimesRequest.

See * Also:

AWS * API Reference

*/ class ListProfileTimesRequest : public CodeGuruProfilerRequest { public: AWS_CODEGURUPROFILER_API ListProfileTimesRequest(); // 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 "ListProfileTimes"; } AWS_CODEGURUPROFILER_API Aws::String SerializePayload() const override; AWS_CODEGURUPROFILER_API void AddQueryStringParameters(Aws::Http::URI& uri) const override; /** *

The end time of the time range from which to list the profiles.

*/ inline const Aws::Utils::DateTime& GetEndTime() const{ return m_endTime; } /** *

The end time of the time range from which to list the profiles.

*/ inline bool EndTimeHasBeenSet() const { return m_endTimeHasBeenSet; } /** *

The end time of the time range from which to list the profiles.

*/ inline void SetEndTime(const Aws::Utils::DateTime& value) { m_endTimeHasBeenSet = true; m_endTime = value; } /** *

The end time of the time range from which to list the profiles.

*/ inline void SetEndTime(Aws::Utils::DateTime&& value) { m_endTimeHasBeenSet = true; m_endTime = std::move(value); } /** *

The end time of the time range from which to list the profiles.

*/ inline ListProfileTimesRequest& WithEndTime(const Aws::Utils::DateTime& value) { SetEndTime(value); return *this;} /** *

The end time of the time range from which to list the profiles.

*/ inline ListProfileTimesRequest& WithEndTime(Aws::Utils::DateTime&& value) { SetEndTime(std::move(value)); return *this;} /** *

The maximum number of profile time results returned by * ListProfileTimes in paginated output. When this parameter is used, * ListProfileTimes only returns maxResults results in a * single page with a nextToken response element. The remaining * results of the initial request can be seen by sending another * ListProfileTimes request with the returned nextToken * value.

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

The maximum number of profile time results returned by * ListProfileTimes in paginated output. When this parameter is used, * ListProfileTimes only returns maxResults results in a * single page with a nextToken response element. The remaining * results of the initial request can be seen by sending another * ListProfileTimes request with the returned nextToken * value.

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

The maximum number of profile time results returned by * ListProfileTimes in paginated output. When this parameter is used, * ListProfileTimes only returns maxResults results in a * single page with a nextToken response element. The remaining * results of the initial request can be seen by sending another * ListProfileTimes request with the returned nextToken * value.

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

The maximum number of profile time results returned by * ListProfileTimes in paginated output. When this parameter is used, * ListProfileTimes only returns maxResults results in a * single page with a nextToken response element. The remaining * results of the initial request can be seen by sending another * ListProfileTimes request with the returned nextToken * value.

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

The nextToken value returned from a previous paginated * ListProfileTimes request where maxResults was used and * the results exceeded the value of that parameter. Pagination continues from the * end of the previous results that returned the nextToken value.

*

This token should be treated as an opaque identifier that is only used * to retrieve the next items in a list and not for other programmatic * purposes.

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

The nextToken value returned from a previous paginated * ListProfileTimes request where maxResults was used and * the results exceeded the value of that parameter. Pagination continues from the * end of the previous results that returned the nextToken value.

*

This token should be treated as an opaque identifier that is only used * to retrieve the next items in a list and not for other programmatic * purposes.

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

The nextToken value returned from a previous paginated * ListProfileTimes request where maxResults was used and * the results exceeded the value of that parameter. Pagination continues from the * end of the previous results that returned the nextToken value.

*

This token should be treated as an opaque identifier that is only used * to retrieve the next items in a list and not for other programmatic * purposes.

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

The nextToken value returned from a previous paginated * ListProfileTimes request where maxResults was used and * the results exceeded the value of that parameter. Pagination continues from the * end of the previous results that returned the nextToken value.

*

This token should be treated as an opaque identifier that is only used * to retrieve the next items in a list and not for other programmatic * purposes.

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

The nextToken value returned from a previous paginated * ListProfileTimes request where maxResults was used and * the results exceeded the value of that parameter. Pagination continues from the * end of the previous results that returned the nextToken value.

*

This token should be treated as an opaque identifier that is only used * to retrieve the next items in a list and not for other programmatic * purposes.

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

The nextToken value returned from a previous paginated * ListProfileTimes request where maxResults was used and * the results exceeded the value of that parameter. Pagination continues from the * end of the previous results that returned the nextToken value.

*

This token should be treated as an opaque identifier that is only used * to retrieve the next items in a list and not for other programmatic * purposes.

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

The nextToken value returned from a previous paginated * ListProfileTimes request where maxResults was used and * the results exceeded the value of that parameter. Pagination continues from the * end of the previous results that returned the nextToken value.

*

This token should be treated as an opaque identifier that is only used * to retrieve the next items in a list and not for other programmatic * purposes.

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

The nextToken value returned from a previous paginated * ListProfileTimes request where maxResults was used and * the results exceeded the value of that parameter. Pagination continues from the * end of the previous results that returned the nextToken value.

*

This token should be treated as an opaque identifier that is only used * to retrieve the next items in a list and not for other programmatic * purposes.

*/ inline ListProfileTimesRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} /** *

The order (ascending or descending by start time of the profile) to use when * listing profiles. Defaults to TIMESTAMP_DESCENDING.

*/ inline const OrderBy& GetOrderBy() const{ return m_orderBy; } /** *

The order (ascending or descending by start time of the profile) to use when * listing profiles. Defaults to TIMESTAMP_DESCENDING.

*/ inline bool OrderByHasBeenSet() const { return m_orderByHasBeenSet; } /** *

The order (ascending or descending by start time of the profile) to use when * listing profiles. Defaults to TIMESTAMP_DESCENDING.

*/ inline void SetOrderBy(const OrderBy& value) { m_orderByHasBeenSet = true; m_orderBy = value; } /** *

The order (ascending or descending by start time of the profile) to use when * listing profiles. Defaults to TIMESTAMP_DESCENDING.

*/ inline void SetOrderBy(OrderBy&& value) { m_orderByHasBeenSet = true; m_orderBy = std::move(value); } /** *

The order (ascending or descending by start time of the profile) to use when * listing profiles. Defaults to TIMESTAMP_DESCENDING.

*/ inline ListProfileTimesRequest& WithOrderBy(const OrderBy& value) { SetOrderBy(value); return *this;} /** *

The order (ascending or descending by start time of the profile) to use when * listing profiles. Defaults to TIMESTAMP_DESCENDING.

*/ inline ListProfileTimesRequest& WithOrderBy(OrderBy&& value) { SetOrderBy(std::move(value)); return *this;} /** *

The aggregation period. This specifies the period during which an * aggregation profile collects posted agent profiles for a profiling group. There * are 3 valid values.

  • P1D — 1 day

  • *

    PT1H — 1 hour

  • PT5M — 5 minutes *

*/ inline const AggregationPeriod& GetPeriod() const{ return m_period; } /** *

The aggregation period. This specifies the period during which an * aggregation profile collects posted agent profiles for a profiling group. There * are 3 valid values.

  • P1D — 1 day

  • *

    PT1H — 1 hour

  • PT5M — 5 minutes *

*/ inline bool PeriodHasBeenSet() const { return m_periodHasBeenSet; } /** *

The aggregation period. This specifies the period during which an * aggregation profile collects posted agent profiles for a profiling group. There * are 3 valid values.

  • P1D — 1 day

  • *

    PT1H — 1 hour

  • PT5M — 5 minutes *

*/ inline void SetPeriod(const AggregationPeriod& value) { m_periodHasBeenSet = true; m_period = value; } /** *

The aggregation period. This specifies the period during which an * aggregation profile collects posted agent profiles for a profiling group. There * are 3 valid values.

  • P1D — 1 day

  • *

    PT1H — 1 hour

  • PT5M — 5 minutes *

*/ inline void SetPeriod(AggregationPeriod&& value) { m_periodHasBeenSet = true; m_period = std::move(value); } /** *

The aggregation period. This specifies the period during which an * aggregation profile collects posted agent profiles for a profiling group. There * are 3 valid values.

  • P1D — 1 day

  • *

    PT1H — 1 hour

  • PT5M — 5 minutes *

*/ inline ListProfileTimesRequest& WithPeriod(const AggregationPeriod& value) { SetPeriod(value); return *this;} /** *

The aggregation period. This specifies the period during which an * aggregation profile collects posted agent profiles for a profiling group. There * are 3 valid values.

  • P1D — 1 day

  • *

    PT1H — 1 hour

  • PT5M — 5 minutes *

*/ inline ListProfileTimesRequest& WithPeriod(AggregationPeriod&& value) { SetPeriod(std::move(value)); return *this;} /** *

The name of the profiling group.

*/ inline const Aws::String& GetProfilingGroupName() const{ return m_profilingGroupName; } /** *

The name of the profiling group.

*/ inline bool ProfilingGroupNameHasBeenSet() const { return m_profilingGroupNameHasBeenSet; } /** *

The name of the profiling group.

*/ inline void SetProfilingGroupName(const Aws::String& value) { m_profilingGroupNameHasBeenSet = true; m_profilingGroupName = value; } /** *

The name of the profiling group.

*/ inline void SetProfilingGroupName(Aws::String&& value) { m_profilingGroupNameHasBeenSet = true; m_profilingGroupName = std::move(value); } /** *

The name of the profiling group.

*/ inline void SetProfilingGroupName(const char* value) { m_profilingGroupNameHasBeenSet = true; m_profilingGroupName.assign(value); } /** *

The name of the profiling group.

*/ inline ListProfileTimesRequest& WithProfilingGroupName(const Aws::String& value) { SetProfilingGroupName(value); return *this;} /** *

The name of the profiling group.

*/ inline ListProfileTimesRequest& WithProfilingGroupName(Aws::String&& value) { SetProfilingGroupName(std::move(value)); return *this;} /** *

The name of the profiling group.

*/ inline ListProfileTimesRequest& WithProfilingGroupName(const char* value) { SetProfilingGroupName(value); return *this;} /** *

The start time of the time range from which to list the profiles.

*/ inline const Aws::Utils::DateTime& GetStartTime() const{ return m_startTime; } /** *

The start time of the time range from which to list the profiles.

*/ inline bool StartTimeHasBeenSet() const { return m_startTimeHasBeenSet; } /** *

The start time of the time range from which to list the profiles.

*/ inline void SetStartTime(const Aws::Utils::DateTime& value) { m_startTimeHasBeenSet = true; m_startTime = value; } /** *

The start time of the time range from which to list the profiles.

*/ inline void SetStartTime(Aws::Utils::DateTime&& value) { m_startTimeHasBeenSet = true; m_startTime = std::move(value); } /** *

The start time of the time range from which to list the profiles.

*/ inline ListProfileTimesRequest& WithStartTime(const Aws::Utils::DateTime& value) { SetStartTime(value); return *this;} /** *

The start time of the time range from which to list the profiles.

*/ inline ListProfileTimesRequest& WithStartTime(Aws::Utils::DateTime&& value) { SetStartTime(std::move(value)); return *this;} private: Aws::Utils::DateTime m_endTime; bool m_endTimeHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; OrderBy m_orderBy; bool m_orderByHasBeenSet = false; AggregationPeriod m_period; bool m_periodHasBeenSet = false; Aws::String m_profilingGroupName; bool m_profilingGroupNameHasBeenSet = false; Aws::Utils::DateTime m_startTime; bool m_startTimeHasBeenSet = false; }; } // namespace Model } // namespace CodeGuruProfiler } // namespace Aws