Interface RecurringRetrieval.Builder

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

  • Method Details

    • dynamicVariables

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

      The dynamic variables to use for substitution during prefetch requests to the ADS.

      Parameters:
      dynamicVariables - The dynamic variables to use for substitution during prefetch requests to the ADS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • delayAfterAvailEndSeconds

      RecurringRetrieval.Builder delayAfterAvailEndSeconds(Integer delayAfterAvailEndSeconds)

      The number of seconds that MediaTailor waits after an ad avail before prefetching ads for the next avail. If not set, the default is 0 (no delay).

      Parameters:
      delayAfterAvailEndSeconds - The number of seconds that MediaTailor waits after an ad avail before prefetching ads for the next avail. If not set, the default is 0 (no delay).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trafficShapingType

      RecurringRetrieval.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

      RecurringRetrieval.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

      RecurringRetrieval.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 RecurringRetrieval.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

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