Class UpdateChannelResponse
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<UpdateChannelResponse.Builder,UpdateChannelResponse>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal Stringarn()The Amazon Resource Name (ARN) associated with the channel.The list of audiences defined in channel.builder()final StringThe name of the channel.final ChannelStateReturns the state whether the channel is running or not.final StringReturns the state whether the channel is running or not.final InstantThe timestamp of when the channel was created.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final SlateSourceThe 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 extendsSdkResponse.final booleanFor responses, this returns true if the service returned a value for the Audiences property.final inthashCode()final booleanFor responses, this returns true if the service returned a value for the Outputs property.final booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.final InstantThe timestamp that indicates when the channel was last modified.final List<ResponseOutputItem> outputs()The channel's output properties.final StringThe type of playback mode for this channel.static Class<? extends UpdateChannelResponse.Builder> tags()The tags to assign to the channel.final Stringtier()The tier associated with this Channel.final TimeShiftConfigurationThe time-shifted viewing configuration for the channel.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.services.mediatailor.model.MediaTailorResponse
responseMetadataMethods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponseMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
The Amazon Resource Name (ARN) associated with the channel.
- Returns:
- The Amazon Resource Name (ARN) associated with 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
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
-
channelState
Returns the state whether the channel is running or not.
If the service returns an enum value that is not available in the current SDK version,
channelStatewill returnChannelState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromchannelStateAsString().- Returns:
- Returns the state whether the channel is running or not.
- See Also:
-
channelStateAsString
Returns the state whether the channel is running or not.
If the service returns an enum value that is not available in the current SDK version,
channelStatewill returnChannelState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromchannelStateAsString().- Returns:
- Returns the state whether the channel is running or not.
- See Also:
-
creationTime
The timestamp of when the channel was created.
- Returns:
- The timestamp of when the channel was created.
-
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
The timestamp that indicates when the channel was last modified.
- Returns:
- The timestamp that indicates 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 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 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
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 associated with this Channel.
- Returns:
- The tier associated with this Channel.
-
timeShiftConfiguration
The time-shifted viewing configuration for the channel.
- Returns:
- The time-shifted viewing configuration for the channel.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<UpdateChannelResponse.Builder,UpdateChannelResponse> - Specified by:
toBuilderin classAwsResponse- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsResponse
-
equals
- Overrides:
equalsin classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin 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
-
getValueForField
Description copied from class:SdkResponseUsed to retrieve the value of a field from any class that extendsSdkResponse. 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, theSdkResponse.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkResponse- 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
-