CreateJobRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.mediaconvert.model.CreateJobRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateJobRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateJobRequest()

Constructors
Constructor and Description
`CreateJobRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateJobRequest`	`addUserMetadataEntry(String key, String value)`
`CreateJobRequest`	`clearUserMetadataEntries()` Removes all the entries added into UserMetadata.
`CreateJobRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`String`	`getClientRequestToken()` Idempotency token for CreateJob operation.
`String`	`getJobTemplate()` When you create a job, you can either specify a job template or specify the transcoding settings individually
`String`	`getQueue()` Optional.
`String`	`getRole()` Required.
`JobSettings`	`getSettings()`
`Map<String,String>`	`getUserMetadata()` User-defined metadata that you want to associate with an MediaConvert job.
`int`	`hashCode()`
`void`	`setClientRequestToken(String clientRequestToken)` Idempotency token for CreateJob operation.
`void`	`setJobTemplate(String jobTemplate)` When you create a job, you can either specify a job template or specify the transcoding settings individually
`void`	`setQueue(String queue)` Optional.
`void`	`setRole(String role)` Required.
`void`	`setSettings(JobSettings settings)`
`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; useful for testing and debugging.
`CreateJobRequest`	`withClientRequestToken(String clientRequestToken)` Idempotency token for CreateJob operation.
`CreateJobRequest`	`withJobTemplate(String jobTemplate)` When you create a job, you can either specify a job template or specify the transcoding settings individually
`CreateJobRequest`	`withQueue(String queue)` Optional.
`CreateJobRequest`	`withRole(String role)` Required.
`CreateJobRequest`	`withSettings(JobSettings settings)`
`CreateJobRequest`	`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
  - CreateJobRequest
```
public CreateJobRequest()
```
- Method Detail
  - setClientRequestToken
```
public void setClientRequestToken(String clientRequestToken)
```
    Idempotency token for CreateJob operation.
    
    Parameters:
    
    clientRequestToken - Idempotency token for CreateJob operation.
  - getClientRequestToken
```
public String getClientRequestToken()
```
    Idempotency token for CreateJob operation.
    
    Returns:
    
    Idempotency token for CreateJob operation.
  - withClientRequestToken
```
public CreateJobRequest withClientRequestToken(String clientRequestToken)
```
    Idempotency token for CreateJob operation.
    
    Parameters:
    
    clientRequestToken - Idempotency token for CreateJob operation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobTemplate
```
public void setJobTemplate(String jobTemplate)
```
    When you create a job, you can either specify a job template or specify the transcoding settings individually
    
    Parameters:
    
    jobTemplate - When you create a job, you can either specify a job template or specify the transcoding settings individually
  - getJobTemplate
```
public String getJobTemplate()
```
    When you create a job, you can either specify a job template or specify the transcoding settings individually
    
    Returns:
    
    When you create a job, you can either specify a job template or specify the transcoding settings individually
  - withJobTemplate
```
public CreateJobRequest withJobTemplate(String jobTemplate)
```
    When you create a job, you can either specify a job template or specify the transcoding settings individually
    
    Parameters:
    
    jobTemplate - When you create a job, you can either specify a job template or specify the transcoding settings individually
    
    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 CreateJobRequest 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)
```
    Required. 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 - Required. 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()
```
    Required. 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:
    
    Required. 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 CreateJobRequest withRole(String role)
```
    Required. 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 - Required. 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 CreateJobRequest withSettings(JobSettings settings)
```
    Parameters:
    
    settings -
    
    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 CreateJobRequest 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 CreateJobRequest addUserMetadataEntry(String key,
                                             String value)
```
  - clearUserMetadataEntries
```
public CreateJobRequest 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; useful for testing and debugging.
    
    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 CreateJobRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Did this page help you?

Class CreateJobRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateJobRequest

Method Detail

setClientRequestToken

getClientRequestToken

withClientRequestToken

setJobTemplate

getJobTemplate

withJobTemplate

setQueue

getQueue

withQueue

setRole

getRole

withRole

setSettings

getSettings

withSettings

getUserMetadata

setUserMetadata

withUserMetadata

addUserMetadataEntry

clearUserMetadataEntries

toString

equals

hashCode

clone