Class Agent.AgentBase

Namespace: ArmoniK.Api.gRPC.V1.Agent
Assembly: ArmoniK.Api.Core.dll

Base class for server-side implementations of Agent

[BindServiceMethod(typeof(Agent), "BindService")]
public abstract class Agent.AgentBase

Inheritance

objectAgent.AgentBase

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).

CreateTask(IAsyncStreamReader<CreateTaskRequest>, ServerCallContext)

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

Parameters

requestStream IAsyncStreamReader<CreateTaskRequest>

context ServerCallContext

Returns

Task<CreateTaskReply>

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 virtual Task<DataResponse> GetCommonData(DataRequest request, ServerCallContext context)

Parameters

request DataRequest

The request received from the client.

context ServerCallContext

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

Returns

Task<DataResponse>

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

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 virtual Task<DataResponse> GetDirectData(DataRequest request, ServerCallContext context)

Parameters

request DataRequest

The request received from the client.

context ServerCallContext

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

Returns

Task<DataResponse>

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

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 virtual Task<DataResponse> GetResourceData(DataRequest request, ServerCallContext context)

Parameters

request DataRequest

The request received from the client.

context ServerCallContext

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

Returns

Task<DataResponse>

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

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 virtual Task<NotifyResultDataResponse> NotifyResultData(NotifyResultDataRequest request, ServerCallContext context)

Parameters

request NotifyResultDataRequest

The request received from the client.

context ServerCallContext

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

Returns

Task<NotifyResultDataResponse>

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

SubmitTasks(SubmitTasksRequest, ServerCallContext)

Create tasks metadata and submit task for processing.

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

Parameters

request SubmitTasksRequest

The request received from the client.

context ServerCallContext

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

Returns

Task<SubmitTasksResponse>

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