Interface BatchUpdateJobItem.Builder

  • Method Details

    • 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

      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

      The job ID of the job to update.

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

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

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

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

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

      BatchUpdateJobItem.Builder maxRetriesPerTask(Integer maxRetriesPerTask)

      The maximum number of retries per failed tasks.

      Parameters:
      maxRetriesPerTask - The maximum number of retries per failed tasks.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • lifecycleStatus

      BatchUpdateJobItem.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 job 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 job 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

      BatchUpdateJobItem.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 job 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 job 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

      BatchUpdateJobItem.Builder maxWorkerCount(Integer maxWorkerCount)

      The maximum number of worker hosts that can concurrently process a job.

      Parameters:
      maxWorkerCount - The maximum number of worker hosts that can concurrently process a job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • name

      The name of the job to update.

      Parameters:
      name - The name of the job to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • description

      BatchUpdateJobItem.Builder description(String description)

      The description of the job to update.

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