Class DescribeProgramResponse

    • Method Detail

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

        public final Instant creationTime()

        The timestamp of when the program was created.

        Returns:
        The timestamp of when the program was created.
      • 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.
      • clipRange

        public final ClipRange clipRange()

        The clip range configuration settings.

        Returns:
        The clip range configuration settings.
      • durationMillis

        public final Long durationMillis()

        The duration of the live program in milliseconds.

        Returns:
        The duration of the live program in milliseconds.
      • 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.
      • 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