Interface IJobs

Namespace
Cratis.Chronicle.Jobs
Assembly
Cratis.Chronicle.dll

Defines the system for working with jobs.

public interface IJobs
Extension Methods

Methods

Delete(JobId)

Deletes the Job with the specified jobId.

Task Delete(JobId jobId)

Parameters

jobId JobId

The job id.

Returns

Task

Awaitable task.

GetJob(JobId)

Gets the Job with the specified jobId.

Task<Job?> GetJob(JobId jobId)

Parameters

jobId JobId

The job id.

Returns

Task<Job>

The job.

GetJobs()

Gets all the Jobs.

Task<IEnumerable<Job>> GetJobs()

Returns

Task<IEnumerable<Job>>

The jobs.

Resume(JobId)

Resumes the Job with the specified jobId.

Task<JobCommandResult> Resume(JobId jobId)

Parameters

jobId JobId

The job id.

Returns

Task<JobCommandResult>

The JobCommandResult telling whether the job was taken forward, and why not when it was not.

Stop(JobId)

Stops the Job with the specified jobId.

Task<JobCommandResult> Stop(JobId jobId)

Parameters

jobId JobId

The job id.

Returns

Task<JobCommandResult>

The JobCommandResult telling whether the job took the stop, and why not when it did not.