Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

ReportingStep

Interface
📦 Aspire.Hosting v17.0.0

Represents a publishing step, which can contain multiple tasks.

type ReportingStep interface{}

Methods

Completes the reporting step with plain-text completion text.
CompleteStep(
completionText string,
options ...*CompleteStepOptions,
) error
completionTextstring
options...*CompleteStepOptionsOptional settings, described under Options.

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

CompletionState*string
CancellationToken*CancellationToken
error

Returns error.

Completes the reporting step with Markdown-formatted completion text.
CompleteStepMarkdown(
markdownString string,
options ...*CompleteStepMarkdownOptions,
) error
markdownStringstring
options...*CompleteStepMarkdownOptionsOptional settings, described under Options.

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

CompletionState*string
CancellationToken*CancellationToken
error

Returns error.

Creates a reporting task with Markdown-formatted status text.
CreateMarkdownTask(
markdownString string,
options ...*CreateMarkdownTaskOptions,
) ReportingTask
markdownStringstring
options...*CreateMarkdownTaskOptionsOptional settings, described under Options.

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

CancellationToken*CancellationToken
ReportingTask

Returns a handle; failures surface later via Err().

Creates a reporting task with plain-text status text.
CreateTask(
statusText string,
options ...*CreateTaskOptions,
) ReportingTask
statusTextstring
options...*CreateTaskOptionsOptional settings, described under Options.

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

CancellationToken*CancellationToken
ReportingTask

Returns a handle; failures surface later via Err().

methodLogStep
Logs a plain-text message for the reporting step.
LogStep(
level string,
message string,
) error
levelstring
messagestring
error

Returns error.

Logs a Markdown-formatted message for the reporting step.
LogStepMarkdown(
level string,
markdownString string,
) error
levelstring
markdownStringstring
error

Returns error.

Applies to

This interface applies to the following types: