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

A complex type that contains settings that determine how and when that * MediaTailor places prefetched ads into upcoming ad breaks.

See * Also:

AWS * API Reference

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

If you only want MediaTailor to insert prefetched ads into avails (ad breaks) * that match specific dynamic variables, such as scte.event_id, set * the avail matching criteria.

*/ inline const Aws::Vector& GetAvailMatchingCriteria() const{ return m_availMatchingCriteria; } /** *

If you only want MediaTailor to insert prefetched ads into avails (ad breaks) * that match specific dynamic variables, such as scte.event_id, set * the avail matching criteria.

*/ inline bool AvailMatchingCriteriaHasBeenSet() const { return m_availMatchingCriteriaHasBeenSet; } /** *

If you only want MediaTailor to insert prefetched ads into avails (ad breaks) * that match specific dynamic variables, such as scte.event_id, set * the avail matching criteria.

*/ inline void SetAvailMatchingCriteria(const Aws::Vector& value) { m_availMatchingCriteriaHasBeenSet = true; m_availMatchingCriteria = value; } /** *

If you only want MediaTailor to insert prefetched ads into avails (ad breaks) * that match specific dynamic variables, such as scte.event_id, set * the avail matching criteria.

*/ inline void SetAvailMatchingCriteria(Aws::Vector&& value) { m_availMatchingCriteriaHasBeenSet = true; m_availMatchingCriteria = std::move(value); } /** *

If you only want MediaTailor to insert prefetched ads into avails (ad breaks) * that match specific dynamic variables, such as scte.event_id, set * the avail matching criteria.

*/ inline PrefetchConsumption& WithAvailMatchingCriteria(const Aws::Vector& value) { SetAvailMatchingCriteria(value); return *this;} /** *

If you only want MediaTailor to insert prefetched ads into avails (ad breaks) * that match specific dynamic variables, such as scte.event_id, set * the avail matching criteria.

*/ inline PrefetchConsumption& WithAvailMatchingCriteria(Aws::Vector&& value) { SetAvailMatchingCriteria(std::move(value)); return *this;} /** *

If you only want MediaTailor to insert prefetched ads into avails (ad breaks) * that match specific dynamic variables, such as scte.event_id, set * the avail matching criteria.

*/ inline PrefetchConsumption& AddAvailMatchingCriteria(const AvailMatchingCriteria& value) { m_availMatchingCriteriaHasBeenSet = true; m_availMatchingCriteria.push_back(value); return *this; } /** *

If you only want MediaTailor to insert prefetched ads into avails (ad breaks) * that match specific dynamic variables, such as scte.event_id, set * the avail matching criteria.

*/ inline PrefetchConsumption& AddAvailMatchingCriteria(AvailMatchingCriteria&& value) { m_availMatchingCriteriaHasBeenSet = true; m_availMatchingCriteria.push_back(std::move(value)); return *this; } /** *

The time when MediaTailor no longer considers the prefetched ads for use in * an ad break. MediaTailor automatically deletes prefetch schedules no less than * seven days after the end time. If you'd like to manually delete the prefetch * schedule, you can call DeletePrefetchSchedule.

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

The time when MediaTailor no longer considers the prefetched ads for use in * an ad break. MediaTailor automatically deletes prefetch schedules no less than * seven days after the end time. If you'd like to manually delete the prefetch * schedule, you can call DeletePrefetchSchedule.

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

The time when MediaTailor no longer considers the prefetched ads for use in * an ad break. MediaTailor automatically deletes prefetch schedules no less than * seven days after the end time. If you'd like to manually delete the prefetch * schedule, you can call DeletePrefetchSchedule.

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

The time when MediaTailor no longer considers the prefetched ads for use in * an ad break. MediaTailor automatically deletes prefetch schedules no less than * seven days after the end time. If you'd like to manually delete the prefetch * schedule, you can call DeletePrefetchSchedule.

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

The time when MediaTailor no longer considers the prefetched ads for use in * an ad break. MediaTailor automatically deletes prefetch schedules no less than * seven days after the end time. If you'd like to manually delete the prefetch * schedule, you can call DeletePrefetchSchedule.

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

The time when MediaTailor no longer considers the prefetched ads for use in * an ad break. MediaTailor automatically deletes prefetch schedules no less than * seven days after the end time. If you'd like to manually delete the prefetch * schedule, you can call DeletePrefetchSchedule.

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

The time when prefetched ads are considered for use in an ad break. If you * don't specify StartTime, the prefetched ads are available after * MediaTailor retrives them from the ad decision server.

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

The time when prefetched ads are considered for use in an ad break. If you * don't specify StartTime, the prefetched ads are available after * MediaTailor retrives them from the ad decision server.

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

The time when prefetched ads are considered for use in an ad break. If you * don't specify StartTime, the prefetched ads are available after * MediaTailor retrives them from the ad decision server.

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

The time when prefetched ads are considered for use in an ad break. If you * don't specify StartTime, the prefetched ads are available after * MediaTailor retrives them from the ad decision server.

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

The time when prefetched ads are considered for use in an ad break. If you * don't specify StartTime, the prefetched ads are available after * MediaTailor retrives them from the ad decision server.

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

The time when prefetched ads are considered for use in an ad break. If you * don't specify StartTime, the prefetched ads are available after * MediaTailor retrives them from the ad decision server.

*/ inline PrefetchConsumption& WithStartTime(Aws::Utils::DateTime&& value) { SetStartTime(std::move(value)); return *this;} private: Aws::Vector m_availMatchingCriteria; bool m_availMatchingCriteriaHasBeenSet = false; Aws::Utils::DateTime m_endTime; bool m_endTimeHasBeenSet = false; Aws::Utils::DateTime m_startTime; bool m_startTimeHasBeenSet = false; }; } // namespace Model } // namespace MediaTailor } // namespace Aws