/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace WAFV2 { namespace Model { /** *

In a GetSampledRequests request, the StartTime and * EndTime objects specify the time range for which you want WAF to * return a sample of web requests.

You must specify the times in * Coordinated Universal Time (UTC) format. UTC format includes the special * designator, Z. For example, "2016-09-27T14:50Z". You * can specify any time range in the previous three hours.

In a * GetSampledRequests response, the StartTime and * EndTime objects specify the time range for which WAF actually * returned a sample of web requests. WAF gets the specified number of requests * from among the first 5,000 requests that your Amazon Web Services resource * receives during the specified time period. If your resource receives more than * 5,000 requests during that period, WAF stops sampling after the 5,000th request. * In that case, EndTime is the time that WAF received the 5,000th * request.

See Also:

AWS * API Reference

*/ class TimeWindow { public: AWS_WAFV2_API TimeWindow(); AWS_WAFV2_API TimeWindow(Aws::Utils::Json::JsonView jsonValue); AWS_WAFV2_API TimeWindow& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_WAFV2_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The beginning of the time range from which you want * GetSampledRequests to return a sample of the requests that your * Amazon Web Services resource received. You must specify the times in Coordinated * Universal Time (UTC) format. UTC format includes the special designator, * Z. For example, "2016-09-27T14:50Z". You can specify * any time range in the previous three hours.

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

The beginning of the time range from which you want * GetSampledRequests to return a sample of the requests that your * Amazon Web Services resource received. You must specify the times in Coordinated * Universal Time (UTC) format. UTC format includes the special designator, * Z. For example, "2016-09-27T14:50Z". You can specify * any time range in the previous three hours.

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

The beginning of the time range from which you want * GetSampledRequests to return a sample of the requests that your * Amazon Web Services resource received. You must specify the times in Coordinated * Universal Time (UTC) format. UTC format includes the special designator, * Z. For example, "2016-09-27T14:50Z". You can specify * any time range in the previous three hours.

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

The beginning of the time range from which you want * GetSampledRequests to return a sample of the requests that your * Amazon Web Services resource received. You must specify the times in Coordinated * Universal Time (UTC) format. UTC format includes the special designator, * Z. For example, "2016-09-27T14:50Z". You can specify * any time range in the previous three hours.

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

The beginning of the time range from which you want * GetSampledRequests to return a sample of the requests that your * Amazon Web Services resource received. You must specify the times in Coordinated * Universal Time (UTC) format. UTC format includes the special designator, * Z. For example, "2016-09-27T14:50Z". You can specify * any time range in the previous three hours.

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

The beginning of the time range from which you want * GetSampledRequests to return a sample of the requests that your * Amazon Web Services resource received. You must specify the times in Coordinated * Universal Time (UTC) format. UTC format includes the special designator, * Z. For example, "2016-09-27T14:50Z". You can specify * any time range in the previous three hours.

*/ inline TimeWindow& WithStartTime(Aws::Utils::DateTime&& value) { SetStartTime(std::move(value)); return *this;} /** *

The end of the time range from which you want GetSampledRequests * to return a sample of the requests that your Amazon Web Services resource * received. You must specify the times in Coordinated Universal Time (UTC) format. * UTC format includes the special designator, Z. For example, * "2016-09-27T14:50Z". You can specify any time range in the previous * three hours.

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

The end of the time range from which you want GetSampledRequests * to return a sample of the requests that your Amazon Web Services resource * received. You must specify the times in Coordinated Universal Time (UTC) format. * UTC format includes the special designator, Z. For example, * "2016-09-27T14:50Z". You can specify any time range in the previous * three hours.

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

The end of the time range from which you want GetSampledRequests * to return a sample of the requests that your Amazon Web Services resource * received. You must specify the times in Coordinated Universal Time (UTC) format. * UTC format includes the special designator, Z. For example, * "2016-09-27T14:50Z". You can specify any time range in the previous * three hours.

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

The end of the time range from which you want GetSampledRequests * to return a sample of the requests that your Amazon Web Services resource * received. You must specify the times in Coordinated Universal Time (UTC) format. * UTC format includes the special designator, Z. For example, * "2016-09-27T14:50Z". You can specify any time range in the previous * three hours.

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

The end of the time range from which you want GetSampledRequests * to return a sample of the requests that your Amazon Web Services resource * received. You must specify the times in Coordinated Universal Time (UTC) format. * UTC format includes the special designator, Z. For example, * "2016-09-27T14:50Z". You can specify any time range in the previous * three hours.

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

The end of the time range from which you want GetSampledRequests * to return a sample of the requests that your Amazon Web Services resource * received. You must specify the times in Coordinated Universal Time (UTC) format. * UTC format includes the special designator, Z. For example, * "2016-09-27T14:50Z". You can specify any time range in the previous * three hours.

*/ inline TimeWindow& WithEndTime(Aws::Utils::DateTime&& value) { SetEndTime(std::move(value)); return *this;} private: Aws::Utils::DateTime m_startTime; bool m_startTimeHasBeenSet = false; Aws::Utils::DateTime m_endTime; bool m_endTimeHasBeenSet = false; }; } // namespace Model } // namespace WAFV2 } // namespace Aws