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

Class DescribeChannelResponse

    • 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 ChannelState 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 return ChannelState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from channelStateAsString().

        Returns:
        Indicates whether the channel is in a running state or not.
        See Also:
        ChannelState

      • channelStateAsString

        public final String 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 return ChannelState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from channelStateAsString().

        Returns:
        Indicates whether the channel is in a running state or not.
        See Also:
        ChannelState

      • 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.

        Returns:
        Contains information about the slate used to fill gaps between programs in the schedule.

      • 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 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 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 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

        public final String tier()

        The channel's tier.

        Returns:
        The channel's tier.

      • logConfiguration

        public final LogConfigurationForChannel logConfiguration()

        The log configuration for the channel.

        Returns:
        The log configuration for the channel.

      • timeShiftConfiguration

        public final TimeShiftConfiguration timeShiftConfiguration()

        The time-shifted viewing configuration for the channel.

        Returns:
        The time-shifted viewing configuration for 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 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.

      • audiences

        public final List<String> 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.

      • 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