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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceChannel.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringarn()The ARN of the channel.List<String>audiences()The list of audiences defined in channel.static Channel.Builderbuilder()StringchannelName()The name of the channel.StringchannelState()Returns the state whether the channel is running or not.InstantcreationTime()The timestamp of when the channel was created.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)SlateSourcefillerSlate()The slate used to fill gaps between programs in the schedule.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAudiences()For responses, this returns true if the service returned a value for the Audiences property.inthashCode()booleanhasOutputs()For responses, this returns true if the service returned a value for the Outputs property.booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.InstantlastModifiedTime()The timestamp of when the channel was last modified.LogConfigurationForChannellogConfiguration()The log configuration.List<ResponseOutputItem>outputs()The channel's output properties.StringplaybackMode()The type of playback mode for this channel.List<SdkField<?>>sdkFields()static Class<? extends Channel.Builder>serializableBuilderClass()Map<String,String>tags()The tags to assign to the channel.Stringtier()The tier for this channel.Channel.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 theisEmpty()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
LINEARPlaybackMode. MediaTailor doesn't support filler slate for channels using theLOOPPlaybackMode.- Returns:
- The slate used to fill gaps between programs in the schedule. You must configure filler slate if your
channel uses the
LINEARPlaybackMode. MediaTailor doesn't support filler slate for channels using theLOOPPlaybackMode.
-
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 theisEmpty()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 theisEmpty()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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Channel.Builder,Channel>
-
builder
public static Channel.Builder builder()
-
serializableBuilderClass
public static Class<? extends Channel.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-