Interface IAutomationTaskService

A service for managing automation tasks, including task retrieval, dynamic instantiation, configuration mapping, and lifecycle operations.

Namespace: DataWeb.Automation

Assembly: DataWeb.Core.dll

Syntax

public interface IAutomationTaskService

Methods

GetTaskAsync(AutomationTaskFilter, CancellationToken)

Asynchronously retrieves the first automation task that matches the specified filter.

Declaration

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

Parameters

Type	Name	Description
AutomationTaskFilter	filter	The AutomationTaskFilter criteria used to retrieve the automation task.
CancellationToken	cancellationToken	A token to monitor for cancellation requests.

Returns

Type	Description
Task<AutomationTask>	A task that represents the asynchronous operation. The task result contains the first matching AutomationTask, or null if no matching task is found or if an error occurs during task instantiation.

GetTasksAsync(AutomationTaskFilter, CancellationToken)

Asynchronously retrieves all automation tasks that match the specified filter.

Declaration

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

Parameters

Type	Name	Description
AutomationTaskFilter	filter	The AutomationTaskFilter criteria used to retrieve automation tasks.
CancellationToken	cancellationToken	A token to monitor for cancellation requests.

Returns

Type	Description
Task<IEnumerable<AutomationTask>>	A task that represents the asynchronous operation. The task result contains an enumerable collection of AutomationTask objects that match the specified criteria. Tasks that fail to instantiate are filtered out and do not appear in the result.

ResetExecutionEndDateAsync(string, CancellationToken)

Clears the execution end date for an automation task by setting it to null.

Declaration

Task ResetExecutionEndDateAsync(string taskIdMaster, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	taskIdMaster	The unique master identifier of the task to update.
CancellationToken	cancellationToken	A token to monitor for cancellation requests.

Returns

Type	Description
Task	A task that represents the asynchronous operation of resetting the execution end date.

SetStatusAsync(string, AutomationTaskStatus, CancellationToken)

Updates the current status of an automation task to the specified value.

Declaration

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

Parameters

Type	Name	Description
string	taskIdMaster	The unique master identifier of the task to update.
AutomationTaskStatus	status	The new AutomationTaskStatus value to assign to the task.
CancellationToken	cancellationToken	A token to monitor for cancellation requests.

Returns

Type	Description
Task	A task that represents the asynchronous operation of updating the task status.

UpdateExecutionEndDateAsync(string, CancellationToken)

Updates the execution end date for an automation task to the current local time.

Declaration

Task UpdateExecutionEndDateAsync(string taskIdMaster, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	taskIdMaster	The unique master identifier of the task to update.
CancellationToken	cancellationToken	A token to monitor for cancellation requests.

Returns

Type	Description
Task	A task that represents the asynchronous operation of updating the execution end date.

UpdateExecutionStartDateAsync(string, CancellationToken)

Updates the execution start date for an automation task to the current local time.

Declaration

Task UpdateExecutionStartDateAsync(string taskIdMaster, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	taskIdMaster	The unique master identifier of the task to update.
CancellationToken	cancellationToken	A token to monitor for cancellation requests.

Returns

Type	Description
Task	A task that represents the asynchronous operation of updating the execution start date.