com.amazonaws.services.mediatailor.model

Class PrefetchConsumption

java.lang.Object

com.amazonaws.services.mediatailor.model.PrefetchConsumption

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

A complex type that contains settings that determine how and when that MediaTailor places prefetched ads into upcoming ad breaks.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
PrefetchConsumption()

Method Summary

Modifier and Type	Method and Description
PrefetchConsumption	clone()
boolean	equals(Object obj)
List<AvailMatchingCriteria>	getAvailMatchingCriteria() If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as scte.event_id, set the avail matching criteria.
Date	getEndTime() The time when MediaTailor no longer considers the prefetched ads for use in an ad break.
Date	getStartTime() The time when prefetched ads are considered for use in an ad break.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAvailMatchingCriteria(Collection<AvailMatchingCriteria> availMatchingCriteria) If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as scte.event_id, set the avail matching criteria.
void	setEndTime(Date endTime) The time when MediaTailor no longer considers the prefetched ads for use in an ad break.
void	setStartTime(Date startTime) The time when prefetched ads are considered for use in an ad break.
String	toString() Returns a string representation of this object.
PrefetchConsumption	withAvailMatchingCriteria(AvailMatchingCriteria... availMatchingCriteria) If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as scte.event_id, set the avail matching criteria.
PrefetchConsumption	withAvailMatchingCriteria(Collection<AvailMatchingCriteria> availMatchingCriteria) If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as scte.event_id, set the avail matching criteria.
PrefetchConsumption	withEndTime(Date endTime) The time when MediaTailor no longer considers the prefetched ads for use in an ad break.
PrefetchConsumption	withStartTime(Date startTime) The time when prefetched ads are considered for use in an ad break.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PrefetchConsumption

public PrefetchConsumption()

Method Detail

getAvailMatchingCriteria

public List<AvailMatchingCriteria> getAvailMatchingCriteria()

If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as scte.event_id, set the avail matching criteria.

Returns:

If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as scte.event_id, set the avail matching criteria.

setAvailMatchingCriteria

public void setAvailMatchingCriteria(Collection<AvailMatchingCriteria> availMatchingCriteria)

If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as scte.event_id, set the avail matching criteria.

Parameters:

availMatchingCriteria - If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as scte.event_id, set the avail matching criteria.

withAvailMatchingCriteria

public PrefetchConsumption withAvailMatchingCriteria(AvailMatchingCriteria... availMatchingCriteria)

If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as scte.event_id, set the avail matching criteria.

NOTE: This method appends the values to the existing list (if any). Use setAvailMatchingCriteria(java.util.Collection) or withAvailMatchingCriteria(java.util.Collection) if you want to override the existing values.

Parameters:

availMatchingCriteria - If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as scte.event_id, set the avail matching criteria.

Returns:

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

withAvailMatchingCriteria

public PrefetchConsumption withAvailMatchingCriteria(Collection<AvailMatchingCriteria> availMatchingCriteria)

If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as scte.event_id, set the avail matching criteria.

Parameters:

availMatchingCriteria - If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as scte.event_id, set the avail matching criteria.

Returns:

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

setEndTime

public void setEndTime(Date endTime)

The time when MediaTailor no longer considers the prefetched ads for use in an ad break. MediaTailor automatically deletes prefetch schedules no less than seven days after the end time. If you'd like to manually delete the prefetch schedule, you can call DeletePrefetchSchedule.

Parameters:

endTime - The time when MediaTailor no longer considers the prefetched ads for use in an ad break. MediaTailor automatically deletes prefetch schedules no less than seven days after the end time. If you'd like to manually delete the prefetch schedule, you can call DeletePrefetchSchedule.

getEndTime

public Date getEndTime()

The time when MediaTailor no longer considers the prefetched ads for use in an ad break. MediaTailor automatically deletes prefetch schedules no less than seven days after the end time. If you'd like to manually delete the prefetch schedule, you can call DeletePrefetchSchedule.

Returns:

The time when MediaTailor no longer considers the prefetched ads for use in an ad break. MediaTailor automatically deletes prefetch schedules no less than seven days after the end time. If you'd like to manually delete the prefetch schedule, you can call DeletePrefetchSchedule.

withEndTime

public PrefetchConsumption withEndTime(Date endTime)

The time when MediaTailor no longer considers the prefetched ads for use in an ad break. MediaTailor automatically deletes prefetch schedules no less than seven days after the end time. If you'd like to manually delete the prefetch schedule, you can call DeletePrefetchSchedule.

Parameters:

endTime - The time when MediaTailor no longer considers the prefetched ads for use in an ad break. MediaTailor automatically deletes prefetch schedules no less than seven days after the end time. If you'd like to manually delete the prefetch schedule, you can call DeletePrefetchSchedule.

Returns:

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

setStartTime

public void setStartTime(Date startTime)

The time when prefetched ads are considered for use in an ad break. If you don't specify StartTime, the prefetched ads are available after MediaTailor retrives them from the ad decision server.

Parameters:

startTime - The time when prefetched ads are considered for use in an ad break. If you don't specify StartTime, the prefetched ads are available after MediaTailor retrives them from the ad decision server.

getStartTime

public Date getStartTime()

The time when prefetched ads are considered for use in an ad break. If you don't specify StartTime, the prefetched ads are available after MediaTailor retrives them from the ad decision server.

Returns:

The time when prefetched ads are considered for use in an ad break. If you don't specify StartTime, the prefetched ads are available after MediaTailor retrives them from the ad decision server.

withStartTime

public PrefetchConsumption withStartTime(Date startTime)

The time when prefetched ads are considered for use in an ad break. If you don't specify StartTime, the prefetched ads are available after MediaTailor retrives them from the ad decision server.

Parameters:

startTime - The time when prefetched ads are considered for use in an ad break. If you don't specify StartTime, the prefetched ads are available after MediaTailor retrives them from the ad decision server.

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 PrefetchConsumption 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.