Interface StepSearchSummary.Builder

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

  • Method Details

    • stepId

      StepSearchSummary.Builder stepId(String stepId)

      The step ID.

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

    • jobId

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

    • queueId

      StepSearchSummary.Builder queueId(String queueId)

      The queue ID.

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

    • name

      StepSearchSummary.Builder name(String name)

      The step name.

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

    • lifecycleStatus

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

      StepSearchSummary.Builder lifecycleStatus(StepLifecycleStatus 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

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

    • taskRunStatus

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

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

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

      StepSearchSummary.Builder targetTaskRunStatus(StepTargetTaskRunStatus 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

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

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

      StepSearchSummary.Builder taskFailureRetryCount(Integer taskFailureRetryCount)

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

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

    • createdAt

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

    • startedAt

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

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

    • parameterSpace

      StepSearchSummary.Builder parameterSpace(ParameterSpace parameterSpace)

      The parameters and combination expressions for the search.

      Parameters:
      parameterSpace - The parameters and combination expressions for the search.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameterSpace

      default StepSearchSummary.Builder parameterSpace(Consumer<ParameterSpace.Builder> parameterSpace)

      The parameters and combination expressions for the search.

      This is a convenience method that creates an instance of the ParameterSpace.Builder avoiding the need to create one manually via ParameterSpace.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to parameterSpace(ParameterSpace).

      Parameters:
      parameterSpace - a consumer that will call methods on ParameterSpace.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: