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

PrefetchRetrieval

A complex type that contains settings governing when MediaTailor prefetches ads, and which dynamic variables that MediaTailor includes in the request to the ad decision server.

Types

Builder

class Builder

Companion

object Companion

Properties

dynamicVariables

val dynamicVariables: Map<String, String>?

The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).

endTime

val endTime: Instant

The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.

startTime

val startTime: Instant?

The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.

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: PrefetchRetrieval.Builder.() -> Unit = {}): PrefetchRetrieval

equals

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

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String