21.286. Class GrpcResultsService
Namespace: ArmoniK.Core.Common.gRPC.Services
Assembly: ArmoniK.Core.Common.dll
The ResultsService provides methods for interacting with results
[Authorize(AuthenticationSchemes = "ArmoniKAuthenticationScheme")]
public class GrpcResultsService : Results.ResultsBase
21.286.1. Inheritance
object ← Results.ResultsBase ← GrpcResultsService
21.286.2. Inherited Members
Results.ResultsBase.ListResults(ListResultsRequest, ServerCallContext), Results.ResultsBase.GetResult(GetResultRequest, ServerCallContext), Results.ResultsBase.GetOwnerTaskId(GetOwnerTaskIdRequest, ServerCallContext), Results.ResultsBase.CreateResultsMetaData(CreateResultsMetaDataRequest, ServerCallContext), Results.ResultsBase.CreateResults(CreateResultsRequest, ServerCallContext), Results.ResultsBase.UploadResultData(IAsyncStreamReader<UploadResultDataRequest>, ServerCallContext), Results.ResultsBase.DownloadResultData(DownloadResultDataRequest, IServerStreamWriter<DownloadResultDataResponse>, ServerCallContext), Results.ResultsBase.DeleteResultsData(DeleteResultsDataRequest, ServerCallContext), Results.ResultsBase.ImportResultsData(ImportResultsDataRequest, ServerCallContext), Results.ResultsBase.GetServiceConfiguration(Empty, ServerCallContext), Results.ResultsBase.WatchResults(IAsyncStreamReader<WatchResultRequest>, IServerStreamWriter<WatchResultResponse>, ServerCallContext), object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()
21.286.3. Constructors
21.286.3.1. GrpcResultsService(IResultTable, ITaskTable, ISessionTable, IObjectStorage, IPushQueueStorage, FunctionExecutionMetrics<GrpcResultsService>, Submitter, ILogger<GrpcResultsService>)
Initializes a new instance of the
public GrpcResultsService(IResultTable resultTable, ITaskTable taskTable, ISessionTable sessionTable, IObjectStorage objectStorage, IPushQueueStorage pushQueueStorage, FunctionExecutionMetrics<GrpcResultsService> meter, Submitter options, ILogger<GrpcResultsService> logger)
21.286.3.1.1. Parameters
resultTable IResultTable
The result table for managing results.
taskTable ITaskTable
The task table for managing tasks.
sessionTable ISessionTable
The session table for managing sessions.
objectStorage IObjectStorage
The object storage for storing result data.
pushQueueStorage IPushQueueStorage
The interface to push tasks into the queue.
meter FunctionExecutionMetrics<GrpcResultsService>
The metrics for function execution.
options Submitter
The submitter options for configuration.
logger ILogger<GrpcResultsService>
The logger for logging information.
21.286.4. Methods
21.286.4.1. CreateResults(CreateResultsRequest, ServerCallContext)
Create one result with data included in the request
[RequiresPermission(typeof(GrpcResultsService), "CreateResults")]
public override Task<CreateResultsResponse> CreateResults(CreateResultsRequest request, ServerCallContext context)
21.286.4.1.1. Parameters
request CreateResultsRequest
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
21.286.4.1.2. Returns
Task<CreateResultsResponse>
The response to send back to the client (wrapped by a task).
21.286.4.2. CreateResultsMetaData(CreateResultsMetaDataRequest, ServerCallContext)
Create the metadata of multiple results at once Data have to be uploaded separately
[RequiresPermission(typeof(GrpcResultsService), "CreateResultsMetaData")]
public override Task<CreateResultsMetaDataResponse> CreateResultsMetaData(CreateResultsMetaDataRequest request, ServerCallContext context)
21.286.4.2.1. Parameters
request CreateResultsMetaDataRequest
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
21.286.4.2.2. Returns
Task<CreateResultsMetaDataResponse>
The response to send back to the client (wrapped by a task).
21.286.4.3. DeleteResultsData(DeleteResultsDataRequest, ServerCallContext)
Delete data from multiple results
[RequiresPermission(typeof(GrpcResultsService), "DeleteResultsData")]
public override Task<DeleteResultsDataResponse> DeleteResultsData(DeleteResultsDataRequest request, ServerCallContext context)
21.286.4.3.1. Parameters
request DeleteResultsDataRequest
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
21.286.4.3.2. Returns
Task<DeleteResultsDataResponse>
The response to send back to the client (wrapped by a task).
21.286.4.4. DownloadResultData(DownloadResultDataRequest, IServerStreamWriter<DownloadResultDataResponse>, ServerCallContext)
Retrieve data
[RequiresPermission(typeof(GrpcResultsService), "DownloadResultData")]
public override Task DownloadResultData(DownloadResultDataRequest request, IServerStreamWriter<DownloadResultDataResponse> responseStream, ServerCallContext context)
21.286.4.4.1. Parameters
request DownloadResultDataRequest
The request received from the client.
responseStream IServerStreamWriter<DownloadResultDataResponse>
Used for sending responses back to the client.
context ServerCallContext
The context of the server-side call handler being invoked.
21.286.4.4.2. Returns
A task indicating completion of the handler.
21.286.4.5. GetOwnerTaskId(GetOwnerTaskIdRequest, ServerCallContext)
Get the id of the task that should produce the result
[RequiresPermission(typeof(GrpcResultsService), "GetOwnerTaskId")]
public override Task<GetOwnerTaskIdResponse> GetOwnerTaskId(GetOwnerTaskIdRequest request, ServerCallContext context)
21.286.4.5.1. Parameters
request GetOwnerTaskIdRequest
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
21.286.4.5.2. Returns
Task<GetOwnerTaskIdResponse>
The response to send back to the client (wrapped by a task).
21.286.4.6. GetResult(GetResultRequest, ServerCallContext)
Get a result by id.
[RequiresPermission(typeof(GrpcResultsService), "GetResult")]
public override Task<GetResultResponse> GetResult(GetResultRequest request, ServerCallContext context)
21.286.4.6.1. Parameters
request GetResultRequest
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
21.286.4.6.2. Returns
Task<GetResultResponse>
The response to send back to the client (wrapped by a task).
21.286.4.7. GetServiceConfiguration(Empty, ServerCallContext)
Get the configuration of the service
[RequiresPermission(typeof(GrpcResultsService), "GetServiceConfiguration")]
public override Task<ResultsServiceConfigurationResponse> GetServiceConfiguration(Empty request, ServerCallContext context)
21.286.4.7.1. Parameters
request Empty
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
21.286.4.7.2. Returns
Task<ResultsServiceConfigurationResponse>
The response to send back to the client (wrapped by a task).
21.286.4.8. ImportResultsData(ImportResultsDataRequest, ServerCallContext)
Import existing data from the object storage into existing results
[RequiresPermission(typeof(GrpcResultsService), "ImportResultsData")]
public override Task<ImportResultsDataResponse> ImportResultsData(ImportResultsDataRequest request, ServerCallContext context)
21.286.4.8.1. Parameters
request ImportResultsDataRequest
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
21.286.4.8.2. Returns
Task<ImportResultsDataResponse>
The response to send back to the client (wrapped by a task).
21.286.4.9. ListResults(ListResultsRequest, ServerCallContext)
Get a results list using pagination, filters and sorting
[RequiresPermission(typeof(GrpcResultsService), "ListResults")]
public override Task<ListResultsResponse> ListResults(ListResultsRequest request, ServerCallContext context)
21.286.4.9.1. Parameters
request ListResultsRequest
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
21.286.4.9.2. Returns
Task<ListResultsResponse>
The response to send back to the client (wrapped by a task).
21.286.4.10. UploadResultData(IAsyncStreamReader<UploadResultDataRequest>, ServerCallContext)
Upload data for result with stream
[RequiresPermission(typeof(GrpcResultsService), "UploadResultData")]
public override Task<UploadResultDataResponse> UploadResultData(IAsyncStreamReader<UploadResultDataRequest> requestStream, ServerCallContext context)
21.286.4.10.1. Parameters
requestStream IAsyncStreamReader<UploadResultDataRequest>
Used for reading requests from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
21.286.4.10.2. Returns
Task<UploadResultDataResponse>
The response to send back to the client (wrapped by a task).