@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Job extends Object implements Serializable, Cloneable, StructuredPojo
Constructor and Description |
---|
Job() |
Modifier and Type | Method and Description |
---|---|
Job |
addUserMetadataEntry(String key,
String value) |
Job |
clearUserMetadataEntries()
Removes all the entries added into UserMetadata.
|
Job |
clone() |
boolean |
equals(Object obj) |
AccelerationSettings |
getAccelerationSettings()
Accelerated transcoding can significantly speed up jobs with long, visually complex content.
|
String |
getArn()
An identifier for this resource that is unique within all of AWS.
|
String |
getBillingTagsSource()
Optional.
|
Date |
getCreatedAt()
The time, in Unix epoch format in seconds, when the job got created.
|
String |
getCurrentPhase()
A job's phase can be PROBING, TRANSCODING OR UPLOADING
|
Integer |
getErrorCode()
Error code for the job
|
String |
getErrorMessage()
Error message of Job
|
String |
getId()
A portion of the job's ARN, unique within your AWS Elemental MediaConvert resources
|
Integer |
getJobPercentComplete()
An estimate of how far your job has progressed.
|
String |
getJobTemplate()
The job template that the job is created from, if it is created from a job template.
|
List<OutputGroupDetail> |
getOutputGroupDetails()
List of output group details
|
String |
getQueue()
Optional.
|
Integer |
getRetryCount()
The number of times that the service automatically attempted to process your job after encountering an error.
|
String |
getRole()
The IAM role you use for creating this job.
|
JobSettings |
getSettings()
JobSettings contains all the transcode settings for a job.
|
String |
getStatus()
A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
|
String |
getStatusUpdateInterval()
Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events.
|
Timing |
getTiming()
Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.
|
Map<String,String> |
getUserMetadata()
User-defined metadata that you want to associate with an MediaConvert job.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAccelerationSettings(AccelerationSettings accelerationSettings)
Accelerated transcoding can significantly speed up jobs with long, visually complex content.
|
void |
setArn(String arn)
An identifier for this resource that is unique within all of AWS.
|
void |
setBillingTagsSource(String billingTagsSource)
Optional.
|
void |
setCreatedAt(Date createdAt)
The time, in Unix epoch format in seconds, when the job got created.
|
void |
setCurrentPhase(String currentPhase)
A job's phase can be PROBING, TRANSCODING OR UPLOADING
|
void |
setErrorCode(Integer errorCode)
Error code for the job
|
void |
setErrorMessage(String errorMessage)
Error message of Job
|
void |
setId(String id)
A portion of the job's ARN, unique within your AWS Elemental MediaConvert resources
|
void |
setJobPercentComplete(Integer jobPercentComplete)
An estimate of how far your job has progressed.
|
void |
setJobTemplate(String jobTemplate)
The job template that the job is created from, if it is created from a job template.
|
void |
setOutputGroupDetails(Collection<OutputGroupDetail> outputGroupDetails)
List of output group details
|
void |
setQueue(String queue)
Optional.
|
void |
setRetryCount(Integer retryCount)
The number of times that the service automatically attempted to process your job after encountering an error.
|
void |
setRole(String role)
The IAM role you use for creating this job.
|
void |
setSettings(JobSettings settings)
JobSettings contains all the transcode settings for a job.
|
void |
setStatus(String status)
A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
|
void |
setStatusUpdateInterval(String statusUpdateInterval)
Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events.
|
void |
setTiming(Timing timing)
Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.
|
void |
setUserMetadata(Map<String,String> userMetadata)
User-defined metadata that you want to associate with an MediaConvert job.
|
String |
toString()
Returns a string representation of this object.
|
Job |
withAccelerationSettings(AccelerationSettings accelerationSettings)
Accelerated transcoding can significantly speed up jobs with long, visually complex content.
|
Job |
withArn(String arn)
An identifier for this resource that is unique within all of AWS.
|
Job |
withBillingTagsSource(BillingTagsSource billingTagsSource)
Optional.
|
Job |
withBillingTagsSource(String billingTagsSource)
Optional.
|
Job |
withCreatedAt(Date createdAt)
The time, in Unix epoch format in seconds, when the job got created.
|
Job |
withCurrentPhase(JobPhase currentPhase)
A job's phase can be PROBING, TRANSCODING OR UPLOADING
|
Job |
withCurrentPhase(String currentPhase)
A job's phase can be PROBING, TRANSCODING OR UPLOADING
|
Job |
withErrorCode(Integer errorCode)
Error code for the job
|
Job |
withErrorMessage(String errorMessage)
Error message of Job
|
Job |
withId(String id)
A portion of the job's ARN, unique within your AWS Elemental MediaConvert resources
|
Job |
withJobPercentComplete(Integer jobPercentComplete)
An estimate of how far your job has progressed.
|
Job |
withJobTemplate(String jobTemplate)
The job template that the job is created from, if it is created from a job template.
|
Job |
withOutputGroupDetails(Collection<OutputGroupDetail> outputGroupDetails)
List of output group details
|
Job |
withOutputGroupDetails(OutputGroupDetail... outputGroupDetails)
List of output group details
|
Job |
withQueue(String queue)
Optional.
|
Job |
withRetryCount(Integer retryCount)
The number of times that the service automatically attempted to process your job after encountering an error.
|
Job |
withRole(String role)
The IAM role you use for creating this job.
|
Job |
withSettings(JobSettings settings)
JobSettings contains all the transcode settings for a job.
|
Job |
withStatus(JobStatus status)
A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
|
Job |
withStatus(String status)
A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
|
Job |
withStatusUpdateInterval(StatusUpdateInterval statusUpdateInterval)
Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events.
|
Job |
withStatusUpdateInterval(String statusUpdateInterval)
Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events.
|
Job |
withTiming(Timing timing)
Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.
|
Job |
withUserMetadata(Map<String,String> userMetadata)
User-defined metadata that you want to associate with an MediaConvert job.
|
public void setAccelerationSettings(AccelerationSettings accelerationSettings)
accelerationSettings
- Accelerated transcoding can significantly speed up jobs with long, visually complex content.public AccelerationSettings getAccelerationSettings()
public Job withAccelerationSettings(AccelerationSettings accelerationSettings)
accelerationSettings
- Accelerated transcoding can significantly speed up jobs with long, visually complex content.public void setArn(String arn)
arn
- An identifier for this resource that is unique within all of AWS.public String getArn()
public Job withArn(String arn)
arn
- An identifier for this resource that is unique within all of AWS.public void setBillingTagsSource(String billingTagsSource)
billingTagsSource
- Optional. Choose a 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. Any transcoding outputs that don't have an
associated tag will appear in your billing report unsorted. If you don't choose a valid value for this
field, your job outputs will appear on the billing report unsorted.BillingTagsSource
public String getBillingTagsSource()
BillingTagsSource
public Job withBillingTagsSource(String billingTagsSource)
billingTagsSource
- Optional. Choose a 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. Any transcoding outputs that don't have an
associated tag will appear in your billing report unsorted. If you don't choose a valid value for this
field, your job outputs will appear on the billing report unsorted.BillingTagsSource
public Job withBillingTagsSource(BillingTagsSource billingTagsSource)
billingTagsSource
- Optional. Choose a 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. Any transcoding outputs that don't have an
associated tag will appear in your billing report unsorted. If you don't choose a valid value for this
field, your job outputs will appear on the billing report unsorted.BillingTagsSource
public void setCreatedAt(Date createdAt)
createdAt
- The time, in Unix epoch format in seconds, when the job got created.public Date getCreatedAt()
public Job withCreatedAt(Date createdAt)
createdAt
- The time, in Unix epoch format in seconds, when the job got created.public void setCurrentPhase(String currentPhase)
currentPhase
- A job's phase can be PROBING, TRANSCODING OR UPLOADINGJobPhase
public String getCurrentPhase()
JobPhase
public Job withCurrentPhase(String currentPhase)
currentPhase
- A job's phase can be PROBING, TRANSCODING OR UPLOADINGJobPhase
public Job withCurrentPhase(JobPhase currentPhase)
currentPhase
- A job's phase can be PROBING, TRANSCODING OR UPLOADINGJobPhase
public void setErrorCode(Integer errorCode)
errorCode
- Error code for the jobpublic Integer getErrorCode()
public Job withErrorCode(Integer errorCode)
errorCode
- Error code for the jobpublic void setErrorMessage(String errorMessage)
errorMessage
- Error message of Jobpublic String getErrorMessage()
public Job withErrorMessage(String errorMessage)
errorMessage
- Error message of Jobpublic void setId(String id)
id
- A portion of the job's ARN, unique within your AWS Elemental MediaConvert resourcespublic String getId()
public Job withId(String id)
id
- A portion of the job's ARN, unique within your AWS Elemental MediaConvert resourcespublic void setJobPercentComplete(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, including audio-only jobs and jobs
that use input clipping, the service can't provide information about job progress. In those cases,
jobPercentComplete returns a null value.public Integer getJobPercentComplete()
public Job withJobPercentComplete(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, including audio-only jobs and jobs
that use input clipping, the service can't provide information about job progress. In those cases,
jobPercentComplete returns a null value.public void setJobTemplate(String jobTemplate)
jobTemplate
- The job template that the job is created from, if it is created from a job template.public String getJobTemplate()
public Job withJobTemplate(String jobTemplate)
jobTemplate
- The job template that the job is created from, if it is created from a job template.public List<OutputGroupDetail> getOutputGroupDetails()
public void setOutputGroupDetails(Collection<OutputGroupDetail> outputGroupDetails)
outputGroupDetails
- List of output group detailspublic Job withOutputGroupDetails(OutputGroupDetail... outputGroupDetails)
NOTE: This method appends the values to the existing list (if any). Use
setOutputGroupDetails(java.util.Collection)
or withOutputGroupDetails(java.util.Collection)
if
you want to override the existing values.
outputGroupDetails
- List of output group detailspublic Job withOutputGroupDetails(Collection<OutputGroupDetail> outputGroupDetails)
outputGroupDetails
- List of output group detailspublic void setQueue(String queue)
queue
- Optional. 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
http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.htmlpublic String getQueue()
public Job withQueue(String queue)
queue
- Optional. 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
http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.htmlpublic void setRetryCount(Integer retryCount)
retryCount
- The number of times that the service automatically attempted to process your job after encountering an
error.public Integer getRetryCount()
public Job withRetryCount(Integer retryCount)
retryCount
- The number of times that the service automatically attempted to process your job after encountering an
error.public void setRole(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 http://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.htmlpublic String getRole()
public Job withRole(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 http://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.htmlpublic void setSettings(JobSettings settings)
settings
- JobSettings contains all the transcode settings for a job.public JobSettings getSettings()
public Job withSettings(JobSettings settings)
settings
- JobSettings contains all the transcode settings for a job.public void setStatus(String status)
status
- A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.JobStatus
public String getStatus()
JobStatus
public Job withStatus(String status)
status
- A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.JobStatus
public Job withStatus(JobStatus status)
status
- A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.JobStatus
public void setStatusUpdateInterval(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
public String getStatusUpdateInterval()
StatusUpdateInterval
public Job withStatusUpdateInterval(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
public Job withStatusUpdateInterval(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
public void setTiming(Timing timing)
timing
- Information about when jobs are submitted, started, and finished is specified in Unix epoch format in
seconds.public Timing getTiming()
public Job withTiming(Timing timing)
timing
- Information about when jobs are submitted, started, and finished is specified in Unix epoch format in
seconds.public Map<String,String> getUserMetadata()
public void setUserMetadata(Map<String,String> userMetadata)
userMetadata
- User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in
key/value pairs.public Job withUserMetadata(Map<String,String> userMetadata)
userMetadata
- User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in
key/value pairs.public Job clearUserMetadataEntries()
public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.