Class FailureScenarioStartResult
- Namespace
- ReferenceApplication.Web.Governance.FailureScenarios
- Assembly
- ReferenceApplication.Web.dll
The result of asking to run a scenario.
public sealed record FailureScenarioStartResult : IEquatable<FailureScenarioStartResult>
- Inheritance
-
FailureScenarioStartResult
- Implements
- Inherited Members
Constructors
FailureScenarioStartResult(FailureScenarioRunState?, FailureScenarioTamperingReport?, int?, string?)
The result of asking to run a scenario.
public FailureScenarioStartResult(FailureScenarioRunState? Run, FailureScenarioTamperingReport? Tampering, int? ErrorStatusCode, string? ErrorMessage)
Parameters
RunFailureScenarioRunStateThe armed run, for a scenario that sends a governed request.
TamperingFailureScenarioTamperingReportThe result, for the evidence-tampering scenario, which sends no request.
ErrorStatusCodeint?The status code to answer with when the scenario cannot run.
ErrorMessagestringWhy the scenario cannot run.
Properties
ErrorMessage
Why the scenario cannot run.
public string? ErrorMessage { get; init; }
Property Value
ErrorStatusCode
The status code to answer with when the scenario cannot run.
public int? ErrorStatusCode { get; init; }
Property Value
- int?
Run
The armed run, for a scenario that sends a governed request.
public FailureScenarioRunState? Run { get; init; }
Property Value
Tampering
The result, for the evidence-tampering scenario, which sends no request.
public FailureScenarioTamperingReport? Tampering { get; init; }
Property Value
Methods
Armed(FailureScenarioRunState)
Creates a result for an armed run.
public static FailureScenarioStartResult Armed(FailureScenarioRunState run)
Parameters
runFailureScenarioRunStateThe armed run.
Returns
- FailureScenarioStartResult
The result.
Refused(int, string)
Creates a result for a scenario that cannot run.
public static FailureScenarioStartResult Refused(int statusCode, string message)
Parameters
Returns
- FailureScenarioStartResult
The result.
Tampered(FailureScenarioTamperingReport)
Creates a result for a completed tampering check.
public static FailureScenarioStartResult Tampered(FailureScenarioTamperingReport report)
Parameters
reportFailureScenarioTamperingReportThe tampering report.
Returns
- FailureScenarioStartResult
The result.