SegmentationDescriptor (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SegmentationDescriptor()

Constructors
Constructor and Description
`SegmentationDescriptor()`

Method Summary

All Methods Instance Methods Concrete Methods
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.

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

- Constructor Detail
  - SegmentationDescriptor
```
public SegmentationDescriptor()
```
- Method Detail
  - setSegmentNum
```
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.
    
    Parameters:
    
    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.
  - getSegmentNum
```
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.
    
    Returns:
    
    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.
  - withSegmentNum
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSegmentationEventId
```
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.
    
    Parameters:
    
    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.
  - getSegmentationEventId
```
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.
    
    Returns:
    
    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.
  - withSegmentationEventId
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSegmentationTypeId
```
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.
    
    Parameters:
    
    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.
  - getSegmentationTypeId
```
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.
    
    Returns:
    
    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.
  - withSegmentationTypeId
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSegmentationUpid
```
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).
    
    Parameters:
    
    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).
  - getSegmentationUpid
```
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).
    
    Returns:
    
    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).
  - withSegmentationUpid
```
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).
    
    Parameters:
    
    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).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSegmentationUpidType
```
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.
    
    Parameters:
    
    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.
  - getSegmentationUpidType
```
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.
    
    Returns:
    
    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.
  - withSegmentationUpidType
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSegmentsExpected
```
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.
    
    Parameters:
    
    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.
  - getSegmentsExpected
```
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.
    
    Returns:
    
    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.
  - withSegmentsExpected
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSubSegmentNum
```
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.
    
    Parameters:
    
    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.
  - getSubSegmentNum
```
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.
    
    Returns:
    
    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.
  - withSubSegmentNum
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSubSegmentsExpected
```
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.
    
    Parameters:
    
    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.
  - getSubSegmentsExpected
```
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.
    
    Returns:
    
    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.
  - withSubSegmentsExpected
```
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.
    
    Parameters:
    
    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.
    
    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 SegmentationDescriptor 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.531

Class SegmentationDescriptor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SegmentationDescriptor

Method Detail

setSegmentNum

getSegmentNum

withSegmentNum

setSegmentationEventId

getSegmentationEventId

withSegmentationEventId

setSegmentationTypeId

getSegmentationTypeId

withSegmentationTypeId

setSegmentationUpid

getSegmentationUpid

withSegmentationUpid

setSegmentationUpidType

getSegmentationUpidType

withSegmentationUpidType

setSegmentsExpected

getSegmentsExpected

withSegmentsExpected

setSubSegmentNum

getSubSegmentNum

withSubSegmentNum

setSubSegmentsExpected

getSubSegmentsExpected

withSubSegmentsExpected

toString

equals

hashCode

clone

marshall