CreateJobRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.elastictranscoder.model.CreateJobRequest

All Implemented Interfaces:

Serializable
```
public class CreateJobRequest
extends AmazonWebServiceRequest
implements Serializable
```
Container for the parameters to the CreateJob operation.
When you create a job, Elastic Transcoder returns JSON data that includes the values that you specified plus information about the job that is created.

If you have specified more than one output for your jobs (for example, one output for the Kindle Fire and another output for the Apple iPhone 4s), you currently must use the Elastic Transcoder API to list the jobs (as opposed to the AWS Console).

See Also:
AmazonElasticTranscoder.createJob(CreateJobRequest), Serialized Form

Constructor Summary

Constructors
Constructor and Description

CreateJobRequest()

Constructors
Constructor and Description
`CreateJobRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`JobInput`	`getInput()` A section of the request body that provides information about the file that is being transcoded.
`CreateJobOutput`	`getOutput()` The `CreateJobOutput` structure.
`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<CreateJobOutput>`	`getOutputs()` A section of the request body that provides information about the transcoded (target) files.
`String`	`getPipelineId()` The `Id` of the pipeline that you want Elastic Transcoder to use for transcoding.
`List<CreateJobPlaylist>`	`getPlaylists()` 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.
`int`	`hashCode()`
`void`	`setInput(JobInput input)` A section of the request body that provides information about the file that is being transcoded.
`void`	`setOutput(CreateJobOutput output)` The `CreateJobOutput` structure.
`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<CreateJobOutput> outputs)` A section of the request body that provides information about the transcoded (target) files.
`void`	`setPipelineId(String pipelineId)` The `Id` of the pipeline that you want Elastic Transcoder to use for transcoding.
`void`	`setPlaylists(Collection<CreateJobPlaylist> playlists)` 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`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`CreateJobRequest`	`withInput(JobInput input)` A section of the request body that provides information about the file that is being transcoded.
`CreateJobRequest`	`withOutput(CreateJobOutput output)` The `CreateJobOutput` structure.
`CreateJobRequest`	`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.
`CreateJobRequest`	`withOutputs(Collection<CreateJobOutput> outputs)` A section of the request body that provides information about the transcoded (target) files.
`CreateJobRequest`	`withOutputs(CreateJobOutput... outputs)` A section of the request body that provides information about the transcoded (target) files.
`CreateJobRequest`	`withPipelineId(String pipelineId)` The `Id` of the pipeline that you want Elastic Transcoder to use for transcoding.
`CreateJobRequest`	`withPlaylists(Collection<CreateJobPlaylist> playlists)` 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.
`CreateJobRequest`	`withPlaylists(CreateJobPlaylist... playlists)` 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.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

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

- Constructor Detail
  - CreateJobRequest
```
public CreateJobRequest()
```
- Method Detail
  - 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 CreateJobRequest 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 body that provides information about the file that is being transcoded.
    
    Returns:
    A section of the request body that provides information about the file that is being transcoded.
  - setInput
```
public void setInput(JobInput input)
```
    A section of the request body that provides information about the file that is being transcoded.
    
    Parameters:
    input - A section of the request body that provides information about the file that is being transcoded.
  - withInput
```
public CreateJobRequest withInput(JobInput input)
```
    A section of the request 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 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 CreateJobOutput getOutput()
```
    The CreateJobOutput structure.
    
    Returns:
    The CreateJobOutput structure.
  - setOutput
```
public void setOutput(CreateJobOutput output)
```
    The CreateJobOutput structure.
    
    Parameters:
    output - The CreateJobOutput structure.
  - withOutput
```
public CreateJobRequest withOutput(CreateJobOutput output)
```
    The CreateJobOutput structure.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    output - The CreateJobOutput structure.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getOutputs
```
public List<CreateJobOutput> getOutputs()
```
    A section of the request body that provides information about the transcoded (target) files. We recommend that you use the Outputs syntax instead of the Output syntax.
    Constraints:
    Length: 0 - 30
    
    Returns:
    A section of the request body that provides information about the transcoded (target) files. We recommend that you use the Outputs syntax instead of the Output syntax.
  - setOutputs
```
public void setOutputs(Collection<CreateJobOutput> outputs)
```
    A section of the request body that provides information about the transcoded (target) files. We recommend that you use the Outputs syntax instead of the Output syntax.
    Constraints:
    Length: 0 - 30
    
    Parameters:
    outputs - A section of the request body that provides information about the transcoded (target) files. We recommend that you use the Outputs syntax instead of the Output syntax.
  - withOutputs
```
public CreateJobRequest withOutputs(CreateJobOutput... outputs)
```
    A section of the request body that provides information about the transcoded (target) files. We recommend that you use the Outputs syntax instead of the Output syntax.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 30
    
    Parameters:
    outputs - A section of the request body that provides information about the transcoded (target) files. We recommend that you use the Outputs syntax instead of the Output syntax.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withOutputs
```
public CreateJobRequest withOutputs(Collection<CreateJobOutput> outputs)
```
    A section of the request body that provides information about the transcoded (target) files. We recommend that you use the Outputs syntax instead of the Output syntax.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 30
    
    Parameters:
    outputs - A section of the request body that provides information about the transcoded (target) files. We recommend that you use the Outputs syntax instead of the Output syntax.
    
    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.
    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.
  - 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.
    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.
  - withOutputKeyPrefix
```
public CreateJobRequest 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.
    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.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getPlaylists
```
public List<CreateJobPlaylist> getPlaylists()
```
    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.
    Constraints:
    Length: 0 - 30
    
    Returns:
    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<CreateJobPlaylist> playlists)
```
    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.
    Constraints:
    Length: 0 - 30
    
    Parameters:
    playlists - 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 CreateJobRequest withPlaylists(CreateJobPlaylist... playlists)
```
    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.
    Constraints:
    Length: 0 - 30
    
    Parameters:
    playlists - 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 CreateJobRequest withPlaylists(Collection<CreateJobPlaylist> playlists)
```
    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.
    Constraints:
    Length: 0 - 30
    
    Parameters:
    playlists - 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.
  - 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 CreateJobRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateJobRequest

Method Detail

getPipelineId

setPipelineId

withPipelineId

getInput

setInput

withInput

getOutput

setOutput

withOutput

getOutputs

setOutputs

withOutputs

withOutputs

getOutputKeyPrefix

setOutputKeyPrefix

withOutputKeyPrefix

getPlaylists

setPlaylists

withPlaylists

withPlaylists

toString

hashCode

equals