Class PrefetchSchedule

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

A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see Using ad prefetching in the MediaTailor User Guide.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the prefetch schedule.

      Returns:
      The Amazon Resource Name (ARN) of the prefetch schedule.

    • consumption

      public final PrefetchConsumption consumption()

      Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks for single prefetch schedules. Ad consumption occurs within a span of time that you define, called a consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.

      Returns:
      Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks for single prefetch schedules. Ad consumption occurs within a span of time that you define, called a consumption window. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.

    • name

      public final String name()

      The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.

      Returns:
      The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.

    • playbackConfigurationName

      public final String playbackConfigurationName()

      The name of the playback configuration to create the prefetch schedule for.

      Returns:
      The name of the playback configuration to create the prefetch schedule for.

    • retrieval

      public final PrefetchRetrieval retrieval()

      A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).

      Returns:
      A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).

    • scheduleType

      public final PrefetchScheduleType scheduleType()

      The frequency that MediaTailor creates prefetch schedules. SINGLE indicates that this schedule applies to one ad break. RECURRING indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.

      For more information about the prefetch types and when you might use each, see Prefetching ads in Elemental MediaTailor.

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

      Returns:
      The frequency that MediaTailor creates prefetch schedules. SINGLE indicates that this schedule applies to one ad break. RECURRING indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.

      For more information about the prefetch types and when you might use each, see Prefetching ads in Elemental MediaTailor.

      See Also:

    • scheduleTypeAsString

      public final String scheduleTypeAsString()

      The frequency that MediaTailor creates prefetch schedules. SINGLE indicates that this schedule applies to one ad break. RECURRING indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.

      For more information about the prefetch types and when you might use each, see Prefetching ads in Elemental MediaTailor.

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

      Returns:
      The frequency that MediaTailor creates prefetch schedules. SINGLE indicates that this schedule applies to one ad break. RECURRING indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.

      For more information about the prefetch types and when you might use each, see Prefetching ads in Elemental MediaTailor.

      See Also:

    • recurringPrefetchConfiguration

      public final RecurringPrefetchConfiguration recurringPrefetchConfiguration()

      The settings that determine how and when MediaTailor prefetches ads and inserts them into ad breaks.

      Returns:
      The settings that determine how and when MediaTailor prefetches ads and inserts them into ad breaks.

    • streamId

      public final String streamId()

      An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.

      Returns:
      An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      The tags assigned to the prefetch schedule. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

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

      Returns:
      The tags assigned to the prefetch schedule. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

    • toBuilder

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

    • builder

      public static PrefetchSchedule.Builder builder()

    • serializableBuilderClass

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