Class DescribeChannelResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeChannelResponse.Builder,
DescribeChannelResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The ARN of the channel.The list of audiences defined in channel.builder()
final String
The name of the channel.final ChannelState
Indicates whether the channel is in a running state or not.final String
Indicates whether the channel is in a running state or not.final Instant
The timestamp of when the channel was created.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final SlateSource
Contains information about 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 extendsSdkResponse
.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 Instant
The timestamp of when the channel was last modified.The log configuration for the channel.final List
<ResponseOutputItem> outputs()
The channel's output properties.final String
The channel's playback mode.static Class
<? extends DescribeChannelResponse.Builder> tags()
The tags assigned to the channel.final String
tier()
The channel's tier.final TimeShiftConfiguration
The 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 String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.services.mediatailor.model.MediaTailorResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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.
-
channelState
Indicates whether the channel is in a running state or not.
If the service returns an enum value that is not available in the current SDK version,
channelState
will returnChannelState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchannelStateAsString()
.- Returns:
- Indicates whether the channel is in a running state or not.
- See Also:
-
channelStateAsString
Indicates whether the channel is in a running state or not.
If the service returns an enum value that is not available in the current SDK version,
channelState
will returnChannelState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchannelStateAsString()
.- Returns:
- Indicates whether the channel is in a running state or not.
- See Also:
-
creationTime
The timestamp of when the channel was created.
- Returns:
- The timestamp of when the channel was created.
-
fillerSlate
Contains information about the slate used to fill gaps between programs in the schedule.
- Returns:
- Contains information about the slate used to fill gaps between programs in the schedule.
-
lastModifiedTime
The timestamp of when the channel was last modified.
- Returns:
- The timestamp of when the channel was last modified.
-
logConfiguration
The log configuration for the channel.
- Returns:
- The log configuration for the channel.
-
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 channel's playback mode.
- Returns:
- The channel's playback mode.
-
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 assigned 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 assigned 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 channel's tier.
- Returns:
- The channel's tier.
-
timeShiftConfiguration
The time-shifted viewing configuration for the channel.
- Returns:
- The time-shifted viewing configuration for 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<DescribeChannelResponse.Builder,
DescribeChannelResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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:SdkResponse
Used 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:
getValueForField
in 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
-