PipelineResults Class Reference

A container for holding pipeline results. More...

Public Member Functions
void	AddOutput< T > (string key, T value)
	Adds the value to the outputs dictionary. Raises an exception if the key already exists. More...
void	Complete ()
	Marks the pipeline as successful. More...
T	GetArgument< T > (string key)
	Searches the output and input dictionaries for the key and returns it. More...
T	GetInput< T > (string key)
	Returns the input for the specified key. More...
T	GetOutput< T > (string key)
	Returns the output for the specified key. More...
	PipelineResults (Dictionary< string, object > inputs)
	Initializes a new result. More...
void	SetOutput< T > (string key, T value)
	Sets the value to the outputs dictionary. More...

Properties
Dictionary< string, object >	Inputs = new Dictionary<string, object>() [get]
	A dictionary of pipeline inputs. More...
Dictionary< string, object >	Outputs = new Dictionary<string, object>() [get]
	A dictionary of pipeline output results. More...
bool	Success [getprivate set]
	True if the pipeline steps are successful. More...

Detailed Description

A container for holding pipeline results.

Definition at line 8 of file PipelineResults.cs.

Constructor & Destructor Documentation

PipelineResults()

PipelineResults

(

Dictionary< string, object >

inputs

)

Initializes a new result.

Parameters

inputs

The input dictionary.

Definition at line 29 of file PipelineResults.cs.

Member Function Documentation

AddOutput< T >()

void AddOutput< T >	(	string	key,
		T	value
	)

Adds the value to the outputs dictionary. Raises an exception if the key already exists.

Template Parameters

T

Parameters

key	The output key.
value	The output value.

Definition at line 91 of file PipelineResults.cs.

Complete()

void Complete

(

)

Marks the pipeline as successful.

Definition at line 99 of file PipelineResults.cs.

GetArgument< T >()

T GetArgument< T >

(

string

key

)

Searches the output and input dictionaries for the key and returns it.

Template Parameters

T	The object type.

Parameters

key	The dictionary key.

Definition at line 39 of file PipelineResults.cs.

GetInput< T >()

T GetInput< T >

(

string

key

)

Returns the input for the specified key.

Parameters

key	The input key.

Definition at line 57 of file PipelineResults.cs.

GetOutput< T >()

T GetOutput< T >

(

string

key

)

Returns the output for the specified key.

Parameters

key	The output key.

Definition at line 68 of file PipelineResults.cs.

SetOutput< T >()

void SetOutput< T >	(	string	key,
		T	value
	)

Sets the value to the outputs dictionary.

Parameters

key	The output key.
value	The output value.

Definition at line 80 of file PipelineResults.cs.

Property Documentation

Inputs

Dictionary<string, object> Inputs = new Dictionary<string, object>()

get

A dictionary of pipeline inputs.

Definition at line 13 of file PipelineResults.cs.

Outputs

Dictionary<string, object> Outputs = new Dictionary<string, object>()

get

A dictionary of pipeline output results.

Definition at line 18 of file PipelineResults.cs.

Success

bool Success

getprivate set

True if the pipeline steps are successful.

Definition at line 23 of file PipelineResults.cs.

---

The documentation for this class was generated from the following file:

• /github/workspace/src/Common/Pipelines/PipelineResults.cs