Class CreateJobRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.elastictranscoder.model.CreateJobRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class CreateJobRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

The CreateJobRequest structure.

See Also:
  • Constructor Details

    • CreateJobRequest

      public CreateJobRequest()
  • Method Details

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

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

      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

      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.

      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:
      Returns a reference to this object so that method calls can be chained together.
    • 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.
    • 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.
    • withInput

      public CreateJobRequest withInput(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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setOutput

      public void setOutput(CreateJobOutput output)
      Parameters:
      output -
    • getOutput

      public CreateJobOutput getOutput()
      Returns:
    • withOutput

      public CreateJobRequest withOutput(CreateJobOutput output)
      Parameters:
      output -
      Returns:
      Returns a reference to this 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.

      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.

      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.

      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.

      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:
      Returns a reference to this 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.

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

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

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

      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:
      Returns a reference to this 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 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:
      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.

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

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

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

      The maximum number of master playlists in a job is 30.

      Returns:
      Returns a reference to this 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 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 - 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.

      The maximum number of master playlists in a job is 30.

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

      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.

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

      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.

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

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

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

      public CreateJobRequest addUserMetadataEntry(String key, String value)
    • clearUserMetadataEntries

      public CreateJobRequest clearUserMetadataEntries()
      Removes all the entries added into UserMetadata. <p> Returns a reference to this 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:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public CreateJobRequest clone()
      Description copied from class: AmazonWebServiceRequest
      Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: