Class ChannelListConfiguration

java.lang.Object
software.amazon.awssdk.services.mediapackagev2.model.ChannelListConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ChannelListConfiguration.Builder,ChannelListConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class ChannelListConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ChannelListConfiguration.Builder,ChannelListConfiguration>

The configuration of the channel.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) associated with the resource.

      Returns:
      The Amazon Resource Name (ARN) associated with the resource.

    • channelName

      public final String channelName()

      The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

      Returns:
      The name that describes the channel. The name is the primary identifier for the channel, and must be unique for your account in the AWS Region and channel group.

    • channelGroupName

      public final String channelGroupName()

      The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

      Returns:
      The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

    • createdAt

      public final Instant createdAt()

      The date and time the channel was created.

      Returns:
      The date and time the channel was created.

    • modifiedAt

      public final Instant modifiedAt()

      The date and time the channel was modified.

      Returns:
      The date and time the channel was modified.

    • description

      public final String description()

      Any descriptive information that you want to add to the channel for future identification purposes.

      Returns:
      Any descriptive information that you want to add to the channel for future identification purposes.

    • inputType

      public final InputType inputType()

      The input type is an immutable field. It defines whether the channel allows CMAF ingest, HLS ingest, or server-side multiview output. Multiview channels receive no ingest of their own. If unprovided, the value defaults to HLS.

      The allowed values are:

      • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

      • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

      • MULTIVIEW – Server-side multiview. The channel receives no ingest of its own. Instead, it composites video from the source channels in its MultiviewConfiguration into a single tiled output stream.

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

      Returns:
      The input type is an immutable field. It defines whether the channel allows CMAF ingest, HLS ingest, or server-side multiview output. Multiview channels receive no ingest of their own. If unprovided, the value defaults to HLS.

      The allowed values are:

      • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

      • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

      • MULTIVIEW – Server-side multiview. The channel receives no ingest of its own. Instead, it composites video from the source channels in its MultiviewConfiguration into a single tiled output stream.

      See Also:

    • inputTypeAsString

      public final String inputTypeAsString()

      The input type is an immutable field. It defines whether the channel allows CMAF ingest, HLS ingest, or server-side multiview output. Multiview channels receive no ingest of their own. If unprovided, the value defaults to HLS.

      The allowed values are:

      • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

      • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

      • MULTIVIEW – Server-side multiview. The channel receives no ingest of its own. Instead, it composites video from the source channels in its MultiviewConfiguration into a single tiled output stream.

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

      Returns:
      The input type is an immutable field. It defines whether the channel allows CMAF ingest, HLS ingest, or server-side multiview output. Multiview channels receive no ingest of their own. If unprovided, the value defaults to HLS.

      The allowed values are:

      • HLS - The HLS streaming specification (which defines M3U8 manifests and TS segments).

      • CMAF - The DASH-IF CMAF Ingest specification (which defines CMAF segments with optional DASH manifests).

      • MULTIVIEW – Server-side multiview. The channel receives no ingest of its own. Instead, it composites video from the source channels in its MultiviewConfiguration into a single tiled output stream.

      See Also:

    • outputLockingMode

      public final OutputLockingMode outputLockingMode()

      The output locking mode configured for the channel.

      The allowed values are:

      • EPOCH_LOCKED - The channel uses epoch-locked behavior with deterministic sequence numbering and fixed segment boundaries aligned to epoch time.

      • NON_EPOCH_LOCKED - The channel uses non-epoch-locked behavior with duration-based segment combining and monotonically increasing sequence numbers starting from 0.

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

      Returns:
      The output locking mode configured for the channel.

      The allowed values are:

      • EPOCH_LOCKED - The channel uses epoch-locked behavior with deterministic sequence numbering and fixed segment boundaries aligned to epoch time.

      • NON_EPOCH_LOCKED - The channel uses non-epoch-locked behavior with duration-based segment combining and monotonically increasing sequence numbers starting from 0.

      See Also:

    • outputLockingModeAsString

      public final String outputLockingModeAsString()

      The output locking mode configured for the channel.

      The allowed values are:

      • EPOCH_LOCKED - The channel uses epoch-locked behavior with deterministic sequence numbering and fixed segment boundaries aligned to epoch time.

      • NON_EPOCH_LOCKED - The channel uses non-epoch-locked behavior with duration-based segment combining and monotonically increasing sequence numbers starting from 0.

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

      Returns:
      The output locking mode configured for the channel.

      The allowed values are:

      • EPOCH_LOCKED - The channel uses epoch-locked behavior with deterministic sequence numbering and fixed segment boundaries aligned to epoch time.

      • NON_EPOCH_LOCKED - The channel uses non-epoch-locked behavior with duration-based segment combining and monotonically increasing sequence numbers starting from 0.

      See Also:

    • multiviewConfiguration

      public final MultiviewConfiguration multiviewConfiguration()

      The multiview configuration for the channel. This is present only when InputType is MULTIVIEW.

      Returns:
      The multiview configuration for the channel. This is present only when InputType is MULTIVIEW.

    • hasAttachedMultiviewChannels

      public final boolean hasAttachedMultiviewChannels()
      For responses, this returns true if the service returned a value for the AttachedMultiviewChannels 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.

    • attachedMultiviewChannels

      public final List<String> attachedMultiviewChannels()

      The multiview channels, in the same channel group, that list this channel as an available source. This is a read-only field.

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

      Returns:
      The multiview channels, in the same channel group, that list this channel as an available source. This is a read-only field.

    • toBuilder

      public ChannelListConfiguration.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<ChannelListConfiguration.Builder,ChannelListConfiguration>
      Returns:
      a builder for type T

    • builder

      public static ChannelListConfiguration.Builder builder()

    • serializableBuilderClass

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