Interface CreatePrefetchScheduleRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreatePrefetchScheduleRequest.Builder,
,CreatePrefetchScheduleRequest> MediaTailorRequest.Builder
,SdkBuilder<CreatePrefetchScheduleRequest.Builder,
,CreatePrefetchScheduleRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreatePrefetchScheduleRequest
-
Method Summary
Modifier and TypeMethodDescriptionconsumption
(Consumer<PrefetchConsumption.Builder> consumption) The configuration settings for how and when MediaTailor consumes prefetched ads from the ad decision server for single prefetch schedules.consumption
(PrefetchConsumption consumption) The configuration settings for how and when MediaTailor consumes prefetched ads from the ad decision server for single prefetch schedules.The name to assign to the schedule request.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.playbackConfigurationName
(String playbackConfigurationName) The name to assign to the playback configuration.recurringPrefetchConfiguration
(Consumer<RecurringPrefetchConfiguration.Builder> recurringPrefetchConfiguration) The configuration that defines how and when MediaTailor performs ad prefetching in a live event.recurringPrefetchConfiguration
(RecurringPrefetchConfiguration recurringPrefetchConfiguration) The configuration that defines how and when MediaTailor performs ad prefetching in a live event.retrieval
(Consumer<PrefetchRetrieval.Builder> retrieval) The configuration settings for retrieval of prefetched ads from the ad decision server.retrieval
(PrefetchRetrieval retrieval) The configuration settings for retrieval of prefetched ads from the ad decision server.scheduleType
(String scheduleType) The frequency that MediaTailor creates prefetch schedules.scheduleType
(PrefetchScheduleType scheduleType) The frequency that MediaTailor creates prefetch schedules.An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.mediatailor.model.MediaTailorRequest.Builder
build
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
-
consumption
The configuration settings for how and when MediaTailor consumes prefetched ads from the ad decision server for single prefetch schedules. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.
- Parameters:
consumption
- The configuration settings for how and when MediaTailor consumes prefetched ads from the ad decision server for single prefetch schedules. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
consumption
default CreatePrefetchScheduleRequest.Builder consumption(Consumer<PrefetchConsumption.Builder> consumption) The configuration settings for how and when MediaTailor consumes prefetched ads from the ad decision server for single prefetch schedules. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.
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 to assign to the schedule request.
- Parameters:
name
- The name to assign to the schedule request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
playbackConfigurationName
The name to assign to the playback configuration.
- Parameters:
playbackConfigurationName
- The name to assign to the playback configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
retrieval
The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.
- Parameters:
retrieval
- The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
retrieval
default CreatePrefetchScheduleRequest.Builder retrieval(Consumer<PrefetchRetrieval.Builder> retrieval) The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.
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:
-
recurringPrefetchConfiguration
CreatePrefetchScheduleRequest.Builder recurringPrefetchConfiguration(RecurringPrefetchConfiguration recurringPrefetchConfiguration) The configuration that defines how and when MediaTailor performs ad prefetching in a live event.
- Parameters:
recurringPrefetchConfiguration
- The configuration that defines how and when MediaTailor performs ad prefetching in a live event.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
recurringPrefetchConfiguration
default CreatePrefetchScheduleRequest.Builder recurringPrefetchConfiguration(Consumer<RecurringPrefetchConfiguration.Builder> recurringPrefetchConfiguration) The configuration that defines how and when MediaTailor performs ad prefetching in a live event.
This is a convenience method that creates an instance of theRecurringPrefetchConfiguration.Builder
avoiding the need to create one manually viaRecurringPrefetchConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torecurringPrefetchConfiguration(RecurringPrefetchConfiguration)
.- Parameters:
recurringPrefetchConfiguration
- a consumer that will call methods onRecurringPrefetchConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
scheduleType
The frequency that MediaTailor creates prefetch schedules.
SINGLE
indicates that this schedule applies to one ad break.RECURRING
indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.For more information about the prefetch types and when you might use each, see Prefetching ads in Elemental MediaTailor.
- Parameters:
scheduleType
- The frequency that MediaTailor creates prefetch schedules.SINGLE
indicates that this schedule applies to one ad break.RECURRING
indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.For more information about the prefetch types and when you might use each, see Prefetching ads in Elemental MediaTailor.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
scheduleType
The frequency that MediaTailor creates prefetch schedules.
SINGLE
indicates that this schedule applies to one ad break.RECURRING
indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.For more information about the prefetch types and when you might use each, see Prefetching ads in Elemental MediaTailor.
- Parameters:
scheduleType
- The frequency that MediaTailor creates prefetch schedules.SINGLE
indicates that this schedule applies to one ad break.RECURRING
indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.For more information about the prefetch types and when you might use each, see Prefetching ads in Elemental MediaTailor.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
streamId
An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If
StreamId
is specified, MediaTailor returns all of the prefetch schedules with an exact match onStreamId
. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless ofStreamId
.- Parameters:
streamId
- An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. IfStreamId
is specified, MediaTailor returns all of the prefetch schedules with an exact match onStreamId
. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless ofStreamId
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreatePrefetchScheduleRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreatePrefetchScheduleRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-