Interface PrefetchSchedule.Builder

All Superinterfaces:
Buildable, CopyableBuilder<PrefetchSchedule.Builder,PrefetchSchedule>, SdkBuilder<PrefetchSchedule.Builder,PrefetchSchedule>, SdkPojo
Enclosing class:
PrefetchSchedule
@Mutable @NotThreadSafe public static interface PrefetchSchedule.Builder extends SdkPojo, CopyableBuilder<PrefetchSchedule.Builder,PrefetchSchedule>

  • Method Details

    • arn

      PrefetchSchedule.Builder arn(String arn)

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

      Parameters:
      arn - The Amazon Resource Name (ARN) of the prefetch schedule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • consumption

      PrefetchSchedule.Builder consumption(PrefetchConsumption 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • consumption

      default PrefetchSchedule.Builder consumption(Consumer<PrefetchConsumption.Builder> 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.

      This is a convenience method that creates an instance of the PrefetchConsumption.Builder avoiding the need to create one manually via PrefetchConsumption.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to consumption(PrefetchConsumption).

      Parameters:
      consumption - a consumer that will call methods on PrefetchConsumption.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • name

      PrefetchSchedule.Builder name(String name)

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

      Parameters:
      name - The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • playbackConfigurationName

      PrefetchSchedule.Builder playbackConfigurationName(String playbackConfigurationName)

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

      Parameters:
      playbackConfigurationName - The name of the playback configuration to create the prefetch schedule for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • retrieval

      PrefetchSchedule.Builder retrieval(PrefetchRetrieval retrieval)

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

      Parameters:
      retrieval - A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • retrieval

      default PrefetchSchedule.Builder retrieval(Consumer<PrefetchRetrieval.Builder> retrieval)

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

      This is a convenience method that creates an instance of the PrefetchRetrieval.Builder avoiding the need to create one manually via PrefetchRetrieval.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to retrieval(PrefetchRetrieval).

      Parameters:
      retrieval - a consumer that will call methods on PrefetchRetrieval.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • scheduleType

      PrefetchSchedule.Builder scheduleType(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • scheduleType

      PrefetchSchedule.Builder scheduleType(PrefetchScheduleType 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • recurringPrefetchConfiguration

      PrefetchSchedule.Builder recurringPrefetchConfiguration(RecurringPrefetchConfiguration recurringPrefetchConfiguration)

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

      Parameters:
      recurringPrefetchConfiguration - The settings that determine how and when MediaTailor prefetches ads and inserts them into ad breaks.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • recurringPrefetchConfiguration

      default PrefetchSchedule.Builder recurringPrefetchConfiguration(Consumer<RecurringPrefetchConfiguration.Builder> recurringPrefetchConfiguration)

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

      This is a convenience method that creates an instance of the RecurringPrefetchConfiguration.Builder avoiding the need to create one manually via RecurringPrefetchConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to recurringPrefetchConfiguration(RecurringPrefetchConfiguration).

      Parameters:
      recurringPrefetchConfiguration - a consumer that will call methods on RecurringPrefetchConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • streamId

      PrefetchSchedule.Builder streamId(String streamId)

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

      Parameters:
      streamId - An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.