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

Class Channel

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

The configuration parameters for a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.

See Also:

  • Method Details

    • arn

      public final String arn()

      The ARN of the channel.

      Returns:
      The ARN of the channel.

    • hasAudiences

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

    • audiences

      public final List<String> audiences()

      The list of audiences defined in channel.

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

      Returns:
      The list of audiences defined in channel.

    • channelName

      public final String channelName()

      The name of the channel.

      Returns:
      The name of the channel.

    • channelState

      public final String channelState()

      Returns the state whether the channel is running or not.

      Returns:
      Returns the state whether the channel is running or not.

    • creationTime

      public final Instant creationTime()

      The timestamp of when the channel was created.

      Returns:
      The timestamp of when the channel was created.

    • fillerSlate

      public final SlateSource fillerSlate()

      The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the LINEAR PlaybackMode. MediaTailor doesn't support filler slate for channels using the LOOP PlaybackMode.

      Returns:
      The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the LINEAR PlaybackMode. MediaTailor doesn't support filler slate for channels using the LOOP PlaybackMode.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The timestamp of when the channel was last modified.

      Returns:
      The timestamp of when the channel was last modified.

    • logConfiguration

      public final LogConfigurationForChannel logConfiguration()

      The log configuration.

      Returns:
      The log configuration.

    • hasOutputs

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

    • outputs

      public final List<ResponseOutputItem> outputs()

      The channel's output properties.

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

      Returns:
      The channel's output properties.

    • playbackMode

      public final String playbackMode()

      The type of playback mode for this channel.

      LINEAR - Programs play back-to-back only once.

      LOOP - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.

      Returns:
      The type of playback mode for this channel.

      LINEAR - Programs play back-to-back only once.

      LOOP - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

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

      Returns:
      The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources.

    • tier

      public final String tier()

      The tier for this channel. STANDARD tier channels can contain live programs.

      Returns:
      The tier for this channel. STANDARD tier channels can contain live programs.

    • toBuilder

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

    • builder

      public static Channel.Builder builder()

    • serializableBuilderClass

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