Class AdBreak

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

Ad break configuration parameters.

See Also:

  • Method Details

    • hasAdBreakMetadata

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

    • adBreakMetadata

      public final List<KeyValuePair> adBreakMetadata()

      Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSETtag for SCTE35_ENHANCED output.

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

      Returns:
      Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSETtag for SCTE35_ENHANCED output.

    • messageType

      public final MessageType messageType()

      The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.

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

      Returns:
      The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
      See Also:

    • messageTypeAsString

      public final String messageTypeAsString()

      The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.

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

      Returns:
      The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
      See Also:

    • offsetMillis

      public final Long offsetMillis()

      How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.

      Returns:
      How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.

    • slate

      public final SlateSource slate()

      Ad break slate configuration.

      Returns:
      Ad break slate configuration.

    • spliceInsertMessage

      public final SpliceInsertMessage spliceInsertMessage()

      This defines the SCTE-35 splice_insert() message inserted around the ad. For information about using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.

      Returns:
      This defines the SCTE-35 splice_insert() message inserted around the ad. For information about using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.

    • timeSignalMessage

      public final TimeSignalMessage timeSignalMessage()

      Defines the SCTE-35 time_signal message inserted around the ad.

      Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a splice_insert SCTE-35 message to the ad break. This message provides basic metadata about the ad break.

      See section 9.7.4 of the 2022 SCTE-35 specification for more information.

      Returns:
      Defines the SCTE-35 time_signal message inserted around the ad.

      Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a splice_insert SCTE-35 message to the ad break. This message provides basic metadata about the ad break.

      See section 9.7.4 of the 2022 SCTE-35 specification for more information.

    • toBuilder

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

    • builder

      public static AdBreak.Builder builder()

    • serializableBuilderClass

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