ParameterProcessor Methods

ClassMethods4 members

Handles processing of parameter resources during application orchestration.

DeleteParameterAsync(ParameterResource, CancellationToken)Task

Prompts the user to delete a parameter value.

public sealed class ParameterProcessor
{
    public Task DeleteParameterAsync(
        ParameterResource parameterResource,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

ParameterProcessor.cs#L379-L410

Parameters

parameterResourceParameterResourceThe parameter resource to delete the value for.

cancellationTokenCancellationTokenoptionalThe cancellation token to observe while waiting for the interaction to complete.

Returns

TaskA task that completes when the user has deleted the value or canceled the interaction.

InitializeParametersAsync(IEnumerable<ParameterResource>, bool)Task

Initializes parameter resources and handles unresolved parameters if interaction service is available.

public sealed class ParameterProcessor
{
    public Task InitializeParametersAsync(
        IEnumerable<ParameterResource> parameterResources,
        bool waitForResolution = false)
    {
        // ...
    }
}

ParameterProcessor.cs

Parameters

parameterResourcesIEnumerable<ParameterResource>The parameter resources to initialize.

waitForResolutionbooloptionalWhether to wait for all parameters to be resolved before completing the returned Task.

Returns

TaskA task that completes when all parameters are resolved (if waitForResolution is true) or when initialization is complete.

InitializeParametersAsync(DistributedApplicationModel, bool, CancellationToken)Task

Initializes parameter resources by collecting dependent parameters from the distributed application model and handles unresolved parameters if interaction service is available.

public sealed class ParameterProcessor
{
    public Task InitializeParametersAsync(
        DistributedApplicationModel model,
        bool waitForResolution = false,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

ParameterProcessor.cs

Parameters

modelDistributedApplicationModelThe distributed application model to collect parameters from.

waitForResolutionbooloptionalWhether to wait for all parameters to be resolved before completing the returned Task.

cancellationTokenCancellationTokenoptionalThe cancellation token to observe while waiting for parameters to be resolved.

Returns

TaskA task that completes when all parameters are resolved (if waitForResolution is true) or when initialization is complete.

SetParameterAsync(ParameterResource, CancellationToken)Task

Prompts the user to set a value for a single parameter.

public sealed class ParameterProcessor
{
    public Task SetParameterAsync(
        ParameterResource parameterResource,
        CancellationToken cancellationToken = default(CancellationToken))
    {
        // ...
    }
}

ParameterProcessor.cs#L334-L369

Parameters

parameterResourceParameterResourceThe parameter resource to set the value for.

cancellationTokenCancellationTokenoptionalThe cancellation token to observe while waiting for the interaction to complete.

Returns

TaskA task that completes when the user has set the value or canceled the interaction.