21.290. Class GrpcTasksService
Namespace: ArmoniK.Core.Common.gRPC.Services
Assembly: ArmoniK.Core.Common.dll
Service for handling tasks.
[Authorize(AuthenticationSchemes = "ArmoniKAuthenticationScheme")]
public class GrpcTasksService : Tasks.TasksBase
21.290.1. Inheritance
object ← Tasks.TasksBase ← GrpcTasksService
21.290.2. Inherited Members
Tasks.TasksBase.ListTasks(ListTasksRequest, ServerCallContext), Tasks.TasksBase.ListTasksDetailed(ListTasksRequest, ServerCallContext), Tasks.TasksBase.GetTask(GetTaskRequest, ServerCallContext), Tasks.TasksBase.CancelTasks(CancelTasksRequest, ServerCallContext), Tasks.TasksBase.GetResultIds(GetResultIdsRequest, ServerCallContext), Tasks.TasksBase.CountTasksByStatus(CountTasksByStatusRequest, ServerCallContext), Tasks.TasksBase.SubmitTasks(SubmitTasksRequest, ServerCallContext), object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()
21.290.3. Constructors
21.290.3.1. GrpcTasksService(ITaskTable, ISessionTable, IResultTable, IPushQueueStorage, FunctionExecutionMetrics<GrpcTasksService>, HttpClient, Submitter, ILogger<GrpcTasksService>)
Initializes a new instance of the
public GrpcTasksService(ITaskTable taskTable, ISessionTable sessionTable, IResultTable resultTable, IPushQueueStorage pushQueueStorage, FunctionExecutionMetrics<GrpcTasksService> meter, HttpClient httpClient, Submitter options, ILogger<GrpcTasksService> logger)
21.290.3.1.1. Parameters
taskTable ITaskTable
The task table for managing tasks.
sessionTable ISessionTable
The session table for managing sessions.
resultTable IResultTable
The result table for managing task inputs and outputs.
pushQueueStorage IPushQueueStorage
The interface to push tasks in the queue.
meter FunctionExecutionMetrics<GrpcTasksService>
The metrics for function execution.
httpClient HttpClient
The HTTP client for making requests.
options Submitter
The submitter options for task submission.
logger ILogger<GrpcTasksService>
The logger for logging information.
21.290.4. Methods
21.290.4.1. CancelTasks(CancelTasksRequest, ServerCallContext)
Cancel tasks using ids.
[RequiresPermission(typeof(GrpcTasksService), "CancelTasks")]
public override Task<CancelTasksResponse> CancelTasks(CancelTasksRequest request, ServerCallContext context)
21.290.4.1.1. Parameters
request CancelTasksRequest
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
21.290.4.1.2. Returns
Task<CancelTasksResponse>
The response to send back to the client (wrapped by a task).
21.290.4.2. CountTasksByStatus(CountTasksByStatusRequest, ServerCallContext)
Get count from tasks status.
[RequiresPermission(typeof(GrpcTasksService), "CountTasksByStatus")]
public override Task<CountTasksByStatusResponse> CountTasksByStatus(CountTasksByStatusRequest request, ServerCallContext context)
21.290.4.2.1. Parameters
request CountTasksByStatusRequest
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
21.290.4.2.2. Returns
Task<CountTasksByStatusResponse>
The response to send back to the client (wrapped by a task).
21.290.4.3. GetResultIds(GetResultIdsRequest, ServerCallContext)
Get ids of the result that tasks should produce.
[RequiresPermission(typeof(GrpcTasksService), "GetResultIds")]
public override Task<GetResultIdsResponse> GetResultIds(GetResultIdsRequest request, ServerCallContext context)
21.290.4.3.1. Parameters
request GetResultIdsRequest
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
21.290.4.3.2. Returns
Task<GetResultIdsResponse>
The response to send back to the client (wrapped by a task).
21.290.4.4. GetTask(GetTaskRequest, ServerCallContext)
Get a task by its id.
[RequiresPermission(typeof(GrpcTasksService), "GetTask")]
public override Task<GetTaskResponse> GetTask(GetTaskRequest request, ServerCallContext context)
21.290.4.4.1. Parameters
request GetTaskRequest
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
21.290.4.4.2. Returns
Task<GetTaskResponse>
The response to send back to the client (wrapped by a task).
21.290.4.5. ListTasks(ListTasksRequest, ServerCallContext)
Get a tasks list using pagination, filters and sorting.
[RequiresPermission(typeof(GrpcTasksService), "ListTasks")]
public override Task<ListTasksResponse> ListTasks(ListTasksRequest request, ServerCallContext context)
21.290.4.5.1. Parameters
request ListTasksRequest
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
21.290.4.5.2. Returns
Task<ListTasksResponse>
The response to send back to the client (wrapped by a task).
21.290.4.6. ListTasksDetailed(ListTasksRequest, ServerCallContext)
Get a tasks list using pagination, filters and sorting with complete metada.
[RequiresPermission(typeof(GrpcTasksService), "ListTasksDetailed")]
public override Task<ListTasksDetailedResponse> ListTasksDetailed(ListTasksRequest request, ServerCallContext context)
21.290.4.6.1. Parameters
request ListTasksRequest
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
21.290.4.6.2. Returns
Task<ListTasksDetailedResponse>
The response to send back to the client (wrapped by a task).
21.290.4.7. SubmitTasks(SubmitTasksRequest, ServerCallContext)
Create tasks metadata and submit task for processing.
[RequiresPermission(typeof(GrpcTasksService), "SubmitTasks")]
public override Task<SubmitTasksResponse> SubmitTasks(SubmitTasksRequest request, ServerCallContext context)
21.290.4.7.1. Parameters
request SubmitTasksRequest
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
21.290.4.7.2. Returns
Task<SubmitTasksResponse>
The response to send back to the client (wrapped by a task).