Class DescribeProgramResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeProgramResponse.Builder,
DescribeProgramResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionadBreaks()
The ad break configuration settings.final String
arn()
The ARN of the program.final List
<AudienceMedia> The list of AudienceMedia defined in program.builder()
final String
The name of the channel that the program belongs to.final ClipRange
The clip range configuration settings.final Instant
The timestamp of when the program was created.final Long
The duration of the live program in milliseconds.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the AdBreaks property.final boolean
For responses, this returns true if the service returned a value for the AudienceMedia property.final int
hashCode()
final String
The name of the LiveSource for this Program.final String
The name of the program.final Instant
The date and time that the program is scheduled to start in ISO 8601 format and Coordinated Universal Time (UTC).static Class
<? extends DescribeProgramResponse.Builder> final String
The source location name.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The name that's used to refer to a VOD source.Methods inherited from class software.amazon.awssdk.services.mediatailor.model.MediaTailorResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
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 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. -
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
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 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. -
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
The name of the channel that the program belongs to.
- Returns:
- The name of the channel that the program belongs to.
-
clipRange
The clip range configuration settings.
- Returns:
- The clip range configuration settings.
-
creationTime
The timestamp of when the program was created.
- Returns:
- The timestamp of when the program was created.
-
durationMillis
The duration of the live program in milliseconds.
- Returns:
- The duration of the live program in milliseconds.
-
liveSourceName
The name of the LiveSource for this Program.
- Returns:
- The name of the LiveSource for this Program.
-
programName
The name of the program.
- Returns:
- The name of the program.
-
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
The source location name.
- Returns:
- The source location name.
-
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
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 interfaceToCopyableBuilder<DescribeProgramResponse.Builder,
DescribeProgramResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-