Class CreatePrefetchScheduleRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.mediatailor.model.MediaTailorRequest
software.amazon.awssdk.services.mediatailor.model.CreatePrefetchScheduleRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreatePrefetchScheduleRequest.Builder,CreatePrefetchScheduleRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreatePrefetchScheduleRequest extends MediaTailorRequest implements ToCopyableBuilder<CreatePrefetchScheduleRequest.Builder,CreatePrefetchScheduleRequest>

  • Method Details

    • consumption

      public final PrefetchConsumption consumption()

      The configuration settings for how and when MediaTailor consumes prefetched ads from the ad decision server for single prefetch schedules. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.

      Returns:
      The configuration settings for how and when MediaTailor consumes prefetched ads from the ad decision server for single prefetch schedules. Each consumption configuration contains an end time and an optional start time that define the consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.

    • name

      public final String name()

      The name to assign to the schedule request.

      Returns:
      The name to assign to the schedule request.

    • playbackConfigurationName

      public final String playbackConfigurationName()

      The name to assign to the playback configuration.

      Returns:
      The name to assign to the playback configuration.

    • retrieval

      public final PrefetchRetrieval retrieval()

      The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.

      Returns:
      The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.

    • recurringPrefetchConfiguration

      public final RecurringPrefetchConfiguration recurringPrefetchConfiguration()

      The configuration that defines how and when MediaTailor performs ad prefetching in a live event.

      Returns:
      The configuration that defines how and when MediaTailor performs ad prefetching in a live event.

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

    • streamId

      public final String streamId()

      An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If StreamId is specified, MediaTailor returns all of the prefetch schedules with an exact match on StreamId. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of StreamId.

      Returns:
      An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If StreamId is specified, MediaTailor returns all of the prefetch schedules with an exact match on StreamId. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of StreamId.

    • toBuilder

      public CreatePrefetchScheduleRequest.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<CreatePrefetchScheduleRequest.Builder,CreatePrefetchScheduleRequest>
      Specified by:
      toBuilder in class MediaTailorRequest
      Returns:
      a builder for type T

    • builder

      public static CreatePrefetchScheduleRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreatePrefetchScheduleRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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