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

Class CreateChannelRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.mediatailor.model.MediaTailorRequest

software.amazon.awssdk.services.mediatailor.model.CreateChannelRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateChannelRequest.Builder,CreateChannelRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateChannelRequest
extends MediaTailorRequest
implements ToCopyableBuilder<CreateChannelRequest.Builder,CreateChannelRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateChannelRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateChannelRequest.Builder	builder()
String	channelName()	The name of the channel.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
SlateSource	fillerSlate()	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.
List<RequestOutputItem>	outputs()	The channel's output properties.
PlaybackMode	playbackMode()	The type of playback mode to use for this channel.
String	playbackModeAsString()	The type of playback mode to use for this channel.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateChannelRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags()	The tags to assign to the channel.
Tier	tier()	The tier of the channel.
String	tierAsString()	The tier of the channel.
TimeShiftConfiguration	timeShiftConfiguration()	The time-shifted viewing configuration you want to associate to the channel.
CreateChannelRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

channelName

public final String channelName()

The name of the channel.

Returns:

The name of the channel.

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.

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<RequestOutputItem> 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 PlaybackMode playbackMode()

The type of playback mode to use for this channel.

LINEAR - The programs in the schedule play once back-to-back in the schedule.

LOOP - The programs in the schedule play back-to-back in an endless loop. When the last program in the schedule stops playing, playback loops back to the first program in the schedule.

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

Returns:

The type of playback mode to use for this channel.

LINEAR - The programs in the schedule play once back-to-back in the schedule.

LOOP - The programs in the schedule play back-to-back in an endless loop. When the last program in the schedule stops playing, playback loops back to the first program in the schedule.

See Also:

PlaybackMode

playbackModeAsString

public final String playbackModeAsString()

The type of playback mode to use for this channel.

LINEAR - The programs in the schedule play once back-to-back in the schedule.

LOOP - The programs in the schedule play back-to-back in an endless loop. When the last program in the schedule stops playing, playback loops back to the first program in the schedule.

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

Returns:

The type of playback mode to use for this channel.

LINEAR - The programs in the schedule play once back-to-back in the schedule.

LOOP - The programs in the schedule play back-to-back in an endless loop. When the last program in the schedule stops playing, playback loops back to the first program in the schedule.

See Also:

PlaybackMode

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

The tier of the channel.

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

Returns:

The tier of the channel.

See Also:

Tier

tierAsString

public final String tierAsString()

The tier of the channel.

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

Returns:

The tier of the channel.

See Also:

Tier

timeShiftConfiguration

public final TimeShiftConfiguration timeShiftConfiguration()

The time-shifted viewing configuration you want to associate to the channel.

Returns:

The time-shifted viewing configuration you want to associate to the channel.

toBuilder

public CreateChannelRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateChannelRequest.Builder,CreateChannelRequest>

Specified by:

toBuilder in class MediaTailorRequest

builder

public static CreateChannelRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateChannelRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo