StepBlockState (engine-api 24.1.2 API)

All Superinterfaces:: BlockState

public interface StepBlockState extends BlockState

Information about a step block. A block is a representation for a sequence of steps and is used to facilitate the parallel execution of steps.

Method Summary

Modifier and Type

Method

Description

int

getCurrentStep()

Returns number of step which is being executed.

String

getSatelliteId()

Returns satellite if it used in current block

List<StepState>

getSteps()

Returns states of all the states included in this block.

default Boolean

hasSteps()

Methods inherited from interface com.xebialabs.deployit.engine.api.execution.BlockState
getDescription, getId, getSatelliteConnectionState, getState

Method Details
- getCurrentStep
  
  int getCurrentStep()
  
  Returns number of step which is being executed.
- getSteps
  
  List<StepState> getSteps()
  
  Returns states of all the states included in this block.
- getSatelliteId
  
  String getSatelliteId()
  
  Returns satellite if it used in current block
- hasSteps
  
  default Boolean hasSteps()
  
  Specified by:
  
  hasSteps in interface BlockState
  
  Returns:
  
  true if block contains steps