software.amazon.awssdk.services.mediatailor.model

Class AvailMatchingCriteria

java.lang.Object

software.amazon.awssdk.services.mediatailor.model.AvailMatchingCriteria

All Implemented Interfaces:

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

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

MediaTailor only places (consumes) prefetched ads if the ad break meets the criteria defined by the dynamic variables. This gives you granular control over which ad break to place the prefetched ads into.

As an example, let's say that you set DynamicVariable to scte.event_id and Operator to EQUALS, and your playback configuration has an ADS URL of https://my.ads.server.com/path?&podId=[scte.avail_num]&event=[scte.event_id]&duration=[session.avail_duration_secs] . And the prefetch request to the ADS contains these values https://my.ads.server.com/path?&podId=3&event=my-awesome-event&duration=30. MediaTailor will only insert the prefetched ads into the ad break if has a SCTE marker with an event id of my-awesome-event, since it must match the event id that MediaTailor uses to query the ADS.

You can specify up to five AvailMatchingCriteria. If you specify multiple AvailMatchingCriteria, MediaTailor combines them to match using a logical AND. You can model logical OR combinations by creating multiple prefetch schedules.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AvailMatchingCriteria.Builder

Method Summary

Modifier and Type	Method and Description
static AvailMatchingCriteria.Builder	builder()
String	dynamicVariable() The dynamic variable(s) that MediaTailor should use as avail matching criteria.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Operator	operator() For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.
String	operatorAsString() For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.
List<SdkField<?>>	sdkFields()
static Class<? extends AvailMatchingCriteria.Builder>	serializableBuilderClass()
AvailMatchingCriteria.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

dynamicVariable

public final String dynamicVariable()

The dynamic variable(s) that MediaTailor should use as avail matching criteria. MediaTailor only places the prefetched ads into the avail if the avail matches the criteria defined by the dynamic variable. For information about dynamic variables, see Using dynamic ad variables in the MediaTailor User Guide.

You can include up to 100 dynamic variables.

Returns:

The dynamic variable(s) that MediaTailor should use as avail matching criteria. MediaTailor only places the prefetched ads into the avail if the avail matches the criteria defined by the dynamic variable. For information about dynamic variables, see Using dynamic ad variables in the MediaTailor User Guide.

You can include up to 100 dynamic variables.

operator

public final Operator operator()

For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.

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

Returns:

For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.

See Also:

Operator

operatorAsString

public final String operatorAsString()

For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.

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

Returns:

For the DynamicVariable specified in AvailMatchingCriteria, the Operator that is used for the comparison.

See Also:

Operator

toBuilder

public AvailMatchingCriteria.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AvailMatchingCriteria.Builder,AvailMatchingCriteria>

builder

public static AvailMatchingCriteria.Builder builder()

serializableBuilderClass

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