AdBreak (AWS Java SDK :: Services :: MediaTailor 2.20.111 API)

java.lang.Object
- software.amazon.awssdk.services.mediatailor.model.AdBreak

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<AdBreak.Builder,AdBreak>

@Generated(value="software.amazon.awssdk:codegen")
public final class AdBreak
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AdBreak.Builder,AdBreak>

Ad break configuration parameters.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AdBreak.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AdBreak.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<KeyValuePair>`	`adBreakMetadata()` Defines a list of key/value pairs that MediaTailor generates within the `EXT-X-ASSET`tag for `SCTE35_ENHANCED` output.
`static AdBreak.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAdBreakMetadata()` For responses, this returns true if the service returned a value for the AdBreakMetadata property.
`int`	`hashCode()`
`MessageType`	`messageType()` The SCTE-35 ad insertion type.
`String`	`messageTypeAsString()` The SCTE-35 ad insertion type.
`Long`	`offsetMillis()` How long (in milliseconds) after the beginning of the program that an ad starts.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AdBreak.Builder>`	`serializableBuilderClass()`
`SlateSource`	`slate()` Ad break slate configuration.
`SpliceInsertMessage`	`spliceInsertMessage()` This defines the SCTE-35 `splice_insert()` message inserted around the ad.
`TimeSignalMessage`	`timeSignalMessage()` Defines the SCTE-35 `time_signal` message inserted around the ad.
`AdBreak.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    MessageType
  - 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:
    
    MessageType
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AdBreak.Builder,AdBreak>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class AdBreak

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasAdBreakMetadata

adBreakMetadata

messageType

messageTypeAsString

offsetMillis

slate

spliceInsertMessage

timeSignalMessage

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields