Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

ReportingTask

Interface
📦 Aspire.Hosting v17.0.0

Represents a publishing task, which belongs to a step.

type ReportingTask interface{}

Methods

Completes the reporting task with plain-text completion text.
CompleteTask(options ...*CompleteTaskOptions) error
options...*CompleteTaskOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*CompleteTaskOptions argument.

CompletionMessage*string
CompletionState*string
CancellationToken*CancellationToken
error

Returns error.

Completes the reporting task with Markdown-formatted completion text.
CompleteTaskMarkdown(
markdownString string,
options ...*CompleteTaskMarkdownOptions,
) error
markdownStringstring
options...*CompleteTaskMarkdownOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*CompleteTaskMarkdownOptions argument.

CompletionState*string
CancellationToken*CancellationToken
error

Returns error.

Updates the reporting task with plain-text status text.
UpdateTask(
statusText string,
options ...*UpdateTaskOptions,
) error
statusTextstring
options...*UpdateTaskOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*UpdateTaskOptions argument.

CancellationToken*CancellationToken
error

Returns error.

Updates the reporting task with Markdown-formatted status text.
UpdateTaskMarkdown(
markdownString string,
options ...*UpdateTaskMarkdownOptions,
) error
markdownStringstring
options...*UpdateTaskMarkdownOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*UpdateTaskMarkdownOptions argument.

CancellationToken*CancellationToken
error

Returns error.

Applies to

This interface applies to the following types: