PrefetchSchedule (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.mediatailor.model.PrefetchSchedule

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PrefetchSchedule
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PrefetchSchedule()

Constructors
Constructor and Description
`PrefetchSchedule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PrefetchSchedule`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon Resource Name (ARN) of the prefetch schedule.
`PrefetchConsumption`	`getConsumption()` Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks.
`String`	`getName()` The name of the prefetch schedule.
`String`	`getPlaybackConfigurationName()` The name of the playback configuration to create the prefetch schedule for.
`PrefetchRetrieval`	`getRetrieval()` A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
`String`	`getStreamId()` An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of the prefetch schedule.
`void`	`setConsumption(PrefetchConsumption consumption)` Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks.
`void`	`setName(String name)` The name of the prefetch schedule.
`void`	`setPlaybackConfigurationName(String playbackConfigurationName)` The name of the playback configuration to create the prefetch schedule for.
`void`	`setRetrieval(PrefetchRetrieval retrieval)` A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
`void`	`setStreamId(String streamId)` An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
`String`	`toString()` Returns a string representation of this object.
`PrefetchSchedule`	`withArn(String arn)` The Amazon Resource Name (ARN) of the prefetch schedule.
`PrefetchSchedule`	`withConsumption(PrefetchConsumption consumption)` Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks.
`PrefetchSchedule`	`withName(String name)` The name of the prefetch schedule.
`PrefetchSchedule`	`withPlaybackConfigurationName(String playbackConfigurationName)` The name of the playback configuration to create the prefetch schedule for.
`PrefetchSchedule`	`withRetrieval(PrefetchRetrieval retrieval)` A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
`PrefetchSchedule`	`withStreamId(String streamId)` An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PrefetchSchedule
```
public PrefetchSchedule()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) of the prefetch schedule.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the prefetch schedule.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the prefetch schedule.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the prefetch schedule.
  - withArn
```
public PrefetchSchedule withArn(String arn)
```
    The Amazon Resource Name (ARN) of the prefetch schedule.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the prefetch schedule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConsumption
```
public void setConsumption(PrefetchConsumption consumption)
```
    Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.
    
    Parameters:
    
    consumption - Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.
  - getConsumption
```
public PrefetchConsumption getConsumption()
```
    Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.
    
    Returns:
    
    Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.
  - withConsumption
```
public PrefetchSchedule withConsumption(PrefetchConsumption consumption)
```
    Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.
    
    Parameters:
    
    consumption - Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
    
    Parameters:
    
    name - The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
  - getName
```
public String getName()
```
    The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
    
    Returns:
    
    The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
  - withName
```
public PrefetchSchedule withName(String name)
```
    The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
    
    Parameters:
    
    name - The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPlaybackConfigurationName
```
public void setPlaybackConfigurationName(String playbackConfigurationName)
```
    The name of the playback configuration to create the prefetch schedule for.
    
    Parameters:
    
    playbackConfigurationName - The name of the playback configuration to create the prefetch schedule for.
  - getPlaybackConfigurationName
```
public String getPlaybackConfigurationName()
```
    The name of the playback configuration to create the prefetch schedule for.
    
    Returns:
    
    The name of the playback configuration to create the prefetch schedule for.
  - withPlaybackConfigurationName
```
public PrefetchSchedule withPlaybackConfigurationName(String playbackConfigurationName)
```
    The name of the playback configuration to create the prefetch schedule for.
    
    Parameters:
    
    playbackConfigurationName - The name of the playback configuration to create the prefetch schedule for.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRetrieval
```
public void setRetrieval(PrefetchRetrieval retrieval)
```
    A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
    
    Parameters:
    
    retrieval - A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
  - getRetrieval
```
public PrefetchRetrieval getRetrieval()
```
    A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
    
    Returns:
    
    A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
  - withRetrieval
```
public PrefetchSchedule withRetrieval(PrefetchRetrieval retrieval)
```
    A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
    
    Parameters:
    
    retrieval - A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
    
    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 you can specify in order to prefetch for multiple streams that use the same playback configuration.
    
    Parameters:
    
    streamId - An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
  - getStreamId
```
public String getStreamId()
```
    An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
    
    Returns:
    
    An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
  - withStreamId
```
public PrefetchSchedule withStreamId(String streamId)
```
    An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
    
    Parameters:
    
    streamId - An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
    
    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 PrefetchSchedule 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.

AWS SDK for Java 1.x API Reference - 1.12.772

Class PrefetchSchedule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PrefetchSchedule

Method Detail

setArn

getArn

withArn

setConsumption

getConsumption

withConsumption

setName

getName

withName

setPlaybackConfigurationName

getPlaybackConfigurationName

withPlaybackConfigurationName

setRetrieval

getRetrieval

withRetrieval

setStreamId

getStreamId

withStreamId

toString

equals

hashCode

clone

marshall