Job (AWS SDK for Java - 2.0.0-preview-1)

java.lang.Object
- software.amazon.awssdk.services.elastictranscoder.model.Job

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<Job.Builder,Job>
```
@Generated("software.amazon.awssdk:codegen")
public class Job
extends Object
implements StructuredPojo, ToCopyableBuilder<Job.Builder,Job>
```
A section of the response body that provides information about the job that is created.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Job.Builder

Nested Classes
Modifier and Type	Class	Description
`static interface`	`Job.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`arn()`	The Amazon Resource Name (ARN) for the job.
`static Job.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`int`	`hashCode()`
`String`	`id()`	The identifier that Elastic Transcoder assigned to the job.
`JobInput`	`input()`	A section of the request or response body that provides information about the file that is being transcoded.
`List<JobInput>`	`inputs()`	Information about the files that you're transcoding.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`	Marshalls this structured data using the given `ProtocolMarshaller`.
`JobOutput`	`output()`	If you specified one output for a job, information about that output.
`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.
`List<JobOutput>`	`outputs()`	Information about the output files.
`String`	`pipelineId()`	The `Id` of the pipeline that you want Elastic Transcoder to use for transcoding.
`List<Playlist>`	`playlists()`
`static Class<? extends Job.Builder>`	`serializableBuilderClass()`
`String`	`status()`	The status of the job: `Submitted`, `Progressing`, `Complete`, `Canceled`, or `Error`.
`Timing`	`timing()`	Details about the timing of a job.
`Job.Builder`	`toBuilder()`	Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`Map<String,String>`	`userMetadata()`	User-defined metadata that you want to associate with an Elastic Transcoder job.

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

- Method Detail
  - id
```
public 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:
    
    The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the job or to delete the job.
  - arn
```
public String arn()
```
    The Amazon Resource Name (ARN) for the job.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the job.
  - pipelineId
```
public 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:
    
    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.
  - input
```
public JobInput input()
```
    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.
  - inputs
```
public List<JobInput> inputs()
```
    Information about the files that you're transcoding. If you specified multiple files for this job, Elastic Transcoder stitches the files together to make one output.
    
    Returns:
    
    Information about the files that you're transcoding. If you specified multiple files for this job, Elastic Transcoder stitches the files together to make one output.
  - output
```
public 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:
    
    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.
  - outputs
```
public List<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:
    
    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.
  - outputKeyPrefix
```
public 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:
    
    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.
  - playlists
```
public List<Playlist> 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.
    
    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 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.
  - status
```
public String status()
```
    The status of the job: Submitted, Progressing, Complete, Canceled, or Error.
    
    Returns:
    
    The status of the job: Submitted, Progressing, Complete, Canceled, or Error.
  - userMetadata
```
public 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 are 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: _.:/=+-%@
    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 are 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: _.:/=+-%@
  - timing
```
public Timing timing()
```
    Details about the timing of a job.
    
    Returns:
    
    Details about the timing of a job.
  - toBuilder
```
public Job.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Job.Builder,Job>
    
    Returns:
    
    a builder for type T
  - builder
```
public static Job.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Job.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Class Job

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

id

arn

pipelineId

input

inputs

output

outputs

outputKeyPrefix

playlists

status

userMetadata

timing

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

marshall