IPipelineActivityReporter Methods

1. Docs
2. /Reference
3. /Search C# APIs
4. /Aspire.Hosting
5. /IPipelineActivityReporter
6. /Methods

InterfaceMethods4 members

Interface for reporting publishing activities.

CompletePublishAsync(PublishCompletionOptions?, CancellationToken)abstractTask

Signals that the entire publishing process has completed.

public interface IPipelineActivityReporter
{
    public abstract Task CompletePublishAsync(
        PublishCompletionOptions? options = null,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

Parameters

optionsPublishCompletionOptions?optionalThe options for completing the publishing process.

cancellationTokenCancellationTokenoptionalThe cancellation token.

Obsolete — Use CompletePublishAsync(PublishCompletionOptions?, CancellationToken) instead.

CompletePublishAsync(string?, CompletionState?, CancellationToken)abstractTask

Signals that the entire publishing process has completed.

public interface IPipelineActivityReporter
{
    public abstract Task CompletePublishAsync(
        string? completionMessage = null,
        CompletionState? completionState = null,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

Parameters

completionMessagestring?optionalThe completion message of the publishing process.

completionStateCompletionState?optionalThe completion state of the publishing process. When null, the state is automatically aggregated from all steps.

cancellationTokenCancellationTokenoptionalThe cancellation token.

CreateStepAsync(string, CancellationToken)abstractTask<IReportingStep>

Creates a new publishing step with the specified title.

public interface IPipelineActivityReporter
{
    public abstract Task<IReportingStep> CreateStepAsync(
        string title,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

IPipelineActivityReporter.cs#L31

Parameters

titlestringThe title of the publishing step.

cancellationTokenCancellationTokenoptionalThe cancellation token.

Returns

Task<IReportingStep>The publishing step

CreateStepAsync(string, string?, int, CancellationToken)virtualTask<IReportingStep>

Creates a new publishing step with optional hierarchy metadata.

public interface IPipelineActivityReporter
{
    public virtual Task<IReportingStep> CreateStepAsync(
        string title,
        string? parentStepId,
        int hierarchyLevel,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

IPipelineActivityReporter.cs#L31

Parameters

titlestringThe title of the publishing step.

parentStepIdstring?An optional identifier for the parent step.

hierarchyLevelintThe hierarchy level for display.

cancellationTokenCancellationTokenoptionalThe cancellation token.

Returns

Task<IReportingStep>The publishing step.