CreateJobPlaylist (AWS Java SDK :: Services :: Amazon Elastic Transcoder 2.20.108 API)

java.lang.Object
- software.amazon.awssdk.services.elastictranscoder.model.CreateJobPlaylist

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<CreateJobPlaylist.Builder,CreateJobPlaylist>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateJobPlaylist
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CreateJobPlaylist.Builder,CreateJobPlaylist>

Information about the master playlist.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateJobPlaylist.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateJobPlaylist.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateJobPlaylist.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`format()` The format of the output playlist.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasOutputKeys()` For responses, this returns true if the service returned a value for the OutputKeys property.
`HlsContentProtection`	`hlsContentProtection()` The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
`String`	`name()` The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8.
`List<String>`	`outputKeys()` For each output in this job that you want to include in a master playlist, the value of the `Outputs:Key` object.
`PlayReadyDrm`	`playReadyDrm()` The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateJobPlaylist.Builder>`	`serializableBuilderClass()`
`CreateJobPlaylist.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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
  - name
```
public final String name()
```
    The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8. If the name includes a / character, the section of the name before the last / must be identical for all Name objects. If you create more than one master playlist, the values of all Name objects must be unique.
    
    Elastic Transcoder automatically appends the relevant file extension to the file name (.m3u8 for HLSv3 and HLSv4 playlists, and .ism and .ismc for Smooth playlists). If you include a file extension in Name, the file name will have two extensions.
    
    Returns:
    
    The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8. If the name includes a / character, the section of the name before the last / must be identical for all Name objects. If you create more than one master playlist, the values of all Name objects must be unique.
    
    Elastic Transcoder automatically appends the relevant file extension to the file name (.m3u8 for HLSv3 and HLSv4 playlists, and .ism and .ismc for Smooth playlists). If you include a file extension in Name, the file name will have two extensions.
  - format
```
public final String format()
```
    The format of the output playlist. Valid formats include HLSv3, HLSv4, and Smooth.
    
    Returns:
    
    The format of the output playlist. Valid formats include HLSv3, HLSv4, and Smooth.
  - hasOutputKeys
```
public final boolean hasOutputKeys()
```
    For responses, this returns true if the service returned a value for the OutputKeys 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.
  - outputKeys
```
public final List<String> outputKeys()
```
    For each output in this job that you want to include in a master playlist, the value of the Outputs:Key object.
    - If your output is not HLS or does not have a segment duration set, the name of the output file is a concatenation of OutputKeyPrefix and Outputs:Key:
      
      OutputKeyPrefixOutputs:Key
    - If your output is HLSv3 and has a segment duration set, or is not included in a playlist, Elastic Transcoder creates an output playlist file with a file extension of .m3u8, and a series of .ts files that include a five-digit sequential counter beginning with 00000:
      
      OutputKeyPrefixOutputs:Key.m3u8
      
      OutputKeyPrefixOutputs:Key00000.ts
    - If your output is HLSv4, has a segment duration set, and is included in an HLSv4 playlist, Elastic Transcoder creates an output playlist file with a file extension of _v4.m3u8. If the output is video, Elastic Transcoder also creates an output file with an extension of _iframe.m3u8:
      
      OutputKeyPrefixOutputs:Key_v4.m3u8
      
      OutputKeyPrefixOutputs:Key_iframe.m3u8
      
      OutputKeyPrefixOutputs:Key.ts
    Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions.
    
    If you include more than one output in a playlist, any segment duration settings, clip settings, or caption settings must be the same for all outputs in the playlist. For Smooth playlists, the Audio:Profile, Video:Profile, and Video:FrameRate to Video:KeyframesMaxDist ratio must be the same for all outputs.
    
    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 hasOutputKeys() method.
    Returns:
    For each output in this job that you want to include in a master playlist, the value of the Outputs:Key object.
    
    If your output is not HLS or does not have a segment duration set, the name of the output file is a concatenation of OutputKeyPrefix and Outputs:Key:
    
    OutputKeyPrefixOutputs:Key
    
    If your output is HLSv3 and has a segment duration set, or is not included in a playlist, Elastic Transcoder creates an output playlist file with a file extension of .m3u8, and a series of .ts files that include a five-digit sequential counter beginning with 00000:
    
    OutputKeyPrefixOutputs:Key.m3u8
    
    OutputKeyPrefixOutputs:Key00000.ts
    
    If your output is HLSv4, has a segment duration set, and is included in an HLSv4 playlist, Elastic Transcoder creates an output playlist file with a file extension of _v4.m3u8. If the output is video, Elastic Transcoder also creates an output file with an extension of _iframe.m3u8:
    
    OutputKeyPrefixOutputs:Key_v4.m3u8
    
    OutputKeyPrefixOutputs:Key_iframe.m3u8
    
    OutputKeyPrefixOutputs:Key.ts
    
    Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions.
    
    If you include more than one output in a playlist, any segment duration settings, clip settings, or caption settings must be the same for all outputs in the playlist. For Smooth playlists, the Audio:Profile, Video:Profile, and Video:FrameRate to Video:KeyframesMaxDist ratio must be the same for all outputs.
  - hlsContentProtection
```
public final HlsContentProtection hlsContentProtection()
```
    The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
    
    Returns:
    
    The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
  - playReadyDrm
```
public final PlayReadyDrm playReadyDrm()
```
    The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
    
    Returns:
    
    The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.
  - toBuilder
```
public CreateJobPlaylist.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateJobPlaylist.Builder,CreateJobPlaylist>
  - builder
```
public static CreateJobPlaylist.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateJobPlaylist.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class CreateJobPlaylist

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

format

hasOutputKeys

outputKeys

hlsContentProtection

playReadyDrm

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields