Pipeline Pipeline Pipeline Pipeline Class

Definition

Defines a class which can be used to invoke a pipeline of commands.

public ref class Pipeline abstract : IDisposable
public abstract class Pipeline : IDisposable
type Pipeline = class
    interface IDisposable
Public MustInherit Class Pipeline
Implements IDisposable
Inheritance
PipelinePipelinePipelinePipeline
Implements

Properties

Commands Commands Commands Commands

gets the collection of commands for this pipeline.

Error Error Error Error

gets the error output reader for this pipeline.

HadErrors HadErrors HadErrors HadErrors

True if pipeline execution encountered and error. It will always be true if _reason is non-null since an exception occurred. For other error types, It has to be set manually.

Input Input Input Input

gets input writer for this pipeline.

InstanceId InstanceId InstanceId InstanceId

gets the unique identifier for this pipeline. This identifier is unique with in the scope of Runspace.

IsNested IsNested IsNested IsNested

Gets the property which indicates if this pipeline is nested.

Output Output Output Output

Gets the output reader for this pipeline.

PipelineStateInfo PipelineStateInfo PipelineStateInfo PipelineStateInfo

Gets Info about current state of the pipeline.

Runspace Runspace Runspace Runspace

gets the runspace this pipeline is created on.

SetPipelineSessionState SetPipelineSessionState SetPipelineSessionState SetPipelineSessionState

If this property is true, SessionState is updated for this pipeline state.

Methods

Connect() Connect() Connect() Connect()

Connects synchronously to a running command on a remote server. The pipeline object must be in the disconnected state.

ConnectAsync() ConnectAsync() ConnectAsync() ConnectAsync()

Connects asynchronously to a running command on a remote server.

Copy() Copy() Copy() Copy()

Creates a new Pipeline that is a copy of the current instance.

Dispose() Dispose() Dispose() Dispose()

Disposes the pipeline. If pipeline is running, dispose first stops the pipeline.

Dispose(Boolean) Dispose(Boolean) Dispose(Boolean) Dispose(Boolean)

Protected dispose which can be overridden by derived classes.

Invoke(IEnumerable) Invoke(IEnumerable) Invoke(IEnumerable) Invoke(IEnumerable)

Invoke the pipeline, synchronously, returning the results as an array of objects.

Invoke() Invoke() Invoke() Invoke()

Invoke the pipeline, synchronously, returning the results as an array of objects.

InvokeAsync() InvokeAsync() InvokeAsync() InvokeAsync()

Invoke the pipeline asynchronously

Stop() Stop() Stop() Stop()

Synchronous call to stop the running pipeline.

StopAsync() StopAsync() StopAsync() StopAsync()

Asynchronous call to stop the running pipeline.

Events

StateChanged StateChanged StateChanged StateChanged

Event raised when Pipeline's state changes.

Applies to