java.lang.Object
- software.amazon.awssdk.services.mediatailor.model.PrefetchSchedule

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PrefetchSchedule.Builder,PrefetchSchedule>
```
@Generated("software.amazon.awssdk:codegen")
public final class PrefetchSchedule
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PrefetchSchedule.Builder,PrefetchSchedule>
```
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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface PrefetchSchedule.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`arn()`	The Amazon Resource Name (ARN) of the prefetch schedule.
`static PrefetchSchedule.Builder`	`builder()`
`PrefetchConsumption`	`consumption()`	Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`name()`	The name of the prefetch schedule.
`String`	`playbackConfigurationName()`	The name of the playback configuration to create the prefetch schedule for.
`PrefetchRetrieval`	`retrieval()`	A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PrefetchSchedule.Builder>`	`serializableBuilderClass()`
`String`	`streamId()`	An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.
`PrefetchSchedule.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of the prefetch schedule.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the prefetch schedule.
  - consumption
```
public final 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.
    
    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.
  - name
```
public final 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.
    
    Returns:
    
    The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.
  - playbackConfigurationName
```
public final String playbackConfigurationName()
```
    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.
  - retrieval
```
public final PrefetchRetrieval retrieval()
```
    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).
  - streamId
```
public final String streamId()
```
    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.
  - toBuilder
```
public PrefetchSchedule.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PrefetchSchedule.Builder,PrefetchSchedule>
  - builder
```
public static PrefetchSchedule.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PrefetchSchedule.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class PrefetchSchedule

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

arn

consumption

name

playbackConfigurationName

retrieval

streamId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields