@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class SegmentationDescriptor extends Object implements Serializable, Cloneable, StructuredPojo
The segmentation_descriptor
message can contain advanced metadata fields, like content identifiers, to
convey a wide range of information about the ad break. MediaTailor writes the ad metadata in the egress manifest as
part of the EXT-X-DATERANGE
or EventStream
ad marker's SCTE-35 data.
segmentation_descriptor
messages must be sent with the time_signal
message type.
See the segmentation_descriptor()
table of the 2022 SCTE-35 specification for more information.
Constructor and Description |
---|
SegmentationDescriptor() |
Modifier and Type | Method and Description |
---|---|
SegmentationDescriptor |
clone() |
boolean |
equals(Object obj) |
Integer |
getSegmentationEventId()
The Event Identifier to assign to the
segmentation_descriptor.segmentation_event_id message, as
defined in section 10.3.3.1 of the 2022 SCTE-35 specification. |
Integer |
getSegmentationTypeId()
The Type Identifier to assign to the
segmentation_descriptor.segmentation_type_id message, as
defined in section 10.3.3.1 of the 2022 SCTE-35 specification. |
String |
getSegmentationUpid()
The Upid to assign to the
segmentation_descriptor.segmentation_upid message, as defined in section
10.3.3.1 of the 2022 SCTE-35 specification. |
Integer |
getSegmentationUpidType()
The Upid Type to assign to the
segmentation_descriptor.segmentation_upid_type message, as defined in
section 10.3.3.1 of the 2022 SCTE-35 specification. |
Integer |
getSegmentNum()
The segment number to assign to the
segmentation_descriptor.segment_num message, as defined in
section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. |
Integer |
getSegmentsExpected()
The number of segments expected, which is assigned to the
segmentation_descriptor.segments_expectedS
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256,
inclusive. |
Integer |
getSubSegmentNum()
The sub-segment number to assign to the
segmentation_descriptor.sub_segment_num message, as defined
in section 10.3.3.1 of the 2022 SCTE-35 specification. |
Integer |
getSubSegmentsExpected()
The number of sub-segments expected, which is assigned to the
segmentation_descriptor.sub_segments_expected message, as defined in section 10.3.3.1 of the 2022
SCTE-35 specification. |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setSegmentationEventId(Integer segmentationEventId)
The Event Identifier to assign to the
segmentation_descriptor.segmentation_event_id message, as
defined in section 10.3.3.1 of the 2022 SCTE-35 specification. |
void |
setSegmentationTypeId(Integer segmentationTypeId)
The Type Identifier to assign to the
segmentation_descriptor.segmentation_type_id message, as
defined in section 10.3.3.1 of the 2022 SCTE-35 specification. |
void |
setSegmentationUpid(String segmentationUpid)
The Upid to assign to the
segmentation_descriptor.segmentation_upid message, as defined in section
10.3.3.1 of the 2022 SCTE-35 specification. |
void |
setSegmentationUpidType(Integer segmentationUpidType)
The Upid Type to assign to the
segmentation_descriptor.segmentation_upid_type message, as defined in
section 10.3.3.1 of the 2022 SCTE-35 specification. |
void |
setSegmentNum(Integer segmentNum)
The segment number to assign to the
segmentation_descriptor.segment_num message, as defined in
section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. |
void |
setSegmentsExpected(Integer segmentsExpected)
The number of segments expected, which is assigned to the
segmentation_descriptor.segments_expectedS
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256,
inclusive. |
void |
setSubSegmentNum(Integer subSegmentNum)
The sub-segment number to assign to the
segmentation_descriptor.sub_segment_num message, as defined
in section 10.3.3.1 of the 2022 SCTE-35 specification. |
void |
setSubSegmentsExpected(Integer subSegmentsExpected)
The number of sub-segments expected, which is assigned to the
segmentation_descriptor.sub_segments_expected message, as defined in section 10.3.3.1 of the 2022
SCTE-35 specification. |
String |
toString()
Returns a string representation of this object.
|
SegmentationDescriptor |
withSegmentationEventId(Integer segmentationEventId)
The Event Identifier to assign to the
segmentation_descriptor.segmentation_event_id message, as
defined in section 10.3.3.1 of the 2022 SCTE-35 specification. |
SegmentationDescriptor |
withSegmentationTypeId(Integer segmentationTypeId)
The Type Identifier to assign to the
segmentation_descriptor.segmentation_type_id message, as
defined in section 10.3.3.1 of the 2022 SCTE-35 specification. |
SegmentationDescriptor |
withSegmentationUpid(String segmentationUpid)
The Upid to assign to the
segmentation_descriptor.segmentation_upid message, as defined in section
10.3.3.1 of the 2022 SCTE-35 specification. |
SegmentationDescriptor |
withSegmentationUpidType(Integer segmentationUpidType)
The Upid Type to assign to the
segmentation_descriptor.segmentation_upid_type message, as defined in
section 10.3.3.1 of the 2022 SCTE-35 specification. |
SegmentationDescriptor |
withSegmentNum(Integer segmentNum)
The segment number to assign to the
segmentation_descriptor.segment_num message, as defined in
section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. |
SegmentationDescriptor |
withSegmentsExpected(Integer segmentsExpected)
The number of segments expected, which is assigned to the
segmentation_descriptor.segments_expectedS
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256,
inclusive. |
SegmentationDescriptor |
withSubSegmentNum(Integer subSegmentNum)
The sub-segment number to assign to the
segmentation_descriptor.sub_segment_num message, as defined
in section 10.3.3.1 of the 2022 SCTE-35 specification. |
SegmentationDescriptor |
withSubSegmentsExpected(Integer subSegmentsExpected)
The number of sub-segments expected, which is assigned to the
segmentation_descriptor.sub_segments_expected message, as defined in section 10.3.3.1 of the 2022
SCTE-35 specification. |
public void setSegmentNum(Integer segmentNum)
The segment number to assign to the segmentation_descriptor.segment_num
message, as defined in
section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value
is 0.
segmentNum
- The segment number to assign to the segmentation_descriptor.segment_num
message, as defined
in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The
default value is 0.public Integer getSegmentNum()
The segment number to assign to the segmentation_descriptor.segment_num
message, as defined in
section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value
is 0.
segmentation_descriptor.segment_num
message, as defined
in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The
default value is 0.public SegmentationDescriptor withSegmentNum(Integer segmentNum)
The segment number to assign to the segmentation_descriptor.segment_num
message, as defined in
section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value
is 0.
segmentNum
- The segment number to assign to the segmentation_descriptor.segment_num
message, as defined
in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The
default value is 0.public void setSegmentationEventId(Integer segmentationEventId)
The Event Identifier to assign to the segmentation_descriptor.segmentation_event_id
message, as
defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The default value is 1.
segmentationEventId
- The Event Identifier to assign to the segmentation_descriptor.segmentation_event_id
message,
as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The default value is 1.public Integer getSegmentationEventId()
The Event Identifier to assign to the segmentation_descriptor.segmentation_event_id
message, as
defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The default value is 1.
segmentation_descriptor.segmentation_event_id
message,
as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The default value is 1.public SegmentationDescriptor withSegmentationEventId(Integer segmentationEventId)
The Event Identifier to assign to the segmentation_descriptor.segmentation_event_id
message, as
defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The default value is 1.
segmentationEventId
- The Event Identifier to assign to the segmentation_descriptor.segmentation_event_id
message,
as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. The default value is 1.public void setSegmentationTypeId(Integer segmentationTypeId)
The Type Identifier to assign to the segmentation_descriptor.segmentation_type_id
message, as
defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The
default value is 48.
segmentationTypeId
- The Type Identifier to assign to the segmentation_descriptor.segmentation_type_id
message, as
defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256,
inclusive. The default value is 48.public Integer getSegmentationTypeId()
The Type Identifier to assign to the segmentation_descriptor.segmentation_type_id
message, as
defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The
default value is 48.
segmentation_descriptor.segmentation_type_id
message,
as defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256,
inclusive. The default value is 48.public SegmentationDescriptor withSegmentationTypeId(Integer segmentationTypeId)
The Type Identifier to assign to the segmentation_descriptor.segmentation_type_id
message, as
defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The
default value is 48.
segmentationTypeId
- The Type Identifier to assign to the segmentation_descriptor.segmentation_type_id
message, as
defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256,
inclusive. The default value is 48.public void setSegmentationUpid(String segmentationUpid)
The Upid to assign to the segmentation_descriptor.segmentation_upid
message, as defined in section
10.3.3.1 of the 2022 SCTE-35 specification. The value must be a hexadecimal string containing only the characters
0 though 9 and A through F. The default value is "" (an empty string).
segmentationUpid
- The Upid to assign to the segmentation_descriptor.segmentation_upid
message, as defined in
section 10.3.3.1 of the 2022 SCTE-35 specification. The value must be a hexadecimal string containing only
the characters 0 though 9 and A through F. The default value is "" (an empty string).public String getSegmentationUpid()
The Upid to assign to the segmentation_descriptor.segmentation_upid
message, as defined in section
10.3.3.1 of the 2022 SCTE-35 specification. The value must be a hexadecimal string containing only the characters
0 though 9 and A through F. The default value is "" (an empty string).
segmentation_descriptor.segmentation_upid
message, as defined in
section 10.3.3.1 of the 2022 SCTE-35 specification. The value must be a hexadecimal string containing
only the characters 0 though 9 and A through F. The default value is "" (an empty string).public SegmentationDescriptor withSegmentationUpid(String segmentationUpid)
The Upid to assign to the segmentation_descriptor.segmentation_upid
message, as defined in section
10.3.3.1 of the 2022 SCTE-35 specification. The value must be a hexadecimal string containing only the characters
0 though 9 and A through F. The default value is "" (an empty string).
segmentationUpid
- The Upid to assign to the segmentation_descriptor.segmentation_upid
message, as defined in
section 10.3.3.1 of the 2022 SCTE-35 specification. The value must be a hexadecimal string containing only
the characters 0 though 9 and A through F. The default value is "" (an empty string).public void setSegmentationUpidType(Integer segmentationUpidType)
The Upid Type to assign to the segmentation_descriptor.segmentation_upid_type
message, as defined in
section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default
value is 14.
segmentationUpidType
- The Upid Type to assign to the segmentation_descriptor.segmentation_upid_type
message, as
defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256,
inclusive. The default value is 14.public Integer getSegmentationUpidType()
The Upid Type to assign to the segmentation_descriptor.segmentation_upid_type
message, as defined in
section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default
value is 14.
segmentation_descriptor.segmentation_upid_type
message, as
defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256,
inclusive. The default value is 14.public SegmentationDescriptor withSegmentationUpidType(Integer segmentationUpidType)
The Upid Type to assign to the segmentation_descriptor.segmentation_upid_type
message, as defined in
section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default
value is 14.
segmentationUpidType
- The Upid Type to assign to the segmentation_descriptor.segmentation_upid_type
message, as
defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256,
inclusive. The default value is 14.public void setSegmentsExpected(Integer segmentsExpected)
The number of segments expected, which is assigned to the segmentation_descriptor.segments_expectedS
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256,
inclusive. The default value is 0.
segmentsExpected
- The number of segments expected, which is assigned to the
segmentation_descriptor.segments_expectedS
message, as defined in section 10.3.3.1 of the
2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.public Integer getSegmentsExpected()
The number of segments expected, which is assigned to the segmentation_descriptor.segments_expectedS
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256,
inclusive. The default value is 0.
segmentation_descriptor.segments_expectedS
message, as defined in section 10.3.3.1 of the
2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.public SegmentationDescriptor withSegmentsExpected(Integer segmentsExpected)
The number of segments expected, which is assigned to the segmentation_descriptor.segments_expectedS
message, as defined in section 10.3.3.1 of the 2022 SCTE-35 specification Values must be between 0 and 256,
inclusive. The default value is 0.
segmentsExpected
- The number of segments expected, which is assigned to the
segmentation_descriptor.segments_expectedS
message, as defined in section 10.3.3.1 of the
2022 SCTE-35 specification Values must be between 0 and 256, inclusive. The default value is 0.public void setSubSegmentNum(Integer subSegmentNum)
The sub-segment number to assign to the segmentation_descriptor.sub_segment_num
message, as defined
in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The defualt
value is null.
subSegmentNum
- The sub-segment number to assign to the segmentation_descriptor.sub_segment_num
message, as
defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256,
inclusive. The defualt value is null.public Integer getSubSegmentNum()
The sub-segment number to assign to the segmentation_descriptor.sub_segment_num
message, as defined
in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The defualt
value is null.
segmentation_descriptor.sub_segment_num
message, as
defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256,
inclusive. The defualt value is null.public SegmentationDescriptor withSubSegmentNum(Integer subSegmentNum)
The sub-segment number to assign to the segmentation_descriptor.sub_segment_num
message, as defined
in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The defualt
value is null.
subSegmentNum
- The sub-segment number to assign to the segmentation_descriptor.sub_segment_num
message, as
defined in section 10.3.3.1 of the 2022 SCTE-35 specification. Values must be between 0 and 256,
inclusive. The defualt value is null.public void setSubSegmentsExpected(Integer subSegmentsExpected)
The number of sub-segments expected, which is assigned to the
segmentation_descriptor.sub_segments_expected
message, as defined in section 10.3.3.1 of the 2022
SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is null.
subSegmentsExpected
- The number of sub-segments expected, which is assigned to the
segmentation_descriptor.sub_segments_expected
message, as defined in section 10.3.3.1 of the
2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is null.public Integer getSubSegmentsExpected()
The number of sub-segments expected, which is assigned to the
segmentation_descriptor.sub_segments_expected
message, as defined in section 10.3.3.1 of the 2022
SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is null.
segmentation_descriptor.sub_segments_expected
message, as defined in section 10.3.3.1 of the
2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is null.public SegmentationDescriptor withSubSegmentsExpected(Integer subSegmentsExpected)
The number of sub-segments expected, which is assigned to the
segmentation_descriptor.sub_segments_expected
message, as defined in section 10.3.3.1 of the 2022
SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is null.
subSegmentsExpected
- The number of sub-segments expected, which is assigned to the
segmentation_descriptor.sub_segments_expected
message, as defined in section 10.3.3.1 of the
2022 SCTE-35 specification. Values must be between 0 and 256, inclusive. The default value is null.public String toString()
toString
in class Object
Object.toString()
public SegmentationDescriptor clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.