Job class
Each job converts an input file into an output file or files. For more information, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html
Constructors
-
Job({required String role, required JobSettings settings, AccelerationSettings? accelerationSettings, AccelerationStatus? accelerationStatus, String? arn, BillingTagsSource? billingTagsSource, DateTime? createdAt, JobPhase? currentPhase, int? errorCode, String? errorMessage, List<
HopDestination> ? hopDestinations, String? id, int? jobPercentComplete, String? jobTemplate, JobMessages? messages, List<OutputGroupDetail> ? outputGroupDetails, int? priority, String? queue, List<QueueTransition> ? queueTransitions, int? retryCount, SimulateReservedQueue? simulateReservedQueue, JobStatus? status, StatusUpdateInterval? statusUpdateInterval, Timing? timing, Map<String, String> ? userMetadata}) -
Job.fromJson(Map<
String, dynamic> json) -
factory
Properties
- accelerationSettings → AccelerationSettings?
-
Accelerated transcoding can significantly speed up jobs with long, visually
complex content.
final
- 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.
final
- arn → String?
-
An identifier for this resource that is unique within all of AWS.
final
- 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.
final
- createdAt → DateTime?
-
The time, in Unix epoch format in seconds, when the job got created.
final
- currentPhase → JobPhase?
-
A job's phase can be PROBING, TRANSCODING OR UPLOADING
final
- errorCode → int?
-
Error code for the job
final
- errorMessage → String?
-
Error message of Job
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
hopDestinations
→ List<
HopDestination> ? -
Optional list of hop destinations.
final
- id → String?
-
A portion of the job's ARN, unique within your AWS Elemental MediaConvert
resources
final
- jobPercentComplete → int?
-
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.
final
- jobTemplate → String?
-
The job template that the job is created from, if it is created from a job
template.
final
- messages → JobMessages?
-
Provides messages from the service about jobs that you have already
successfully submitted.
final
-
outputGroupDetails
→ List<
OutputGroupDetail> ? -
List of output group details
final
- priority → int?
-
Relative priority on the job.
final
- queue → String?
-
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.html
final
-
queueTransitions
→ List<
QueueTransition> ? -
The job's queue hopping history.
final
- retryCount → int?
-
The number of times that the service automatically attempted to process your
job after encountering an error.
final
- role → String
-
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.html
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- settings → JobSettings
-
JobSettings contains all the transcode settings for a job.
final
- 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.
final
- status → JobStatus?
-
A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
final
- 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.
final
- timing → Timing?
-
Information about when jobs are submitted, started, and finished is
specified in Unix epoch format in seconds.
final
-
userMetadata
→ Map<
String, String> ? -
User-defined metadata that you want to associate with an MediaConvert job.
You specify metadata in key/value pairs.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited