Package software.amazon.awssdk.services.mediatailor.model

Class TimeSignalMessage

java.lang.Object

software.amazon.awssdk.services.mediatailor.model.TimeSignalMessage

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<TimeSignalMessage.Builder,TimeSignalMessage>

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

The SCTE-35 time_signal message can be sent with one or more segmentation_descriptor messages. A time_signal message can be sent only if a single segmentation_descriptor message is sent.

The time_signal message contains only the splice_time field which is constructed using a given presentation timestamp. When sending a time_signal message, the splice_command_type field in the splice_info_section message is set to 6 (0x06).

See the time_signal() table of the 2022 SCTE-35 specification for more information.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TimeSignalMessage.Builder

Method Summary

Modifier and Type	Method	Description
static TimeSignalMessage.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSegmentationDescriptors()	For responses, this returns true if the service returned a value for the SegmentationDescriptors property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
List<SegmentationDescriptor>	segmentationDescriptors()	The configurations for the SCTE-35 segmentation_descriptor message(s) sent with the time_signal message.
static Class<? extends TimeSignalMessage.Builder>	serializableBuilderClass()
TimeSignalMessage.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

hasSegmentationDescriptors

public final boolean hasSegmentationDescriptors()

For responses, this returns true if the service returned a value for the SegmentationDescriptors 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.

segmentationDescriptors

public final List<SegmentationDescriptor> segmentationDescriptors()

The configurations for the SCTE-35 segmentation_descriptor message(s) sent with the time_signal message.

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

Returns:

The configurations for the SCTE-35 segmentation_descriptor message(s) sent with the time_signal message.

toBuilder

public TimeSignalMessage.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TimeSignalMessage.Builder,TimeSignalMessage>

builder

public static TimeSignalMessage.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo