Class Scte35SegmentationDescriptor

java.lang.Object
software.amazon.awssdk.services.medialive.model.Scte35SegmentationDescriptor
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Scte35SegmentationDescriptor.Builder,Scte35SegmentationDescriptor>
@Generated("software.amazon.awssdk:codegen") public final class Scte35SegmentationDescriptor extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Scte35SegmentationDescriptor.Builder,Scte35SegmentationDescriptor>
Corresponds to SCTE-35 segmentation_descriptor.
See Also:

  • Method Details

    • deliveryRestrictions

      public final Scte35DeliveryRestrictions deliveryRestrictions()
      Holds the four SCTE-35 delivery restriction parameters.
      Returns:
      Holds the four SCTE-35 delivery restriction parameters.

    • segmentNum

      public final Integer segmentNum()
      Corresponds to SCTE-35 segment_num. A value that is valid for the specified segmentation_type_id.
      Returns:
      Corresponds to SCTE-35 segment_num. A value that is valid for the specified segmentation_type_id.

    • segmentationCancelIndicator

      public final Scte35SegmentationCancelIndicator segmentationCancelIndicator()
      Corresponds to SCTE-35 segmentation_event_cancel_indicator.

      If the service returns an enum value that is not available in the current SDK version, segmentationCancelIndicator will return Scte35SegmentationCancelIndicator.UNKNOWN_TO_SDK_VERSION . The raw value returned by the service is available from segmentationCancelIndicatorAsString().

      Returns:
      Corresponds to SCTE-35 segmentation_event_cancel_indicator.
      See Also:

    • segmentationCancelIndicatorAsString

      public final String segmentationCancelIndicatorAsString()
      Corresponds to SCTE-35 segmentation_event_cancel_indicator.

      If the service returns an enum value that is not available in the current SDK version, segmentationCancelIndicator will return Scte35SegmentationCancelIndicator.UNKNOWN_TO_SDK_VERSION . The raw value returned by the service is available from segmentationCancelIndicatorAsString().

      Returns:
      Corresponds to SCTE-35 segmentation_event_cancel_indicator.
      See Also:

    • segmentationDuration

      public final Long segmentationDuration()
      Corresponds to SCTE-35 segmentation_duration. Optional. The duration for the time_signal, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. Enter time in 90 KHz clock ticks. If you do not enter a duration, the time_signal will continue until you insert a cancellation message.
      Returns:
      Corresponds to SCTE-35 segmentation_duration. Optional. The duration for the time_signal, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. Enter time in 90 KHz clock ticks. If you do not enter a duration, the time_signal will continue until you insert a cancellation message.

    • segmentationEventId

      public final Long segmentationEventId()
      Corresponds to SCTE-35 segmentation_event_id.
      Returns:
      Corresponds to SCTE-35 segmentation_event_id.

    • segmentationTypeId

      public final Integer segmentationTypeId()
      Corresponds to SCTE-35 segmentation_type_id. One of the segmentation_type_id values listed in the SCTE-35 specification. On the console, enter the ID in decimal (for example, "52"). In the CLI, API, or an SDK, enter the ID in hex (for example, "0x34") or decimal (for example, "52").
      Returns:
      Corresponds to SCTE-35 segmentation_type_id. One of the segmentation_type_id values listed in the SCTE-35 specification. On the console, enter the ID in decimal (for example, "52"). In the CLI, API, or an SDK, enter the ID in hex (for example, "0x34") or decimal (for example, "52").

    • segmentationUpid

      public final String segmentationUpid()
      Corresponds to SCTE-35 segmentation_upid. Enter a string containing the hexadecimal representation of the characters that make up the SCTE-35 segmentation_upid value. Must contain an even number of hex characters. Do not include spaces between each hex pair. For example, the ASCII "ADS Information" becomes hex "41445320496e666f726d6174696f6e.
      Returns:
      Corresponds to SCTE-35 segmentation_upid. Enter a string containing the hexadecimal representation of the characters that make up the SCTE-35 segmentation_upid value. Must contain an even number of hex characters. Do not include spaces between each hex pair. For example, the ASCII "ADS Information" becomes hex "41445320496e666f726d6174696f6e.

    • segmentationUpidType

      public final Integer segmentationUpidType()
      Corresponds to SCTE-35 segmentation_upid_type. On the console, enter one of the types listed in the SCTE-35 specification, converted to a decimal. For example, "0x0C" hex from the specification is "12" in decimal. In the CLI, API, or an SDK, enter one of the types listed in the SCTE-35 specification, in either hex (for example, "0x0C" ) or in decimal (for example, "12").
      Returns:
      Corresponds to SCTE-35 segmentation_upid_type. On the console, enter one of the types listed in the SCTE-35 specification, converted to a decimal. For example, "0x0C" hex from the specification is "12" in decimal. In the CLI, API, or an SDK, enter one of the types listed in the SCTE-35 specification, in either hex (for example, "0x0C" ) or in decimal (for example, "12").

    • segmentsExpected

      public final Integer segmentsExpected()
      Corresponds to SCTE-35 segments_expected. A value that is valid for the specified segmentation_type_id.
      Returns:
      Corresponds to SCTE-35 segments_expected. A value that is valid for the specified segmentation_type_id.

    • subSegmentNum

      public final Integer subSegmentNum()
      Corresponds to SCTE-35 sub_segment_num. A value that is valid for the specified segmentation_type_id.
      Returns:
      Corresponds to SCTE-35 sub_segment_num. A value that is valid for the specified segmentation_type_id.

    • subSegmentsExpected

      public final Integer subSegmentsExpected()
      Corresponds to SCTE-35 sub_segments_expected. A value that is valid for the specified segmentation_type_id.
      Returns:
      Corresponds to SCTE-35 sub_segments_expected. A value that is valid for the specified segmentation_type_id.

    • toBuilder

      public Scte35SegmentationDescriptor.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Scte35SegmentationDescriptor.Builder,Scte35SegmentationDescriptor>
      Returns:
      a builder for type T

    • builder

      public static Scte35SegmentationDescriptor.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Scte35SegmentationDescriptor.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.