Cmdlet

Update-Console

Module: ConsoleMonster
Inputs: System.Object

Updates a live widget or a caller-managed run through one validated operation.

Syntax

Update-Console
[-Complete]
[-Counter <IDictionary>]
[-Detail <Object>]
[-Increment <Double>]
[-Key <String>]
[-Label <Object>]
[-ParentKey <String>]
[-RemainingSeconds <Double>]
[-Restart]
[-Result <StatusKind>]
[-Session <LiveSession>]
[-Status <StatusKind>]
[-Total <Double>]
[-Value <Object>]
[-WidgetId] <String>
[<CommonParameters>]

Parameter set: Fields

Update-Console
-Append
[-Key <String>]
[-Session <LiveSession>]
-Value <Object>
[-WidgetId] <String>
[<CommonParameters>]

Parameter set: Append

Update-Console
-Row <Object>
[-Session <LiveSession>]
[-WidgetId] <String>
[<CommonParameters>]

Parameter set: Row

Update-Console
-Key <String>
-RemoveRow
[-Session <LiveSession>]
[-WidgetId] <String>
[<CommonParameters>]

Parameter set: RemoveRow

Update-Console
-ClearRows
[-Session <LiveSession>]
[-WidgetId] <String>
[<CommonParameters>]

Parameter set: ClearRows

Update-Console
-Index <Int32[]>
[-Session <LiveSession>]
-Status <StatusKind>
[-WidgetId] <String>
[<CommonParameters>]

Parameter set: Cells

Update-Console
-AppendCells
[-Count <Int32>]
[-Session <LiveSession>]
[-Status <StatusKind>]
[-WidgetId] <String>
[<CommonParameters>]

Parameter set: AppendCells

Update-Console
-CellCount <Int32>
[-Session <LiveSession>]
[-WidgetId] <String>
[<CommonParameters>]

Parameter set: ResizeCells

Update-Console
-Content <Object>
[-Session <LiveSession>]
[-WidgetId] <String>
[<CommonParameters>]

Parameter set: Content

Update-Console
-NodeKey <String>
[-Session <LiveSession>]
-Status <StatusKind>
[-WidgetId] <String>
[<CommonParameters>]

Parameter set: FlowNode

Update-Console
[-Cut]
-EdgeKey <String>
[-Session <LiveSession>]
-Status <StatusKind>
[-WidgetId] <String>
[<CommonParameters>]

Parameter set: FlowEdge

Update-Console
[-Detail <Object>]
[-DurationSeconds <Double>]
-Index <Int32[]>
[-Label <Object>]
[-Run] <LiveRun>
-Status <StatusKind>
[<CommonParameters>]

Parameter set: Run

Description

WidgetId is position zero. Fields are checked against the resolved widget before any events are posted. Structural sets separate table rows, cell batches, content replacement and run items. Unknown targets and unsupported fields are terminating errors.

Examples

Example 1

Update-Console build -Value 5 -Total 20 -Label 'Compile'

Advance a build and change its label

Example 2

Update-Console -Run $run -Index 0 -Status Pass -Detail 'Uploaded'

Finish one run item

Parameters

-Complete SwitchParameter optionalsets: Fields: Finishes the activity or lane.
-Counter IDictionary optionalsets: Fields: Summary labels mapped to nonnegative integer counts.
-Detail Object optionalsets: Fields, Run: The replacement detail.
-Increment Double optionalsets: Fields: The additive change; cannot be combined with Value.
-Key String required in RemoveRowsets: Fields, Append, RemoveRow: The item key; RemoveRow requires it.
-Label Object optionalsets: Fields, Run: The replacement label or current run phase.
-ParentKey String optionalsets: Fields: The parent activity key.
-RemainingSeconds Double optionalsets: Fields: The estimated remaining time, in seconds.
-Restart SwitchParameter optionalsets: Fields: Restarts an indeterminate progress indicator.
-Result StatusKind optionalsets: Fields: The result of completed lane steps.; Possible values: Pending, Running, Pass, Fail, Warn, Skip, Info
-Session LiveSession optionalsets: Fields, Append, Row, RemoveRow, ClearRows, Cells, AppendCells, ResizeCells, Content, FlowNode, FlowEdge: The session, otherwise ConsoleSession or the current session.
-Status StatusKind required in Cells, FlowNode, FlowEdge, Runsets: Fields, Cells, AppendCells, FlowNode, FlowEdge, Run: The new state.; Possible values: Pending, Running, Pass, Fail, Warn, Skip, Info
-Total Double optionalsets: Fields: The planned total; zero means unknown.
-Value Object required in Appendsets: Fields, Append: The absolute value or appended numeric sample.
-WidgetId String requiredposition: 0sets: Fields, Append, Row, RemoveRow, ClearRows, Cells, AppendCells, ResizeCells, Content, FlowNode, FlowEdge: The live widget identifier.
-Append SwitchParameter requiredsets: Append: Appends Value as a chart sample.
-Row Object requiredpipeline: True (ByValue)sets: Row: A row with Key and Values properties, retaining typed cells.
-RemoveRow SwitchParameter requiredsets: RemoveRow: Removes the row addressed by Key.
-ClearRows SwitchParameter requiredsets: ClearRows: Clears all live table rows.
-Index Int32[] requiredsets: Cells, Run: Zero-based cells; the Run set requires exactly one index.
-AppendCells SwitchParameter requiredsets: AppendCells: Appends outcome cells.
-Count Int32 optionalsets: AppendCells: The number of appended cells; default one.
-CellCount Int32 requiredsets: ResizeCells: The new cell count, at least one.
-Content Object requiredpipeline: True (ByValue)sets: Content: The replacement widget or a script block producing widgets; null clears the region.
-NodeKey String requiredsets: FlowNode: The flow node whose status changes.
-Cut SwitchParameter optionalsets: FlowEdge: Severs the edge; Cut:$false reconnects it. Omission preserves connectivity.
-EdgeKey String requiredsets: FlowEdge: The flow edge whose status or connectivity changes.
-DurationSeconds Double optionalsets: Run: The measured run duration in seconds.
-Run LiveRun requiredposition: 0sets: Run: The caller-managed run handle.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.