21.285. Class GrpcAgentService

Namespace: ArmoniK.Core.Common.gRPC.Services
Assembly: ArmoniK.Core.Common.dll

public class GrpcAgentService : Agent.AgentBase

21.285.1. Inheritance

object ← Agent.AgentBase ← GrpcAgentService

21.285.2. Inherited Members

Agent.AgentBase.CreateTask(IAsyncStreamReader<CreateTaskRequest>, ServerCallContext), Agent.AgentBase.CreateResultsMetaData(CreateResultsMetaDataRequest, ServerCallContext), Agent.AgentBase.CreateResults(CreateResultsRequest, ServerCallContext), Agent.AgentBase.NotifyResultData(NotifyResultDataRequest, ServerCallContext), Agent.AgentBase.SubmitTasks(SubmitTasksRequest, ServerCallContext), Agent.AgentBase.GetResourceData(DataRequest, ServerCallContext), Agent.AgentBase.GetCommonData(DataRequest, ServerCallContext), Agent.AgentBase.GetDirectData(DataRequest, ServerCallContext), object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()

21.285.3. Methods

21.285.3.1. CreateResults(CreateResultsRequest, ServerCallContext)

Create one result with data included in the request

public override Task<CreateResultsResponse> CreateResults(CreateResultsRequest request, ServerCallContext context)

21.285.3.1.1. Parameters

request CreateResultsRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

21.285.3.1.2. Returns

Task<CreateResultsResponse>

The response to send back to the client (wrapped by a task).

21.285.3.2. CreateResultsMetaData(CreateResultsMetaDataRequest, ServerCallContext)

Create the metadata of multiple results at once Data have to be uploaded separately

public override Task<CreateResultsMetaDataResponse> CreateResultsMetaData(CreateResultsMetaDataRequest request, ServerCallContext context)

21.285.3.2.1. Parameters

request CreateResultsMetaDataRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

21.285.3.2.2. Returns

Task<CreateResultsMetaDataResponse>

The response to send back to the client (wrapped by a task).

21.285.3.3. CreateTask(IAsyncStreamReader<CreateTaskRequest>, ServerCallContext)

public override Task<CreateTaskReply> CreateTask(IAsyncStreamReader<CreateTaskRequest> requestStream, ServerCallContext context)

21.285.3.3.1. Parameters

requestStream IAsyncStreamReader<CreateTaskRequest>

context ServerCallContext

21.285.3.3.2. Returns

Task<CreateTaskReply>

21.285.3.4. GetCommonData(DataRequest, ServerCallContext)

Retrieve Resource Data from the Agent Data is stored in the shared folder between Agent and Worker as a file with the result id as name Blocks until data are available in the shared folder

public override Task<DataResponse> GetCommonData(DataRequest request, ServerCallContext context)

21.285.3.4.1. Parameters

request DataRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

21.285.3.4.2. Returns

Task<DataResponse>

The response to send back to the client (wrapped by a task).

21.285.3.5. GetDirectData(DataRequest, ServerCallContext)

Retrieve Resource Data from the Agent Data is stored in the shared folder between Agent and Worker as a file with the result id as name Blocks until data are available in the shared folder

public override Task<DataResponse> GetDirectData(DataRequest request, ServerCallContext context)

21.285.3.5.1. Parameters

request DataRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

21.285.3.5.2. Returns

Task<DataResponse>

The response to send back to the client (wrapped by a task).

21.285.3.6. GetResourceData(DataRequest, ServerCallContext)

Retrieve Resource Data from the Agent Data is stored in the shared folder between Agent and Worker as a file with the result id as name Blocks until data are available in the shared folder

public override Task<DataResponse> GetResourceData(DataRequest request, ServerCallContext context)

21.285.3.6.1. Parameters

request DataRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

21.285.3.6.2. Returns

Task<DataResponse>

The response to send back to the client (wrapped by a task).

21.285.3.7. NotifyResultData(NotifyResultDataRequest, ServerCallContext)

Notify Agent that a data file representing the Result to upload is available in the shared folder The name of the file should be the result id Blocks until data are stored in Object Storage

public override Task<NotifyResultDataResponse> NotifyResultData(NotifyResultDataRequest request, ServerCallContext context)

21.285.3.7.1. Parameters

request NotifyResultDataRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

21.285.3.7.2. Returns

Task<NotifyResultDataResponse>

The response to send back to the client (wrapped by a task).

21.285.3.8. Start(IAgent)

Adds the given thus making the worker able to interact with it.

public Task Start(IAgent agent)

21.285.3.8.1. Parameters

agent IAgent

The agent to start the service with.

21.285.3.8.2. Returns

Task

A completed task.

21.285.3.9. Stop()

Removes the underlying thus making the worker unable to interact with the agent.

public Task Stop()

21.285.3.9.1. Returns

Task

A completed task.

21.285.3.10. SubmitTasks(SubmitTasksRequest, ServerCallContext)

Create tasks metadata and submit task for processing.

public override Task<SubmitTasksResponse> SubmitTasks(SubmitTasksRequest request, ServerCallContext context)

21.285.3.10.1. Parameters

request SubmitTasksRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

21.285.3.10.2. Returns

Task<SubmitTasksResponse>

The response to send back to the client (wrapped by a task).