Interface CreateJobRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>,DeadlineRequest.Builder,SdkBuilder<CreateJobRequest.Builder,CreateJobRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- CreateJobRequest
public static interface CreateJobRequest.Builder extends DeadlineRequest.Builder, SdkPojo, CopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default CreateJobRequest.Builderattachments(Consumer<Attachments.Builder> attachments)The attachments for the job.CreateJobRequest.Builderattachments(Attachments attachments)The attachments for the job.CreateJobRequest.BuilderclientToken(String clientToken)The unique token which the server uses to recognize retries of the same request.CreateJobRequest.BuilderfarmId(String farmId)The farm ID of the farm to connect to the job.CreateJobRequest.BuildermaxFailedTasksCount(Integer maxFailedTasksCount)The number of task failures before the job stops running and is marked asFAILED.CreateJobRequest.BuildermaxRetriesPerTask(Integer maxRetriesPerTask)The maximum number of retries for a job.CreateJobRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)CreateJobRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)CreateJobRequest.Builderparameters(Map<String,JobParameter> parameters)The parameters for the job.CreateJobRequest.Builderpriority(Integer priority)The priority of the job on a scale of 1 to 100.CreateJobRequest.BuilderqueueId(String queueId)The ID of the queue that the job is submitted to.CreateJobRequest.BuilderstorageProfileId(String storageProfileId)The storage profile ID for the storage profile to connect to the job.CreateJobRequest.BuildertargetTaskRunStatus(String targetTaskRunStatus)The initial status of the job's tasks when they are created.CreateJobRequest.BuildertargetTaskRunStatus(CreateJobTargetTaskRunStatus targetTaskRunStatus)The initial status of the job's tasks when they are created.CreateJobRequest.Buildertemplate(String template)The job template to use for this job.CreateJobRequest.BuildertemplateType(String templateType)The file type for the job template.CreateJobRequest.BuildertemplateType(JobTemplateType templateType)The file type for the job template.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.deadline.model.DeadlineRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
attachments
CreateJobRequest.Builder attachments(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.
-
attachments
default CreateJobRequest.Builder attachments(Consumer<Attachments.Builder> attachments)
The attachments for the job. Attach files required for the job to run to a render job.
This is a convenience method that creates an instance of theAttachments.Builderavoiding the need to create one manually viaAttachments.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toattachments(Attachments).- Parameters:
attachments- a consumer that will call methods onAttachments.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
attachments(Attachments)
-
clientToken
CreateJobRequest.Builder clientToken(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.
-
farmId
CreateJobRequest.Builder farmId(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.
-
maxFailedTasksCount
CreateJobRequest.Builder maxFailedTasksCount(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 asFAILED.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxRetriesPerTask
CreateJobRequest.Builder maxRetriesPerTask(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.
-
parameters
CreateJobRequest.Builder parameters(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.
-
priority
CreateJobRequest.Builder priority(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.
-
queueId
CreateJobRequest.Builder queueId(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.
-
storageProfileId
CreateJobRequest.Builder storageProfileId(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.
-
targetTaskRunStatus
CreateJobRequest.Builder targetTaskRunStatus(String targetTaskRunStatus)
The initial status of the job's tasks when they are created. Tasks that are created with a
SUSPENDEDstatus 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 aSUSPENDEDstatus 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,CreateJobTargetTaskRunStatus
-
targetTaskRunStatus
CreateJobRequest.Builder targetTaskRunStatus(CreateJobTargetTaskRunStatus targetTaskRunStatus)
The initial status of the job's tasks when they are created. Tasks that are created with a
SUSPENDEDstatus 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 aSUSPENDEDstatus 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,CreateJobTargetTaskRunStatus
-
template
CreateJobRequest.Builder template(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.
-
templateType
CreateJobRequest.Builder templateType(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,JobTemplateType
-
templateType
CreateJobRequest.Builder templateType(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,JobTemplateType
-
overrideConfiguration
CreateJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
CreateJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-