Class AvailMatchingCriteria

java.lang.Object
software.amazon.awssdk.services.mediatailor.model.AvailMatchingCriteria
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AvailMatchingCriteria.Builder,AvailMatchingCriteria>
@Generated("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:

  • Method Details

    • 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:

    • 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:

    • toBuilder

      public AvailMatchingCriteria.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<AvailMatchingCriteria.Builder,AvailMatchingCriteria>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.