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

Class PrefetchConsumption

java.lang.Object

software.amazon.awssdk.services.mediatailor.model.PrefetchConsumption

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PrefetchConsumption.Builder,PrefetchConsumption>

@Generated("software.amazon.awssdk:codegen")
public final class PrefetchConsumption
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PrefetchConsumption.Builder,PrefetchConsumption>

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PrefetchConsumption.Builder

Method Summary

Modifier and Type	Method	Description
List<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.
static PrefetchConsumption.Builder	builder()
Instant	endTime()	The time when MediaTailor no longer considers the prefetched ads for use in an ad break.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAvailMatchingCriteria()	For responses, this returns true if the service returned a value for the AvailMatchingCriteria property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends PrefetchConsumption.Builder>	serializableBuilderClass()
Instant	startTime()	The time when prefetched ads are considered for use in an ad break.
PrefetchConsumption.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

hasAvailMatchingCriteria

public final boolean hasAvailMatchingCriteria()

For responses, this returns true if the service returned a value for the AvailMatchingCriteria property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

availMatchingCriteria

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAvailMatchingCriteria() method.

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.

endTime

public final Instant 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:

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.

startTime

public final Instant 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:

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.

toBuilder

public PrefetchConsumption.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PrefetchConsumption.Builder,PrefetchConsumption>

builder

public static PrefetchConsumption.Builder builder()

serializableBuilderClass

public static Class<? extends PrefetchConsumption.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