Class DescribeChannelResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.mediatailor.model.MediaTailorResponse
software.amazon.awssdk.services.mediatailor.model.DescribeChannelResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeChannelResponse.Builder,DescribeChannelResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeChannelResponse extends MediaTailorResponse implements ToCopyableBuilder<DescribeChannelResponse.Builder,DescribeChannelResponse>

  • Method Details

    • arn

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

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

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

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

    • logConfiguration

      public final LogConfigurationForChannel 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 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.

    • timeShiftConfiguration

      public final TimeShiftConfiguration timeShiftConfiguration()

      The time-shifted viewing configuration for the channel.

      Returns:
      The time-shifted viewing configuration for the channel.

    • toBuilder

      public DescribeChannelResponse.Builder 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 interface ToCopyableBuilder<DescribeChannelResponse.Builder,DescribeChannelResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeChannelResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.