IExecutionConfigurationBuilder Methods

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

InterfaceMethods2 members

Builder for gathering and resolving the execution configuration (arguments and environment variables) for a specific resource.

AddExecutionConfigurationGatherer(IExecutionConfigurationGatherer)abstractIExecutionConfigurationBuilder

Adds a configuration gatherer to the builder.

public interface IExecutionConfigurationBuilder
{
    public abstract IExecutionConfigurationBuilder AddExecutionConfigurationGatherer(
        IExecutionConfigurationGatherer gatherer)
    {
        // ...
    }
}

Parameters

gathererIExecutionConfigurationGathererThe configuration gatherer to add.

Returns

IExecutionConfigurationBuilderThe current instance of the builder.

BuildAsync(DistributedApplicationExecutionContext, ILogger?, CancellationToken)abstractTask<IExecutionConfigurationResult>

Builds the processed resource configuration (resolved arguments and environment variables).

public interface IExecutionConfigurationBuilder
{
    public abstract Task<IExecutionConfigurationResult> BuildAsync(
        DistributedApplicationExecutionContext executionContext,
        ILogger? resourceLogger = null,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

Parameters

executionContextDistributedApplicationExecutionContextThe distributed application execution context.

resourceLoggerILogger?optionalA logger instance for the resource. If none is provided, a default logger will be used.

cancellationTokenCancellationTokenoptionalA cancellation token.

Returns

Task<IExecutionConfigurationResult>The resource configuration result. Any exceptions that occurred while processing are available via the IExecutionConfigurationResult.Exception property.