CreateJobOutput (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.elastictranscoder.model.CreateJobOutput

All Implemented Interfaces:

Serializable
```
public class CreateJobOutput
extends Object
implements Serializable
```
The CreateJobOutput structure.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

CreateJobOutput()

Constructors
Constructor and Description
`CreateJobOutput()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`JobAlbumArt`	`getAlbumArt()` Information about the album art that you want Elastic Transcoder to add to the file during transcoding.
`String`	`getKey()` The name to assign to the transcoded file.
`String`	`getPresetId()` The `Id` of the preset to use for this job.
`String`	`getRotate()` The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input.
`String`	`getSegmentDuration()` If you specify a preset in `PresetId` for which the value of `Container` is ts (MPEG-TS), SegmentDuration is the duration of each .ts file in seconds.
`String`	`getThumbnailPattern()` Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.
`List<JobWatermark>`	`getWatermarks()` Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding.
`int`	`hashCode()`
`void`	`setAlbumArt(JobAlbumArt albumArt)` Information about the album art that you want Elastic Transcoder to add to the file during transcoding.
`void`	`setKey(String key)` The name to assign to the transcoded file.
`void`	`setPresetId(String presetId)` The `Id` of the preset to use for this job.
`void`	`setRotate(String rotate)` The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input.
`void`	`setSegmentDuration(String segmentDuration)` If you specify a preset in `PresetId` for which the value of `Container` is ts (MPEG-TS), SegmentDuration is the duration of each .ts file in seconds.
`void`	`setThumbnailPattern(String thumbnailPattern)` Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.
`void`	`setWatermarks(Collection<JobWatermark> watermarks)` Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`CreateJobOutput`	`withAlbumArt(JobAlbumArt albumArt)` Information about the album art that you want Elastic Transcoder to add to the file during transcoding.
`CreateJobOutput`	`withKey(String key)` The name to assign to the transcoded file.
`CreateJobOutput`	`withPresetId(String presetId)` The `Id` of the preset to use for this job.
`CreateJobOutput`	`withRotate(String rotate)` The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input.
`CreateJobOutput`	`withSegmentDuration(String segmentDuration)` If you specify a preset in `PresetId` for which the value of `Container` is ts (MPEG-TS), SegmentDuration is the duration of each .ts file in seconds.
`CreateJobOutput`	`withThumbnailPattern(String thumbnailPattern)` Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.
`CreateJobOutput`	`withWatermarks(Collection<JobWatermark> watermarks)` Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding.
`CreateJobOutput`	`withWatermarks(JobWatermark... watermarks)` Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateJobOutput
```
public CreateJobOutput()
```
- Method Detail
  - getKey
```
public String getKey()
```
    The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the OutputBucket object in the pipeline that is specified by the pipeline ID. If a file with the specified name already exists in the output bucket, the job fails.
    Constraints:
    Length: 1 - 255
    
    Returns:
    The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the OutputBucket object in the pipeline that is specified by the pipeline ID. If a file with the specified name already exists in the output bucket, the job fails.
  - setKey
```
public void setKey(String key)
```
    The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the OutputBucket object in the pipeline that is specified by the pipeline ID. If a file with the specified name already exists in the output bucket, the job fails.
    Constraints:
    Length: 1 - 255
    
    Parameters:
    key - The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the OutputBucket object in the pipeline that is specified by the pipeline ID. If a file with the specified name already exists in the output bucket, the job fails.
  - withKey
```
public CreateJobOutput withKey(String key)
```
    The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the OutputBucket object in the pipeline that is specified by the pipeline ID. If a file with the specified name already exists in the output bucket, the job fails.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 255
    
    Parameters:
    key - The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the OutputBucket object in the pipeline that is specified by the pipeline ID. If a file with the specified name already exists in the output bucket, the job fails.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getThumbnailPattern
```
public String getThumbnailPattern()
```
    Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.
    If you don't want Elastic Transcoder to create thumbnails, specify "".
    If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:
    - {count} (Required): If you want to create thumbnails, you must include {count} in the ThumbnailPattern object. Wherever you specify {count}, Elastic Transcoder adds a five-digit sequence number (beginning with 00001) to thumbnail file names. The number indicates where a given thumbnail appears in the sequence of thumbnails for a transcoded file. If you specify a literal value and/or {resolution} but you omit {count}, Elastic Transcoder returns a validation error and does not create the job.
    - Literal values (Optional): You can specify literal values anywhere in the ThumbnailPattern object. For example, you can include them as a file name prefix or as a delimiter between {resolution} and {count}.
    - {resolution} (Optional): If you want Elastic Transcoder to include the resolution in the file name, include {resolution} in the ThumbnailPattern object.
    When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png) that appears in the preset that you specified in the PresetID value of CreateJobOutput. Elastic Transcoder also appends the applicable file name extension.
    Constraints:
    Pattern: (^$)|(^.*\{count\}.*$)
    Returns:
    Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.
    If you don't want Elastic Transcoder to create thumbnails, specify "".
    If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:
    
    {count} (Required): If you want to create thumbnails, you must include {count} in the ThumbnailPattern object. Wherever you specify {count}, Elastic Transcoder adds a five-digit sequence number (beginning with 00001) to thumbnail file names. The number indicates where a given thumbnail appears in the sequence of thumbnails for a transcoded file. If you specify a literal value and/or {resolution} but you omit {count}, Elastic Transcoder returns a validation error and does not create the job.
    
    Literal values (Optional): You can specify literal values anywhere in the ThumbnailPattern object. For example, you can include them as a file name prefix or as a delimiter between {resolution} and {count}.
    
    {resolution} (Optional): If you want Elastic Transcoder to include the resolution in the file name, include {resolution} in the ThumbnailPattern object.
    
    When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png) that appears in the preset that you specified in the PresetID value of CreateJobOutput. Elastic Transcoder also appends the applicable file name extension.
  - setThumbnailPattern
```
public void setThumbnailPattern(String thumbnailPattern)
```
    Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.
    If you don't want Elastic Transcoder to create thumbnails, specify "".
    If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:
    - {count} (Required): If you want to create thumbnails, you must include {count} in the ThumbnailPattern object. Wherever you specify {count}, Elastic Transcoder adds a five-digit sequence number (beginning with 00001) to thumbnail file names. The number indicates where a given thumbnail appears in the sequence of thumbnails for a transcoded file. If you specify a literal value and/or {resolution} but you omit {count}, Elastic Transcoder returns a validation error and does not create the job.
    - Literal values (Optional): You can specify literal values anywhere in the ThumbnailPattern object. For example, you can include them as a file name prefix or as a delimiter between {resolution} and {count}.
    - {resolution} (Optional): If you want Elastic Transcoder to include the resolution in the file name, include {resolution} in the ThumbnailPattern object.
    When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png) that appears in the preset that you specified in the PresetID value of CreateJobOutput. Elastic Transcoder also appends the applicable file name extension.
    Constraints:
    Pattern: (^$)|(^.*\{count\}.*$)
    Parameters:
    thumbnailPattern - Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.
    If you don't want Elastic Transcoder to create thumbnails, specify "".
    If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:
    
    {count} (Required): If you want to create thumbnails, you must include {count} in the ThumbnailPattern object. Wherever you specify {count}, Elastic Transcoder adds a five-digit sequence number (beginning with 00001) to thumbnail file names. The number indicates where a given thumbnail appears in the sequence of thumbnails for a transcoded file. If you specify a literal value and/or {resolution} but you omit {count}, Elastic Transcoder returns a validation error and does not create the job.
    
    Literal values (Optional): You can specify literal values anywhere in the ThumbnailPattern object. For example, you can include them as a file name prefix or as a delimiter between {resolution} and {count}.
    
    {resolution} (Optional): If you want Elastic Transcoder to include the resolution in the file name, include {resolution} in the ThumbnailPattern object.
    
    When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png) that appears in the preset that you specified in the PresetID value of CreateJobOutput. Elastic Transcoder also appends the applicable file name extension.
  - withThumbnailPattern
```
public CreateJobOutput withThumbnailPattern(String thumbnailPattern)
```
    Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.
    If you don't want Elastic Transcoder to create thumbnails, specify "".
    If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:
    - {count} (Required): If you want to create thumbnails, you must include {count} in the ThumbnailPattern object. Wherever you specify {count}, Elastic Transcoder adds a five-digit sequence number (beginning with 00001) to thumbnail file names. The number indicates where a given thumbnail appears in the sequence of thumbnails for a transcoded file. If you specify a literal value and/or {resolution} but you omit {count}, Elastic Transcoder returns a validation error and does not create the job.
    - Literal values (Optional): You can specify literal values anywhere in the ThumbnailPattern object. For example, you can include them as a file name prefix or as a delimiter between {resolution} and {count}.
    - {resolution} (Optional): If you want Elastic Transcoder to include the resolution in the file name, include {resolution} in the ThumbnailPattern object.
    When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png) that appears in the preset that you specified in the PresetID value of CreateJobOutput. Elastic Transcoder also appends the applicable file name extension.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: (^$)|(^.*\{count\}.*$)
    Parameters:
    thumbnailPattern - Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.
    If you don't want Elastic Transcoder to create thumbnails, specify "".
    If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:
    
    {count} (Required): If you want to create thumbnails, you must include {count} in the ThumbnailPattern object. Wherever you specify {count}, Elastic Transcoder adds a five-digit sequence number (beginning with 00001) to thumbnail file names. The number indicates where a given thumbnail appears in the sequence of thumbnails for a transcoded file. If you specify a literal value and/or {resolution} but you omit {count}, Elastic Transcoder returns a validation error and does not create the job.
    
    Literal values (Optional): You can specify literal values anywhere in the ThumbnailPattern object. For example, you can include them as a file name prefix or as a delimiter between {resolution} and {count}.
    
    {resolution} (Optional): If you want Elastic Transcoder to include the resolution in the file name, include {resolution} in the ThumbnailPattern object.
    
    When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png) that appears in the preset that you specified in the PresetID value of CreateJobOutput. Elastic Transcoder also appends the applicable file name extension.
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getRotate
```
public String getRotate()
```
    The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. Enter one of the following values: auto, 0, 90, 180, 270. The value auto generally works only if the file that you're transcoding contains rotation metadata.
    Constraints:
    Pattern: (^auto$)|(^0$)|(^90$)|(^180$)|(^270$)
    
    Returns:
    The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. Enter one of the following values: auto, 0, 90, 180, 270. The value auto generally works only if the file that you're transcoding contains rotation metadata.
  - setRotate
```
public void setRotate(String rotate)
```
    The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. Enter one of the following values: auto, 0, 90, 180, 270. The value auto generally works only if the file that you're transcoding contains rotation metadata.
    Constraints:
    Pattern: (^auto$)|(^0$)|(^90$)|(^180$)|(^270$)
    
    Parameters:
    rotate - The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. Enter one of the following values: auto, 0, 90, 180, 270. The value auto generally works only if the file that you're transcoding contains rotation metadata.
  - withRotate
```
public CreateJobOutput withRotate(String rotate)
```
    The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. Enter one of the following values: auto, 0, 90, 180, 270. The value auto generally works only if the file that you're transcoding contains rotation metadata.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: (^auto$)|(^0$)|(^90$)|(^180$)|(^270$)
    
    Parameters:
    rotate - The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. Enter one of the following values: auto, 0, 90, 180, 270. The value auto generally works only if the file that you're transcoding contains rotation metadata.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getPresetId
```
public String getPresetId()
```
    The Id of the preset to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding.
    Constraints:
    Pattern: ^\d{13}-\w{6}$
    
    Returns:
    The Id of the preset to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding.
  - setPresetId
```
public void setPresetId(String presetId)
```
    The Id of the preset to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding.
    Constraints:
    Pattern: ^\d{13}-\w{6}$
    
    Parameters:
    presetId - The Id of the preset to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding.
  - withPresetId
```
public CreateJobOutput withPresetId(String presetId)
```
    The Id of the preset to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: ^\d{13}-\w{6}$
    
    Parameters:
    presetId - The Id of the preset to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getSegmentDuration
```
public String getSegmentDuration()
```
    If you specify a preset in PresetId for which the value of Container is ts (MPEG-TS), SegmentDuration is the duration of each .ts file in seconds. The range of valid values is 1 to 60 seconds.
    Constraints:
    Pattern: ^\d{1,5}([.]\d{0,5})?$
    
    Returns:
    If you specify a preset in PresetId for which the value of Container is ts (MPEG-TS), SegmentDuration is the duration of each .ts file in seconds. The range of valid values is 1 to 60 seconds.
  - setSegmentDuration
```
public void setSegmentDuration(String segmentDuration)
```
    If you specify a preset in PresetId for which the value of Container is ts (MPEG-TS), SegmentDuration is the duration of each .ts file in seconds. The range of valid values is 1 to 60 seconds.
    Constraints:
    Pattern: ^\d{1,5}([.]\d{0,5})?$
    
    Parameters:
    segmentDuration - If you specify a preset in PresetId for which the value of Container is ts (MPEG-TS), SegmentDuration is the duration of each .ts file in seconds. The range of valid values is 1 to 60 seconds.
  - withSegmentDuration
```
public CreateJobOutput withSegmentDuration(String segmentDuration)
```
    If you specify a preset in PresetId for which the value of Container is ts (MPEG-TS), SegmentDuration is the duration of each .ts file in seconds. The range of valid values is 1 to 60 seconds.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: ^\d{1,5}([.]\d{0,5})?$
    
    Parameters:
    segmentDuration - If you specify a preset in PresetId for which the value of Container is ts (MPEG-TS), SegmentDuration is the duration of each .ts file in seconds. The range of valid values is 1 to 60 seconds.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getWatermarks
```
public List<JobWatermark> getWatermarks()
```
    Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output. Settings for each watermark must be defined in the preset for the current output.
    
    Returns:
    Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output. Settings for each watermark must be defined in the preset for the current output.
  - setWatermarks
```
public void setWatermarks(Collection<JobWatermark> watermarks)
```
    Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output. Settings for each watermark must be defined in the preset for the current output.
    
    Parameters:
    watermarks - Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output. Settings for each watermark must be defined in the preset for the current output.
  - withWatermarks
```
public CreateJobOutput withWatermarks(JobWatermark... watermarks)
```
    Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output. Settings for each watermark must be defined in the preset for the current output.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    watermarks - Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output. Settings for each watermark must be defined in the preset for the current output.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withWatermarks
```
public CreateJobOutput withWatermarks(Collection<JobWatermark> watermarks)
```
    Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output. Settings for each watermark must be defined in the preset for the current output.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    watermarks - Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output. Settings for each watermark must be defined in the preset for the current output.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getAlbumArt
```
public JobAlbumArt getAlbumArt()
```
    Information about the album art that you want Elastic Transcoder to add to the file during transcoding. You can specify up to twenty album artworks for each output. Settings for each artwork must be defined in the job for the current output.
    
    Returns:
    Information about the album art that you want Elastic Transcoder to add to the file during transcoding. You can specify up to twenty album artworks for each output. Settings for each artwork must be defined in the job for the current output.
  - setAlbumArt
```
public void setAlbumArt(JobAlbumArt albumArt)
```
    Information about the album art that you want Elastic Transcoder to add to the file during transcoding. You can specify up to twenty album artworks for each output. Settings for each artwork must be defined in the job for the current output.
    
    Parameters:
    albumArt - Information about the album art that you want Elastic Transcoder to add to the file during transcoding. You can specify up to twenty album artworks for each output. Settings for each artwork must be defined in the job for the current output.
  - withAlbumArt
```
public CreateJobOutput withAlbumArt(JobAlbumArt albumArt)
```
    Information about the album art that you want Elastic Transcoder to add to the file during transcoding. You can specify up to twenty album artworks for each output. Settings for each artwork must be defined in the job for the current output.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    albumArt - Information about the album art that you want Elastic Transcoder to add to the file during transcoding. You can specify up to twenty album artworks for each output. Settings for each artwork must be defined in the job for the current output.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of this object.
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Did this page help you?

Class CreateJobOutput

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CreateJobOutput

Method Detail

getKey

setKey

withKey

getThumbnailPattern

setThumbnailPattern

withThumbnailPattern

getRotate

setRotate

withRotate

getPresetId

setPresetId

withPresetId

getSegmentDuration

setSegmentDuration

withSegmentDuration

getWatermarks

setWatermarks

withWatermarks

withWatermarks

getAlbumArt

setAlbumArt

withAlbumArt

toString

hashCode

equals