Job (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.mediaconvert.model.Job

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Job
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Job()

Constructors
Constructor and Description
`Job()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Job`	`addUserMetadataEntry(String key, String value)` Add a single UserMetadata entry
`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`	`getAccelerationStatus()` Describes whether the current job is running with accelerated transcoding.
`String`	`getArn()` An identifier for this resource that is unique within all of AWS.
`String`	`getBillingTagsSource()` 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.
`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
`List<HopDestination>`	`getHopDestinations()` Optional list of hop destinations.
`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.
`JobMessages`	`getMessages()` Provides messages from the service about jobs that you have already successfully submitted.
`List<OutputGroupDetail>`	`getOutputGroupDetails()` List of output group details
`Integer`	`getPriority()` Relative priority on the job.
`String`	`getQueue()` When you create a job, you can specify a queue to send it to.
`List<QueueTransition>`	`getQueueTransitions()` The job's queue hopping history.
`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`	`getSimulateReservedQueue()` Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need.
`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`	`setAccelerationStatus(String accelerationStatus)` Describes whether the current job is running with accelerated transcoding.
`void`	`setArn(String arn)` An identifier for this resource that is unique within all of AWS.
`void`	`setBillingTagsSource(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.
`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`	`setHopDestinations(Collection<HopDestination> hopDestinations)` Optional list of hop destinations.
`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`	`setMessages(JobMessages messages)` Provides messages from the service about jobs that you have already successfully submitted.
`void`	`setOutputGroupDetails(Collection<OutputGroupDetail> outputGroupDetails)` List of output group details
`void`	`setPriority(Integer priority)` Relative priority on the job.
`void`	`setQueue(String queue)` When you create a job, you can specify a queue to send it to.
`void`	`setQueueTransitions(Collection<QueueTransition> queueTransitions)` The job's queue hopping history.
`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`	`setSimulateReservedQueue(String simulateReservedQueue)` Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need.
`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`	`withAccelerationStatus(AccelerationStatus accelerationStatus)` Describes whether the current job is running with accelerated transcoding.
`Job`	`withAccelerationStatus(String accelerationStatus)` Describes whether the current job is running with accelerated transcoding.
`Job`	`withArn(String arn)` An identifier for this resource that is unique within all of AWS.
`Job`	`withBillingTagsSource(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`	`withBillingTagsSource(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`	`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`	`withHopDestinations(Collection<HopDestination> hopDestinations)` Optional list of hop destinations.
`Job`	`withHopDestinations(HopDestination... hopDestinations)` Optional list of hop destinations.
`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`	`withMessages(JobMessages messages)` Provides messages from the service about jobs that you have already successfully submitted.
`Job`	`withOutputGroupDetails(Collection<OutputGroupDetail> outputGroupDetails)` List of output group details
`Job`	`withOutputGroupDetails(OutputGroupDetail... outputGroupDetails)` List of output group details
`Job`	`withPriority(Integer priority)` Relative priority on the job.
`Job`	`withQueue(String queue)` When you create a job, you can specify a queue to send it to.
`Job`	`withQueueTransitions(Collection<QueueTransition> queueTransitions)` The job's queue hopping history.
`Job`	`withQueueTransitions(QueueTransition... queueTransitions)` The job's queue hopping history.
`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`	`withSimulateReservedQueue(SimulateReservedQueue simulateReservedQueue)` Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need.
`Job`	`withSimulateReservedQueue(String simulateReservedQueue)` Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need.
`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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Job
```
public Job()
```
- Method Detail
  - setAccelerationSettings
```
public void setAccelerationSettings(AccelerationSettings accelerationSettings)
```
    Accelerated transcoding can significantly speed up jobs with long, visually complex content.
    
    Parameters:
    
    accelerationSettings - Accelerated transcoding can significantly speed up jobs with long, visually complex content.
  - getAccelerationSettings
```
public AccelerationSettings getAccelerationSettings()
```
    Accelerated transcoding can significantly speed up jobs with long, visually complex content.
    
    Returns:
    
    Accelerated transcoding can significantly speed up jobs with long, visually complex content.
  - withAccelerationSettings
```
public Job withAccelerationSettings(AccelerationSettings accelerationSettings)
```
    Accelerated transcoding can significantly speed up jobs with long, visually complex content.
    
    Parameters:
    
    accelerationSettings - Accelerated transcoding can significantly speed up jobs with long, visually complex content.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAccelerationStatus
```
public void setAccelerationStatus(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    AccelerationStatus
  - getAccelerationStatus
```
public String getAccelerationStatus()
```
    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.
    
    Returns:
    
    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.
    
    See Also:
    
    AccelerationStatus
  - withAccelerationStatus
```
public Job withAccelerationStatus(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AccelerationStatus
  - withAccelerationStatus
```
public Job withAccelerationStatus(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AccelerationStatus
  - setArn
```
public void setArn(String arn)
```
    An identifier for this resource that is unique within all of AWS.
    
    Parameters:
    
    arn - An identifier for this resource that is unique within all of AWS.
  - getArn
```
public String getArn()
```
    An identifier for this resource that is unique within all of AWS.
    
    Returns:
    
    An identifier for this resource that is unique within all of AWS.
  - withArn
```
public Job withArn(String arn)
```
    An identifier for this resource that is unique within all of AWS.
    
    Parameters:
    
    arn - An identifier for this resource that is unique within all of AWS.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBillingTagsSource
```
public void setBillingTagsSource(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.
    
    Parameters:
    
    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.
    
    See Also:
    
    BillingTagsSource
  - getBillingTagsSource
```
public String getBillingTagsSource()
```
    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.
    
    Returns:
    
    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.
    
    See Also:
    
    BillingTagsSource
  - withBillingTagsSource
```
public Job withBillingTagsSource(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BillingTagsSource
  - withBillingTagsSource
```
public Job withBillingTagsSource(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BillingTagsSource
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The time, in Unix epoch format in seconds, when the job got created.
    
    Parameters:
    
    createdAt - The time, in Unix epoch format in seconds, when the job got created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    The time, in Unix epoch format in seconds, when the job got created.
    
    Returns:
    
    The time, in Unix epoch format in seconds, when the job got created.
  - withCreatedAt
```
public Job withCreatedAt(Date createdAt)
```
    The time, in Unix epoch format in seconds, when the job got created.
    
    Parameters:
    
    createdAt - The time, in Unix epoch format in seconds, when the job got created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCurrentPhase
```
public void setCurrentPhase(String currentPhase)
```
    A job's phase can be PROBING, TRANSCODING OR UPLOADING
    
    Parameters:
    
    currentPhase - A job's phase can be PROBING, TRANSCODING OR UPLOADING
    
    See Also:
    
    JobPhase
  - getCurrentPhase
```
public String getCurrentPhase()
```
    A job's phase can be PROBING, TRANSCODING OR UPLOADING
    
    Returns:
    
    A job's phase can be PROBING, TRANSCODING OR UPLOADING
    
    See Also:
    
    JobPhase
  - withCurrentPhase
```
public Job withCurrentPhase(String currentPhase)
```
    A job's phase can be PROBING, TRANSCODING OR UPLOADING
    
    Parameters:
    
    currentPhase - A job's phase can be PROBING, TRANSCODING OR UPLOADING
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobPhase
  - withCurrentPhase
```
public Job withCurrentPhase(JobPhase currentPhase)
```
    A job's phase can be PROBING, TRANSCODING OR UPLOADING
    
    Parameters:
    
    currentPhase - A job's phase can be PROBING, TRANSCODING OR UPLOADING
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobPhase
  - setErrorCode
```
public void setErrorCode(Integer errorCode)
```
    Error code for the job
    
    Parameters:
    
    errorCode - Error code for the job
  - getErrorCode
```
public Integer getErrorCode()
```
    Error code for the job
    
    Returns:
    
    Error code for the job
  - withErrorCode
```
public Job withErrorCode(Integer errorCode)
```
    Error code for the job
    
    Parameters:
    
    errorCode - Error code for the job
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setErrorMessage
```
public void setErrorMessage(String errorMessage)
```
    Error message of Job
    
    Parameters:
    
    errorMessage - Error message of Job
  - getErrorMessage
```
public String getErrorMessage()
```
    Error message of Job
    
    Returns:
    
    Error message of Job
  - withErrorMessage
```
public Job withErrorMessage(String errorMessage)
```
    Error message of Job
    
    Parameters:
    
    errorMessage - Error message of Job
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getHopDestinations
```
public List<HopDestination> getHopDestinations()
```
    Optional list of hop destinations.
    
    Returns:
    
    Optional list of hop destinations.
  - setHopDestinations
```
public void setHopDestinations(Collection<HopDestination> hopDestinations)
```
    Optional list of hop destinations.
    
    Parameters:
    
    hopDestinations - Optional list of hop destinations.
  - withHopDestinations
```
public Job withHopDestinations(HopDestination... hopDestinations)
```
    Optional list of hop destinations.
    NOTE: This method appends the values to the existing list (if any). Use setHopDestinations(java.util.Collection) or withHopDestinations(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    hopDestinations - Optional list of hop destinations.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withHopDestinations
```
public Job withHopDestinations(Collection<HopDestination> hopDestinations)
```
    Optional list of hop destinations.
    
    Parameters:
    
    hopDestinations - Optional list of hop destinations.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setId
```
public void setId(String id)
```
    A portion of the job's ARN, unique within your AWS Elemental MediaConvert resources
    
    Parameters:
    
    id - A portion of the job's ARN, unique within your AWS Elemental MediaConvert resources
  - getId
```
public String getId()
```
    A portion of the job's ARN, unique within your AWS Elemental MediaConvert resources
    
    Returns:
    
    A portion of the job's ARN, unique within your AWS Elemental MediaConvert resources
  - withId
```
public Job withId(String id)
```
    A portion of the job's ARN, unique within your AWS Elemental MediaConvert resources
    
    Parameters:
    
    id - A portion of the job's ARN, unique within your AWS Elemental MediaConvert resources
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobPercentComplete
```
public void setJobPercentComplete(Integer 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.
    
    Parameters:
    
    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.
  - getJobPercentComplete
```
public Integer getJobPercentComplete()
```
    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.
    
    Returns:
    
    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.
  - withJobPercentComplete
```
public Job withJobPercentComplete(Integer 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobTemplate
```
public void setJobTemplate(String jobTemplate)
```
    The job template that the job is created from, if it is created from a job template.
    
    Parameters:
    
    jobTemplate - The job template that the job is created from, if it is created from a job template.
  - getJobTemplate
```
public String getJobTemplate()
```
    The job template that the job is created from, if it is created from a job template.
    
    Returns:
    
    The job template that the job is created from, if it is created from a job template.
  - withJobTemplate
```
public Job withJobTemplate(String jobTemplate)
```
    The job template that the job is created from, if it is created from a job template.
    
    Parameters:
    
    jobTemplate - The job template that the job is created from, if it is created from a job template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMessages
```
public void setMessages(JobMessages messages)
```
    Provides messages from the service about jobs that you have already successfully submitted.
    
    Parameters:
    
    messages - Provides messages from the service about jobs that you have already successfully submitted.
  - getMessages
```
public JobMessages getMessages()
```
    Provides messages from the service about jobs that you have already successfully submitted.
    
    Returns:
    
    Provides messages from the service about jobs that you have already successfully submitted.
  - withMessages
```
public Job withMessages(JobMessages messages)
```
    Provides messages from the service about jobs that you have already successfully submitted.
    
    Parameters:
    
    messages - Provides messages from the service about jobs that you have already successfully submitted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getOutputGroupDetails
```
public List<OutputGroupDetail> getOutputGroupDetails()
```
    List of output group details
    
    Returns:
    
    List of output group details
  - setOutputGroupDetails
```
public void setOutputGroupDetails(Collection<OutputGroupDetail> outputGroupDetails)
```
    List of output group details
    
    Parameters:
    
    outputGroupDetails - List of output group details
  - withOutputGroupDetails
```
public Job withOutputGroupDetails(OutputGroupDetail... outputGroupDetails)
```
    List of output group details
    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.
    
    Parameters:
    
    outputGroupDetails - List of output group details
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withOutputGroupDetails
```
public Job withOutputGroupDetails(Collection<OutputGroupDetail> outputGroupDetails)
```
    List of output group details
    
    Parameters:
    
    outputGroupDetails - List of output group details
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPriority
```
public void setPriority(Integer priority)
```
    Relative priority on the job.
    
    Parameters:
    
    priority - Relative priority on the job.
  - getPriority
```
public Integer getPriority()
```
    Relative priority on the job.
    
    Returns:
    
    Relative priority on the job.
  - withPriority
```
public Job withPriority(Integer priority)
```
    Relative priority on the job.
    
    Parameters:
    
    priority - Relative priority on the job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setQueue
```
public void setQueue(String 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.html
    
    Parameters:
    
    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.html
  - getQueue
```
public String getQueue()
```
    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
    
    Returns:
    
    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
  - withQueue
```
public Job withQueue(String 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.html
    
    Parameters:
    
    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.html
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getQueueTransitions
```
public List<QueueTransition> getQueueTransitions()
```
    The job's queue hopping history.
    
    Returns:
    
    The job's queue hopping history.
  - setQueueTransitions
```
public void setQueueTransitions(Collection<QueueTransition> queueTransitions)
```
    The job's queue hopping history.
    
    Parameters:
    
    queueTransitions - The job's queue hopping history.
  - withQueueTransitions
```
public Job withQueueTransitions(QueueTransition... queueTransitions)
```
    The job's queue hopping history.
    NOTE: This method appends the values to the existing list (if any). Use setQueueTransitions(java.util.Collection) or withQueueTransitions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    queueTransitions - The job's queue hopping history.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withQueueTransitions
```
public Job withQueueTransitions(Collection<QueueTransition> queueTransitions)
```
    The job's queue hopping history.
    
    Parameters:
    
    queueTransitions - The job's queue hopping history.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRetryCount
```
public void setRetryCount(Integer retryCount)
```
    The number of times that the service automatically attempted to process your job after encountering an error.
    
    Parameters:
    
    retryCount - The number of times that the service automatically attempted to process your job after encountering an error.
  - getRetryCount
```
public Integer getRetryCount()
```
    The number of times that the service automatically attempted to process your job after encountering an error.
    
    Returns:
    
    The number of times that the service automatically attempted to process your job after encountering an error.
  - withRetryCount
```
public Job withRetryCount(Integer retryCount)
```
    The number of times that the service automatically attempted to process your job after encountering an error.
    
    Parameters:
    
    retryCount - The number of times that the service automatically attempted to process your job after encountering an error.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRole
```
public void setRole(String 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.html
    
    Parameters:
    
    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.html
  - getRole
```
public String getRole()
```
    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
    
    Returns:
    
    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
  - withRole
```
public Job withRole(String 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.html
    
    Parameters:
    
    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.html
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSettings
```
public void setSettings(JobSettings settings)
```
    JobSettings contains all the transcode settings for a job.
    
    Parameters:
    
    settings - JobSettings contains all the transcode settings for a job.
  - getSettings
```
public JobSettings getSettings()
```
    JobSettings contains all the transcode settings for a job.
    
    Returns:
    
    JobSettings contains all the transcode settings for a job.
  - withSettings
```
public Job withSettings(JobSettings settings)
```
    JobSettings contains all the transcode settings for a job.
    
    Parameters:
    
    settings - JobSettings contains all the transcode settings for a job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSimulateReservedQueue
```
public void setSimulateReservedQueue(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    SimulateReservedQueue
  - getSimulateReservedQueue
```
public String getSimulateReservedQueue()
```
    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.
    
    Returns:
    
    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.
    
    See Also:
    
    SimulateReservedQueue
  - withSimulateReservedQueue
```
public Job withSimulateReservedQueue(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SimulateReservedQueue
  - withSimulateReservedQueue
```
public Job withSimulateReservedQueue(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SimulateReservedQueue
  - setStatus
```
public void setStatus(String status)
```
    A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
    
    Parameters:
    
    status - A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
    
    See Also:
    
    JobStatus
  - getStatus
```
public String getStatus()
```
    A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
    
    Returns:
    
    A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
    
    See Also:
    
    JobStatus
  - withStatus
```
public Job withStatus(String status)
```
    A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
    
    Parameters:
    
    status - A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - withStatus
```
public Job withStatus(JobStatus status)
```
    A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
    
    Parameters:
    
    status - A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - setStatusUpdateInterval
```
public void setStatusUpdateInterval(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    StatusUpdateInterval
  - getStatusUpdateInterval
```
public String getStatusUpdateInterval()
```
    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.
    
    Returns:
    
    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.
    
    See Also:
    
    StatusUpdateInterval
  - withStatusUpdateInterval
```
public Job withStatusUpdateInterval(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StatusUpdateInterval
  - withStatusUpdateInterval
```
public Job withStatusUpdateInterval(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StatusUpdateInterval
  - setTiming
```
public void setTiming(Timing timing)
```
    Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.
    
    Parameters:
    
    timing - Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.
  - getTiming
```
public Timing getTiming()
```
    Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.
    
    Returns:
    
    Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.
  - withTiming
```
public Job withTiming(Timing timing)
```
    Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.
    
    Parameters:
    
    timing - Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getUserMetadata
```
public Map<String,String> getUserMetadata()
```
    User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.
    
    Returns:
    
    User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.
  - setUserMetadata
```
public void setUserMetadata(Map<String,String> userMetadata)
```
    User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.
    
    Parameters:
    
    userMetadata - User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.
  - withUserMetadata
```
public Job withUserMetadata(Map<String,String> userMetadata)
```
    User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.
    
    Parameters:
    
    userMetadata - User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addUserMetadataEntry
```
public Job addUserMetadataEntry(String key,
                                String value)
```
    Add a single UserMetadata entry
    
    See Also:
    
    withUserMetadata(java.util.Map<java.lang.String, java.lang.String>)
  - clearUserMetadataEntries
```
public Job clearUserMetadataEntries()
```
    Removes all the entries added into UserMetadata.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Job clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Job

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Job

Method Detail

setAccelerationSettings

getAccelerationSettings

withAccelerationSettings

setAccelerationStatus

getAccelerationStatus

withAccelerationStatus

withAccelerationStatus

setArn

getArn

withArn

setBillingTagsSource

getBillingTagsSource

withBillingTagsSource

withBillingTagsSource

setCreatedAt

getCreatedAt

withCreatedAt

setCurrentPhase

getCurrentPhase

withCurrentPhase

withCurrentPhase

setErrorCode

getErrorCode

withErrorCode

setErrorMessage

getErrorMessage

withErrorMessage

getHopDestinations

setHopDestinations

withHopDestinations

withHopDestinations

setId

getId

withId

setJobPercentComplete

getJobPercentComplete

withJobPercentComplete

setJobTemplate

getJobTemplate

withJobTemplate

setMessages

getMessages

withMessages

getOutputGroupDetails

setOutputGroupDetails

withOutputGroupDetails

withOutputGroupDetails

setPriority

getPriority

withPriority

setQueue

getQueue

withQueue

getQueueTransitions

setQueueTransitions

withQueueTransitions

withQueueTransitions

setRetryCount

getRetryCount

withRetryCount

setRole

getRole

withRole

setSettings

getSettings

withSettings

setSimulateReservedQueue

getSimulateReservedQueue

withSimulateReservedQueue

withSimulateReservedQueue

setStatus

getStatus