Class JobStepExecution

Represents an execution of a step that belongs to a job. The job execution this step execution belongs to can be accessed via getJobExecution(). If a pipeline is used to implement a step this step execution is available in the pipeline dictionary under the key ‘JobStepExecution’. If a script module is used to implement a step this step execution is available as the second parameter of the module’s function that is used to execute the step, e.g.:

1...
2exports.execute( parameters, stepExecution)
3{
4     ...
5     var jobExecution = stepExecution.getJobExecution();
6     ...
7}
8...

Property Summary 

PropertyDescription
ID: String (read-only)Returns the ID of this step execution.
jobExecution: JobExecution (read-only)Returns the job execution this step execution belongs to.
stepID: String (read-only)Returns the ID of the step this step execution belongs to.
stepTypeID: String (read-only)Returns the ID of the step type of the step this step execution belongs to.

Constructor Summary 

This class does not have a constructor, so you cannot create it directly.

Method Summary 

MethodDescription
getID()Returns the ID of this step execution.
getJobExecution()Returns the job execution this step execution belongs to.
getParameterValue(String)Returns the value of the parameter of the step this step execution belongs to.
getStepID()Returns the ID of the step this step execution belongs to.
getStepTypeID()Returns the ID of the step type of the step this step execution belongs to.

Methods inherited from class Object 

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Property Details 

ID 

ID: String (read-only)

Returns the ID of this step execution.


jobExecution 

jobExecution: JobExecution (read-only)

Returns the job execution this step execution belongs to.


stepID 

stepID: String (read-only)

Returns the ID of the step this step execution belongs to.


stepTypeID 

stepTypeID: String (read-only)

Returns the ID of the step type of the step this step execution belongs to.


Method Details 

getID() 

getID(): String

Returns the ID of this step execution.

Returns:

  • the ID of this step execution.

getJobExecution() 

getJobExecution(): JobExecution

Returns the job execution this step execution belongs to.

Returns:

  • the job execution this step execution belongs to.

getParameterValue(String) 

getParameterValue(name: String): Object

Returns the value of the parameter of the step this step execution belongs to.

Parameters:

  • name - The name of the parameter.

Returns:

  • the value of the parameter of the step this step execution belongs to.

getStepID() 

getStepID(): String

Returns the ID of the step this step execution belongs to.

Returns:

  • the ID of the step this step execution belongs to.

getStepTypeID() 

getStepTypeID(): String

Returns the ID of the step type of the step this step execution belongs to.

Returns:

  • the ID of the step type of the step this step execution belongs to.

DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!