Class PipelineDiagnostics
Represents diagnostic information about a pipeline.
Namespace: Microsoft.Psi.Diagnostics
Assembly: Microsoft.Psi.dll
Syntax
public class PipelineDiagnostics : object
Remarks
This is a summarized snapshot of the graph with aggregated message statistics which is posted to the diagnostics stream. It has a much smaller memory footprint compared with PipelineDiagnosticsInternal.
Constructors
View SourcePipelineDiagnostics(Int32, String, Boolean, PipelineDiagnostics, PipelineDiagnostics[], PipelineDiagnostics.PipelineElementDiagnostics[])
Initializes a new instance of the PipelineDiagnostics class.
Declaration
public PipelineDiagnostics(int id, string name, bool isPipelineRunning, PipelineDiagnostics parentPipelineDiagnostics, PipelineDiagnostics[] subpipelineDiagnostics, PipelineDiagnostics.PipelineElementDiagnostics[] pipelineElements)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | id | Pipeline ID. |
String | name | Pipeline name. |
System.Boolean | isPipelineRunning | Whether the pipeline is running (after started, before stopped). |
PipelineDiagnostics | parentPipelineDiagnostics | Parent pipeline of this pipeline (it any). |
PipelineDiagnostics[] | subpipelineDiagnostics | Subpipelines of this pipeline. |
PipelineDiagnostics.PipelineElementDiagnostics[] | pipelineElements | Elements in this pipeline. |
Properties
View SourceAncestorPipelines
Gets ancestor pipeline diagnostics.
Declaration
public IEnumerable<PipelineDiagnostics> AncestorPipelines { get; }
Property Value
Type | Description |
---|---|
IEnumerable<PipelineDiagnostics> |
DescendantPipelines
Gets descendant pipeline diagnostics.
Declaration
public IEnumerable<PipelineDiagnostics> DescendantPipelines { get; }
Property Value
Type | Description |
---|---|
IEnumerable<PipelineDiagnostics> |
Id
Gets pipeline ID.
Declaration
public int Id { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
IsPipelineRunning
Gets a value indicating whether the pipeline is running (after started, before stopped).
Declaration
public bool IsPipelineRunning { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Name
Gets pipeline name.
Declaration
public string Name { get; }
Property Value
Type | Description |
---|---|
String |
ParentPipelineDiagnostics
Gets or sets parent pipeline of this pipeline (it any).
Declaration
public PipelineDiagnostics ParentPipelineDiagnostics { get; set; }
Property Value
Type | Description |
---|---|
PipelineDiagnostics |
PipelineElements
Gets or sets elements in this pipeline.
Declaration
public PipelineDiagnostics.PipelineElementDiagnostics[] PipelineElements { get; set; }
Property Value
Type | Description |
---|---|
PipelineDiagnostics.PipelineElementDiagnostics[] |
SubpipelineDiagnostics
Gets or sets subpipelines of this pipeline.
Declaration
public PipelineDiagnostics[] SubpipelineDiagnostics { get; set; }
Property Value
Type | Description |
---|---|
PipelineDiagnostics[] |