Interface BatchGetJobItem.Builder

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

  • Method Details

    • farmId

      BatchGetJobItem.Builder farmId(String farmId)

      The farm ID of the job.

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

    • queueId

      BatchGetJobItem.Builder queueId(String queueId)

      The queue ID of the job.

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

    • jobId

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

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

      BatchGetJobItem.Builder lifecycleStatus(String lifecycleStatus)

      The life cycle status of the job.

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

    • lifecycleStatus

      BatchGetJobItem.Builder lifecycleStatus(JobLifecycleStatus lifecycleStatus)

      The life cycle status of the job.

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

    • lifecycleStatusMessage

      BatchGetJobItem.Builder lifecycleStatusMessage(String lifecycleStatusMessage)

      A message that communicates the status of the life cycle.

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

    • priority

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

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

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

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

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

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

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

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

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

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

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

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

      The number of tasks for each run status for the job.

      Parameters:
      taskRunStatusCounts - The number of tasks for each run status for the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • taskRunStatusCounts

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

      The number of tasks for each run status for the job.

      Parameters:
      taskRunStatusCounts - The number of tasks for each run status for the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • taskFailureRetryCount

      BatchGetJobItem.Builder taskFailureRetryCount(Integer taskFailureRetryCount)

      The number of times that tasks failed and were retried.

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

    • storageProfileId

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

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

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

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

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

      BatchGetJobItem.Builder description(String description)

      The description of the job.

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

    • maxWorkerCount

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

    • sourceJobId

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