com.amazonaws.services.deadline.model

Class CreateJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.deadline.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()

Method Summary

Modifier and Type	Method and Description
CreateJobRequest	addParametersEntry(String key, JobParameter value) Add a single Parameters entry
CreateJobRequest	clearParametersEntries() Removes all the entries added into Parameters.
CreateJobRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Attachments	getAttachments() The attachments for the job.
String	getClientToken() The unique token which the server uses to recognize retries of the same request.
String	getFarmId() The farm ID of the farm to connect to the job.
Integer	getMaxFailedTasksCount() The number of task failures before the job stops running and is marked as FAILED.
Integer	getMaxRetriesPerTask() The maximum number of retries for a job.
Map<String,JobParameter>	getParameters() The parameters for the job.
Integer	getPriority() The priority of the job on a scale of 1 to 100.
String	getQueueId() The ID of the queue that the job is submitted to.
String	getStorageProfileId() The storage profile ID for the storage profile to connect to the job.
String	getTargetTaskRunStatus() The initial status of the job's tasks when they are created.
String	getTemplate() The job template to use for this job.
String	getTemplateType() The file type for the job template.
int	hashCode()
void	setAttachments(Attachments attachments) The attachments for the job.
void	setClientToken(String clientToken) The unique token which the server uses to recognize retries of the same request.
void	setFarmId(String farmId) The farm ID of the farm to connect to the job.
void	setMaxFailedTasksCount(Integer maxFailedTasksCount) The number of task failures before the job stops running and is marked as FAILED.
void	setMaxRetriesPerTask(Integer maxRetriesPerTask) The maximum number of retries for a job.
void	setParameters(Map<String,JobParameter> parameters) The parameters for the job.
void	setPriority(Integer priority) The priority of the job on a scale of 1 to 100.
void	setQueueId(String queueId) The ID of the queue that the job is submitted to.
void	setStorageProfileId(String storageProfileId) The storage profile ID for the storage profile to connect to the job.
void	setTargetTaskRunStatus(String targetTaskRunStatus) The initial status of the job's tasks when they are created.
void	setTemplate(String template) The job template to use for this job.
void	setTemplateType(String templateType) The file type for the job template.
String	toString() Returns a string representation of this object.
CreateJobRequest	withAttachments(Attachments attachments) The attachments for the job.
CreateJobRequest	withClientToken(String clientToken) The unique token which the server uses to recognize retries of the same request.
CreateJobRequest	withFarmId(String farmId) The farm ID of the farm to connect to the job.
CreateJobRequest	withMaxFailedTasksCount(Integer maxFailedTasksCount) The number of task failures before the job stops running and is marked as FAILED.
CreateJobRequest	withMaxRetriesPerTask(Integer maxRetriesPerTask) The maximum number of retries for a job.
CreateJobRequest	withParameters(Map<String,JobParameter> parameters) The parameters for the job.
CreateJobRequest	withPriority(Integer priority) The priority of the job on a scale of 1 to 100.
CreateJobRequest	withQueueId(String queueId) The ID of the queue that the job is submitted to.
CreateJobRequest	withStorageProfileId(String storageProfileId) The storage profile ID for the storage profile to connect to the job.
CreateJobRequest	withTargetTaskRunStatus(CreateJobTargetTaskRunStatus targetTaskRunStatus) The initial status of the job's tasks when they are created.
CreateJobRequest	withTargetTaskRunStatus(String targetTaskRunStatus) The initial status of the job's tasks when they are created.
CreateJobRequest	withTemplate(String template) The job template to use for this job.
CreateJobRequest	withTemplateType(JobTemplateType templateType) The file type for the job template.
CreateJobRequest	withTemplateType(String templateType) The file type for the job template.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateJobRequest

public CreateJobRequest()

Method Detail

setAttachments

public void setAttachments(Attachments attachments)

The attachments for the job. Attach files required for the job to run to a render job.

Parameters:

attachments - The attachments for the job. Attach files required for the job to run to a render job.

getAttachments

public Attachments getAttachments()

The attachments for the job. Attach files required for the job to run to a render job.

Returns:

The attachments for the job. Attach files required for the job to run to a render job.

withAttachments

public CreateJobRequest withAttachments(Attachments attachments)

The attachments for the job. Attach files required for the job to run to a render job.

Parameters:

attachments - The attachments for the job. Attach files required for the job to run to a render job.

Returns:

Returns a reference to this object so that method calls can be chained together.

setClientToken

public void setClientToken(String clientToken)

The unique token which the server uses to recognize retries of the same request.

Parameters:

clientToken - The unique token which the server uses to recognize retries of the same request.

getClientToken

public String getClientToken()

The unique token which the server uses to recognize retries of the same request.

Returns:

The unique token which the server uses to recognize retries of the same request.

withClientToken

public CreateJobRequest withClientToken(String clientToken)

The unique token which the server uses to recognize retries of the same request.

Parameters:

clientToken - The unique token which the server uses to recognize retries of the same request.

Returns:

Returns a reference to this object so that method calls can be chained together.

setFarmId

public void setFarmId(String farmId)

The farm ID of the farm to connect to the job.

Parameters:

farmId - The farm ID of the farm to connect to the job.

getFarmId

public String getFarmId()

The farm ID of the farm to connect to the job.

Returns:

The farm ID of the farm to connect to the job.

withFarmId

public CreateJobRequest withFarmId(String farmId)

The farm ID of the farm to connect to the job.

Parameters:

farmId - The farm ID of the farm to connect to the job.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxFailedTasksCount

public void setMaxFailedTasksCount(Integer maxFailedTasksCount)

The number of task failures before the job stops running and is marked as FAILED.

Parameters:

maxFailedTasksCount - The number of task failures before the job stops running and is marked as FAILED.

getMaxFailedTasksCount

public Integer getMaxFailedTasksCount()

The number of task failures before the job stops running and is marked as FAILED.

Returns:

The number of task failures before the job stops running and is marked as FAILED.

withMaxFailedTasksCount

public CreateJobRequest withMaxFailedTasksCount(Integer maxFailedTasksCount)

The number of task failures before the job stops running and is marked as FAILED.

Parameters:

maxFailedTasksCount - The number of task failures before the job stops running and is marked as FAILED.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxRetriesPerTask

public void setMaxRetriesPerTask(Integer maxRetriesPerTask)

The maximum number of retries for a job.

Parameters:

maxRetriesPerTask - The maximum number of retries for a job.

getMaxRetriesPerTask

public Integer getMaxRetriesPerTask()

The maximum number of retries for a job.

Returns:

The maximum number of retries for a job.

withMaxRetriesPerTask

public CreateJobRequest withMaxRetriesPerTask(Integer maxRetriesPerTask)

The maximum number of retries for a job.

Parameters:

maxRetriesPerTask - The maximum number of retries for a job.

Returns:

Returns a reference to this object so that method calls can be chained together.

getParameters

public Map<String,JobParameter> getParameters()

The parameters for the job.

Returns:

The parameters for the job.

setParameters

public void setParameters(Map<String,JobParameter> parameters)

The parameters for the job.

Parameters:

parameters - The parameters for the job.

withParameters

public CreateJobRequest withParameters(Map<String,JobParameter> parameters)

The parameters for the job.

Parameters:

parameters - The parameters for the job.

Returns:

Returns a reference to this object so that method calls can be chained together.

addParametersEntry

public CreateJobRequest addParametersEntry(String key,
                                           JobParameter value)

Add a single Parameters entry

See Also:

withParameters(java.util.Map<java.lang.String, com.amazonaws.services.deadline.model.JobParameter>)

clearParametersEntries

public CreateJobRequest clearParametersEntries()

Removes all the entries added into Parameters.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPriority

public void setPriority(Integer priority)

The priority of the job on a scale of 1 to 100. The highest priority is 1.

Parameters:

priority - The priority of the job on a scale of 1 to 100. The highest priority is 1.

getPriority

public Integer getPriority()

The priority of the job on a scale of 1 to 100. The highest priority is 1.

Returns:

The priority of the job on a scale of 1 to 100. The highest priority is 1.

withPriority

public CreateJobRequest withPriority(Integer priority)

The priority of the job on a scale of 1 to 100. The highest priority is 1.

Parameters:

priority - The priority of the job on a scale of 1 to 100. The highest priority is 1.

Returns:

Returns a reference to this object so that method calls can be chained together.

setQueueId

public void setQueueId(String queueId)

The ID of the queue that the job is submitted to.

Parameters:

queueId - The ID of the queue that the job is submitted to.

getQueueId

public String getQueueId()

The ID of the queue that the job is submitted to.

Returns:

The ID of the queue that the job is submitted to.

withQueueId

public CreateJobRequest withQueueId(String queueId)

The ID of the queue that the job is submitted to.

Parameters:

queueId - The ID of the queue that the job is submitted to.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStorageProfileId

public void setStorageProfileId(String storageProfileId)

The storage profile ID for the storage profile to connect to the job.

Parameters:

storageProfileId - The storage profile ID for the storage profile to connect to the job.

getStorageProfileId

public String getStorageProfileId()

The storage profile ID for the storage profile to connect to the job.

Returns:

The storage profile ID for the storage profile to connect to the job.

withStorageProfileId

public CreateJobRequest withStorageProfileId(String storageProfileId)

The storage profile ID for the storage profile to connect to the job.

Parameters:

storageProfileId - The storage profile ID for the storage profile to connect to the job.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTargetTaskRunStatus

public void setTargetTaskRunStatus(String targetTaskRunStatus)

The initial status of the job's tasks when they are created. Tasks that are created with a SUSPENDED status will not run until you update their status.

Parameters:

targetTaskRunStatus - The initial status of the job's tasks when they are created. Tasks that are created with a SUSPENDED status will not run until you update their status.

See Also:

CreateJobTargetTaskRunStatus

getTargetTaskRunStatus

public String getTargetTaskRunStatus()

The initial status of the job's tasks when they are created. Tasks that are created with a SUSPENDED status will not run until you update their status.

Returns:

The initial status of the job's tasks when they are created. Tasks that are created with a SUSPENDED status will not run until you update their status.

See Also:

CreateJobTargetTaskRunStatus

withTargetTaskRunStatus

public CreateJobRequest withTargetTaskRunStatus(String targetTaskRunStatus)

The initial status of the job's tasks when they are created. Tasks that are created with a SUSPENDED status will not run until you update their status.

Parameters:

targetTaskRunStatus - The initial status of the job's tasks when they are created. Tasks that are created with a SUSPENDED status will not run until you update their status.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CreateJobTargetTaskRunStatus

withTargetTaskRunStatus

public CreateJobRequest withTargetTaskRunStatus(CreateJobTargetTaskRunStatus targetTaskRunStatus)

The initial status of the job's tasks when they are created. Tasks that are created with a SUSPENDED status will not run until you update their status.

Parameters:

targetTaskRunStatus - The initial status of the job's tasks when they are created. Tasks that are created with a SUSPENDED status will not run until you update their status.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CreateJobTargetTaskRunStatus

setTemplate

public void setTemplate(String template)

The job template to use for this job.

Parameters:

template - The job template to use for this job.

getTemplate

public String getTemplate()

The job template to use for this job.

Returns:

The job template to use for this job.

withTemplate

public CreateJobRequest withTemplate(String template)

The job template to use for this job.

Parameters:

template - The job template to use for this job.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTemplateType

public void setTemplateType(String templateType)

The file type for the job template.

Parameters:

templateType - The file type for the job template.

See Also:

JobTemplateType

getTemplateType

public String getTemplateType()

The file type for the job template.

Returns:

The file type for the job template.

See Also:

JobTemplateType

withTemplateType

public CreateJobRequest withTemplateType(String templateType)

The file type for the job template.

Parameters:

templateType - The file type for the job template.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

JobTemplateType

withTemplateType

public CreateJobRequest withTemplateType(JobTemplateType templateType)

The file type for the job template.

Parameters:

templateType - The file type for the job template.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

JobTemplateType

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 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()