mediatailor/aws.sdk.kotlin.services.mediatailor.model/RecurringRetrieval

RecurringRetrieval

With recurring prefetch, MediaTailor automatically prefetches ads for every avail that occurs during the retrieval window. The following configurations describe the MediaTailor behavior when prefetching ads for a live event.

Types

Builder

class Builder

Companion

object Companion

Properties

delayAfterAvailEndSeconds

val delayAfterAvailEndSeconds: Int?

The number of seconds that MediaTailor waits after an ad avail before prefetching ads for the next avail. If not set, the default is 0 (no delay).

dynamicVariables

val dynamicVariables: Map<String, String>?

The dynamic variables to use for substitution during prefetch requests to the ADS.

trafficShapingRetrievalWindow

val trafficShapingRetrievalWindow: TrafficShapingRetrievalWindow?

The configuration that tells Elemental MediaTailor how many seconds to spread out requests to the ad decision server (ADS). Instead of sending ADS requests for all sessions at the same time, MediaTailor spreads the requests across the amount of time specified in the retrieval window.

trafficShapingTpsConfiguration

val trafficShapingTpsConfiguration: TrafficShapingTpsConfiguration?

The configuration for TPS-based traffic shaping. This approach limits requests to the ad decision server (ADS) based on transactions per second and concurrent users.

trafficShapingType

val trafficShapingType: TrafficShapingType?

Indicates the type of traffic shaping used to limit the number of requests to the ADS at one time.

Functions

copy

inline fun copy(block: RecurringRetrieval.Builder.() -> Unit = {}): RecurringRetrieval

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String