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 http://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)`
`Job`	`clearUserMetadataEntries()` Removes all the entries added into UserMetadata.
`Job`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` An identifier for this resource that is unique within all of AWS.
`String`	`getBillingTagsSource()`
`Date`	`getCreatedAt()` The time, in Unix epoch format in seconds, when the job got created.
`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
`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.
`String`	`getRole()` The IAM role you use for creating this job.
`JobSettings`	`getSettings()`
`String`	`getStatus()`
`Timing`	`getTiming()`
`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`	`setArn(String arn)` An identifier for this resource that is unique within all of AWS.
`void`	`setBillingTagsSource(String billingTagsSource)`
`void`	`setCreatedAt(Date createdAt)` The time, in Unix epoch format in seconds, when the job got created.
`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`	`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`	`setRole(String role)` The IAM role you use for creating this job.
`void`	`setSettings(JobSettings settings)`
`void`	`setStatus(String status)`
`void`	`setTiming(Timing timing)`
`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`	`withArn(String arn)` An identifier for this resource that is unique within all of AWS.
`Job`	`withBillingTagsSource(BillingTagsSource billingTagsSource)`
`Job`	`withBillingTagsSource(String billingTagsSource)`
`Job`	`withCreatedAt(Date createdAt)` The time, in Unix epoch format in seconds, when the job got created.
`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`	`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`	`withRole(String role)` The IAM role you use for creating this job.
`Job`	`withSettings(JobSettings settings)`
`Job`	`withStatus(JobStatus status)`
`Job`	`withStatus(String status)`
`Job`	`withTiming(Timing timing)`
`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
  - 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)
```
    Parameters:
    
    billingTagsSource -
    
    See Also:
    
    BillingTagsSource
  - getBillingTagsSource
```
public String getBillingTagsSource()
```
    Returns:
    
    See Also:
    
    BillingTagsSource
  - withBillingTagsSource
```
public Job withBillingTagsSource(String billingTagsSource)
```
    Parameters:
    
    billingTagsSource -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BillingTagsSource
  - withBillingTagsSource
```
public Job withBillingTagsSource(BillingTagsSource billingTagsSource)
```
    Parameters:
    
    billingTagsSource -
    
    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.
  - 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.
  - 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.
  - 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.
  - 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.
  - setQueue
```
public void setQueue(String 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.html
    
    Parameters:
    
    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.html
  - getQueue
```
public String getQueue()
```
    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.html
    
    Returns:
    
    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.html
  - withQueue
```
public Job withQueue(String 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.html
    
    Parameters:
    
    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.html
    
    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 http://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 http://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 http://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 http://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 http://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 http://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)
```
    Parameters:
    
    settings -
  - getSettings
```
public JobSettings getSettings()
```
    Returns:
  - withSettings
```
public Job withSettings(JobSettings settings)
```
    Parameters:
    
    settings -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    Parameters:
    
    status -
    
    See Also:
    
    JobStatus
  - getStatus
```
public String getStatus()
```
    Returns:
    
    See Also:
    
    JobStatus
  - withStatus
```
public Job withStatus(String status)
```
    Parameters:
    
    status -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - withStatus
```
public Job withStatus(JobStatus status)
```
    Parameters:
    
    status -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    JobStatus
  - setTiming
```
public void setTiming(Timing timing)
```
    Parameters:
    
    timing -
  - getTiming
```
public Timing getTiming()
```
    Returns:
  - withTiming
```
public Job withTiming(Timing timing)
```
    Parameters:
    
    timing -
    
    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)
```
  - 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

setArn

getArn

withArn

setBillingTagsSource

getBillingTagsSource

withBillingTagsSource

withBillingTagsSource

setCreatedAt

getCreatedAt

withCreatedAt

setErrorCode

getErrorCode

withErrorCode

setErrorMessage

getErrorMessage

withErrorMessage

setId

getId

withId

setJobTemplate

getJobTemplate

withJobTemplate

getOutputGroupDetails

setOutputGroupDetails

withOutputGroupDetails

withOutputGroupDetails

setQueue

getQueue

withQueue

setRole

getRole

withRole

setSettings

getSettings

withSettings

setStatus

getStatus

withStatus

withStatus

setTiming

getTiming

withTiming

getUserMetadata

setUserMetadata

withUserMetadata

addUserMetadataEntry

clearUserMetadataEntries

toString

equals

hashCode

clone

marshall