com.amazonaws.services.mediatailor.model

Class CreatePrefetchScheduleRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.mediatailor.model.CreatePrefetchScheduleRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreatePrefetchScheduleRequest
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
CreatePrefetchScheduleRequest()

Method Summary

Modifier and Type	Method and Description
CreatePrefetchScheduleRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
PrefetchConsumption	getConsumption() The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server.
String	getName() The name to assign to the schedule request.
String	getPlaybackConfigurationName() The name to assign to the playback configuration.
PrefetchRetrieval	getRetrieval() The configuration settings for retrieval of prefetched ads from the ad decision server.
String	getStreamId() An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration.
int	hashCode()
void	setConsumption(PrefetchConsumption consumption) The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server.
void	setName(String name) The name to assign to the schedule request.
void	setPlaybackConfigurationName(String playbackConfigurationName) The name to assign to the playback configuration.
void	setRetrieval(PrefetchRetrieval retrieval) The configuration settings for retrieval of prefetched ads from the ad decision server.
void	setStreamId(String streamId) An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration.
String	toString() Returns a string representation of this object.
CreatePrefetchScheduleRequest	withConsumption(PrefetchConsumption consumption) The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server.
CreatePrefetchScheduleRequest	withName(String name) The name to assign to the schedule request.
CreatePrefetchScheduleRequest	withPlaybackConfigurationName(String playbackConfigurationName) The name to assign to the playback configuration.
CreatePrefetchScheduleRequest	withRetrieval(PrefetchRetrieval retrieval) The configuration settings for retrieval of prefetched ads from the ad decision server.
CreatePrefetchScheduleRequest	withStreamId(String streamId) An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration.

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

CreatePrefetchScheduleRequest

public CreatePrefetchScheduleRequest()

Method Detail

setConsumption

public void setConsumption(PrefetchConsumption consumption)

The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server. 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 MediaTailor's consumption of the prefetched ads from the ad decision server. 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.

getConsumption

public PrefetchConsumption getConsumption()

The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server. 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:

The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server. 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.

withConsumption

public CreatePrefetchScheduleRequest withConsumption(PrefetchConsumption consumption)

The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server. 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 MediaTailor's consumption of the prefetched ads from the ad decision server. 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.

setName

public void setName(String name)

The name to assign to the schedule request.

Parameters:

name - The name to assign to the schedule request.

getName

public String getName()

The name to assign to the schedule request.

Returns:

The name to assign to the schedule request.

withName

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

setPlaybackConfigurationName

public void setPlaybackConfigurationName(String playbackConfigurationName)

The name to assign to the playback configuration.

Parameters:

playbackConfigurationName - The name to assign to the playback configuration.

getPlaybackConfigurationName

public String getPlaybackConfigurationName()

The name to assign to the playback configuration.

Returns:

The name to assign to the playback configuration.

withPlaybackConfigurationName

public CreatePrefetchScheduleRequest withPlaybackConfigurationName(String 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.

setRetrieval

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

getRetrieval

public PrefetchRetrieval getRetrieval()

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:

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.

withRetrieval

public CreatePrefetchScheduleRequest withRetrieval(PrefetchRetrieval 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.

setStreamId

public void setStreamId(String 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 on StreamId. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of StreamId.

Parameters:

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 on StreamId. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of StreamId.

getStreamId

public String getStreamId()

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 on StreamId. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of StreamId.

Returns:

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 on StreamId. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of StreamId.

withStreamId

public CreatePrefetchScheduleRequest withStreamId(String 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 on StreamId. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of StreamId.

Parameters:

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 on StreamId. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of StreamId.

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 CreatePrefetchScheduleRequest 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()