Did this page help you?

   Yes   No   Tell us about it...

com.amazonaws.services.elastictranscoder.model
Class Job

java.lang.Object
  extended by com.amazonaws.services.elastictranscoder.model.Job
All Implemented Interfaces:
Serializable

public class Job
extends Object
implements Serializable

A section of the response body that provides information about the job that is created.

See Also:
Serialized Form

Constructor Summary
Job()
           
 
Method Summary
 boolean equals(Object obj)
           
 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()
          Outputs in MPEG-TS format only.If you specify a preset in PresetId for which the value of Container is 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, l, Canceled, or Error.
 int hashCode()
           
 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)
          Outputs in MPEG-TS format only.If you specify a preset in PresetId for which the value of Container is 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, l, Canceled, or Error.
 String toString()
          Returns a string representation of this object; useful for testing and debugging.
 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)
          Outputs in MPEG-TS format only.If you specify a preset in PresetId for which the value of Container is ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create.
 Job withPlaylists(Playlist... playlists)
          Outputs in MPEG-TS format only.If you specify a preset in PresetId for which the value of Container is 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, l, Canceled, or Error.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Job

public Job()
Method Detail

getId

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.

Constraints:
Pattern: ^\d{13}-\w{6}$

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.

setId

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.

Constraints:
Pattern: ^\d{13}-\w{6}$

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.

withId

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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Pattern: ^\d{13}-\w{6}$

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:
A reference to this updated object so that method calls can be chained together.

getPipelineId

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.

Constraints:
Pattern: ^\d{13}-\w{6}$

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.

setPipelineId

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.

Constraints:
Pattern: ^\d{13}-\w{6}$

Parameters:
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.

withPipelineId

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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Pattern: ^\d{13}-\w{6}$

Parameters:
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.
Returns:
A reference to this updated object so that method calls can be chained together.

getInput

public JobInput 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.

setInput

public void setInput(JobInput input)
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.

withInput

public Job withInput(JobInput input)
A section of the request or response body that provides information about the file that is being transcoded.

Returns a reference to this object so that method calls can be chained together.

Parameters:
input - A section of the request or response body that provides information about the file that is being transcoded.
Returns:
A reference to this updated object so that method calls can be chained together.

getOutput

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.

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.


setOutput

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.

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.


withOutput

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.

Outputs recommended instead. A section of the request or response body that provides information about the transcoded (target) file.

Returns a reference to this object so that method calls can be chained together.

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:
A reference to this updated object so that method calls can be chained together.

getOutputs

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.

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 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.


setOutputs

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.

Parameters:
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.


withOutputs

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.

Returns a reference to this object so that method calls can be chained together.

Parameters:
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.

Returns:
A reference to this updated object so that method calls can be chained together.

withOutputs

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.

Returns a reference to this object so that method calls can be chained together.

Parameters:
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.

Returns:
A reference to this updated object so that method calls can be chained together.

getOutputKeyPrefix

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.

Constraints:
Length: 1 - 255

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.

setOutputKeyPrefix

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.

Constraints:
Length: 1 - 255

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 the OutputKeyPrefix.

withOutputKeyPrefix

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.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 255

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 the OutputKeyPrefix.
Returns:
A reference to this updated object so that method calls can be chained together.

getPlaylists

public List<Playlist> getPlaylists()
Outputs in MPEG-TS format only.If you specify a preset in PresetId for which the value of Container is ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create.

We recommend that you create only one master playlist. The maximum number of master playlists in a job is 30.

Returns:
Outputs in MPEG-TS format only.If you specify a preset in PresetId for which the value of Container is ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create.

We recommend that you create only one master playlist. The maximum number of master playlists in a job is 30.


setPlaylists

public void setPlaylists(Collection<Playlist> playlists)
Outputs in MPEG-TS format only.If you specify a preset in PresetId for which the value of Container is ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create.

We recommend that you create only one master playlist. The maximum number of master playlists in a job is 30.

Parameters:
playlists - Outputs in MPEG-TS format only.If you specify a preset in PresetId for which the value of Container is ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create.

We recommend that you create only one master playlist. The maximum number of master playlists in a job is 30.


withPlaylists

public Job withPlaylists(Playlist... playlists)
Outputs in MPEG-TS format only.If you specify a preset in PresetId for which the value of Container is ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create.

We recommend that you create only one master playlist. The maximum number of master playlists in a job is 30.

Returns a reference to this object so that method calls can be chained together.

Parameters:
playlists - Outputs in MPEG-TS format only.If you specify a preset in PresetId for which the value of Container is ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create.

We recommend that you create only one master playlist. The maximum number of master playlists in a job is 30.

Returns:
A reference to this updated object so that method calls can be chained together.

withPlaylists

public Job withPlaylists(Collection<Playlist> playlists)
Outputs in MPEG-TS format only.If you specify a preset in PresetId for which the value of Container is ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create.

We recommend that you create only one master playlist. The maximum number of master playlists in a job is 30.

Returns a reference to this object so that method calls can be chained together.

Parameters:
playlists - Outputs in MPEG-TS format only.If you specify a preset in PresetId for which the value of Container is ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create.

We recommend that you create only one master playlist. The maximum number of master playlists in a job is 30.

Returns:
A reference to this updated object so that method calls can be chained together.

getStatus

public String getStatus()
The status of the job: Submitted, Progressing, l, Canceled, or Error.

Constraints:
Pattern: (^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)

Returns:
The status of the job: Submitted, Progressing, l, Canceled, or Error.

setStatus

public void setStatus(String status)
The status of the job: Submitted, Progressing, l, Canceled, or Error.

Constraints:
Pattern: (^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)

Parameters:
status - The status of the job: Submitted, Progressing, l, Canceled, or Error.

withStatus

public Job withStatus(String status)
The status of the job: Submitted, Progressing, l, Canceled, or Error.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Pattern: (^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)

Parameters:
status - The status of the job: Submitted, Progressing, l, Canceled, or Error.
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


Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.