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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceScheduleEntry.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description LongapproximateDurationSeconds()The approximate duration of this program, in seconds.InstantapproximateStartTime()The approximate time that the program will start playing.Stringarn()The ARN of the program.List<String>audiences()The list of audiences defined in ScheduleEntry.static ScheduleEntry.Builderbuilder()StringchannelName()The name of the channel that uses this schedule.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAudiences()For responses, this returns true if the service returned a value for the Audiences property.inthashCode()booleanhasScheduleAdBreaks()For responses, this returns true if the service returned a value for the ScheduleAdBreaks property.StringliveSourceName()The name of the live source used for the program.StringprogramName()The name of the program.List<ScheduleAdBreak>scheduleAdBreaks()The schedule's ad break properties.ScheduleEntryTypescheduleEntryType()The type of schedule entry.StringscheduleEntryTypeAsString()The type of schedule entry.List<SdkField<?>>sdkFields()static Class<? extends ScheduleEntry.Builder>serializableBuilderClass()StringsourceLocationName()The name of the source location.ScheduleEntry.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringvodSourceName()The name of the VOD source.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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.
-
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 theisEmpty()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.
-
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 theisEmpty()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,
scheduleEntryTypewill returnScheduleEntryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromscheduleEntryTypeAsString().- Returns:
- The type of schedule entry.
- See Also:
ScheduleEntryType
-
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,
scheduleEntryTypewill returnScheduleEntryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromscheduleEntryTypeAsString().- Returns:
- The type of schedule entry.
- See Also:
ScheduleEntryType
-
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.
-
toBuilder
public ScheduleEntry.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ScheduleEntry.Builder,ScheduleEntry>
-
builder
public static ScheduleEntry.Builder builder()
-
serializableBuilderClass
public static Class<? extends ScheduleEntry.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-