Package software.amazon.awssdk.services.mediatailor.model

Class CreatePrefetchScheduleRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.mediatailor.model.MediaTailorRequest

software.amazon.awssdk.services.mediatailor.model.CreatePrefetchScheduleRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreatePrefetchScheduleRequest.Builder,CreatePrefetchScheduleRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreatePrefetchScheduleRequest
extends MediaTailorRequest
implements ToCopyableBuilder<CreatePrefetchScheduleRequest.Builder,CreatePrefetchScheduleRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreatePrefetchScheduleRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreatePrefetchScheduleRequest.Builder	builder()
PrefetchConsumption	consumption()	The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision server.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name to assign to the schedule request.
String	playbackConfigurationName()	The name to assign to the playback configuration.
PrefetchRetrieval	retrieval()	The configuration settings for retrieval of prefetched ads from the ad decision server.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreatePrefetchScheduleRequest.Builder>	serializableBuilderClass()
String	streamId()	An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration.
CreatePrefetchScheduleRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

consumption

public final 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.

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.

name

public final String name()

The name to assign to the schedule request.

Returns:

The name to assign to the schedule request.

playbackConfigurationName

public final String playbackConfigurationName()

The name to assign to the playback configuration.

Returns:

The name to assign to the playback configuration.

retrieval

public final 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.

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.

streamId

public final 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.

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.

toBuilder

public CreatePrefetchScheduleRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreatePrefetchScheduleRequest.Builder,CreatePrefetchScheduleRequest>

Specified by:

toBuilder in class MediaTailorRequest

builder

public static CreatePrefetchScheduleRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreatePrefetchScheduleRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo