Class DescribeProgramResponse

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.DescribeProgramResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeProgramResponse.Builder,DescribeProgramResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeProgramResponse extends MediaTailorResponse implements ToCopyableBuilder<DescribeProgramResponse.Builder,DescribeProgramResponse>

  • Method Details

    • hasAdBreaks

      public final boolean hasAdBreaks()
      For responses, this returns true if the service returned a value for the AdBreaks 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.

    • adBreaks

      public final List<AdBreak> adBreaks()

      The ad break configuration settings.

      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 hasAdBreaks() method.

      Returns:
      The ad break configuration settings.

    • arn

      public final String arn()

      The ARN of the program.

      Returns:
      The ARN of the program.

    • hasAudienceMedia

      public final boolean hasAudienceMedia()
      For responses, this returns true if the service returned a value for the AudienceMedia 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.

    • audienceMedia

      public final List<AudienceMedia> audienceMedia()

      The list of AudienceMedia defined in program.

      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 hasAudienceMedia() method.

      Returns:
      The list of AudienceMedia defined in program.

    • channelName

      public final String channelName()

      The name of the channel that the program belongs to.

      Returns:
      The name of the channel that the program belongs to.

    • clipRange

      public final ClipRange clipRange()

      The clip range configuration settings.

      Returns:
      The clip range configuration settings.

    • creationTime

      public final Instant creationTime()

      The timestamp of when the program was created.

      Returns:
      The timestamp of when the program was created.

    • durationMillis

      public final Long durationMillis()

      The duration of the live program in milliseconds.

      Returns:
      The duration of the live program in milliseconds.

    • liveSourceName

      public final String liveSourceName()

      The name of the LiveSource for this Program.

      Returns:
      The name of the LiveSource for this Program.

    • programName

      public final String programName()

      The name of the program.

      Returns:
      The name of the program.

    • scheduledStartTime

      public final Instant scheduledStartTime()

      The date and time that the program is scheduled to start in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2021-03-27T17:48:16.751Z represents March 27, 2021 at 17:48:16.751 UTC.

      Returns:
      The date and time that the program is scheduled to start in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2021-03-27T17:48:16.751Z represents March 27, 2021 at 17:48:16.751 UTC.

    • sourceLocationName

      public final String sourceLocationName()

      The source location name.

      Returns:
      The source location name.

    • vodSourceName

      public final String vodSourceName()

      The name that's used to refer to a VOD source.

      Returns:
      The name that's used to refer to a VOD source.

    • toBuilder

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

    • builder

      public static DescribeProgramResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeProgramResponse.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.