Interface PutPlaybackConfigurationResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<PutPlaybackConfigurationResponse.Builder,
,PutPlaybackConfigurationResponse> MediaTailorResponse.Builder
,SdkBuilder<PutPlaybackConfigurationResponse.Builder,
,PutPlaybackConfigurationResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
PutPlaybackConfigurationResponse
-
Method Summary
Modifier and TypeMethodDescriptionadDecisionServerUrl
(String adDecisionServerUrl) The URL for the ad decision server (ADS).availSuppression
(Consumer<AvailSuppression.Builder> availSuppression) The configuration for avail suppression, also known as ad suppression.availSuppression
(AvailSuppression availSuppression) The configuration for avail suppression, also known as ad suppression.bumper
(Consumer<Bumper.Builder> bumper) The configuration for bumpers.The configuration for bumpers.cdnConfiguration
(Consumer<CdnConfiguration.Builder> cdnConfiguration) The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.cdnConfiguration
(CdnConfiguration cdnConfiguration) The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.The player parameters and aliases used as dynamic variables during session initialization.dashConfiguration
(Consumer<DashConfiguration.Builder> dashConfiguration) The configuration for DASH content.dashConfiguration
(DashConfiguration dashConfiguration) The configuration for DASH content.hlsConfiguration
(Consumer<HlsConfiguration.Builder> hlsConfiguration) The configuration for HLS content.hlsConfiguration
(HlsConfiguration hlsConfiguration) The configuration for HLS content.insertionMode
(String insertionMode) The setting that controls whether players can use stitched or guided ad insertion.insertionMode
(InsertionMode insertionMode) The setting that controls whether players can use stitched or guided ad insertion.livePreRollConfiguration
(Consumer<LivePreRollConfiguration.Builder> livePreRollConfiguration) The configuration for pre-roll ad insertion.livePreRollConfiguration
(LivePreRollConfiguration livePreRollConfiguration) The configuration for pre-roll ad insertion.logConfiguration
(Consumer<LogConfiguration.Builder> logConfiguration) The Amazon CloudWatch log settings for a playback configuration.logConfiguration
(LogConfiguration logConfiguration) The Amazon CloudWatch log settings for a playback configuration.manifestProcessingRules
(Consumer<ManifestProcessingRules.Builder> manifestProcessingRules) The configuration for manifest processing rules.manifestProcessingRules
(ManifestProcessingRules manifestProcessingRules) The configuration for manifest processing rules.The identifier for the playback configuration.personalizationThresholdSeconds
(Integer personalizationThresholdSeconds) Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break.playbackConfigurationArn
(String playbackConfigurationArn) The Amazon Resource Name (ARN) associated with the playback configuration.playbackEndpointPrefix
(String playbackEndpointPrefix) The playback endpoint prefix associated with the playback configuration.sessionInitializationEndpointPrefix
(String sessionInitializationEndpointPrefix) The session initialization endpoint prefix associated with the playback configuration.slateAdUrl
(String slateAdUrl) The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads.The tags to assign to the playback configuration.transcodeProfileName
(String transcodeProfileName) The name that is used to associate this playback configuration with a custom transcode profile.videoContentSourceUrl
(String videoContentSourceUrl) The URL prefix for the parent manifest for the stream, minus the asset ID.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.mediatailor.model.MediaTailorResponse.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
adDecisionServerUrl
The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.
- Parameters:
adDecisionServerUrl
- The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
availSuppression
The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
- Parameters:
availSuppression
- The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
availSuppression
default PutPlaybackConfigurationResponse.Builder availSuppression(Consumer<AvailSuppression.Builder> availSuppression) The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.
This is a convenience method that creates an instance of theAvailSuppression.Builder
avoiding the need to create one manually viaAvailSuppression.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toavailSuppression(AvailSuppression)
.- Parameters:
availSuppression
- a consumer that will call methods onAvailSuppression.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
bumper
The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.
- Parameters:
bumper
- The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
bumper
The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see Bumpers.
This is a convenience method that creates an instance of theBumper.Builder
avoiding the need to create one manually viaBumper.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tobumper(Bumper)
.- Parameters:
bumper
- a consumer that will call methods onBumper.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
cdnConfiguration
The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
- Parameters:
cdnConfiguration
- The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cdnConfiguration
default PutPlaybackConfigurationResponse.Builder cdnConfiguration(Consumer<CdnConfiguration.Builder> cdnConfiguration) The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
This is a convenience method that creates an instance of theCdnConfiguration.Builder
avoiding the need to create one manually viaCdnConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocdnConfiguration(CdnConfiguration)
.- Parameters:
cdnConfiguration
- a consumer that will call methods onCdnConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
configurationAliases
PutPlaybackConfigurationResponse.Builder configurationAliases(Map<String, ? extends Map<String, String>> configurationAliases) The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.
- Parameters:
configurationAliases
- The player parameters and aliases used as dynamic variables during session initialization. For more information, see Domain Variables.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dashConfiguration
The configuration for DASH content.
- Parameters:
dashConfiguration
- The configuration for DASH content.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dashConfiguration
default PutPlaybackConfigurationResponse.Builder dashConfiguration(Consumer<DashConfiguration.Builder> dashConfiguration) The configuration for DASH content.
This is a convenience method that creates an instance of theDashConfiguration.Builder
avoiding the need to create one manually viaDashConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todashConfiguration(DashConfiguration)
.- Parameters:
dashConfiguration
- a consumer that will call methods onDashConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
hlsConfiguration
The configuration for HLS content.
- Parameters:
hlsConfiguration
- The configuration for HLS content.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
hlsConfiguration
default PutPlaybackConfigurationResponse.Builder hlsConfiguration(Consumer<HlsConfiguration.Builder> hlsConfiguration) The configuration for HLS content.
This is a convenience method that creates an instance of theHlsConfiguration.Builder
avoiding the need to create one manually viaHlsConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tohlsConfiguration(HlsConfiguration)
.- Parameters:
hlsConfiguration
- a consumer that will call methods onHlsConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
insertionMode
The setting that controls whether players can use stitched or guided ad insertion. The default,
STITCHED_ONLY
, forces all player sessions to use stitched (server-side) ad insertion. ChoosingPLAYER_SELECT
allows players to select either stitched or guided ad insertion at session-initialization time. The default for players that do not specify an insertion mode is stitched.- Parameters:
insertionMode
- The setting that controls whether players can use stitched or guided ad insertion. The default,STITCHED_ONLY
, forces all player sessions to use stitched (server-side) ad insertion. ChoosingPLAYER_SELECT
allows players to select either stitched or guided ad insertion at session-initialization time. The default for players that do not specify an insertion mode is stitched.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
insertionMode
The setting that controls whether players can use stitched or guided ad insertion. The default,
STITCHED_ONLY
, forces all player sessions to use stitched (server-side) ad insertion. ChoosingPLAYER_SELECT
allows players to select either stitched or guided ad insertion at session-initialization time. The default for players that do not specify an insertion mode is stitched.- Parameters:
insertionMode
- The setting that controls whether players can use stitched or guided ad insertion. The default,STITCHED_ONLY
, forces all player sessions to use stitched (server-side) ad insertion. ChoosingPLAYER_SELECT
allows players to select either stitched or guided ad insertion at session-initialization time. The default for players that do not specify an insertion mode is stitched.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
livePreRollConfiguration
PutPlaybackConfigurationResponse.Builder livePreRollConfiguration(LivePreRollConfiguration livePreRollConfiguration) The configuration for pre-roll ad insertion.
- Parameters:
livePreRollConfiguration
- The configuration for pre-roll ad insertion.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
livePreRollConfiguration
default PutPlaybackConfigurationResponse.Builder livePreRollConfiguration(Consumer<LivePreRollConfiguration.Builder> livePreRollConfiguration) The configuration for pre-roll ad insertion.
This is a convenience method that creates an instance of theLivePreRollConfiguration.Builder
avoiding the need to create one manually viaLivePreRollConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolivePreRollConfiguration(LivePreRollConfiguration)
.- Parameters:
livePreRollConfiguration
- a consumer that will call methods onLivePreRollConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
logConfiguration
The Amazon CloudWatch log settings for a playback configuration.
- Parameters:
logConfiguration
- The Amazon CloudWatch log settings for a playback configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
logConfiguration
default PutPlaybackConfigurationResponse.Builder logConfiguration(Consumer<LogConfiguration.Builder> logConfiguration) The Amazon CloudWatch log settings for a playback configuration.
This is a convenience method that creates an instance of theLogConfiguration.Builder
avoiding the need to create one manually viaLogConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tologConfiguration(LogConfiguration)
.- Parameters:
logConfiguration
- a consumer that will call methods onLogConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
manifestProcessingRules
PutPlaybackConfigurationResponse.Builder manifestProcessingRules(ManifestProcessingRules manifestProcessingRules) The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
- Parameters:
manifestProcessingRules
- The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
manifestProcessingRules
default PutPlaybackConfigurationResponse.Builder manifestProcessingRules(Consumer<ManifestProcessingRules.Builder> manifestProcessingRules) The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.
This is a convenience method that creates an instance of theManifestProcessingRules.Builder
avoiding the need to create one manually viaManifestProcessingRules.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomanifestProcessingRules(ManifestProcessingRules)
.- Parameters:
manifestProcessingRules
- a consumer that will call methods onManifestProcessingRules.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
name
The identifier for the playback configuration.
- Parameters:
name
- The identifier for the playback configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
personalizationThresholdSeconds
PutPlaybackConfigurationResponse.Builder personalizationThresholdSeconds(Integer personalizationThresholdSeconds) Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor.
- Parameters:
personalizationThresholdSeconds
- Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to ad replacement in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see Ad Behavior in AWS Elemental MediaTailor.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
playbackConfigurationArn
The Amazon Resource Name (ARN) associated with the playback configuration.
- Parameters:
playbackConfigurationArn
- The Amazon Resource Name (ARN) associated with the playback configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
playbackEndpointPrefix
The playback endpoint prefix associated with the playback configuration.
- Parameters:
playbackEndpointPrefix
- The playback endpoint prefix associated with the playback configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sessionInitializationEndpointPrefix
PutPlaybackConfigurationResponse.Builder sessionInitializationEndpointPrefix(String sessionInitializationEndpointPrefix) The session initialization endpoint prefix associated with the playback configuration.
- Parameters:
sessionInitializationEndpointPrefix
- The session initialization endpoint prefix associated with the playback configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
slateAdUrl
The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.
- Parameters:
slateAdUrl
- The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
The tags to assign to the playback configuration. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.
- Parameters:
tags
- The tags to assign to the playback configuration. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
transcodeProfileName
The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.
- Parameters:
transcodeProfileName
- The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
videoContentSourceUrl
The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.
- Parameters:
videoContentSourceUrl
- The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-