Class Job
- All Implemented Interfaces:
Serializable
,Cloneable
A section of the response body that provides information about the job that is created.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddUserMetadataEntry
(String key, String value) Removes all the entries added into UserMetadata.clone()
boolean
getArn()
The Amazon Resource Name (ARN) for the job.getId()
The identifier that Elastic Transcoder assigned to the job.getInput()
A section of the request or response body that provides information about the file that is being transcoded.If you specified one output for a job, information about that output.The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists.Information about the output files.TheId
of the pipeline that you want Elastic Transcoder to use for transcoding.Outputs in Fragmented MP4 or MPEG-TS format only. If you specify a preset inPresetId
for which the value ofContainer
is fmp4 (Fragmented MP4) or ts (MPEG-TS),Playlists
contains information about the master playlists that you want Elastic Transcoder to create.The status of the job:Submitted
,Progressing
,Complete
,Canceled
, orError
.Details about the timing of a job.User-defined metadata that you want to associate with an Elastic Transcoder job.int
hashCode()
void
The Amazon Resource Name (ARN) for the job.void
The identifier that Elastic Transcoder assigned to the job.void
A section of the request or response body that provides information about the file that is being transcoded.void
If you specified one output for a job, information about that output.void
setOutputKeyPrefix
(String outputKeyPrefix) The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists.void
setOutputs
(Collection<JobOutput> outputs) Information about the output files.void
setPipelineId
(String pipelineId) TheId
of the pipeline that you want Elastic Transcoder to use for transcoding.void
setPlaylists
(Collection<Playlist> playlists) Outputs in Fragmented MP4 or MPEG-TS format only. If you specify a preset inPresetId
for which the value ofContainer
is fmp4 (Fragmented MP4) or ts (MPEG-TS),Playlists
contains information about the master playlists that you want Elastic Transcoder to create.void
The status of the job:Submitted
,Progressing
,Complete
,Canceled
, orError
.void
Details about the timing of a job.void
setUserMetadata
(Map<String, String> userMetadata) User-defined metadata that you want to associate with an Elastic Transcoder job.toString()
Returns a string representation of this object; useful for testing and debugging.The Amazon Resource Name (ARN) for the job.The identifier that Elastic Transcoder assigned to the job.A section of the request or response body that provides information about the file that is being transcoded.withOutput
(JobOutput output) If you specified one output for a job, information about that output.withOutputKeyPrefix
(String outputKeyPrefix) The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists.withOutputs
(JobOutput... outputs) Information about the output files.withOutputs
(Collection<JobOutput> outputs) Information about the output files.withPipelineId
(String pipelineId) TheId
of the pipeline that you want Elastic Transcoder to use for transcoding.withPlaylists
(Playlist... playlists) Outputs in Fragmented MP4 or MPEG-TS format only. If you specify a preset inPresetId
for which the value ofContainer
is fmp4 (Fragmented MP4) or ts (MPEG-TS),Playlists
contains information about the master playlists that you want Elastic Transcoder to create.withPlaylists
(Collection<Playlist> playlists) Outputs in Fragmented MP4 or MPEG-TS format only. If you specify a preset inPresetId
for which the value ofContainer
is fmp4 (Fragmented MP4) or ts (MPEG-TS),Playlists
contains information about the master playlists that you want Elastic Transcoder to create.withStatus
(String status) The status of the job:Submitted
,Progressing
,Complete
,Canceled
, orError
.withTiming
(Timing timing) Details about the timing of a job.withUserMetadata
(Map<String, String> userMetadata) User-defined metadata that you want to associate with an Elastic Transcoder job.
-
Constructor Details
-
Job
public Job()
-
-
Method Details
-
setId
The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the job or to delete the job.
- Parameters:
id
- The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the job or to delete the job.
-
getId
The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the job or to delete the job.
- Returns:
- The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the job or to delete the job.
-
withId
The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the job or to delete the job.
- Parameters:
id
- The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the job or to delete the job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setArn
The Amazon Resource Name (ARN) for the job.
- Parameters:
arn
- The Amazon Resource Name (ARN) for the job.
-
getArn
The Amazon Resource Name (ARN) for the job.
- Returns:
- The Amazon Resource Name (ARN) for the job.
-
withArn
The Amazon Resource Name (ARN) for the job.
- Parameters:
arn
- The Amazon Resource Name (ARN) for the job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPipelineId
The
Id
of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.- Parameters:
pipelineId
- TheId
of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.
-
getPipelineId
The
Id
of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.- Returns:
- The
Id
of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.
-
withPipelineId
The
Id
of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.- Parameters:
pipelineId
- TheId
of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setInput
A section of the request or response body that provides information about the file that is being transcoded.
- Parameters:
input
- A section of the request or response body that provides information about the file that is being transcoded.
-
getInput
A section of the request or response body that provides information about the file that is being transcoded.
- Returns:
- A section of the request or response body that provides information about the file that is being transcoded.
-
withInput
A section of the request or response body that provides information about the file that is being transcoded.
- Parameters:
input
- A section of the request or response body that provides information about the file that is being transcoded.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setOutput
If you specified one output for a job, information about that output. If you specified multiple outputs for a job, the Output object lists information about the first output. This duplicates the information that is listed for the first output in the Outputs object.
Outputs recommended instead. A section of the request or response body that provides information about the transcoded (target) file.- Parameters:
output
- If you specified one output for a job, information about that output. If you specified multiple outputs for a job, the Output object lists information about the first output. This duplicates the information that is listed for the first output in the Outputs object.Outputs recommended instead. A section of the request or response body that provides information about the transcoded (target) file.
-
getOutput
If you specified one output for a job, information about that output. If you specified multiple outputs for a job, the Output object lists information about the first output. This duplicates the information that is listed for the first output in the Outputs object.
Outputs recommended instead. A section of the request or response body that provides information about the transcoded (target) file.- Returns:
- If you specified one output for a job, information about that
output. If you specified multiple outputs for a job, the Output
object lists information about the first output. This duplicates
the information that is listed for the first output in the
Outputs object.
Outputs recommended instead. A section of the request or response body that provides information about the transcoded (target) file.
-
withOutput
If you specified one output for a job, information about that output. If you specified multiple outputs for a job, the Output object lists information about the first output. This duplicates the information that is listed for the first output in the Outputs object.
Outputs recommended instead. A section of the request or response body that provides information about the transcoded (target) file.- Parameters:
output
- If you specified one output for a job, information about that output. If you specified multiple outputs for a job, the Output object lists information about the first output. This duplicates the information that is listed for the first output in the Outputs object.Outputs recommended instead. A section of the request or response body that provides information about the transcoded (target) file.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getOutputs
Information about the output files. We recommend that you use the
Outputs
syntax for all jobs, even when you want Elastic Transcoder to transcode a file into only one format. Do not use both theOutputs
andOutput
syntaxes in the same request. You can create a maximum of 30 outputs per job.If you specify more than one output for a job, Elastic Transcoder creates the files for each output in the order in which you specify them in the job.
- Returns:
- Information about the output files. We recommend that you use the
Outputs
syntax for all jobs, even when you want Elastic Transcoder to transcode a file into only one format. Do not use both theOutputs
andOutput
syntaxes in the same request. You can create a maximum of 30 outputs per job.If you specify more than one output for a job, Elastic Transcoder creates the files for each output in the order in which you specify them in the job.
-
setOutputs
Information about the output files. We recommend that you use the
Outputs
syntax for all jobs, even when you want Elastic Transcoder to transcode a file into only one format. Do not use both theOutputs
andOutput
syntaxes in the same request. You can create a maximum of 30 outputs per job.If you specify more than one output for a job, Elastic Transcoder creates the files for each output in the order in which you specify them in the job.
- Parameters:
outputs
- Information about the output files. We recommend that you use theOutputs
syntax for all jobs, even when you want Elastic Transcoder to transcode a file into only one format. Do not use both theOutputs
andOutput
syntaxes in the same request. You can create a maximum of 30 outputs per job.If you specify more than one output for a job, Elastic Transcoder creates the files for each output in the order in which you specify them in the job.
-
withOutputs
Information about the output files. We recommend that you use the
Outputs
syntax for all jobs, even when you want Elastic Transcoder to transcode a file into only one format. Do not use both theOutputs
andOutput
syntaxes in the same request. You can create a maximum of 30 outputs per job.If you specify more than one output for a job, Elastic Transcoder creates the files for each output in the order in which you specify them in the job.
NOTE: This method appends the values to the existing list (if any). Use
setOutputs(java.util.Collection)
orwithOutputs(java.util.Collection)
if you want to override the existing values.- Parameters:
outputs
- Information about the output files. We recommend that you use theOutputs
syntax for all jobs, even when you want Elastic Transcoder to transcode a file into only one format. Do not use both theOutputs
andOutput
syntaxes in the same request. You can create a maximum of 30 outputs per job.If you specify more than one output for a job, Elastic Transcoder creates the files for each output in the order in which you specify them in the job.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withOutputs
Information about the output files. We recommend that you use the
Outputs
syntax for all jobs, even when you want Elastic Transcoder to transcode a file into only one format. Do not use both theOutputs
andOutput
syntaxes in the same request. You can create a maximum of 30 outputs per job.If you specify more than one output for a job, Elastic Transcoder creates the files for each output in the order in which you specify them in the job.
- Parameters:
outputs
- Information about the output files. We recommend that you use theOutputs
syntax for all jobs, even when you want Elastic Transcoder to transcode a file into only one format. Do not use both theOutputs
andOutput
syntaxes in the same request. You can create a maximum of 30 outputs per job.If you specify more than one output for a job, Elastic Transcoder creates the files for each output in the order in which you specify them in the job.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setOutputKeyPrefix
The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists. We recommend that you add a / or some other delimiter to the end of the
OutputKeyPrefix
.- Parameters:
outputKeyPrefix
- The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists. We recommend that you add a / or some other delimiter to the end of theOutputKeyPrefix
.
-
getOutputKeyPrefix
The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists. We recommend that you add a / or some other delimiter to the end of the
OutputKeyPrefix
.- Returns:
- The value, if any, that you want Elastic Transcoder to prepend to
the names of all files that this job creates, including output
files, thumbnails, and playlists. We recommend that you add a /
or some other delimiter to the end of the
OutputKeyPrefix
.
-
withOutputKeyPrefix
The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists. We recommend that you add a / or some other delimiter to the end of the
OutputKeyPrefix
.- Parameters:
outputKeyPrefix
- The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists. We recommend that you add a / or some other delimiter to the end of theOutputKeyPrefix
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getPlaylists
Outputs in Fragmented MP4 or MPEG-TS format only. If you specify a preset inPresetId
for which the value ofContainer
is fmp4 (Fragmented MP4) or ts (MPEG-TS),Playlists
contains information about the master playlists that you want Elastic Transcoder to create.The maximum number of master playlists in a job is 30.
- Returns:
- Outputs in Fragmented MP4 or MPEG-TS format only.If
you specify a preset in
PresetId
for which the value ofContainer
is fmp4 (Fragmented MP4) or ts (MPEG-TS),Playlists
contains information about the master playlists that you want Elastic Transcoder to create.
-
setPlaylists
Outputs in Fragmented MP4 or MPEG-TS format only. If you specify a preset inPresetId
for which the value ofContainer
is fmp4 (Fragmented MP4) or ts (MPEG-TS),Playlists
contains information about the master playlists that you want Elastic Transcoder to create.The maximum number of master playlists in a job is 30.
- Parameters:
playlists
- Outputs in Fragmented MP4 or MPEG-TS format only.If you specify a preset inPresetId
for which the value ofContainer
is fmp4 (Fragmented MP4) or ts (MPEG-TS),Playlists
contains information about the master playlists that you want Elastic Transcoder to create.
-
withPlaylists
Outputs in Fragmented MP4 or MPEG-TS format only. If you specify a preset inPresetId
for which the value ofContainer
is fmp4 (Fragmented MP4) or ts (MPEG-TS),Playlists
contains information about the master playlists that you want Elastic Transcoder to create.The maximum number of master playlists in a job is 30.
NOTE: This method appends the values to the existing list (if any). Use
setPlaylists(java.util.Collection)
orwithPlaylists(java.util.Collection)
if you want to override the existing values.- Parameters:
playlists
- Outputs in Fragmented MP4 or MPEG-TS format only.If you specify a preset inPresetId
for which the value ofContainer
is fmp4 (Fragmented MP4) or ts (MPEG-TS),Playlists
contains information about the master playlists that you want Elastic Transcoder to create.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withPlaylists
Outputs in Fragmented MP4 or MPEG-TS format only. If you specify a preset inPresetId
for which the value ofContainer
is fmp4 (Fragmented MP4) or ts (MPEG-TS),Playlists
contains information about the master playlists that you want Elastic Transcoder to create.The maximum number of master playlists in a job is 30.
- Parameters:
playlists
- Outputs in Fragmented MP4 or MPEG-TS format only.If you specify a preset inPresetId
for which the value ofContainer
is fmp4 (Fragmented MP4) or ts (MPEG-TS),Playlists
contains information about the master playlists that you want Elastic Transcoder to create.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStatus
The status of the job:
Submitted
,Progressing
,Complete
,Canceled
, orError
.- Parameters:
status
- The status of the job:Submitted
,Progressing
,Complete
,Canceled
, orError
.
-
getStatus
The status of the job:
Submitted
,Progressing
,Complete
,Canceled
, orError
.- Returns:
- The status of the job:
Submitted
,Progressing
,Complete
,Canceled
, orError
.
-
withStatus
The status of the job:
Submitted
,Progressing
,Complete
,Canceled
, orError
.- Parameters:
status
- The status of the job:Submitted
,Progressing
,Complete
,Canceled
, orError
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getUserMetadata
User-defined metadata that you want to associate with an Elastic Transcoder job. You specify metadata in
key/value
pairs, and you can add up to 10key/value
pairs per job. Elastic Transcoder does not guarantee thatkey/value
pairs will be returned in the same order in which you specify them.Metadata
keys
andvalues
must use characters from the following list:-
0-9
-
A-Z
anda-z
-
Space
-
The following symbols:
_.:/=+-%@
- Returns:
- User-defined metadata that you want to associate with an Elastic
Transcoder job. You specify metadata in
key/value
pairs, and you can add up to 10key/value
pairs per job. Elastic Transcoder does not guarantee thatkey/value
pairs will be returned in the same order in which you specify them.Metadata
keys
andvalues
must use characters from the following list:-
0-9
-
A-Z
anda-z
-
Space
-
The following symbols:
_.:/=+-%@
-
-
-
setUserMetadata
User-defined metadata that you want to associate with an Elastic Transcoder job. You specify metadata in
key/value
pairs, and you can add up to 10key/value
pairs per job. Elastic Transcoder does not guarantee thatkey/value
pairs will be returned in the same order in which you specify them.Metadata
keys
andvalues
must use characters from the following list:-
0-9
-
A-Z
anda-z
-
Space
-
The following symbols:
_.:/=+-%@
- Parameters:
userMetadata
- User-defined metadata that you want to associate with an Elastic Transcoder job. You specify metadata inkey/value
pairs, and you can add up to 10key/value
pairs per job. Elastic Transcoder does not guarantee thatkey/value
pairs will be returned in the same order in which you specify them.Metadata
keys
andvalues
must use characters from the following list:-
0-9
-
A-Z
anda-z
-
Space
-
The following symbols:
_.:/=+-%@
-
-
-
withUserMetadata
User-defined metadata that you want to associate with an Elastic Transcoder job. You specify metadata in
key/value
pairs, and you can add up to 10key/value
pairs per job. Elastic Transcoder does not guarantee thatkey/value
pairs will be returned in the same order in which you specify them.Metadata
keys
andvalues
must use characters from the following list:-
0-9
-
A-Z
anda-z
-
Space
-
The following symbols:
_.:/=+-%@
- Parameters:
userMetadata
- User-defined metadata that you want to associate with an Elastic Transcoder job. You specify metadata inkey/value
pairs, and you can add up to 10key/value
pairs per job. Elastic Transcoder does not guarantee thatkey/value
pairs will be returned in the same order in which you specify them.Metadata
keys
andvalues
must use characters from the following list:-
0-9
-
A-Z
anda-z
-
Space
-
The following symbols:
_.:/=+-%@
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
addUserMetadataEntry
-
clearUserMetadataEntries
Removes all the entries added into UserMetadata. <p> Returns a reference to this object so that method calls can be chained together. -
setTiming
Details about the timing of a job.
- Parameters:
timing
- Details about the timing of a job.
-
getTiming
Details about the timing of a job.
- Returns:
- Details about the timing of a job.
-
withTiming
Details about the timing of a job.
- Parameters:
timing
- Details about the timing of a job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-