Interface PrefetchRetrieval.Builder

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

  • Method Details

    • dynamicVariables

      PrefetchRetrieval.Builder dynamicVariables(Map<String,String> dynamicVariables)

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

      You initially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.

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

      You initially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.

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

    • endTime

      PrefetchRetrieval.Builder endTime(Instant endTime)

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

      Parameters:
      endTime - The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startTime

      PrefetchRetrieval.Builder startTime(Instant startTime)

      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.

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

    • trafficShapingType

      PrefetchRetrieval.Builder trafficShapingType(String trafficShapingType)

      Indicates if this configuration uses a retrieval window for traffic shaping and limiting the number of requests to the ADS at one time.

      Parameters:
      trafficShapingType - Indicates if this configuration uses a retrieval window for traffic shaping and limiting the number of requests to the ADS at one time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • trafficShapingType

      PrefetchRetrieval.Builder trafficShapingType(TrafficShapingType trafficShapingType)

      Indicates if this configuration uses a retrieval window for traffic shaping and limiting the number of requests to the ADS at one time.

      Parameters:
      trafficShapingType - Indicates if this configuration uses a retrieval window for traffic shaping and limiting the number of requests to the ADS at one time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • trafficShapingRetrievalWindow

      PrefetchRetrieval.Builder trafficShapingRetrievalWindow(TrafficShapingRetrievalWindow trafficShapingRetrievalWindow)

      Configuration for spreading ADS traffic across a set window instead of sending ADS requests for all sessions at the same time.

      Parameters:
      trafficShapingRetrievalWindow - Configuration for spreading ADS traffic across a set window instead of sending ADS requests for all sessions at the same time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trafficShapingRetrievalWindow

      default PrefetchRetrieval.Builder trafficShapingRetrievalWindow(Consumer<TrafficShapingRetrievalWindow.Builder> trafficShapingRetrievalWindow)

      Configuration for spreading ADS traffic across a set window instead of sending ADS requests for all sessions at the same time.

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

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

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