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(value="software.amazon.awssdk:codegen")
public final class Channel
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Channel.Builder,Channel>

The configuration parameters for a channel.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Channel.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The ARN of the channel.
static Channel.Builder	builder()
String	channelName() The name of the channel.
String	channelState() Returns the state whether the channel is running or not.
Instant	creationTime() The timestamp of when the channel was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
SlateSource	fillerSlate() Contains information about the slate used to fill gaps between programs in the schedule.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasOutputs() For responses, this returns true if the service returned a value for the Outputs property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
Instant	lastModifiedTime() The timestamp of when the channel was last modified.
List<ResponseOutputItem>	outputs() The channel's output properties.
String	playbackMode() 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.
Channel.Builder	toBuilder()
String	toString() 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.

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()

Contains information about the slate used to fill gaps between programs in the schedule. You must configure FillerSlate if your channel uses an LINEAR PlaybackMode.

Returns:

Contains information about the slate used to fill gaps between programs in the schedule. You must configure FillerSlate if your channel uses an LINEAR 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.

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.

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.

toBuilder

public Channel.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Channel.Builder,Channel>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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