Interface PrefetchConsumption.Builder

All Superinterfaces:
Buildable, CopyableBuilder<PrefetchConsumption.Builder,PrefetchConsumption>, SdkBuilder<PrefetchConsumption.Builder,PrefetchConsumption>, SdkPojo
Enclosing class:
PrefetchConsumption

public static interface PrefetchConsumption.Builder extends SdkPojo, CopyableBuilder<PrefetchConsumption.Builder,PrefetchConsumption>
  • Method Details

    • availMatchingCriteria

      PrefetchConsumption.Builder availMatchingCriteria(Collection<AvailMatchingCriteria> availMatchingCriteria)

      If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as scte.event_id, set the avail matching criteria.

      Parameters:
      availMatchingCriteria - If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as scte.event_id, set the avail matching criteria.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • availMatchingCriteria

      PrefetchConsumption.Builder availMatchingCriteria(AvailMatchingCriteria... availMatchingCriteria)

      If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as scte.event_id, set the avail matching criteria.

      Parameters:
      availMatchingCriteria - If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as scte.event_id, set the avail matching criteria.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • availMatchingCriteria

      PrefetchConsumption.Builder availMatchingCriteria(Consumer<AvailMatchingCriteria.Builder>... availMatchingCriteria)

      If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as scte.event_id, set the avail matching criteria.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to availMatchingCriteria(List<AvailMatchingCriteria>).

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

      The time when MediaTailor no longer considers the prefetched ads for use in an ad break. MediaTailor automatically deletes prefetch schedules no less than seven days after the end time. If you'd like to manually delete the prefetch schedule, you can call DeletePrefetchSchedule.

      Parameters:
      endTime - The time when MediaTailor no longer considers the prefetched ads for use in an ad break. MediaTailor automatically deletes prefetch schedules no less than seven days after the end time. If you'd like to manually delete the prefetch schedule, you can call DeletePrefetchSchedule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • startTime

      PrefetchConsumption.Builder startTime(Instant startTime)

      The time when prefetched ads are considered for use in an ad break. If you don't specify StartTime, the prefetched ads are available after MediaTailor retrives them from the ad decision server.

      Parameters:
      startTime - The time when prefetched ads are considered for use in an ad break. If you don't specify StartTime, the prefetched ads are available after MediaTailor retrives them from the ad decision server.
      Returns:
      Returns a reference to this object so that method calls can be chained together.