mediatailor/aws.sdk.kotlin.services.mediatailor.model/PrefetchSchedule/Builder

Builder

Properties

The Amazon Resource Name (ARN) of the prefetch schedule.

Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks for single prefetch schedules. Ad consumption occurs within a span of time that you define, called a consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.

name

var name: String?

The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.

playbackConfigurationName

var playbackConfigurationName: String?

The name of the playback configuration to create the prefetch schedule for.

recurringPrefetchConfiguration

var recurringPrefetchConfiguration: RecurringPrefetchConfiguration?

The settings that determine how and when MediaTailor prefetches ads and inserts them into ad breaks.

retrieval

var retrieval: PrefetchRetrieval?

A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).

scheduleType

var scheduleType: PrefetchScheduleType?

The frequency that MediaTailor creates prefetch schedules. SINGLE indicates that this schedule applies to one ad break. RECURRING indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.

streamId

var streamId: String?

An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.

Functions

consumption

fun consumption(block: PrefetchConsumption.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.mediatailor.model.PrefetchConsumption inside the given block

recurringPrefetchConfiguration

fun recurringPrefetchConfiguration(block: RecurringPrefetchConfiguration.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.mediatailor.model.RecurringPrefetchConfiguration inside the given block

retrieval

fun retrieval(block: PrefetchRetrieval.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.mediatailor.model.PrefetchRetrieval inside the given block