Class Transition

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

Program transition configuration.

See Also:

  • Method Details

    • durationMillis

      public final Long durationMillis()

      The duration of the live program in seconds.

      Returns:
      The duration of the live program in seconds.

    • relativePosition

      public final RelativePosition relativePosition()

      The position where this program will be inserted relative to the RelativePosition.

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

      Returns:
      The position where this program will be inserted relative to the RelativePosition.
      See Also:

    • relativePositionAsString

      public final String relativePositionAsString()

      The position where this program will be inserted relative to the RelativePosition.

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

      Returns:
      The position where this program will be inserted relative to the RelativePosition.
      See Also:

    • relativeProgram

      public final String relativeProgram()

      The name of the program that this program will be inserted next to, as defined by RelativePosition.

      Returns:
      The name of the program that this program will be inserted next to, as defined by RelativePosition.

    • scheduledStartTimeMillis

      public final Long scheduledStartTimeMillis()

      The date and time that the program is scheduled to start, in epoch milliseconds.

      Returns:
      The date and time that the program is scheduled to start, in epoch milliseconds.

    • type

      public final String type()

      Defines when the program plays in the schedule. You can set the value to ABSOLUTE or RELATIVE.

      ABSOLUTE - The program plays at a specific wall clock time. This setting can only be used for channels using the LINEAR PlaybackMode.

      Note the following considerations when using ABSOLUTE transitions:

      If the preceding program in the schedule has a duration that extends past the wall clock time, MediaTailor truncates the preceding program on a common segment boundary.

      If there are gaps in playback, MediaTailor plays the FillerSlate you configured for your linear channel.

      RELATIVE - The program is inserted into the schedule either before or after a program that you specify via RelativePosition.

      Returns:
      Defines when the program plays in the schedule. You can set the value to ABSOLUTE or RELATIVE.

      ABSOLUTE - The program plays at a specific wall clock time. This setting can only be used for channels using the LINEAR PlaybackMode.

      Note the following considerations when using ABSOLUTE transitions:

      If the preceding program in the schedule has a duration that extends past the wall clock time, MediaTailor truncates the preceding program on a common segment boundary.

      If there are gaps in playback, MediaTailor plays the FillerSlate you configured for your linear channel.

      RELATIVE - The program is inserted into the schedule either before or after a program that you specify via RelativePosition.

    • toBuilder

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

    • builder

      public static Transition.Builder builder()

    • serializableBuilderClass

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