Interface JobSummary.Builder

  • Method Details

    • jobId

      JobSummary.Builder jobId(String jobId)

      The job ID.

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

      The job name.

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

      JobSummary.Builder lifecycleStatus(String lifecycleStatus)

      The life cycle status.

      Parameters:
      lifecycleStatus - The life cycle status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • lifecycleStatus

      JobSummary.Builder lifecycleStatus(JobLifecycleStatus lifecycleStatus)

      The life cycle status.

      Parameters:
      lifecycleStatus - The life cycle status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • lifecycleStatusMessage

      JobSummary.Builder lifecycleStatusMessage(String lifecycleStatusMessage)

      The life cycle status message.

      Parameters:
      lifecycleStatusMessage - The life cycle status message.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • priority

      JobSummary.Builder priority(Integer priority)

      The job priority.

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

      JobSummary.Builder createdAt(Instant createdAt)

      The date and time the resource was created.

      Parameters:
      createdAt - The date and time the resource was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • createdBy

      JobSummary.Builder createdBy(String createdBy)

      The user or system that created this resource.

      Parameters:
      createdBy - The user or system that created this resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • updatedAt

      JobSummary.Builder updatedAt(Instant updatedAt)

      The date and time the resource was updated.

      Parameters:
      updatedAt - The date and time the resource was updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • updatedBy

      JobSummary.Builder updatedBy(String updatedBy)

      The user or system that updated this resource.

      Parameters:
      updatedBy - The user or system that updated this resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • startedAt

      JobSummary.Builder startedAt(Instant startedAt)

      The date and time the resource started running.

      Parameters:
      startedAt - The date and time the resource started running.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • endedAt

      JobSummary.Builder endedAt(Instant endedAt)

      The date and time the resource ended running.

      Parameters:
      endedAt - The date and time the resource ended running.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • taskRunStatus

      JobSummary.Builder taskRunStatus(String taskRunStatus)

      The task run status for the job.

      • PENDING–pending and waiting for resources.

      • READY–ready to be processed.

      • ASSIGNED–assigned and will run next on a worker.

      • SCHEDULED–scheduled to be run on a worker.

      • INTERRUPTING–being interrupted.

      • RUNNING–running on a worker.

      • SUSPENDED–the task is suspended.

      • CANCELED–the task has been canceled.

      • FAILED–the task has failed.

      • SUCCEEDED–the task has succeeded.

      Parameters:
      taskRunStatus - The task run status for the job.

      • PENDING–pending and waiting for resources.

      • READY–ready to be processed.

      • ASSIGNED–assigned and will run next on a worker.

      • SCHEDULED–scheduled to be run on a worker.

      • INTERRUPTING–being interrupted.

      • RUNNING–running on a worker.

      • SUSPENDED–the task is suspended.

      • CANCELED–the task has been canceled.

      • FAILED–the task has failed.

      • SUCCEEDED–the task has succeeded.

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

      JobSummary.Builder taskRunStatus(TaskRunStatus taskRunStatus)

      The task run status for the job.

      • PENDING–pending and waiting for resources.

      • READY–ready to be processed.

      • ASSIGNED–assigned and will run next on a worker.

      • SCHEDULED–scheduled to be run on a worker.

      • INTERRUPTING–being interrupted.

      • RUNNING–running on a worker.

      • SUSPENDED–the task is suspended.

      • CANCELED–the task has been canceled.

      • FAILED–the task has failed.

      • SUCCEEDED–the task has succeeded.

      Parameters:
      taskRunStatus - The task run status for the job.

      • PENDING–pending and waiting for resources.

      • READY–ready to be processed.

      • ASSIGNED–assigned and will run next on a worker.

      • SCHEDULED–scheduled to be run on a worker.

      • INTERRUPTING–being interrupted.

      • RUNNING–running on a worker.

      • SUSPENDED–the task is suspended.

      • CANCELED–the task has been canceled.

      • FAILED–the task has failed.

      • SUCCEEDED–the task has succeeded.

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

      JobSummary.Builder targetTaskRunStatus(String targetTaskRunStatus)

      The task status to start with on the job.

      Parameters:
      targetTaskRunStatus - The task status to start with on the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • targetTaskRunStatus

      JobSummary.Builder targetTaskRunStatus(JobTargetTaskRunStatus targetTaskRunStatus)

      The task status to start with on the job.

      Parameters:
      targetTaskRunStatus - The task status to start with on the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • taskRunStatusCountsWithStrings

      JobSummary.Builder taskRunStatusCountsWithStrings(Map<String,Integer> taskRunStatusCounts)

      The number of tasks running on the job.

      Parameters:
      taskRunStatusCounts - The number of tasks running on the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • taskRunStatusCounts

      JobSummary.Builder taskRunStatusCounts(Map<TaskRunStatus,Integer> taskRunStatusCounts)

      The number of tasks running on the job.

      Parameters:
      taskRunStatusCounts - The number of tasks running on the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • taskFailureRetryCount

      JobSummary.Builder taskFailureRetryCount(Integer taskFailureRetryCount)

      The total number of times tasks from the job failed and were retried.

      Parameters:
      taskFailureRetryCount - The total number of times tasks from the job failed and were retried.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • maxFailedTasksCount

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

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

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

      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.

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

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