Class PrefetchRetrieval

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

A complex type that contains settings governing when MediaTailor prefetches ads, and which dynamic variables that MediaTailor includes in the request to the ad decision server.

See Also:

  • Method Details

    • hasDynamicVariables

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

    • dynamicVariables

      public final Map<String,String> dynamicVariables()

      The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).

      You initially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.

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

      Returns:
      The dynamic variables to use for substitution during prefetch requests to the ad decision server (ADS).

      You initially configure dynamic variables for the ADS URL when you set up your playback configuration. When you specify DynamicVariables for prefetch retrieval, MediaTailor includes the dynamic variables in the request to the ADS.

    • endTime

      public final Instant endTime()

      The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.

      Returns:
      The time when prefetch retrieval ends for the ad break. Prefetching will be attempted for manifest requests that occur at or before this time.

    • startTime

      public final Instant startTime()

      The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.

      Returns:
      The time when prefetch retrievals can start for this break. Ad prefetching will be attempted for manifest requests that occur at or after this time. Defaults to the current time. If not specified, the prefetch retrieval starts as soon as possible.

    • trafficShapingType

      public final TrafficShapingType trafficShapingType()

      Indicates if this configuration uses a retrieval window for traffic shaping and limiting the number of requests to the ADS at one time.

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

      Returns:
      Indicates if this configuration uses a retrieval window for traffic shaping and limiting the number of requests to the ADS at one time.
      See Also:

    • trafficShapingTypeAsString

      public final String trafficShapingTypeAsString()

      Indicates if this configuration uses a retrieval window for traffic shaping and limiting the number of requests to the ADS at one time.

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

      Returns:
      Indicates if this configuration uses a retrieval window for traffic shaping and limiting the number of requests to the ADS at one time.
      See Also:

    • trafficShapingRetrievalWindow

      public final TrafficShapingRetrievalWindow trafficShapingRetrievalWindow()

      Configuration for spreading ADS traffic across a set window instead of sending ADS requests for all sessions at the same time.

      Returns:
      Configuration for spreading ADS traffic across a set window instead of sending ADS requests for all sessions at the same time.

    • toBuilder

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

    • builder

      public static PrefetchRetrieval.Builder builder()

    • serializableBuilderClass

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