Class JobStore
Manages job persistence and logging in Azure Cosmos DB.
Implements
Inherited Members
Namespace: DataWeb.Worker.AzureCosmosDB
Assembly: DataWeb.Data.AzureCosmosDB.dll
Syntax
public class JobStore : IJobStoreConstructors
JobStore(ICosmosHelper, IEnvironmentService, IConfigurationService, TimeProvider)
Manages job persistence and logging in Azure Cosmos DB.
Declaration
public JobStore(ICosmosHelper cosmosHelper, IEnvironmentService environmentService, IConfigurationService configurationService, TimeProvider timeProvider)Parameters
| Type | Name | Description |
|---|---|---|
| ICosmosHelper | cosmosHelper | |
| IEnvironmentService | environmentService | |
| IConfigurationService | configurationService | |
| TimeProvider | timeProvider |
Properties
Name
Gets the name of the store implementation.
Declaration
public string Name { get; }Property Value
| Type | Description |
|---|---|
| string |
Methods
ConvertStatusToString(JobStatus)
Declaration
public static string ConvertStatusToString(JobStatus status)Parameters
| Type | Name | Description |
|---|---|---|
| JobStatus | status |
Returns
| Type | Description |
|---|---|
| string |
ExistsInStatusAsync(string, JobStatus, CancellationToken)
Checks if a job with the specified name exists in the given status.
Declaration
public Task<bool> ExistsInStatusAsync(string name, JobStatus status, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | The name of the job to search for. |
| JobStatus | status | The job status to match. |
| CancellationToken | cancellationToken | Cancellation token. |
Returns
| Type | Description |
|---|---|
| Task<bool> | True if a job with the specified name and status exists; otherwise false. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | Thrown when name is null or empty. |
GetJobAsync(JobFilter, CancellationToken)
Retrieves a single job matching the specified filter criteria.
Declaration
public Task<Job> GetJobAsync(JobFilter filter, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| JobFilter | filter | The filter criteria for the job. |
| CancellationToken | cancellationToken | Cancellation token. |
Returns
| Type | Description |
|---|---|
| Task<Job> | The first job matching the filter, or null if no match found. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | Thrown when filter is null. |
GetJobsAsync(JobFilter, CancellationToken)
Retrieves jobs matching the specified filter criteria.
Declaration
public Task<IEnumerable<Job>> GetJobsAsync(JobFilter filter, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| JobFilter | filter | The filter criteria for jobs. |
| CancellationToken | cancellationToken | Cancellation token. |
Returns
| Type | Description |
|---|---|
| Task<IEnumerable<Job>> | A collection of jobs matching the filter. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | Thrown when filter is null. |
GetLogAsync(string, CancellationToken)
Retrieves the complete log file for a job.
Declaration
public Task<string> GetLogAsync(string jobId, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | jobId | The ID of the job. |
| CancellationToken | cancellationToken | Cancellation token. |
Returns
| Type | Description |
|---|---|
| Task<string> | The complete log file content as a string. |
SetJobAsync(string, int, JobStatus, List<Parameter>, CancellationToken)
Creates a new job with the specified parameters.
Declaration
public Task<string> SetJobAsync(string name, int total, JobStatus status, List<Parameter> parameters = null, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | The name of the job. |
| int | total | The total number of items to process. |
| JobStatus | status | The initial job status. |
| List<Parameter> | parameters | Optional job parameters. |
| CancellationToken | cancellationToken | Cancellation token. |
Returns
| Type | Description |
|---|---|
| Task<string> | The ID of the newly created job. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | Thrown when name is null or empty. |
SetStatusAsync(string, JobStatus, CancellationToken)
Updates the status of a job and sets the end date if completed or cancelled.
Declaration
public Task SetStatusAsync(string jobId, JobStatus status, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | jobId | The ID of the job to update. |
| JobStatus | status | The new job status. |
| CancellationToken | cancellationToken | Cancellation token. |
Returns
| Type | Description |
|---|---|
| Task |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | Thrown when jobId is null or empty. |
UpdateEntryAsync(string, int, int, CancellationToken)
Updates the progress and error count for a job.
Declaration
public Task UpdateEntryAsync(string jobId, int progress, int errors, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | jobId | The ID of the job to update. |
| int | progress | The current progress value. |
| int | errors | The current error count. |
| CancellationToken | cancellationToken | Cancellation token. |
Returns
| Type | Description |
|---|---|
| Task |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | Thrown when jobId is null or empty. |
UpdateTextLogAsync(string, string, CancellationToken)
Appends a line to the job's log file.
Declaration
public Task UpdateTextLogAsync(string jobId, string line, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | jobId | The ID of the job. |
| string | line | The line to append to the log. |
| CancellationToken | cancellationToken | Cancellation token. |
Returns
| Type | Description |
|---|---|
| Task |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | Thrown when jobId is null or empty. |