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

Class PrefetchConsumption

java.lang.Object
software.amazon.awssdk.services.mediatailor.model.PrefetchConsumption
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PrefetchConsumption.Builder,PrefetchConsumption>
@Generated("software.amazon.awssdk:codegen") public final class PrefetchConsumption extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PrefetchConsumption.Builder,PrefetchConsumption>

A complex type that contains settings that determine how and when that MediaTailor places prefetched ads into upcoming ad breaks.

See Also:

  • Method Details

    • hasAvailMatchingCriteria

      public final boolean hasAvailMatchingCriteria()
      For responses, this returns true if the service returned a value for the AvailMatchingCriteria 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.

    • availMatchingCriteria

      public final List<AvailMatchingCriteria> availMatchingCriteria()

      If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as scte.event_id, set the avail matching criteria.

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

      Returns:
      If you only want MediaTailor to insert prefetched ads into avails (ad breaks) that match specific dynamic variables, such as scte.event_id, set the avail matching criteria.

    • endTime

      public final Instant endTime()

      The time when MediaTailor no longer considers the prefetched ads for use in an ad break. MediaTailor automatically deletes prefetch schedules no less than seven days after the end time. If you'd like to manually delete the prefetch schedule, you can call DeletePrefetchSchedule.

      Returns:
      The time when MediaTailor no longer considers the prefetched ads for use in an ad break. MediaTailor automatically deletes prefetch schedules no less than seven days after the end time. If you'd like to manually delete the prefetch schedule, you can call DeletePrefetchSchedule.

    • startTime

      public final Instant startTime()

      The time when prefetched ads are considered for use in an ad break. If you don't specify StartTime, the prefetched ads are available after MediaTailor retrives them from the ad decision server.

      Returns:
      The time when prefetched ads are considered for use in an ad break. If you don't specify StartTime, the prefetched ads are available after MediaTailor retrives them from the ad decision server.

    • toBuilder

      public PrefetchConsumption.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<PrefetchConsumption.Builder,PrefetchConsumption>
      Returns:
      a builder for type T

    • builder

      public static PrefetchConsumption.Builder builder()

    • serializableBuilderClass

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