Skip to content

/AWS1/CL_MDTPREFETCHSCHEDULE

A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_arn TYPE /AWS1/MDT__STRING /AWS1/MDT__STRING

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

iv_name TYPE /AWS1/MDT__STRING /AWS1/MDT__STRING

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

iv_playbackconfigurationname TYPE /AWS1/MDT__STRING /AWS1/MDT__STRING

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

Optional arguments:

io_consumption TYPE REF TO /AWS1/CL_MDTPREFETCHCONSUMPT00 /AWS1/CL_MDTPREFETCHCONSUMPT00

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.

io_retrieval TYPE REF TO /AWS1/CL_MDTPREFETCHRETRIEVAL /AWS1/CL_MDTPREFETCHRETRIEVAL

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

iv_scheduletype TYPE /AWS1/MDTPREFETCHSCHEDULETYPE /AWS1/MDTPREFETCHSCHEDULETYPE

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.

For more information about the prefetch types and when you might use each, see Prefetching ads in Elemental MediaTailor.

io_recurringprefetchconf TYPE REF TO /AWS1/CL_MDTRECURRINGPREFETC00 /AWS1/CL_MDTRECURRINGPREFETC00

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

iv_streamid TYPE /AWS1/MDT__STRING /AWS1/MDT__STRING

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


Queryable Attributes

Arn

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

Accessible with the following methods

Method Description
GET_ARN() Getter for ARN, with configurable default
ASK_ARN() Getter for ARN w/ exceptions if field has no value
HAS_ARN() Determine if ARN has a value

Consumption

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.

Accessible with the following methods

Method Description
GET_CONSUMPTION() Getter for CONSUMPTION

Name

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

Accessible with the following methods

Method Description
GET_NAME() Getter for NAME, with configurable default
ASK_NAME() Getter for NAME w/ exceptions if field has no value
HAS_NAME() Determine if NAME has a value

PlaybackConfigurationName

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

Accessible with the following methods

Method Description
GET_PLAYBACKCONFNAME() Getter for PLAYBACKCONFIGURATIONNAME, with configurable defa
ASK_PLAYBACKCONFNAME() Getter for PLAYBACKCONFIGURATIONNAME w/ exceptions if field
HAS_PLAYBACKCONFNAME() Determine if PLAYBACKCONFIGURATIONNAME has a value

Retrieval

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

Accessible with the following methods

Method Description
GET_RETRIEVAL() Getter for RETRIEVAL

ScheduleType

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.

For more information about the prefetch types and when you might use each, see Prefetching ads in Elemental MediaTailor.

Accessible with the following methods

Method Description
GET_SCHEDULETYPE() Getter for SCHEDULETYPE, with configurable default
ASK_SCHEDULETYPE() Getter for SCHEDULETYPE w/ exceptions if field has no value
HAS_SCHEDULETYPE() Determine if SCHEDULETYPE has a value

RecurringPrefetchConfiguration

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

Accessible with the following methods

Method Description
GET_RECURRINGPREFETCHCONF() Getter for RECURRINGPREFETCHCONF

StreamId

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

Accessible with the following methods

Method Description
GET_STREAMID() Getter for STREAMID, with configurable default
ASK_STREAMID() Getter for STREAMID w/ exceptions if field has no value
HAS_STREAMID() Determine if STREAMID has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT___LISTOFPREFETCHSCHEDULE

TYPES TT___LISTOFPREFETCHSCHEDULE TYPE STANDARD TABLE OF REF TO /AWS1/CL_MDTPREFETCHSCHEDULE WITH DEFAULT KEY
.