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 the type of traffic shaping used to limit the number of requests to the ADS at one time.

      Parameters:
      trafficShapingType - Indicates the type of traffic shaping used to limit 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 the type of traffic shaping used to limit the number of requests to the ADS at one time.

      Parameters:
      trafficShapingType - Indicates the type of traffic shaping used to limit 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)

      The configuration that tells Elemental MediaTailor how many seconds to spread out requests to the ad decision server (ADS). Instead of sending ADS requests for all sessions at the same time, MediaTailor spreads the requests across the amount of time specified in the retrieval window.

      Parameters:
      trafficShapingRetrievalWindow - The configuration that tells Elemental MediaTailor how many seconds to spread out requests to the ad decision server (ADS). Instead of sending ADS requests for all sessions at the same time, MediaTailor spreads the requests across the amount of time specified in the retrieval window.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trafficShapingRetrievalWindow

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

      The configuration that tells Elemental MediaTailor how many seconds to spread out requests to the ad decision server (ADS). Instead of sending ADS requests for all sessions at the same time, MediaTailor spreads the requests across the amount of time specified in the retrieval window.

      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:

    • trafficShapingTpsConfiguration

      PrefetchRetrieval.Builder trafficShapingTpsConfiguration(TrafficShapingTpsConfiguration trafficShapingTpsConfiguration)

      The configuration for TPS-based traffic shaping. This approach limits requests to the ad decision server (ADS) based on transactions per second and concurrent users.

      Parameters:
      trafficShapingTpsConfiguration - The configuration for TPS-based traffic shaping. This approach limits requests to the ad decision server (ADS) based on transactions per second and concurrent users.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trafficShapingTpsConfiguration

      default PrefetchRetrieval.Builder trafficShapingTpsConfiguration(Consumer<TrafficShapingTpsConfiguration.Builder> trafficShapingTpsConfiguration)

      The configuration for TPS-based traffic shaping. This approach limits requests to the ad decision server (ADS) based on transactions per second and concurrent users.

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

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

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