Class CreateChannelRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateChannelRequest.Builder,
CreateChannelRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionThe list of audiences defined in channel.static CreateChannelRequest.Builder
builder()
final String
The name of the channel.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final SlateSource
The slate used to fill gaps between programs in the schedule.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the Audiences property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Outputs property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final List
<RequestOutputItem> outputs()
The channel's output properties.final PlaybackMode
The type of playback mode to use for this channel.final String
The type of playback mode to use for this channel.static Class
<? extends CreateChannelRequest.Builder> tags()
The tags to assign to the channel.final Tier
tier()
The tier of the channel.final String
The tier of the channel.final TimeShiftConfiguration
The time-shifted viewing configuration you want to associate to the channel.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
The name of the channel.
- Returns:
- The name of the channel.
-
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 theLOOP
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 theLOOP
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 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
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
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 returnPlaybackMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplaybackModeAsString()
.- 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:
-
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 returnPlaybackMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplaybackModeAsString()
.- 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:
-
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
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
The tier of the channel.
If the service returns an enum value that is not available in the current SDK version,
tier
will returnTier.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtierAsString()
.- Returns:
- The tier of the channel.
- See Also:
-
tierAsString
The tier of the channel.
If the service returns an enum value that is not available in the current SDK version,
tier
will returnTier.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtierAsString()
.- Returns:
- The tier of the channel.
- See Also:
-
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
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 interfaceToCopyableBuilder<CreateChannelRequest.Builder,
CreateChannelRequest> - Specified by:
toBuilder
in classMediaTailorRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-