Interface Job.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Job.Builder,
,Job> SdkBuilder<Job.Builder,
,Job> SdkPojo
- Enclosing class:
Job
-
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) for the job.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.A section of the request or response body that provides information about the file that is being transcoded.inputs
(Collection<JobInput> inputs) Information about the files that you're transcoding.inputs
(Consumer<JobInput.Builder>... inputs) Information about the files that you're transcoding.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.If you specified one output for a job, information about that output.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.outputs
(Collection<JobOutput> outputs) Information about the output files.outputs
(Consumer<JobOutput.Builder>... outputs) Information about the output files.Information about the output files.pipelineId
(String pipelineId) TheId
of the pipeline that you want Elastic Transcoder to use for transcoding.playlists
(Collection<Playlist> playlists) playlists
(Consumer<Playlist.Builder>... playlists) The status of the job:Submitted
,Progressing
,Complete
,Canceled
, orError
.default Job.Builder
timing
(Consumer<Timing.Builder> timing) Details about the timing of a job.Details about the timing of a job.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, sdkFields
-
Method Details
-
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
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
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
- TheId
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
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
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 theJobInput.Builder
avoiding the need to create one manually viaJobInput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinput(JobInput)
.- Parameters:
input
- a consumer that will call methods onJobInput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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 theJobInput.Builder
avoiding the need to create one manually viaJobInput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinputs(List<JobInput>)
.- Parameters:
inputs
- a consumer that will call methods onJobInput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 theJobOutput.Builder
avoiding the need to create one manually viaJobOutput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooutput(JobOutput)
.- Parameters:
output
- a consumer that will call methods onJobOutput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theOutputs
andOutput
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 theOutputs
syntax for all jobs, even when you want Elastic Transcoder to transcode a file into only one format. Do not use both theOutputs
andOutput
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
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 theOutputs
andOutput
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 theOutputs
syntax for all jobs, even when you want Elastic Transcoder to transcode a file into only one format. Do not use both theOutputs
andOutput
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
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 theOutputs
andOutput
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 theJobOutput.Builder
avoiding the need to create one manually viaJobOutput.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooutputs(List<JobOutput>)
.- Parameters:
outputs
- a consumer that will call methods onJobOutput.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theOutputKeyPrefix
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
playlists
Outputs in Fragmented MP4 or MPEG-TS format only.
If you specify a preset in
PresetId
for which the value ofContainer
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 ofContainer
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
Outputs in Fragmented MP4 or MPEG-TS format only.
If you specify a preset in
PresetId
for which the value ofContainer
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 ofContainer
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
Outputs in Fragmented MP4 or MPEG-TS format only.
If you specify a preset in
PresetId
for which the value ofContainer
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 thePlaylist.Builder
avoiding the need to create one manually viaPlaylist.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toplaylists(List<Playlist>)
.- Parameters:
playlists
- a consumer that will call methods onPlaylist.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
The status of the job:
Submitted
,Progressing
,Complete
,Canceled
, orError
.- Parameters:
status
- The status of the job:Submitted
,Progressing
,Complete
,Canceled
, orError
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 10key/value
pairs per job. Elastic Transcoder does not guarantee thatkey/value
pairs are returned in the same order in which you specify them.Metadata
keys
andvalues
must use characters from the following list:-
0-9
-
A-Z
anda-z
-
Space
-
The following symbols:
_.:/=+-%@
- Parameters:
userMetadata
- User-defined metadata that you want to associate with an Elastic Transcoder job. You specify metadata inkey/value
pairs, and you can add up to 10key/value
pairs per job. Elastic Transcoder does not guarantee thatkey/value
pairs are returned in the same order in which you specify them.Metadata
keys
andvalues
must use characters from the following list:-
0-9
-
A-Z
anda-z
-
Space
-
The following symbols:
_.:/=+-%@
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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
Details about the timing of a job.
This is a convenience method that creates an instance of theTiming.Builder
avoiding the need to create one manually viaTiming.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totiming(Timing)
.- Parameters:
timing
- a consumer that will call methods onTiming.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-