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

Class AlternateMedia

java.lang.Object

software.amazon.awssdk.services.mediatailor.model.AlternateMedia

All Implemented Interfaces:

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

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

A playlist of media (VOD and/or live) to be played instead of the default media on a particular program.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AlternateMedia.Builder

Method Summary

Modifier and Type	Method	Description
List<AdBreak>	adBreaks()	Ad break configuration parameters defined in AlternateMedia.
static AlternateMedia.Builder	builder()
ClipRange	clipRange()	Returns the value of the ClipRange property for this object.
Long	durationMillis()	The duration of the alternateMedia in milliseconds.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAdBreaks()	For responses, this returns true if the service returned a value for the AdBreaks property.
int	hashCode()
String	liveSourceName()	The name of the live source for alternateMedia.
Long	scheduledStartTimeMillis()	The date and time that the alternateMedia is scheduled to start, in epoch milliseconds.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AlternateMedia.Builder>	serializableBuilderClass()
String	sourceLocationName()	The name of the source location for alternateMedia.
AlternateMedia.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	vodSourceName()	The name of the VOD source for alternateMedia.

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

sourceLocationName

public final String sourceLocationName()

The name of the source location for alternateMedia.

Returns:

The name of the source location for alternateMedia.

liveSourceName

public final String liveSourceName()

The name of the live source for alternateMedia.

Returns:

The name of the live source for alternateMedia.

vodSourceName

public final String vodSourceName()

The name of the VOD source for alternateMedia.

Returns:

The name of the VOD source for alternateMedia.

clipRange

public final ClipRange clipRange()

Returns the value of the ClipRange property for this object.

Returns:

The value of the ClipRange property for this object.

scheduledStartTimeMillis

public final Long scheduledStartTimeMillis()

The date and time that the alternateMedia is scheduled to start, in epoch milliseconds.

Returns:

The date and time that the alternateMedia is scheduled to start, in epoch milliseconds.

hasAdBreaks

public final boolean hasAdBreaks()

For responses, this returns true if the service returned a value for the AdBreaks 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.

adBreaks

public final List<AdBreak> adBreaks()

Ad break configuration parameters defined in AlternateMedia.

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 hasAdBreaks() method.

Returns:

Ad break configuration parameters defined in AlternateMedia.

durationMillis

public final Long durationMillis()

The duration of the alternateMedia in milliseconds.

Returns:

The duration of the alternateMedia in milliseconds.

toBuilder

public AlternateMedia.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AlternateMedia.Builder,AlternateMedia>

builder

public static AlternateMedia.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo