com.amazonaws.services.mediatailor.model

Class PutPlaybackConfigurationRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.mediatailor.model.PutPlaybackConfigurationRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PutPlaybackConfigurationRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutPlaybackConfigurationRequest()

Method Summary

Modifier and Type	Method and Description
PutPlaybackConfigurationRequest	addConfigurationAliasesEntry(String key, Map<String,String> value) Add a single ConfigurationAliases entry
PutPlaybackConfigurationRequest	addTagsEntry(String key, String value) Add a single Tags entry
PutPlaybackConfigurationRequest	clearConfigurationAliasesEntries() Removes all the entries added into ConfigurationAliases.
PutPlaybackConfigurationRequest	clearTagsEntries() Removes all the entries added into Tags.
PutPlaybackConfigurationRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAdDecisionServerUrl() The URL for the ad decision server (ADS).
AvailSuppression	getAvailSuppression() The configuration for Avail Suppression.
Bumper	getBumper() The configuration for bumpers.
CdnConfiguration	getCdnConfiguration() The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
Map<String,Map<String,String>>	getConfigurationAliases() Predefined aliases for dynamic variables.
DashConfigurationForPut	getDashConfiguration() The configuration for DASH content.
LivePreRollConfiguration	getLivePreRollConfiguration() The configuration for pre-roll ad insertion.
ManifestProcessingRules	getManifestProcessingRules() The configuration for manifest processing rules.
String	getName() The identifier for the playback configuration.
Integer	getPersonalizationThresholdSeconds() The maximum duration of underfilled ad time (in seconds) allowed in an ad break.
String	getSlateAdUrl() The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads.
Map<String,String>	getTags() The tags to assign to the playback configuration.
String	getTranscodeProfileName() The name that is used to associate this playback configuration with a custom transcode profile.
String	getVideoContentSourceUrl() The URL prefix for the master playlist for the stream, minus the asset ID.
int	hashCode()
void	setAdDecisionServerUrl(String adDecisionServerUrl) The URL for the ad decision server (ADS).
void	setAvailSuppression(AvailSuppression availSuppression) The configuration for Avail Suppression.
void	setBumper(Bumper bumper) The configuration for bumpers.
void	setCdnConfiguration(CdnConfiguration cdnConfiguration) The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
void	setConfigurationAliases(Map<String,Map<String,String>> configurationAliases) Predefined aliases for dynamic variables.
void	setDashConfiguration(DashConfigurationForPut dashConfiguration) The configuration for DASH content.
void	setLivePreRollConfiguration(LivePreRollConfiguration livePreRollConfiguration) The configuration for pre-roll ad insertion.
void	setManifestProcessingRules(ManifestProcessingRules manifestProcessingRules) The configuration for manifest processing rules.
void	setName(String name) The identifier for the playback configuration.
void	setPersonalizationThresholdSeconds(Integer personalizationThresholdSeconds) The maximum duration of underfilled ad time (in seconds) allowed in an ad break.
void	setSlateAdUrl(String slateAdUrl) The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads.
void	setTags(Map<String,String> tags) The tags to assign to the playback configuration.
void	setTranscodeProfileName(String transcodeProfileName) The name that is used to associate this playback configuration with a custom transcode profile.
void	setVideoContentSourceUrl(String videoContentSourceUrl) The URL prefix for the master playlist for the stream, minus the asset ID.
String	toString() Returns a string representation of this object.
PutPlaybackConfigurationRequest	withAdDecisionServerUrl(String adDecisionServerUrl) The URL for the ad decision server (ADS).
PutPlaybackConfigurationRequest	withAvailSuppression(AvailSuppression availSuppression) The configuration for Avail Suppression.
PutPlaybackConfigurationRequest	withBumper(Bumper bumper) The configuration for bumpers.
PutPlaybackConfigurationRequest	withCdnConfiguration(CdnConfiguration cdnConfiguration) The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.
PutPlaybackConfigurationRequest	withConfigurationAliases(Map<String,Map<String,String>> configurationAliases) Predefined aliases for dynamic variables.
PutPlaybackConfigurationRequest	withDashConfiguration(DashConfigurationForPut dashConfiguration) The configuration for DASH content.
PutPlaybackConfigurationRequest	withLivePreRollConfiguration(LivePreRollConfiguration livePreRollConfiguration) The configuration for pre-roll ad insertion.
PutPlaybackConfigurationRequest	withManifestProcessingRules(ManifestProcessingRules manifestProcessingRules) The configuration for manifest processing rules.
PutPlaybackConfigurationRequest	withName(String name) The identifier for the playback configuration.
PutPlaybackConfigurationRequest	withPersonalizationThresholdSeconds(Integer personalizationThresholdSeconds) The maximum duration of underfilled ad time (in seconds) allowed in an ad break.
PutPlaybackConfigurationRequest	withSlateAdUrl(String slateAdUrl) The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads.
PutPlaybackConfigurationRequest	withTags(Map<String,String> tags) The tags to assign to the playback configuration.
PutPlaybackConfigurationRequest	withTranscodeProfileName(String transcodeProfileName) The name that is used to associate this playback configuration with a custom transcode profile.
PutPlaybackConfigurationRequest	withVideoContentSourceUrl(String videoContentSourceUrl) The URL prefix for the master playlist for the stream, minus the asset ID.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutPlaybackConfigurationRequest

public PutPlaybackConfigurationRequest()

Method Detail

setAdDecisionServerUrl

public void setAdDecisionServerUrl(String 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.

getAdDecisionServerUrl

public String getAdDecisionServerUrl()

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:

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.

withAdDecisionServerUrl

public PutPlaybackConfigurationRequest withAdDecisionServerUrl(String 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.

setAvailSuppression

public void setAvailSuppression(AvailSuppression availSuppression)

The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.

Parameters:

availSuppression - The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.

getAvailSuppression

public AvailSuppression getAvailSuppression()

The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.

Returns:

The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.

withAvailSuppression

public PutPlaybackConfigurationRequest withAvailSuppression(AvailSuppression availSuppression)

The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.

Parameters:

availSuppression - The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.

Returns:

Returns a reference to this object so that method calls can be chained together.

setBumper

public void setBumper(Bumper 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.

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.

getBumper

public Bumper getBumper()

The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break.

Returns:

The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break.

withBumper

public PutPlaybackConfigurationRequest withBumper(Bumper 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.

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCdnConfiguration

public void setCdnConfiguration(CdnConfiguration 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.

getCdnConfiguration

public CdnConfiguration getCdnConfiguration()

The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

Returns:

The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

withCdnConfiguration

public PutPlaybackConfigurationRequest withCdnConfiguration(CdnConfiguration 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.

getConfigurationAliases

public Map<String,Map<String,String>> getConfigurationAliases()

Predefined aliases for dynamic variables.

Returns:

Predefined aliases for dynamic variables.

setConfigurationAliases

public void setConfigurationAliases(Map<String,Map<String,String>> configurationAliases)

Predefined aliases for dynamic variables.

Parameters:

configurationAliases - Predefined aliases for dynamic variables.

withConfigurationAliases

public PutPlaybackConfigurationRequest withConfigurationAliases(Map<String,Map<String,String>> configurationAliases)

Predefined aliases for dynamic variables.

Parameters:

configurationAliases - Predefined aliases for dynamic variables.

Returns:

Returns a reference to this object so that method calls can be chained together.

addConfigurationAliasesEntry

public PutPlaybackConfigurationRequest addConfigurationAliasesEntry(String key,
                                                                    Map<String,String> value)

Add a single ConfigurationAliases entry

See Also:

withConfigurationAliases(java.util.Map<java.lang.String, java.util.Map<java.lang.String, java.lang.String>>)

clearConfigurationAliasesEntries

public PutPlaybackConfigurationRequest clearConfigurationAliasesEntries()

Removes all the entries added into ConfigurationAliases.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDashConfiguration

public void setDashConfiguration(DashConfigurationForPut dashConfiguration)

The configuration for DASH content.

Parameters:

dashConfiguration - The configuration for DASH content.

getDashConfiguration

public DashConfigurationForPut getDashConfiguration()

The configuration for DASH content.

Returns:

The configuration for DASH content.

withDashConfiguration

public PutPlaybackConfigurationRequest withDashConfiguration(DashConfigurationForPut 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.

setLivePreRollConfiguration

public void setLivePreRollConfiguration(LivePreRollConfiguration livePreRollConfiguration)

The configuration for pre-roll ad insertion.

Parameters:

livePreRollConfiguration - The configuration for pre-roll ad insertion.

getLivePreRollConfiguration

public LivePreRollConfiguration getLivePreRollConfiguration()

The configuration for pre-roll ad insertion.

Returns:

The configuration for pre-roll ad insertion.

withLivePreRollConfiguration

public PutPlaybackConfigurationRequest withLivePreRollConfiguration(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.

setManifestProcessingRules

public void setManifestProcessingRules(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.

getManifestProcessingRules

public ManifestProcessingRules getManifestProcessingRules()

The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.

Returns:

The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.

withManifestProcessingRules

public PutPlaybackConfigurationRequest withManifestProcessingRules(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.

setName

public void setName(String name)

The identifier for the playback configuration.

Parameters:

name - The identifier for the playback configuration.

getName

public String getName()

The identifier for the playback configuration.

Returns:

The identifier for the playback configuration.

withName

public PutPlaybackConfigurationRequest withName(String 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.

setPersonalizationThresholdSeconds

public void setPersonalizationThresholdSeconds(Integer personalizationThresholdSeconds)

The maximum duration of underfilled ad time (in seconds) allowed in an ad break.

Parameters:

personalizationThresholdSeconds - The maximum duration of underfilled ad time (in seconds) allowed in an ad break.

getPersonalizationThresholdSeconds

public Integer getPersonalizationThresholdSeconds()

The maximum duration of underfilled ad time (in seconds) allowed in an ad break.

Returns:

The maximum duration of underfilled ad time (in seconds) allowed in an ad break.

withPersonalizationThresholdSeconds

public PutPlaybackConfigurationRequest withPersonalizationThresholdSeconds(Integer personalizationThresholdSeconds)

The maximum duration of underfilled ad time (in seconds) allowed in an ad break.

Parameters:

personalizationThresholdSeconds - The maximum duration of underfilled ad time (in seconds) allowed in an ad break.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSlateAdUrl

public void setSlateAdUrl(String 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.

getSlateAdUrl

public String getSlateAdUrl()

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:

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.

withSlateAdUrl

public PutPlaybackConfigurationRequest withSlateAdUrl(String 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.

getTags

public Map<String,String> getTags()

The tags to assign to the playback configuration.

Returns:

The tags to assign to the playback configuration.

setTags

public void setTags(Map<String,String> tags)

The tags to assign to the playback configuration.

Parameters:

tags - The tags to assign to the playback configuration.

withTags

public PutPlaybackConfigurationRequest withTags(Map<String,String> tags)

The tags to assign to the playback configuration.

Parameters:

tags - The tags to assign to the playback configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

addTagsEntry

public PutPlaybackConfigurationRequest addTagsEntry(String key,
                                                    String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public PutPlaybackConfigurationRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTranscodeProfileName

public void setTranscodeProfileName(String 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.

getTranscodeProfileName

public String getTranscodeProfileName()

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:

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.

withTranscodeProfileName

public PutPlaybackConfigurationRequest withTranscodeProfileName(String 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.

setVideoContentSourceUrl

public void setVideoContentSourceUrl(String videoContentSourceUrl)

The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.

Parameters:

videoContentSourceUrl - The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.

getVideoContentSourceUrl

public String getVideoContentSourceUrl()

The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.

Returns:

The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.

withVideoContentSourceUrl

public PutPlaybackConfigurationRequest withVideoContentSourceUrl(String videoContentSourceUrl)

The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.

Parameters:

videoContentSourceUrl - The URL prefix for the master playlist 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.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public PutPlaybackConfigurationRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()