Package software.amazon.awssdk.services.mediapackage.model

Enum AdsOnDeliveryRestrictions

java.lang.Object

java.lang.Enum<AdsOnDeliveryRestrictions>

software.amazon.awssdk.services.mediapackage.model.AdsOnDeliveryRestrictions

All Implemented Interfaces:

Serializable, Comparable<AdsOnDeliveryRestrictions>

@Generated("software.amazon.awssdk:codegen")
public enum AdsOnDeliveryRestrictions
extends Enum<AdsOnDeliveryRestrictions>

This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to determine whether a message signals an ad. Choosing "NONE" means no SCTE-35 messages become ads. Choosing "RESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that contain delivery restrictions will be treated as ads. Choosing "UNRESTRICTED" means SCTE-35 messages of the types specified in AdTriggers that do not contain delivery restrictions will be treated as ads. Choosing "BOTH" means all SCTE-35 messages of the types specified in AdTriggers will be treated as ads. Note that Splice Insert messages do not have these flags and are always treated as ads if specified in AdTriggers.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOTH
NONE
RESTRICTED
UNKNOWN_TO_SDK_VERSION
UNRESTRICTED

Method Summary

Modifier and Type	Method	Description
static AdsOnDeliveryRestrictions	fromValue(String value)	Use this in place of valueOf to convert the raw string returned by the service into the enum value.
static Set<AdsOnDeliveryRestrictions>	knownValues()	Use this in place of values() to return a Set of all values known to the SDK.
String	toString()
static AdsOnDeliveryRestrictions	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AdsOnDeliveryRestrictions[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final AdsOnDeliveryRestrictions NONE

RESTRICTED

public static final AdsOnDeliveryRestrictions RESTRICTED

UNRESTRICTED

public static final AdsOnDeliveryRestrictions UNRESTRICTED

BOTH

public static final AdsOnDeliveryRestrictions BOTH

UNKNOWN_TO_SDK_VERSION

public static final AdsOnDeliveryRestrictions UNKNOWN_TO_SDK_VERSION

Method Detail

values

public static AdsOnDeliveryRestrictions[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AdsOnDeliveryRestrictions c : AdsOnDeliveryRestrictions.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AdsOnDeliveryRestrictions valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<AdsOnDeliveryRestrictions>

fromValue

public static AdsOnDeliveryRestrictions fromValue(String value)

Use this in place of valueOf to convert the raw string returned by the service into the enum value.

Parameters:

value - real value

Returns:

AdsOnDeliveryRestrictions corresponding to the value

knownValues

public static Set<AdsOnDeliveryRestrictions> knownValues()

Use this in place of values() to return a Set of all values known to the SDK. This will return all known enum values except UNKNOWN_TO_SDK_VERSION.

Returns:

a Set of known AdsOnDeliveryRestrictionss