Package io.jenkins.blueocean.rest.model

Class BluePipelineStep

java.lang.Object

io.jenkins.blueocean.rest.model.Resource

io.jenkins.blueocean.rest.model.BluePipelineStep

All Implemented Interfaces:

Reachable

Direct Known Subclasses:

BluePipelineNode

public abstract class BluePipelineStep
extends Resource

Pipeline Step resource

Author:

Vivek Pandey

Field Summary

Fields

Modifier and Type	Field	Description
static String	ACTIONS
static String	DISPLAY_DESCRIPTION
static String	DISPLAY_NAME
static String	DURATION_IN_MILLIS
static String	EDGES
static String	ID
static String	RESULT
static String	START_TIME
static String	TYPE

Constructor Summary

Constructors

Constructor	Description
BluePipelineStep()

Method Summary

Modifier and Type	Method	Description
abstract Collection<BlueActionProxy>	getActions()
abstract String	getDisplayDescription()	Step display description.
abstract String	getDisplayName()	Step display name.
abstract Long	getDurationInMillis()	Execution duration
abstract String	getId()	id of step.
abstract BlueInputStep	getInputStep()	Input step associated with this step
abstract Object	getLog()
abstract BlueRun.BlueRunResult	getResult()	Step execution result
abstract Date	getStartTime()	Start time of execution
abstract String	getStartTimeString()	Start time string representation
abstract BlueRun.BlueRunState	getStateObj()	Step execution state
abstract String	getStepType()
abstract String	getType()	Type of step.
abstract org.kohsuke.stapler.HttpResponse	submitInputStep(org.kohsuke.stapler.StaplerRequest request)	Processes submitted input step via POST request

Methods inherited from class io.jenkins.blueocean.rest.model.Resource

getLinks, getState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.jenkins.blueocean.rest.Reachable

getLink

Field Detail

DISPLAY_NAME

public static final String DISPLAY_NAME

See Also:

Constant Field Values

DISPLAY_DESCRIPTION

public static final String DISPLAY_DESCRIPTION

See Also:

Constant Field Values

RESULT

public static final String RESULT

See Also:

Constant Field Values

START_TIME

public static final String START_TIME

See Also:

Constant Field Values

ID

public static final String ID

See Also:

Constant Field Values

EDGES

public static final String EDGES

See Also:

Constant Field Values

DURATION_IN_MILLIS

public static final String DURATION_IN_MILLIS

See Also:

Constant Field Values

ACTIONS

public static final String ACTIONS

See Also:

Constant Field Values

TYPE

public static final String TYPE

See Also:

Constant Field Values

Constructor Detail

BluePipelineStep

public BluePipelineStep()

Method Detail

getId

@Exported(name="id")
public abstract String getId()

id of step.

Returns:

node id

getDisplayName

@Exported(name="displayName")
public abstract String getDisplayName()

Step display name.

Returns:

display name

getDisplayDescription

@Exported(name="displayDescription")
public abstract String getDisplayDescription()

Step display description.

Returns:

display description

getType

@Exported(name="type")
public abstract String getType()

Type of step.

Returns:

step type

getStepType

public abstract String getStepType()

Returns:

the step type

getResult

@Exported(name="result")
public abstract BlueRun.BlueRunResult getResult()

Step execution result

Returns:

BlueRun.BlueRunResult instance

getStateObj

@Exported(name="state")
public abstract BlueRun.BlueRunState getStateObj()

Step execution state

Returns:

execution state BlueRun.BlueRunState

getStartTime

public abstract Date getStartTime()

Start time of execution

Returns:

start time of execution

getStartTimeString

@Exported(name="startTime")
public abstract String getStartTimeString()

Start time string representation

Returns:

start time of execution

getDurationInMillis

@Exported(name="durationInMillis")
public abstract Long getDurationInMillis()

Execution duration

Returns:

execution duration in milli seconds

getLog

public abstract Object getLog()

Returns:

Gives logs associated with this node

getActions

@Navigable
@Exported(name="actions",
          inline=true)
public abstract Collection<BlueActionProxy> getActions()

Returns:

Gives Actions associated with this pipeline node

getInputStep

@Exported(name="input",
          inline=true)
public abstract BlueInputStep getInputStep()

Input step associated with this step

Returns:

input step

submitInputStep

@POST
@WebMethod(name="")
public abstract org.kohsuke.stapler.HttpResponse submitInputStep(org.kohsuke.stapler.StaplerRequest request)

Processes submitted input step via POST request

Parameters:

request - stapler request

Returns:

http response