Interface GetJobResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<GetJobResponse.Builder,GetJobResponse>, DeadlineResponse.Builder, SdkBuilder<GetJobResponse.Builder,GetJobResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
GetJobResponse
@Mutable @NotThreadSafe public static interface GetJobResponse.Builder extends DeadlineResponse.Builder, SdkPojo, CopyableBuilder<GetJobResponse.Builder,GetJobResponse>

  • Method Details

    • jobId

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

      GetJobResponse.Builder name(String name)

      The name of the job.

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

    • lifecycleStatus

      GetJobResponse.Builder lifecycleStatus(String lifecycleStatus)

      The life cycle status for the job.

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

    • lifecycleStatus

      GetJobResponse.Builder lifecycleStatus(JobLifecycleStatus lifecycleStatus)

      The life cycle status for the job.

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

    • lifecycleStatusMessage

      GetJobResponse.Builder lifecycleStatusMessage(String lifecycleStatusMessage)

      A message that communicates the status of the life cycle for the job.

      Parameters:
      lifecycleStatusMessage - A message that communicates the status of the life cycle for the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • priority

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

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

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

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

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

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

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

      GetJobResponse.Builder taskRunStatus(String taskRunStatus)

      The task run status for the job.

      Parameters:
      taskRunStatus - The task run status for the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • taskRunStatus

      GetJobResponse.Builder taskRunStatus(TaskRunStatus taskRunStatus)

      The task run status for the job.

      Parameters:
      taskRunStatus - The task run status for the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • targetTaskRunStatus

      GetJobResponse.Builder targetTaskRunStatus(String targetTaskRunStatus)

      The task status with which the job started.

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

    • targetTaskRunStatus

      GetJobResponse.Builder targetTaskRunStatus(JobTargetTaskRunStatus targetTaskRunStatus)

      The task status with which the job started.

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

    • taskRunStatusCountsWithStrings

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

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

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

    • storageProfileId

      GetJobResponse.Builder storageProfileId(String storageProfileId)

      The storage profile ID associated with the job.

      Parameters:
      storageProfileId - The storage profile ID associated with the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxFailedTasksCount

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

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

    • parameters

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

      GetJobResponse.Builder attachments(Attachments attachments)

      The attachments for the job.

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

    • attachments

      default GetJobResponse.Builder attachments(Consumer<Attachments.Builder> attachments)

      The attachments for the 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:

    • description

      GetJobResponse.Builder description(String description)

      The description of the job.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

      Parameters:
      description - The description of the job.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

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

    • maxWorkerCount

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

      If you don't set the maxWorkerCount when you create a job, this value is not returned in the response.

      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.

      If you don't set the maxWorkerCount when you create a job, this value is not returned in the response.

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

    • sourceJobId

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