com.amazonaws.services.mediatailor.model

Class PrefetchRetrieval

java.lang.Object

com.amazonaws.services.mediatailor.model.PrefetchRetrieval

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

A complex type that contains settings governing when MediaTailor prefetches ads, and which dynamic variables that MediaTailor includes in the request to the ad decision server.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
PrefetchRetrieval()

Method Summary

Modifier and Type	Method and Description
PrefetchRetrieval	addDynamicVariablesEntry(String key, String value) Add a single DynamicVariables entry
PrefetchRetrieval	clearDynamicVariablesEntries() Removes all the entries added into DynamicVariables.
PrefetchRetrieval	clone()
boolean	equals(Object obj)
Map<String,String>	getDynamicVariables() The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).
Date	getEndTime() The time when prefetch retrieval ends for the ad break.
Date	getStartTime() The time when prefetch retrievals can start for this break.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setDynamicVariables(Map<String,String> dynamicVariables) The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).
void	setEndTime(Date endTime) The time when prefetch retrieval ends for the ad break.
void	setStartTime(Date startTime) The time when prefetch retrievals can start for this break.
String	toString() Returns a string representation of this object.
PrefetchRetrieval	withDynamicVariables(Map<String,String> dynamicVariables) The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).
PrefetchRetrieval	withEndTime(Date endTime) The time when prefetch retrieval ends for the ad break.
PrefetchRetrieval	withStartTime(Date startTime) The time when prefetch retrievals can start for this break.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PrefetchRetrieval

public PrefetchRetrieval()

Method Detail

getDynamicVariables

public Map<String,String> getDynamicVariables()

The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).

You initially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.

Returns:

The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).

You initially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.

setDynamicVariables

public void setDynamicVariables(Map<String,String> dynamicVariables)

The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).

You initially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.

Parameters:

dynamicVariables - The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).

You initially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.

withDynamicVariables

public PrefetchRetrieval withDynamicVariables(Map<String,String> dynamicVariables)

The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).

You initially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.

Parameters:

dynamicVariables - The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).

You initially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.

Returns:

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

addDynamicVariablesEntry

public PrefetchRetrieval addDynamicVariablesEntry(String key,
                                                  String value)

Add a single DynamicVariables entry

See Also:

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

clearDynamicVariablesEntries

public PrefetchRetrieval clearDynamicVariablesEntries()

Removes all the entries added into DynamicVariables.

Returns:

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

setEndTime

public void setEndTime(Date endTime)

The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.

Parameters:

endTime - The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.

getEndTime

public Date getEndTime()

The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.

Returns:

The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.

withEndTime

public PrefetchRetrieval withEndTime(Date endTime)

The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.

Parameters:

endTime - The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.

Returns:

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

setStartTime

public void setStartTime(Date startTime)

The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.

Parameters:

startTime - The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.

getStartTime

public Date getStartTime()

The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.

Returns:

The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.

withStartTime

public PrefetchRetrieval withStartTime(Date startTime)

The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.

Parameters:

startTime - The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.

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 PrefetchRetrieval clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.