Interface PrefetchSchedule.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<PrefetchSchedule.Builder,
,PrefetchSchedule> SdkBuilder<PrefetchSchedule.Builder,
,PrefetchSchedule> SdkPojo
- Enclosing class:
PrefetchSchedule
-
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of the prefetch schedule.default PrefetchSchedule.Builder
consumption
(Consumer<PrefetchConsumption.Builder> consumption) Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks.consumption
(PrefetchConsumption consumption) Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks.The name of the prefetch schedule.playbackConfigurationName
(String playbackConfigurationName) The name of the playback configuration to create the prefetch schedule for.default PrefetchSchedule.Builder
retrieval
(Consumer<PrefetchRetrieval.Builder> retrieval) A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).retrieval
(PrefetchRetrieval retrieval) A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.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, sdkFields
-
Method Details
-
arn
The Amazon Resource Name (ARN) of the prefetch schedule.
- Parameters:
arn
- The Amazon Resource Name (ARN) of the prefetch schedule.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
consumption
Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.
- Parameters:
consumption
- Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
consumption
Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.
This is a convenience method that creates an instance of thePrefetchConsumption.Builder
avoiding the need to create one manually viaPrefetchConsumption.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toconsumption(PrefetchConsumption)
.- Parameters:
consumption
- a consumer that will call methods onPrefetchConsumption.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
name
The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
- Parameters:
name
- The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
playbackConfigurationName
The name of the playback configuration to create the prefetch schedule for.
- Parameters:
playbackConfigurationName
- The name of the playback configuration to create the prefetch schedule for.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
retrieval
A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
- Parameters:
retrieval
- A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
retrieval
A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
This is a convenience method that creates an instance of thePrefetchRetrieval.Builder
avoiding the need to create one manually viaPrefetchRetrieval.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toretrieval(PrefetchRetrieval)
.- Parameters:
retrieval
- a consumer that will call methods onPrefetchRetrieval.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
streamId
An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
- Parameters:
streamId
- An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-