Interface BatchGetStepItem.Builder

  • Method Details

    • farmId

      The farm ID of the step.

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

      BatchGetStepItem.Builder queueId(String queueId)

      The queue ID of the step.

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

      The job ID of the step.

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

      The step ID.

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

      The name of the step.

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

      BatchGetStepItem.Builder lifecycleStatus(String lifecycleStatus)

      The life cycle status of the step.

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

      BatchGetStepItem.Builder lifecycleStatus(StepLifecycleStatus lifecycleStatus)

      The life cycle status of the step.

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

      BatchGetStepItem.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.
    • taskRunStatus

      BatchGetStepItem.Builder taskRunStatus(String taskRunStatus)

      The task run status for the step.

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

      BatchGetStepItem.Builder taskRunStatus(TaskRunStatus taskRunStatus)

      The task run status for the step.

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

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

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

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

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

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

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

      BatchGetStepItem.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.
    • targetTaskRunStatus

      BatchGetStepItem.Builder targetTaskRunStatus(String targetTaskRunStatus)

      The task status to start with on the step.

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

      BatchGetStepItem.Builder targetTaskRunStatus(StepTargetTaskRunStatus targetTaskRunStatus)

      The task status to start with on the step.

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

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

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

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

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

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

      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.
    • dependencyCounts

      BatchGetStepItem.Builder dependencyCounts(DependencyCounts dependencyCounts)

      The number of dependencies for the step.

      Parameters:
      dependencyCounts - The number of dependencies for the step.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • dependencyCounts

      default BatchGetStepItem.Builder dependencyCounts(Consumer<DependencyCounts.Builder> dependencyCounts)

      The number of dependencies for the step.

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

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

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

      BatchGetStepItem.Builder requiredCapabilities(StepRequiredCapabilities requiredCapabilities)

      The required capabilities for the step.

      Parameters:
      requiredCapabilities - The required capabilities for the step.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • requiredCapabilities

      default BatchGetStepItem.Builder requiredCapabilities(Consumer<StepRequiredCapabilities.Builder> requiredCapabilities)

      The required capabilities for the step.

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

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

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

      BatchGetStepItem.Builder parameterSpace(ParameterSpace parameterSpace)

      The parameter space for the step.

      Parameters:
      parameterSpace - The parameter space for the step.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • parameterSpace

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

      The parameter space for the step.

      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:
    • description

      BatchGetStepItem.Builder description(String description)

      The description of the step.

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