Interface CreateJobRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>, DeadlineRequest.Builder, SdkBuilder<CreateJobRequest.Builder,CreateJobRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateJobRequest
@Mutable @NotThreadSafe public static interface CreateJobRequest.Builder extends DeadlineRequest.Builder, SdkPojo, CopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>

  • Method Details

    • 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.

    • 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.

    • 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.

    • 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:

    • 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:

    • priority

      CreateJobRequest.Builder priority(Integer priority)

      The priority of the job. The highest priority (first scheduled) is 100. When two jobs have the same priority, the oldest job is scheduled first.

      Parameters:
      priority - The priority of the job. The highest priority (first scheduled) is 100. When two jobs have the same priority, the oldest job is scheduled first.
      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.

    • 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 the Attachments.Builder avoiding the need to create one manually via Attachments.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to attachments(Attachments).

      Parameters:
      attachments - a consumer that will call methods on Attachments.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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 job status when it is created. Jobs that are created with a SUSPENDED status will not run until manually requeued.

      Parameters:
      targetTaskRunStatus - The initial job status when it is created. Jobs that are created with a SUSPENDED status will not run until manually requeued.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • targetTaskRunStatus

      CreateJobRequest.Builder targetTaskRunStatus(CreateJobTargetTaskRunStatus targetTaskRunStatus)

      The initial job status when it is created. Jobs that are created with a SUSPENDED status will not run until manually requeued.

      Parameters:
      targetTaskRunStatus - The initial job status when it is created. Jobs that are created with a SUSPENDED status will not run until manually requeued.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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 as FAILED.
      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 each task.

      Parameters:
      maxRetriesPerTask - The maximum number of retries for each task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxWorkerCount

      CreateJobRequest.Builder maxWorkerCount(Integer maxWorkerCount)

      The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.

      You can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum number of workers.

      If you don't specify the maxWorkerCount, Deadline Cloud won't throttle the number of workers used to process the job.

      Parameters:
      maxWorkerCount - The maximum number of worker hosts that can concurrently process a job. When the maxWorkerCount is reached, no more workers will be assigned to process the job, even if the fleets assigned to the job's queue has available workers.

      You can't set the maxWorkerCount to 0. If you set it to -1, there is no maximum number of workers.

      If you don't specify the maxWorkerCount, Deadline Cloud won't throttle the number of workers used to process the job.

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

    • sourceJobId

      CreateJobRequest.Builder sourceJobId(String sourceJobId)

      The job ID for the source job.

      Parameters:
      sourceJobId - The job ID for the source job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.