Class Results.ResultsBase
Namespace: ArmoniK.Api.gRPC.V1.Results
Assembly: ArmoniK.Api.Core.dll
Base class for server-side implementations of Results
[BindServiceMethod(typeof(Results), "BindService")]
public abstract class Results.ResultsBase
Inheritance
Inherited Members
object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()
Methods
CreateResults(CreateResultsRequest, ServerCallContext)
Create one result with data included in the request
public virtual Task<CreateResultsResponse> CreateResults(CreateResultsRequest request, ServerCallContext context)
Parameters
request CreateResultsRequest
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
Returns
Task<CreateResultsResponse>
The response to send back to the client (wrapped by a task).
CreateResultsMetaData(CreateResultsMetaDataRequest, ServerCallContext)
Create the metadata of multiple results at once Data have to be uploaded separately
public virtual Task<CreateResultsMetaDataResponse> CreateResultsMetaData(CreateResultsMetaDataRequest request, ServerCallContext context)
Parameters
request CreateResultsMetaDataRequest
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
Returns
Task<CreateResultsMetaDataResponse>
The response to send back to the client (wrapped by a task).
DeleteResultsData(DeleteResultsDataRequest, ServerCallContext)
Delete data from multiple results
public virtual Task<DeleteResultsDataResponse> DeleteResultsData(DeleteResultsDataRequest request, ServerCallContext context)
Parameters
request DeleteResultsDataRequest
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
Returns
Task<DeleteResultsDataResponse>
The response to send back to the client (wrapped by a task).
DownloadResultData(DownloadResultDataRequest, IServerStreamWriter<DownloadResultDataResponse>, ServerCallContext)
Retrieve data
public virtual Task DownloadResultData(DownloadResultDataRequest request, IServerStreamWriter<DownloadResultDataResponse> responseStream, ServerCallContext context)
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.
Returns
A task indicating completion of the handler.
GetOwnerTaskId(GetOwnerTaskIdRequest, ServerCallContext)
Get the id of the task that should produce the result
public virtual Task<GetOwnerTaskIdResponse> GetOwnerTaskId(GetOwnerTaskIdRequest request, ServerCallContext context)
Parameters
request GetOwnerTaskIdRequest
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
Returns
Task<GetOwnerTaskIdResponse>
The response to send back to the client (wrapped by a task).
GetResult(GetResultRequest, ServerCallContext)
Get a result by id.
public virtual Task<GetResultResponse> GetResult(GetResultRequest request, ServerCallContext context)
Parameters
request GetResultRequest
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
Returns
Task<GetResultResponse>
The response to send back to the client (wrapped by a task).
GetServiceConfiguration(Empty, ServerCallContext)
Get the configuration of the service
public virtual Task<ResultsServiceConfigurationResponse> GetServiceConfiguration(Empty request, ServerCallContext context)
Parameters
request Empty
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
Returns
Task<ResultsServiceConfigurationResponse>
The response to send back to the client (wrapped by a task).
ImportResultsData(ImportResultsDataRequest, ServerCallContext)
Import existing data from the object storage into existing results
public virtual Task<ImportResultsDataResponse> ImportResultsData(ImportResultsDataRequest request, ServerCallContext context)
Parameters
request ImportResultsDataRequest
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
Returns
Task<ImportResultsDataResponse>
The response to send back to the client (wrapped by a task).
ListResults(ListResultsRequest, ServerCallContext)
Get a results list using pagination, filters and sorting
public virtual Task<ListResultsResponse> ListResults(ListResultsRequest request, ServerCallContext context)
Parameters
request ListResultsRequest
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
Returns
Task<ListResultsResponse>
The response to send back to the client (wrapped by a task).
UploadResultData(IAsyncStreamReader<UploadResultDataRequest>, ServerCallContext)
Upload data for result with stream
public virtual Task<UploadResultDataResponse> UploadResultData(IAsyncStreamReader<UploadResultDataRequest> requestStream, ServerCallContext context)
Parameters
requestStream IAsyncStreamReader<UploadResultDataRequest>
Used for reading requests from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
Returns
Task<UploadResultDataResponse>
The response to send back to the client (wrapped by a task).
WatchResults(IAsyncStreamReader<WatchResultRequest>, IServerStreamWriter<WatchResultResponse>, ServerCallContext)
This endpoint allows a user to watch a list of results and be notified when there is any change. The user sends the list of ids they want to watch. The submitter will then send the statuses for all requested ids immediately and keep the stream open. Ids not present in DB will be returned at that time with the special state NOTFOUND. The submitter will send updates to the client via the opened stream. Any reply can be implicitely chunked if there are too many event to report at the same time (or for the first reply). It is possible to filter out specific statuses from events.
public virtual Task WatchResults(IAsyncStreamReader<WatchResultRequest> requestStream, IServerStreamWriter<WatchResultResponse> responseStream, ServerCallContext context)
Parameters
requestStream IAsyncStreamReader<WatchResultRequest>
Used for reading requests from the client.
responseStream IServerStreamWriter<WatchResultResponse>
Used for sending responses back to the client.
context ServerCallContext
The context of the server-side call handler being invoked.
Returns
A task indicating completion of the handler.