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

Class AvailSuppression

java.lang.Object

software.amazon.awssdk.services.mediatailor.model.AvailSuppression

All Implemented Interfaces:

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

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

The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see Ad Suppression.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AvailSuppression.Builder

Method Summary

Modifier and Type	Method	Description
static AvailSuppression.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FillPolicy	fillPolicy()	Defines the policy to apply to the avail suppression mode.
String	fillPolicyAsString()	Defines the policy to apply to the avail suppression mode.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Mode	mode()	Sets the ad suppression mode.
String	modeAsString()	Sets the ad suppression mode.
List<SdkField<?>>	sdkFields()
static Class<? extends AvailSuppression.Builder>	serializableBuilderClass()
AvailSuppression.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	value()	A live edge offset time in HH:MM:SS.

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

fillPolicy

public final FillPolicy fillPolicy()

Defines the policy to apply to the avail suppression mode. BEHIND_LIVE_EDGE will always use the full avail suppression policy. AFTER_LIVE_EDGE mode can be used to invoke partial ad break fills when a session starts mid-break.

If the service returns an enum value that is not available in the current SDK version, fillPolicy will return FillPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fillPolicyAsString().

Returns:

Defines the policy to apply to the avail suppression mode. BEHIND_LIVE_EDGE will always use the full avail suppression policy. AFTER_LIVE_EDGE mode can be used to invoke partial ad break fills when a session starts mid-break.

See Also:

FillPolicy

fillPolicyAsString

public final String fillPolicyAsString()

Defines the policy to apply to the avail suppression mode. BEHIND_LIVE_EDGE will always use the full avail suppression policy. AFTER_LIVE_EDGE mode can be used to invoke partial ad break fills when a session starts mid-break.

If the service returns an enum value that is not available in the current SDK version, fillPolicy will return FillPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fillPolicyAsString().

Returns:

Defines the policy to apply to the avail suppression mode. BEHIND_LIVE_EDGE will always use the full avail suppression policy. AFTER_LIVE_EDGE mode can be used to invoke partial ad break fills when a session starts mid-break.

See Also:

FillPolicy

mode

public final Mode mode()

Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window. When Mode is set to AFTER_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks that are within the live edge plus the avail suppression value.

If the service returns an enum value that is not available in the current SDK version, mode will return Mode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

Returns:

Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window. When Mode is set to AFTER_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks that are within the live edge plus the avail suppression value.

See Also:

Mode

modeAsString

public final String modeAsString()

Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window. When Mode is set to AFTER_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks that are within the live edge plus the avail suppression value.

If the service returns an enum value that is not available in the current SDK version, mode will return Mode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().

Returns:

Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window. When Mode is set to AFTER_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks that are within the live edge plus the avail suppression value.

See Also:

Mode

value

public final String value()

A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45 minutes behind the live edge.

Returns:

A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45 minutes behind the live edge.

toBuilder

public AvailSuppression.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AvailSuppression.Builder,AvailSuppression>

builder

public static AvailSuppression.Builder builder()

serializableBuilderClass

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