Class Sessions.SessionsBase
Namespace: ArmoniK.Api.gRPC.V1.Sessions
Assembly: ArmoniK.Api.Core.dll
Base class for server-side implementations of Sessions
[BindServiceMethod(typeof(Sessions), "BindService")]
public abstract class Sessions.SessionsBase
Inheritance
Inherited Members
object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()
Methods
CancelSession(CancelSessionRequest, ServerCallContext)
Cancel a session by its id.
public virtual Task<CancelSessionResponse> CancelSession(CancelSessionRequest request, ServerCallContext context)
Parameters
request CancelSessionRequest
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
Returns
Task<CancelSessionResponse>
The response to send back to the client (wrapped by a task).
CloseSession(CloseSessionRequest, ServerCallContext)
Close a session by its id..
public virtual Task<CloseSessionResponse> CloseSession(CloseSessionRequest request, ServerCallContext context)
Parameters
request CloseSessionRequest
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
Returns
Task<CloseSessionResponse>
The response to send back to the client (wrapped by a task).
CreateSession(CreateSessionRequest, ServerCallContext)
Create a session
public virtual Task<CreateSessionReply> CreateSession(CreateSessionRequest request, ServerCallContext context)
Parameters
request CreateSessionRequest
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
Returns
Task<CreateSessionReply>
The response to send back to the client (wrapped by a task).
DeleteSession(DeleteSessionRequest, ServerCallContext)
Delete a session by its id. Removes metadata from Results, Sessions and Tasks associated to the session.
public virtual Task<DeleteSessionResponse> DeleteSession(DeleteSessionRequest request, ServerCallContext context)
Parameters
request DeleteSessionRequest
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
Returns
Task<DeleteSessionResponse>
The response to send back to the client (wrapped by a task).
GetSession(GetSessionRequest, ServerCallContext)
Get a session by its id.
public virtual Task<GetSessionResponse> GetSession(GetSessionRequest request, ServerCallContext context)
Parameters
request GetSessionRequest
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
Returns
Task<GetSessionResponse>
The response to send back to the client (wrapped by a task).
ListSessions(ListSessionsRequest, ServerCallContext)
Get a sessions list using pagination, filters and sorting.
public virtual Task<ListSessionsResponse> ListSessions(ListSessionsRequest request, ServerCallContext context)
Parameters
request ListSessionsRequest
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
Returns
Task<ListSessionsResponse>
The response to send back to the client (wrapped by a task).
PauseSession(PauseSessionRequest, ServerCallContext)
Pause a session by its id.
public virtual Task<PauseSessionResponse> PauseSession(PauseSessionRequest request, ServerCallContext context)
Parameters
request PauseSessionRequest
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
Returns
Task<PauseSessionResponse>
The response to send back to the client (wrapped by a task).
PurgeSession(PurgeSessionRequest, ServerCallContext)
Purge a session by its id. Removes Results data.
public virtual Task<PurgeSessionResponse> PurgeSession(PurgeSessionRequest request, ServerCallContext context)
Parameters
request PurgeSessionRequest
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
Returns
Task<PurgeSessionResponse>
The response to send back to the client (wrapped by a task).
ResumeSession(ResumeSessionRequest, ServerCallContext)
Resume a paused session by its id.
public virtual Task<ResumeSessionResponse> ResumeSession(ResumeSessionRequest request, ServerCallContext context)
Parameters
request ResumeSessionRequest
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
Returns
Task<ResumeSessionResponse>
The response to send back to the client (wrapped by a task).
StopSubmission(StopSubmissionRequest, ServerCallContext)
Stops clients and/or workers from submitting new tasks in the given session.
public virtual Task<StopSubmissionResponse> StopSubmission(StopSubmissionRequest request, ServerCallContext context)
Parameters
request StopSubmissionRequest
The request received from the client.
context ServerCallContext
The context of the server-side call handler being invoked.
Returns
Task<StopSubmissionResponse>
The response to send back to the client (wrapped by a task).