Class JobResult<TResult>

a wrapper for holding a job execution result as well as any progress details.

Inheritance

object

JobResult<TResult>

Implements

IJobResult

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: FastEndpoints

Assembly: FastEndpoints.dll

Syntax

public class JobResult<TResult> : IJobResult where TResult : notnull

Type Parameters

Name	Description
TResult	the type of the end result

Constructors

JobResult(int)

a wrapper for holding a job execution result as well as any progress details.

Declaration

public JobResult(int totalSteps)

Parameters

Type	Name	Description
int	totalSteps	the total number of steps the job is expected to have

Properties

CurrentStatus

the current status

Declaration

public string? CurrentStatus { get; set; }

Property Value

Type	Description
string

CurrentStep

the number of steps currently completed

Declaration

public int CurrentStep { get; set; }

Property Value

Type	Description
int

IsComplete

returns true if either the result is ready or if all the steps are complete.

Declaration

public bool IsComplete { get; }

Property Value

Type	Description
bool

ProgressPercentage

the percentage of steps currently completed

Declaration

public int ProgressPercentage { get; }

Property Value

Type	Description
int

Result

the end result

Declaration

public TResult? Result { get; set; }

Property Value

Type	Description
TResult

TotalSteps

the number of total steps to be completed

Declaration

public int TotalSteps { get; set; }

Property Value

Type	Description
int

Implements

IJobResult