public class Job extends Object implements Serializable, Cloneable
A section of the response body that provides information about the job that is created.
Constructor and Description |
---|
Job() |
Modifier and Type | Method and Description |
---|---|
Job |
addUserMetadataEntry(String key,
String value) |
Job |
clearUserMetadataEntries()
Removes all the entries added into UserMetadata.
|
Job |
clone() |
boolean |
equals(Object obj) |
String |
getArn()
The Amazon Resource Name (ARN) for the job.
|
String |
getId()
The identifier that Elastic Transcoder assigned to the job.
|
JobInput |
getInput()
A section of the request or response body that provides information about the file that is being transcoded.
|
JobOutput |
getOutput()
If you specified one output for a job, information about that output.
|
String |
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.
|
List<JobOutput> |
getOutputs()
Information about the output files.
|
String |
getPipelineId()
The
Id of the pipeline that you want Elastic Transcoder to use for transcoding. |
List<Playlist> |
getPlaylists()
PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS),
Playlists contains information about the master playlists that you want Elastic Transcoder to
create. |
String |
getStatus()
The status of the job:
Submitted , Progressing , Complete ,
Canceled , or Error . |
Timing |
getTiming()
Details about the timing of a job.
|
Map<String,String> |
getUserMetadata()
User-defined metadata that you want to associate with an Elastic Transcoder job.
|
int |
hashCode() |
void |
setArn(String arn)
The Amazon Resource Name (ARN) for the job.
|
void |
setId(String id)
The identifier that Elastic Transcoder assigned to the job.
|
void |
setInput(JobInput input)
A section of the request or response body that provides information about the file that is being transcoded.
|
void |
setOutput(JobOutput output)
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)
The
Id of the pipeline that you want Elastic Transcoder to use for transcoding. |
void |
setPlaylists(Collection<Playlist> playlists)
PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS),
Playlists contains information about the master playlists that you want Elastic Transcoder to
create. |
void |
setStatus(String status)
The status of the job:
Submitted , Progressing , Complete ,
Canceled , or Error . |
void |
setTiming(Timing timing)
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.
|
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
Job |
withArn(String arn)
The Amazon Resource Name (ARN) for the job.
|
Job |
withId(String id)
The identifier that Elastic Transcoder assigned to the job.
|
Job |
withInput(JobInput input)
A section of the request or response body that provides information about the file that is being transcoded.
|
Job |
withOutput(JobOutput output)
If you specified one output for a job, information about that output.
|
Job |
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.
|
Job |
withOutputs(Collection<JobOutput> outputs)
Information about the output files.
|
Job |
withOutputs(JobOutput... outputs)
Information about the output files.
|
Job |
withPipelineId(String pipelineId)
The
Id of the pipeline that you want Elastic Transcoder to use for transcoding. |
Job |
withPlaylists(Collection<Playlist> playlists)
PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS),
Playlists contains information about the master playlists that you want Elastic Transcoder to
create. |
Job |
withPlaylists(Playlist... playlists)
PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS),
Playlists contains information about the master playlists that you want Elastic Transcoder to
create. |
Job |
withStatus(String status)
The status of the job:
Submitted , Progressing , Complete ,
Canceled , or Error . |
Job |
withTiming(Timing timing)
Details about the timing of a job.
|
Job |
withUserMetadata(Map<String,String> userMetadata)
User-defined metadata that you want to associate with an Elastic Transcoder job.
|
public void setId(String 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.
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.public String 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.
public Job withId(String 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.
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.public void setArn(String arn)
The Amazon Resource Name (ARN) for the job.
arn
- The Amazon Resource Name (ARN) for the job.public String getArn()
The Amazon Resource Name (ARN) for the job.
public Job withArn(String arn)
The Amazon Resource Name (ARN) for the job.
arn
- The Amazon Resource Name (ARN) for the job.public void setPipelineId(String pipelineId)
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.
pipelineId
- 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.public String 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.
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.public Job withPipelineId(String pipelineId)
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.
pipelineId
- 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.public void setInput(JobInput input)
A section of the request or response body that provides information about the file that is being transcoded.
input
- A section of the request or response body that provides information about the file that is being
transcoded.public JobInput getInput()
A section of the request or response body that provides information about the file that is being transcoded.
public Job withInput(JobInput input)
A section of the request or response body that provides information about the file that is being transcoded.
input
- A section of the request or response body that provides information about the file that is being
transcoded.public void setOutput(JobOutput 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.
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.
public JobOutput 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.
public Job withOutput(JobOutput 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.
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.
public List<JobOutput> 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 the
Outputs
and Output
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.
Outputs
syntax for all
jobs, even when you want Elastic Transcoder to transcode a file into only one format. Do not use both the
Outputs
and Output
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.
public void setOutputs(Collection<JobOutput> outputs)
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 the
Outputs
and Output
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.
outputs
- 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 the
Outputs
and Output
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.
public Job withOutputs(JobOutput... outputs)
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 the
Outputs
and Output
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)
or withOutputs(java.util.Collection)
if you want to override
the existing values.
outputs
- 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 the
Outputs
and Output
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.
public Job withOutputs(Collection<JobOutput> outputs)
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 the
Outputs
and Output
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.
outputs
- 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 the
Outputs
and Output
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.
public 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. We recommend that you add a / or some other delimiter to the
end of the OutputKeyPrefix
.
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 the OutputKeyPrefix
.public String 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
.
OutputKeyPrefix
.public Job 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. We recommend that you add a / or some other delimiter to the
end of the OutputKeyPrefix
.
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 the OutputKeyPrefix
.public List<Playlist> getPlaylists()
PresetId
for which the value of Container
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.
PresetId
for which the value of Container
is fmp4 (Fragmented MP4) or ts
(MPEG-TS), Playlists
contains information about the master playlists that you want Elastic
Transcoder to create.public void setPlaylists(Collection<Playlist> playlists)
PresetId
for which the value of Container
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.
playlists
- Outputs in Fragmented MP4 or MPEG-TS format only.If you specify a preset in
PresetId
for which the value of Container
is fmp4 (Fragmented MP4) or ts
(MPEG-TS), Playlists
contains information about the master playlists that you want Elastic
Transcoder to create.public Job withPlaylists(Playlist... playlists)
PresetId
for which the value of Container
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)
or withPlaylists(java.util.Collection)
if you want to
override the existing values.
playlists
- Outputs in Fragmented MP4 or MPEG-TS format only.If you specify a preset in
PresetId
for which the value of Container
is fmp4 (Fragmented MP4) or ts
(MPEG-TS), Playlists
contains information about the master playlists that you want Elastic
Transcoder to create.public Job withPlaylists(Collection<Playlist> playlists)
PresetId
for which the value of Container
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.
playlists
- Outputs in Fragmented MP4 or MPEG-TS format only.If you specify a preset in
PresetId
for which the value of Container
is fmp4 (Fragmented MP4) or ts
(MPEG-TS), Playlists
contains information about the master playlists that you want Elastic
Transcoder to create.public void setStatus(String status)
The status of the job: Submitted
, Progressing
, Complete
,
Canceled
, or Error
.
status
- The status of the job: Submitted
, Progressing
, Complete
,
Canceled
, or Error
.public String getStatus()
The status of the job: Submitted
, Progressing
, Complete
,
Canceled
, or Error
.
Submitted
, Progressing
, Complete
,
Canceled
, or Error
.public Job withStatus(String status)
The status of the job: Submitted
, Progressing
, Complete
,
Canceled
, or Error
.
status
- The status of the job: Submitted
, Progressing
, Complete
,
Canceled
, or Error
.public Map<String,String> 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 10 key/value
pairs per job. Elastic Transcoder
does not guarantee that key/value
pairs will be returned in the same order in which you specify
them.
Metadata keys
and values
must use characters from the following list:
0-9
A-Z
and a-z
Space
The following symbols: _.:/=+-%@
key/value
pairs, and you can add up to 10 key/value
pairs per job. Elastic
Transcoder does not guarantee that key/value
pairs will be returned in the same order in
which you specify them.
Metadata keys
and values
must use characters from the following list:
0-9
A-Z
and a-z
Space
The following symbols: _.:/=+-%@
public void setUserMetadata(Map<String,String> userMetadata)
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 10 key/value
pairs per job. Elastic Transcoder
does not guarantee that key/value
pairs will be returned in the same order in which you specify
them.
Metadata keys
and values
must use characters from the following list:
0-9
A-Z
and a-z
Space
The following symbols: _.:/=+-%@
userMetadata
- 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 10 key/value
pairs per job. Elastic
Transcoder does not guarantee that key/value
pairs will be returned in the same order in
which you specify them.
Metadata keys
and values
must use characters from the following list:
0-9
A-Z
and a-z
Space
The following symbols: _.:/=+-%@
public Job withUserMetadata(Map<String,String> userMetadata)
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 10 key/value
pairs per job. Elastic Transcoder
does not guarantee that key/value
pairs will be returned in the same order in which you specify
them.
Metadata keys
and values
must use characters from the following list:
0-9
A-Z
and a-z
Space
The following symbols: _.:/=+-%@
userMetadata
- 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 10 key/value
pairs per job. Elastic
Transcoder does not guarantee that key/value
pairs will be returned in the same order in
which you specify them.
Metadata keys
and values
must use characters from the following list:
0-9
A-Z
and a-z
Space
The following symbols: _.:/=+-%@
public Job clearUserMetadataEntries()
public void setTiming(Timing timing)
Details about the timing of a job.
timing
- Details about the timing of a job.public Timing getTiming()
Details about the timing of a job.
public Job withTiming(Timing timing)
Details about the timing of a job.
timing
- Details about the timing of a job.public String toString()
toString
in class Object
Object.toString()
Copyright © 2016. All rights reserved.