Class ScheduleEntry

java.lang.Object
software.amazon.awssdk.services.mediatailor.model.ScheduleEntry
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ScheduleEntry.Builder,ScheduleEntry>
@Generated("software.amazon.awssdk:codegen") public final class ScheduleEntry extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ScheduleEntry.Builder,ScheduleEntry>

The properties for a schedule.

See Also:

  • Method Details

    • approximateDurationSeconds

      public final Long approximateDurationSeconds()

      The approximate duration of this program, in seconds.

      Returns:
      The approximate duration of this program, in seconds.

    • approximateStartTime

      public final Instant approximateStartTime()

      The approximate time that the program will start playing.

      Returns:
      The approximate time that the program will start playing.

    • 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 uses this schedule.

      Returns:
      The name of the channel that uses this schedule.

    • liveSourceName

      public final String liveSourceName()

      The name of the live source used for the program.

      Returns:
      The name of the live source used for the program.

    • programName

      public final String programName()

      The name of the program.

      Returns:
      The name of the program.

    • hasScheduleAdBreaks

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

    • scheduleAdBreaks

      public final List<ScheduleAdBreak> scheduleAdBreaks()

      The schedule's ad break 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 hasScheduleAdBreaks() method.

      Returns:
      The schedule's ad break properties.

    • scheduleEntryType

      public final ScheduleEntryType scheduleEntryType()

      The type of schedule entry.

      If the service returns an enum value that is not available in the current SDK version, scheduleEntryType will return ScheduleEntryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scheduleEntryTypeAsString().

      Returns:
      The type of schedule entry.
      See Also:

    • scheduleEntryTypeAsString

      public final String scheduleEntryTypeAsString()

      The type of schedule entry.

      If the service returns an enum value that is not available in the current SDK version, scheduleEntryType will return ScheduleEntryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scheduleEntryTypeAsString().

      Returns:
      The type of schedule entry.
      See Also:

    • sourceLocationName

      public final String sourceLocationName()

      The name of the source location.

      Returns:
      The name of the source location.

    • vodSourceName

      public final String vodSourceName()

      The name of the VOD source.

      Returns:
      The name of the VOD source.

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

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

    • toBuilder

      public ScheduleEntry.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<ScheduleEntry.Builder,ScheduleEntry>
      Returns:
      a builder for type T

    • builder

      public static ScheduleEntry.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.