Interface IAutomationTaskStore

Represents a store for automation tasks.

Namespace: DataWeb.Automation

Assembly: DataWeb.Core.dll

Syntax

public interface IAutomationTaskStore

Properties

Name

Gets the name of the automation task store.

Declaration

string Name { get; }

Property Value

Type	Description
string

Methods

GetTaskAsync(AutomationTaskFilter, CancellationToken)

Retrieves a single automation task data object that matches the specified filter criteria.

Declaration

Task<AutomationTaskData> GetTaskAsync(AutomationTaskFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
AutomationTaskFilter	filter	The AutomationTaskFilter to use when retrieving the automation task.
CancellationToken	cancellationToken

Returns

Type	Description
Task<AutomationTaskData>	A task that represents the asynchronous operation. The task result contains the automation task data object that matches the specified filter criteria.

GetTasksAsync(AutomationTaskFilter, CancellationToken)

Retrieves a list of automation task data objects that match the specified filter criteria.

Declaration

Task<IEnumerable<AutomationTaskData>> GetTasksAsync(AutomationTaskFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
AutomationTaskFilter	filter	The AutomationTaskFilter to use when retrieving automation tasks.
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<AutomationTaskData>>	A task that represents the asynchronous operation. The task result contains the list of automation task data objects that match the specified filter criteria.

SetExecutionEndDateAsync(string, DateTimeOffset?, CancellationToken)

Sets the execution end date for the automation task with the specified id.

Declaration

Task SetExecutionEndDateAsync(string taskIdMaster, DateTimeOffset? date, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	taskIdMaster	The master identifier of the task to update.
DateTimeOffset?	date	The execution end date to set.
CancellationToken	cancellationToken	A cancellation token to observe while waiting for the task to complete.

Returns

Type	Description
Task	A task that represents the asynchronous operation.

SetExecutionStartDateAsync(string, DateTimeOffset?, CancellationToken)

Sets the execution start date for the automation task with the specified id.

Declaration

Task SetExecutionStartDateAsync(string taskIdMaster, DateTimeOffset? date, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	taskIdMaster	The master identifier of the task to update.
DateTimeOffset?	date	The execution start date to set.
CancellationToken	cancellationToken	A cancellation token to observe while waiting for the task to complete.

Returns

Type	Description
Task	A task that represents the asynchronous operation.

SetStatusAsync(string, AutomationTaskStatus, CancellationToken)

Updates the status of the automation task with the specified master ID.

Declaration

Task SetStatusAsync(string taskIdMaster, AutomationTaskStatus status, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	taskIdMaster	The master identifier of the task to update.
AutomationTaskStatus	status	The new status to set for the task.
CancellationToken	cancellationToken	A cancellation token to observe while waiting for the task to complete.

Returns

Type	Description
Task	A task that represents the asynchronous operation.