AdBreak (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.mediatailor.model.AdBreak

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AdBreak
extends Object
implements Serializable, Cloneable, StructuredPojo

Ad break configuration parameters.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AdBreak()

Constructors
Constructor and Description
`AdBreak()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AdBreak`	`clone()`
`boolean`	`equals(Object obj)`
`List<KeyValuePair>`	`getAdBreakMetadata()` Defines a list of key/value pairs that MediaTailor generates within the `EXT-X-ASSET`tag for `SCTE35_ENHANCED` output.
`String`	`getMessageType()` The SCTE-35 ad insertion type.
`Long`	`getOffsetMillis()` How long (in milliseconds) after the beginning of the program that an ad starts.
`SlateSource`	`getSlate()` Ad break slate configuration.
`SpliceInsertMessage`	`getSpliceInsertMessage()` This defines the SCTE-35 `splice_insert()` message inserted around the ad.
`TimeSignalMessage`	`getTimeSignalMessage()` Defines the SCTE-35 `time_signal` message inserted around the ad.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAdBreakMetadata(Collection<KeyValuePair> adBreakMetadata)` Defines a list of key/value pairs that MediaTailor generates within the `EXT-X-ASSET`tag for `SCTE35_ENHANCED` output.
`void`	`setMessageType(String messageType)` The SCTE-35 ad insertion type.
`void`	`setOffsetMillis(Long offsetMillis)` How long (in milliseconds) after the beginning of the program that an ad starts.
`void`	`setSlate(SlateSource slate)` Ad break slate configuration.
`void`	`setSpliceInsertMessage(SpliceInsertMessage spliceInsertMessage)` This defines the SCTE-35 `splice_insert()` message inserted around the ad.
`void`	`setTimeSignalMessage(TimeSignalMessage timeSignalMessage)` Defines the SCTE-35 `time_signal` message inserted around the ad.
`String`	`toString()` Returns a string representation of this object.
`AdBreak`	`withAdBreakMetadata(Collection<KeyValuePair> adBreakMetadata)` Defines a list of key/value pairs that MediaTailor generates within the `EXT-X-ASSET`tag for `SCTE35_ENHANCED` output.
`AdBreak`	`withAdBreakMetadata(KeyValuePair... adBreakMetadata)` Defines a list of key/value pairs that MediaTailor generates within the `EXT-X-ASSET`tag for `SCTE35_ENHANCED` output.
`AdBreak`	`withMessageType(MessageType messageType)` The SCTE-35 ad insertion type.
`AdBreak`	`withMessageType(String messageType)` The SCTE-35 ad insertion type.
`AdBreak`	`withOffsetMillis(Long offsetMillis)` How long (in milliseconds) after the beginning of the program that an ad starts.
`AdBreak`	`withSlate(SlateSource slate)` Ad break slate configuration.
`AdBreak`	`withSpliceInsertMessage(SpliceInsertMessage spliceInsertMessage)` This defines the SCTE-35 `splice_insert()` message inserted around the ad.
`AdBreak`	`withTimeSignalMessage(TimeSignalMessage timeSignalMessage)` Defines the SCTE-35 `time_signal` message inserted around the ad.

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

- Constructor Detail
  - AdBreak
```
public AdBreak()
```
- Method Detail
  - getAdBreakMetadata
```
public List<KeyValuePair> getAdBreakMetadata()
```
    Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSETtag for SCTE35_ENHANCED output.
    
    Returns:
    
    Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSETtag for SCTE35_ENHANCED output.
  - setAdBreakMetadata
```
public void setAdBreakMetadata(Collection<KeyValuePair> adBreakMetadata)
```
    Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSETtag for SCTE35_ENHANCED output.
    
    Parameters:
    
    adBreakMetadata - Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSETtag for SCTE35_ENHANCED output.
  - withAdBreakMetadata
```
public AdBreak withAdBreakMetadata(KeyValuePair... adBreakMetadata)
```
    Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSETtag for SCTE35_ENHANCED output.
    
    NOTE: This method appends the values to the existing list (if any). Use setAdBreakMetadata(java.util.Collection) or withAdBreakMetadata(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    adBreakMetadata - Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSETtag for SCTE35_ENHANCED output.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAdBreakMetadata
```
public AdBreak withAdBreakMetadata(Collection<KeyValuePair> adBreakMetadata)
```
    Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSETtag for SCTE35_ENHANCED output.
    
    Parameters:
    
    adBreakMetadata - Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSETtag for SCTE35_ENHANCED output.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMessageType
```
public void setMessageType(String messageType)
```
    The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
    
    Parameters:
    
    messageType - The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
    
    See Also:
    
    MessageType
  - getMessageType
```
public String getMessageType()
```
    The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
    
    Returns:
    
    The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
    
    See Also:
    
    MessageType
  - withMessageType
```
public AdBreak withMessageType(String messageType)
```
    The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
    
    Parameters:
    
    messageType - The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MessageType
  - withMessageType
```
public AdBreak withMessageType(MessageType messageType)
```
    The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
    
    Parameters:
    
    messageType - The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MessageType
  - setOffsetMillis
```
public void setOffsetMillis(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.
    
    Parameters:
    
    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.
  - getOffsetMillis
```
public Long getOffsetMillis()
```
    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.
  - withOffsetMillis
```
public AdBreak withOffsetMillis(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSlate
```
public void setSlate(SlateSource slate)
```
    Ad break slate configuration.
    
    Parameters:
    
    slate - Ad break slate configuration.
  - getSlate
```
public SlateSource getSlate()
```
    Ad break slate configuration.
    
    Returns:
    
    Ad break slate configuration.
  - withSlate
```
public AdBreak withSlate(SlateSource slate)
```
    Ad break slate configuration.
    
    Parameters:
    
    slate - Ad break slate configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSpliceInsertMessage
```
public void setSpliceInsertMessage(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.
    
    Parameters:
    
    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.
  - getSpliceInsertMessage
```
public SpliceInsertMessage getSpliceInsertMessage()
```
    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.
  - withSpliceInsertMessage
```
public AdBreak withSpliceInsertMessage(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimeSignalMessage
```
public void setTimeSignalMessage(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.
    
    Parameters:
    
    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.
  - getTimeSignalMessage
```
public TimeSignalMessage getTimeSignalMessage()
```
    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.
  - withTimeSignalMessage
```
public AdBreak withTimeSignalMessage(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AdBreak clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.772

Class AdBreak

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AdBreak

Method Detail

getAdBreakMetadata

setAdBreakMetadata

withAdBreakMetadata

withAdBreakMetadata

setMessageType

getMessageType

withMessageType

withMessageType

setOffsetMillis

getOffsetMillis

withOffsetMillis

setSlate

getSlate

withSlate

setSpliceInsertMessage

getSpliceInsertMessage

withSpliceInsertMessage

setTimeSignalMessage

getTimeSignalMessage

withTimeSignalMessage

toString

equals

hashCode

clone

marshall