public static interface Job.Builder extends SdkPojo, CopyableBuilder<Job.Builder,Job>
| Modifier and Type | Method and Description |
|---|---|
Job.Builder |
accelerationSettings(AccelerationSettings accelerationSettings)
Accelerated transcoding can significantly speed up jobs with long, visually complex content.
|
default Job.Builder |
accelerationSettings(Consumer<AccelerationSettings.Builder> accelerationSettings)
Accelerated transcoding can significantly speed up jobs with long, visually complex content.
|
Job.Builder |
accelerationStatus(AccelerationStatus accelerationStatus)
Describes whether the current job is running with accelerated transcoding.
|
Job.Builder |
accelerationStatus(String accelerationStatus)
Describes whether the current job is running with accelerated transcoding.
|
Job.Builder |
arn(String arn)
An identifier for this resource that is unique within all of AWS.
|
Job.Builder |
billingTagsSource(BillingTagsSource billingTagsSource)
The tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on
any billing report that you set up.
|
Job.Builder |
billingTagsSource(String billingTagsSource)
The tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on
any billing report that you set up.
|
Job.Builder |
clientRequestToken(String clientRequestToken)
Prevent duplicate jobs from being created and ensure idempotency for your requests.
|
Job.Builder |
createdAt(Instant createdAt)
The time, in Unix epoch format in seconds, when the job got created.
|
Job.Builder |
currentPhase(JobPhase currentPhase)
A job's phase can be PROBING, TRANSCODING OR UPLOADING
|
Job.Builder |
currentPhase(String currentPhase)
A job's phase can be PROBING, TRANSCODING OR UPLOADING
|
Job.Builder |
errorCode(Integer errorCode)
Error code for the job
|
Job.Builder |
errorMessage(String errorMessage)
Error message of Job
|
Job.Builder |
hopDestinations(Collection<HopDestination> hopDestinations)
Optional list of hop destinations.
|
Job.Builder |
hopDestinations(Consumer<HopDestination.Builder>... hopDestinations)
Optional list of hop destinations.
|
Job.Builder |
hopDestinations(HopDestination... hopDestinations)
Optional list of hop destinations.
|
Job.Builder |
id(String id)
A portion of the job's ARN, unique within your AWS Elemental MediaConvert resources
|
Job.Builder |
jobPercentComplete(Integer jobPercentComplete)
An estimate of how far your job has progressed.
|
Job.Builder |
jobTemplate(String jobTemplate)
The job template that the job is created from, if it is created from a job template.
|
default Job.Builder |
messages(Consumer<JobMessages.Builder> messages)
Provides messages from the service about jobs that you have already successfully submitted.
|
Job.Builder |
messages(JobMessages messages)
Provides messages from the service about jobs that you have already successfully submitted.
|
Job.Builder |
outputGroupDetails(Collection<OutputGroupDetail> outputGroupDetails)
List of output group details
|
Job.Builder |
outputGroupDetails(Consumer<OutputGroupDetail.Builder>... outputGroupDetails)
List of output group details This is a convenience method that creates an instance of the
OutputGroupDetail.Builder avoiding the need to
create one manually via
OutputGroupDetail.builder(). |
Job.Builder |
outputGroupDetails(OutputGroupDetail... outputGroupDetails)
List of output group details
|
Job.Builder |
priority(Integer priority)
Relative priority on the job.
|
Job.Builder |
queue(String queue)
When you create a job, you can specify a queue to send it to.
|
Job.Builder |
queueTransitions(Collection<QueueTransition> queueTransitions)
The job's queue hopping history.
|
Job.Builder |
queueTransitions(Consumer<QueueTransition.Builder>... queueTransitions)
The job's queue hopping history.
|
Job.Builder |
queueTransitions(QueueTransition... queueTransitions)
The job's queue hopping history.
|
Job.Builder |
retryCount(Integer retryCount)
The number of times that the service automatically attempted to process your job after encountering an error.
|
Job.Builder |
role(String role)
The IAM role you use for creating this job.
|
default Job.Builder |
settings(Consumer<JobSettings.Builder> settings)
JobSettings contains all the transcode settings for a job.
|
Job.Builder |
settings(JobSettings settings)
JobSettings contains all the transcode settings for a job.
|
Job.Builder |
simulateReservedQueue(SimulateReservedQueue simulateReservedQueue)
Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need.
|
Job.Builder |
simulateReservedQueue(String simulateReservedQueue)
Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need.
|
Job.Builder |
status(JobStatus status)
A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
|
Job.Builder |
status(String status)
A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
|
Job.Builder |
statusUpdateInterval(StatusUpdateInterval statusUpdateInterval)
Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events.
|
Job.Builder |
statusUpdateInterval(String statusUpdateInterval)
Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events.
|
default Job.Builder |
timing(Consumer<Timing.Builder> timing)
Information about when jobs are submitted, started, and finished is specified in Unix epoch format in
seconds.
|
Job.Builder |
timing(Timing timing)
Information about when jobs are submitted, started, and finished is specified in Unix epoch format in
seconds.
|
Job.Builder |
userMetadata(Map<String,String> userMetadata)
User-defined metadata that you want to associate with an MediaConvert job.
|
Job.Builder |
warnings(Collection<WarningGroup> warnings)
Contains any warning messages for the job.
|
Job.Builder |
warnings(Consumer<WarningGroup.Builder>... warnings)
Contains any warning messages for the job.
|
Job.Builder |
warnings(WarningGroup... warnings)
Contains any warning messages for the job.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildJob.Builder accelerationSettings(AccelerationSettings accelerationSettings)
accelerationSettings - Accelerated transcoding can significantly speed up jobs with long, visually complex content.default Job.Builder accelerationSettings(Consumer<AccelerationSettings.Builder> accelerationSettings)
AccelerationSettings.Builder avoiding the need to
create one manually via AccelerationSettings.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and
its result is passed to accelerationSettings(AccelerationSettings).
accelerationSettings - a consumer that will call methods on AccelerationSettings.BuilderaccelerationSettings(AccelerationSettings)Job.Builder accelerationStatus(String accelerationStatus)
accelerationStatus - Describes whether the current job is running with accelerated transcoding. For jobs that have
Acceleration (AccelerationMode) set to DISABLED, AccelerationStatus is always NOT_APPLICABLE. For jobs
that have Acceleration (AccelerationMode) set to ENABLED or PREFERRED, AccelerationStatus is one of
the other states. AccelerationStatus is IN_PROGRESS initially, while the service determines whether
the input files and job settings are compatible with accelerated transcoding. If they are,
AcclerationStatus is ACCELERATED. If your input files and job settings aren't compatible with
accelerated transcoding, the service either fails your job or runs it without accelerated transcoding,
depending on how you set Acceleration (AccelerationMode). When the service runs your job without
accelerated transcoding, AccelerationStatus is NOT_ACCELERATED.AccelerationStatus,
AccelerationStatusJob.Builder accelerationStatus(AccelerationStatus accelerationStatus)
accelerationStatus - Describes whether the current job is running with accelerated transcoding. For jobs that have
Acceleration (AccelerationMode) set to DISABLED, AccelerationStatus is always NOT_APPLICABLE. For jobs
that have Acceleration (AccelerationMode) set to ENABLED or PREFERRED, AccelerationStatus is one of
the other states. AccelerationStatus is IN_PROGRESS initially, while the service determines whether
the input files and job settings are compatible with accelerated transcoding. If they are,
AcclerationStatus is ACCELERATED. If your input files and job settings aren't compatible with
accelerated transcoding, the service either fails your job or runs it without accelerated transcoding,
depending on how you set Acceleration (AccelerationMode). When the service runs your job without
accelerated transcoding, AccelerationStatus is NOT_ACCELERATED.AccelerationStatus,
AccelerationStatusJob.Builder arn(String arn)
arn - An identifier for this resource that is unique within all of AWS.Job.Builder billingTagsSource(String billingTagsSource)
billingTagsSource - The tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert
costs on any billing report that you set up.BillingTagsSource,
BillingTagsSourceJob.Builder billingTagsSource(BillingTagsSource billingTagsSource)
billingTagsSource - The tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert
costs on any billing report that you set up.BillingTagsSource,
BillingTagsSourceJob.Builder clientRequestToken(String clientRequestToken)
clientRequestToken - Prevent duplicate jobs from being created and ensure idempotency for your requests. A client request
token can be any string that includes up to 64 ASCII characters. If you reuse a client request token
within one minute of a successful request, the API returns the job details of the original request
instead. For more information see
https://docs.aws.amazon.com/mediaconvert/latest/apireference/idempotency.html.Job.Builder createdAt(Instant createdAt)
createdAt - The time, in Unix epoch format in seconds, when the job got created.Job.Builder currentPhase(String currentPhase)
Job.Builder currentPhase(JobPhase currentPhase)
Job.Builder errorCode(Integer errorCode)
errorCode - Error code for the jobJob.Builder errorMessage(String errorMessage)
errorMessage - Error message of JobJob.Builder hopDestinations(Collection<HopDestination> hopDestinations)
hopDestinations - Optional list of hop destinations.Job.Builder hopDestinations(HopDestination... hopDestinations)
hopDestinations - Optional list of hop destinations.Job.Builder hopDestinations(Consumer<HopDestination.Builder>... hopDestinations)
HopDestination.Builder avoiding the need to create
one manually via HopDestination.builder().
When the Consumer completes,
SdkBuilder.build() is called
immediately and its result is passed to #hopDestinations(List.
hopDestinations - a consumer that will call methods on
HopDestination.Builder#hopDestinations(java.util.Collection) Job.Builder id(String id)
id - A portion of the job's ARN, unique within your AWS Elemental MediaConvert resourcesJob.Builder jobPercentComplete(Integer jobPercentComplete)
jobPercentComplete - An estimate of how far your job has progressed. This estimate is shown as a percentage of the total
time from when your job leaves its queue to when your output files appear in your output Amazon S3
bucket. AWS Elemental MediaConvert provides jobPercentComplete in CloudWatch STATUS_UPDATE events and
in the response to GetJob and ListJobs requests. The jobPercentComplete estimate is reliable for the
following input containers: Quicktime, Transport Stream, MP4, and MXF. For some jobs, the service
can't provide information about job progress. In those cases, jobPercentComplete returns a null value.Job.Builder jobTemplate(String jobTemplate)
jobTemplate - The job template that the job is created from, if it is created from a job template.Job.Builder messages(JobMessages messages)
messages - Provides messages from the service about jobs that you have already successfully submitted.default Job.Builder messages(Consumer<JobMessages.Builder> messages)
JobMessages.Builder avoiding the need to create
one manually via JobMessages.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result
is passed to messages(JobMessages).
messages - a consumer that will call methods on JobMessages.Buildermessages(JobMessages)Job.Builder outputGroupDetails(Collection<OutputGroupDetail> outputGroupDetails)
outputGroupDetails - List of output group detailsJob.Builder outputGroupDetails(OutputGroupDetail... outputGroupDetails)
outputGroupDetails - List of output group detailsJob.Builder outputGroupDetails(Consumer<OutputGroupDetail.Builder>... outputGroupDetails)
OutputGroupDetail.Builder avoiding the need to
create one manually via
OutputGroupDetail.builder().
When the Consumer completes,
SdkBuilder.build() is called
immediately and its result is passed to #outputGroupDetails(List.
outputGroupDetails - a consumer that will call methods on
OutputGroupDetail.Builder#outputGroupDetails(java.util.Collection) Job.Builder priority(Integer priority)
priority - Relative priority on the job.Job.Builder queue(String queue)
queue - When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to
the default queue. For more about queues, see the User Guide topic at
https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.htmlJob.Builder queueTransitions(Collection<QueueTransition> queueTransitions)
queueTransitions - The job's queue hopping history.Job.Builder queueTransitions(QueueTransition... queueTransitions)
queueTransitions - The job's queue hopping history.Job.Builder queueTransitions(Consumer<QueueTransition.Builder>... queueTransitions)
QueueTransition.Builder avoiding the need to
create one manually via QueueTransition.builder().
When the Consumer completes,
SdkBuilder.build() is called
immediately and its result is passed to #queueTransitions(List.
queueTransitions - a consumer that will call methods on
QueueTransition.Builder#queueTransitions(java.util.Collection) Job.Builder retryCount(Integer retryCount)
retryCount - The number of times that the service automatically attempted to process your job after encountering an
error.Job.Builder role(String role)
role - The IAM role you use for creating this job. For details about permissions, see the User Guide topic at
the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.htmlJob.Builder settings(JobSettings settings)
settings - JobSettings contains all the transcode settings for a job.default Job.Builder settings(Consumer<JobSettings.Builder> settings)
JobSettings.Builder avoiding the need to create one manually via
JobSettings.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result
is passed to settings(JobSettings).
settings - a consumer that will call methods on JobSettings.Buildersettings(JobSettings)Job.Builder simulateReservedQueue(String simulateReservedQueue)
simulateReservedQueue - Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you
need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar
performance to what you will see with one RTS in a reserved queue. This setting is disabled by
default.SimulateReservedQueue,
SimulateReservedQueueJob.Builder simulateReservedQueue(SimulateReservedQueue simulateReservedQueue)
simulateReservedQueue - Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you
need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar
performance to what you will see with one RTS in a reserved queue. This setting is disabled by
default.SimulateReservedQueue,
SimulateReservedQueueJob.Builder status(String status)
Job.Builder status(JobStatus status)
Job.Builder statusUpdateInterval(String statusUpdateInterval)
statusUpdateInterval - Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the
interval, in seconds, between status updates. MediaConvert sends an update at this interval from the
time the service begins processing your job to the time it completes the transcode or encounters an
error.StatusUpdateInterval,
StatusUpdateIntervalJob.Builder statusUpdateInterval(StatusUpdateInterval statusUpdateInterval)
statusUpdateInterval - Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the
interval, in seconds, between status updates. MediaConvert sends an update at this interval from the
time the service begins processing your job to the time it completes the transcode or encounters an
error.StatusUpdateInterval,
StatusUpdateIntervalJob.Builder timing(Timing timing)
timing - Information about when jobs are submitted, started, and finished is specified in Unix epoch format in
seconds.default Job.Builder timing(Consumer<Timing.Builder> timing)
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).
timing - a consumer that will call methods on Timing.Buildertiming(Timing)Job.Builder userMetadata(Map<String,String> userMetadata)
userMetadata - User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in
key/value pairs.Job.Builder warnings(Collection<WarningGroup> warnings)
warnings - Contains any warning messages for the job. Use to help identify potential issues with your input,
output, or job. For more information, see
https://docs.aws.amazon.com/mediaconvert/latest/ug/warning_codes.htmlJob.Builder warnings(WarningGroup... warnings)
warnings - Contains any warning messages for the job. Use to help identify potential issues with your input,
output, or job. For more information, see
https://docs.aws.amazon.com/mediaconvert/latest/ug/warning_codes.htmlJob.Builder warnings(Consumer<WarningGroup.Builder>... warnings)
WarningGroup.Builder avoiding the need to create
one manually via WarningGroup.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately
and its result is passed to #warnings(List.
warnings - a consumer that will call methods on
WarningGroup.Builder#warnings(java.util.Collection) Copyright © 2023. All rights reserved.