Interface UpdateJobRequest.Builder

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

  • Method Details

    • clientToken

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

    • targetTaskRunStatus

      UpdateJobRequest.Builder targetTaskRunStatus(String targetTaskRunStatus)

      The task status to update the job's tasks to.

      Parameters:
      targetTaskRunStatus - The task status to update the job's tasks to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • targetTaskRunStatus

      UpdateJobRequest.Builder targetTaskRunStatus(JobTargetTaskRunStatus targetTaskRunStatus)

      The task status to update the job's tasks to.

      Parameters:
      targetTaskRunStatus - The task status to update the job's tasks to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • priority

      UpdateJobRequest.Builder priority(Integer priority)

      The job priority to update.

      Parameters:
      priority - The job priority to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxFailedTasksCount

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

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

    • lifecycleStatus

      UpdateJobRequest.Builder lifecycleStatus(String lifecycleStatus)

      The status of a job in its lifecycle. When you change the status of the job to ARCHIVED, the job can't be scheduled or archived.

      An archived jobs and its steps and tasks are deleted after 120 days. The job can't be recovered.

      Parameters:
      lifecycleStatus - The status of a job in its lifecycle. When you change the status of the job to ARCHIVED, the job can't be scheduled or archived.

      An archived jobs and its steps and tasks are deleted after 120 days. The job can't be recovered.

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

    • lifecycleStatus

      UpdateJobRequest.Builder lifecycleStatus(UpdateJobLifecycleStatus lifecycleStatus)

      The status of a job in its lifecycle. When you change the status of the job to ARCHIVED, the job can't be scheduled or archived.

      An archived jobs and its steps and tasks are deleted after 120 days. The job can't be recovered.

      Parameters:
      lifecycleStatus - The status of a job in its lifecycle. When you change the status of the job to ARCHIVED, the job can't be scheduled or archived.

      An archived jobs and its steps and tasks are deleted after 120 days. The job can't be recovered.

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

    • maxWorkerCount

      UpdateJobRequest.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, the default is -1.

      The maximum number of workers that can process tasks in 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, the default is -1.

      The maximum number of workers that can process tasks in the job.

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

    • farmId

      UpdateJobRequest.Builder farmId(String farmId)

      The farm ID of the job to update.

      Parameters:
      farmId - The farm ID of the job to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queueId

      UpdateJobRequest.Builder queueId(String queueId)

      The queue ID of the job to update.

      Parameters:
      queueId - The queue ID of the job to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobId

      UpdateJobRequest.Builder jobId(String jobId)

      The job ID to update.

      Parameters:
      jobId - The job ID to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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