Interface RecurringRetrieval.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<RecurringRetrieval.Builder,
,RecurringRetrieval> SdkBuilder<RecurringRetrieval.Builder,
,RecurringRetrieval> SdkPojo
- Enclosing class:
RecurringRetrieval
-
Method Summary
Modifier and TypeMethodDescriptiondelayAfterAvailEndSeconds
(Integer delayAfterAvailEndSeconds) The number of seconds that MediaTailor waits after an ad avail before prefetching ads for the next avail.dynamicVariables
(Map<String, String> dynamicVariables) The dynamic variables to use for substitution during prefetch requests to the ADS.default RecurringRetrieval.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.trafficShapingRetrievalWindow
(TrafficShapingRetrievalWindow trafficShapingRetrievalWindow) Configuration for spreading ADS traffic across a set window instead of sending ADS requests for all sessions at the same time.default RecurringRetrieval.Builder
trafficShapingTpsConfiguration
(Consumer<TrafficShapingTpsConfiguration.Builder> trafficShapingTpsConfiguration) The configuration for TPS-based traffic shaping that limits the number of requests to the ad decision server (ADS) based on transactions per second instead of time windows.trafficShapingTpsConfiguration
(TrafficShapingTpsConfiguration trafficShapingTpsConfiguration) The configuration for TPS-based traffic shaping that limits the number of requests to the ad decision server (ADS) based on transactions per second instead of time windows.trafficShapingType
(String trafficShapingType) Indicates the type of traffic shaping used for traffic shaping and limiting the number of requests to the ADS at one time.trafficShapingType
(TrafficShapingType trafficShapingType) Indicates the type of traffic shaping used for traffic shaping and limiting the number of requests to the ADS at one time.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
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
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
Indicates the type of traffic shaping used for traffic shaping and limiting the number of requests to the ADS at one time.
- Parameters:
trafficShapingType
- Indicates the type of traffic shaping used 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
Indicates the type of traffic shaping used for traffic shaping and limiting the number of requests to the ADS at one time.
- Parameters:
trafficShapingType
- Indicates the type of traffic shaping used 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
RecurringRetrieval.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 RecurringRetrieval.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 theTrafficShapingRetrievalWindow.Builder
avoiding the need to create one manually viaTrafficShapingRetrievalWindow.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totrafficShapingRetrievalWindow(TrafficShapingRetrievalWindow)
.- Parameters:
trafficShapingRetrievalWindow
- a consumer that will call methods onTrafficShapingRetrievalWindow.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 that limits the number of requests to the ad decision server (ADS) based on transactions per second instead of time windows.
- Parameters:
trafficShapingTpsConfiguration
- The configuration for TPS-based traffic shaping that limits the number of requests to the ad decision server (ADS) based on transactions per second instead of time windows.- 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 that limits the number of requests to the ad decision server (ADS) based on transactions per second instead of time windows.
This is a convenience method that creates an instance of theTrafficShapingTpsConfiguration.Builder
avoiding the need to create one manually viaTrafficShapingTpsConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totrafficShapingTpsConfiguration(TrafficShapingTpsConfiguration)
.- Parameters:
trafficShapingTpsConfiguration
- a consumer that will call methods onTrafficShapingTpsConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-