Interface Job.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Job.Builder,Job>, SdkBuilder<Job.Builder,Job>, SdkPojo

Enclosing class:

Job

@Mutable
@NotThreadSafe
public static interface Job.Builder
extends SdkPojo, CopyableBuilder<Job.Builder,Job>

Method Summary

Modifier and Type	Method	Description
Job.Builder	arn(String arn)	The Amazon Resource Name (ARN) for the job.
Job.Builder	id(String id)	The identifier that Elastic Transcoder assigned to the job.
default Job.Builder	input(Consumer<JobInput.Builder> input)	A section of the request or response body that provides information about the file that is being transcoded.
Job.Builder	input(JobInput input)	A section of the request or response body that provides information about the file that is being transcoded.
Job.Builder	inputs(Collection<JobInput> inputs)	Information about the files that you're transcoding.
Job.Builder	inputs(Consumer<JobInput.Builder>... inputs)	Information about the files that you're transcoding.
Job.Builder	inputs(JobInput... inputs)	Information about the files that you're transcoding.
default Job.Builder	output(Consumer<JobOutput.Builder> output)	If you specified one output for a job, information about that output.
Job.Builder	output(JobOutput output)	If you specified one output for a job, information about that output.
Job.Builder	outputKeyPrefix(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.Builder	outputs(Collection<JobOutput> outputs)	Information about the output files.
Job.Builder	outputs(Consumer<JobOutput.Builder>... outputs)	Information about the output files.
Job.Builder	outputs(JobOutput... outputs)	Information about the output files.
Job.Builder	pipelineId(String pipelineId)	The Id of the pipeline that you want Elastic Transcoder to use for transcoding.
Job.Builder	playlists(Collection<Playlist> playlists)
Job.Builder	playlists(Consumer<Playlist.Builder>... playlists)
Job.Builder	playlists(Playlist... playlists)
Job.Builder	status(String status)	The status of the job: Submitted, Progressing, Complete, Canceled, or Error.
default Job.Builder	timing(Consumer<Timing.Builder> timing)	Details about the timing of a job.
Job.Builder	timing(Timing timing)	Details about the timing of a job.
Job.Builder	userMetadata(Map<String,String> userMetadata)	User-defined metadata that you want to associate with an Elastic Transcoder job.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

id

Job.Builder id(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.

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:

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

arn

Job.Builder arn(String arn)

The Amazon Resource Name (ARN) for the job.

Parameters:

arn - The Amazon Resource Name (ARN) for the job.

Returns:

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

pipelineId

Job.Builder pipelineId(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.

input

Job.Builder input(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.

Returns:

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

input

default Job.Builder input(Consumer<JobInput.Builder> input)

A section of the request or response body that provides information about the file that is being transcoded.

This is a convenience method that creates an instance of the JobInput.Builder avoiding the need to create one manually via JobInput.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to input(JobInput).

Parameters:

input - a consumer that will call methods on JobInput.Builder

Returns:

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

See Also:

• input(JobInput)

inputs

Job.Builder inputs(Collection<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.

Parameters:

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:

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

inputs

Job.Builder inputs(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.

Parameters:

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:

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

inputs

Job.Builder inputs(Consumer<JobInput.Builder>... 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.

This is a convenience method that creates an instance of the JobInput.Builder avoiding the need to create one manually via JobInput.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inputs(List<JobInput>).

Parameters:

inputs - a consumer that will call methods on JobInput.Builder

Returns:

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

See Also:

• inputs(java.util.Collection<JobInput>)

output

Job.Builder output(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.

Returns:

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

output

default Job.Builder output(Consumer<JobOutput.Builder> 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.

This is a convenience method that creates an instance of the JobOutput.Builder avoiding the need to create one manually via JobOutput.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to output(JobOutput).

Parameters:

output - a consumer that will call methods on JobOutput.Builder

Returns:

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

See Also:

• output(JobOutput)

outputs

Job.Builder outputs(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.

Returns:

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

outputs

Job.Builder outputs(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.

Returns:

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

outputs

Job.Builder outputs(Consumer<JobOutput.Builder>... 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.

This is a convenience method that creates an instance of the JobOutput.Builder avoiding the need to create one manually via JobOutput.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputs(List<JobOutput>).

Parameters:

outputs - a consumer that will call methods on JobOutput.Builder

Returns:

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

See Also:

• outputs(java.util.Collection<JobOutput>)

outputKeyPrefix

Job.Builder outputKeyPrefix(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.

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:

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

playlists

Job.Builder playlists(Collection<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.

Parameters:

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:

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

playlists

Job.Builder playlists(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.

Parameters:

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:

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

playlists

Job.Builder playlists(Consumer<Playlist.Builder>... 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.

This is a convenience method that creates an instance of the Playlist.Builder avoiding the need to create one manually via Playlist.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to playlists(List<Playlist>).

Parameters:

playlists - a consumer that will call methods on Playlist.Builder

Returns:

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

See Also:

• playlists(java.util.Collection<Playlist>)

status

Job.Builder status(String status)

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

Parameters:

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

Returns:

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

userMetadata

Job.Builder userMetadata(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: _.:/=+-%@

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

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

timing

Job.Builder timing(Timing timing)

Details about the timing of a job.

Parameters:

timing - Details about the timing of a job.

Returns:

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

timing

default Job.Builder timing(Consumer<Timing.Builder> timing)

Details about the timing of a job.

This is a convenience method that creates an instance of the Timing.Builder avoiding the need to create one manually via Timing.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to timing(Timing).

Parameters:

timing - a consumer that will call methods on Timing.Builder

Returns:

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

See Also:

• timing(Timing)