IReportingStep Methods

Docs / Reference / Search C# APIs / Aspire.Hosting / IReportingStep / Methods

Methods

Docs Reference Search C# APIs Aspire.Hosting IReportingStep Methods

Interface Methods 7 members

Represents a publishing step, which can contain multiple tasks.

CompleteAsync(string, CompletionState, CancellationToken) abstract Task

Completes the step with the specified completion text and state.

public interface IReportingStep
{
    public abstract Task CompleteAsync(
        string completionText,
        CompletionState completionState = CompletionState.Completed,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

Parameters

completionText string The completion text for the step.

completionState CompletionState optional The completion state for the step.

cancellationToken CancellationToken optional The cancellation token.

CompleteAsync(MarkdownString, CompletionState, CancellationToken) abstract Task

Completes the step with Markdown-formatted completion text and the specified state.

public interface IReportingStep
{
    public abstract Task CompleteAsync(
        MarkdownString completionText,
        CompletionState completionState = CompletionState.Completed,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

Parameters

completionText MarkdownString The Markdown-formatted completion text for the step.

completionState CompletionState optional The completion state for the step.

cancellationToken CancellationToken optional The cancellation token.

CreateTaskAsync(string, CancellationToken) abstract Task<IReportingTask>

Creates a new task within this step.

public interface IReportingStep
{
    public abstract Task<IReportingTask> CreateTaskAsync(
        string statusText,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

Parameters

statusText string The initial status text for the task.

cancellationToken CancellationToken optional The cancellation token.

Returns

Task<IReportingTask> The created task.

CreateTaskAsync(MarkdownString, CancellationToken) abstract Task<IReportingTask>

Creates a new task within this step with Markdown-formatted status text.

public interface IReportingStep
{
    public abstract Task<IReportingTask> CreateTaskAsync(
        MarkdownString statusText,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

Parameters

statusText MarkdownString The initial Markdown-formatted status text for the task.

cancellationToken CancellationToken optional The cancellation token.

Returns

Task<IReportingTask> The created task.

Obsolete — Use Log(LogLevel, string) or Log(LogLevel, MarkdownString) instead.

Log(LogLevel, string, bool) abstract

Logs a message at the specified level within this step.

public interface IReportingStep
{
    public abstract void Log(
        LogLevel logLevel,
        string message,
        bool enableMarkdown)
    {
        // ...
    }
}

Parameters

logLevel LogLevel The log level for the message.

message string The message to log.

enableMarkdown bool Whether to enable Markdown formatting for the message.

Log(LogLevel, string) abstract

Logs a plain-text message at the specified level within this step.

public interface IReportingStep
{
    public abstract void Log(
        LogLevel logLevel,
        string message)
    {
        // ...
    }
}

Parameters

logLevel LogLevel The log level for the message.

message string The plain-text message to log.

Log(LogLevel, MarkdownString) abstract

Logs a Markdown-formatted message at the specified level within this step.

public interface IReportingStep
{
    public abstract void Log(
        LogLevel logLevel,
        MarkdownString message)
    {
        // ...
    }
}

Parameters

logLevel LogLevel The log level for the message.

message MarkdownString The Markdown-formatted message to log.