UNPKG

@aneoconsultingfr/armonik.api

Version:

gRPC API to interact with ArmoniK built for the web

87 lines (84 loc) 4.85 kB
import { Observable } from 'rxjs'; import { Empty, Configuration, Session, TaskIdList, Count, ResultRequest, TaskOutputRequest, Output } from './objects.mjs'; import { CreateSessionRequest, CreateSessionReply, CreateSmallTaskRequest, CreateTaskReply, CreateLargeTaskRequest, TaskFilter, SessionFilter, SessionIdList, ResultReply, AvailabilityReply, WaitRequest, GetTaskStatusRequest, GetTaskStatusReply, GetResultStatusRequest, GetResultStatusReply, WatchResultRequest, WatchResultStream } from './submitter_common.mjs'; import 'protobufjs/minimal.js'; import './google/protobuf/duration.mjs'; import './task_status.mjs'; import './result_status.mjs'; import './session_status.mjs'; declare const protobufPackage = "armonik.api.grpc.v1.submitter"; interface Submitter { /** @deprecated */ GetServiceConfiguration(request: Empty): Promise<Configuration>; /** @deprecated */ CreateSession(request: CreateSessionRequest): Promise<CreateSessionReply>; /** @deprecated */ CancelSession(request: Session): Promise<Empty>; /** @deprecated */ CreateSmallTasks(request: CreateSmallTaskRequest): Promise<CreateTaskReply>; /** @deprecated */ CreateLargeTasks(request: Observable<CreateLargeTaskRequest>): Promise<CreateTaskReply>; /** @deprecated */ ListTasks(request: TaskFilter): Promise<TaskIdList>; /** @deprecated */ ListSessions(request: SessionFilter): Promise<SessionIdList>; /** @deprecated */ CountTasks(request: TaskFilter): Promise<Count>; /** @deprecated */ TryGetResultStream(request: ResultRequest): Observable<ResultReply>; /** @deprecated */ TryGetTaskOutput(request: TaskOutputRequest): Promise<Output>; /** @deprecated */ WaitForAvailability(request: ResultRequest): Promise<AvailabilityReply>; /** @deprecated */ WaitForCompletion(request: WaitRequest): Promise<Count>; /** @deprecated */ CancelTasks(request: TaskFilter): Promise<Empty>; /** @deprecated */ GetTaskStatus(request: GetTaskStatusRequest): Promise<GetTaskStatusReply>; /** @deprecated */ GetResultStatus(request: GetResultStatusRequest): Promise<GetResultStatusReply>; /** * 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. * * @deprecated */ WatchResults(request: Observable<WatchResultRequest>): Observable<WatchResultStream>; } declare const SubmitterServiceName = "armonik.api.grpc.v1.submitter.Submitter"; declare class SubmitterClientImpl implements Submitter { private readonly rpc; private readonly service; constructor(rpc: Rpc, opts?: { service?: string; }); GetServiceConfiguration(request: Empty): Promise<Configuration>; CreateSession(request: CreateSessionRequest): Promise<CreateSessionReply>; CancelSession(request: Session): Promise<Empty>; CreateSmallTasks(request: CreateSmallTaskRequest): Promise<CreateTaskReply>; CreateLargeTasks(request: Observable<CreateLargeTaskRequest>): Promise<CreateTaskReply>; ListTasks(request: TaskFilter): Promise<TaskIdList>; ListSessions(request: SessionFilter): Promise<SessionIdList>; CountTasks(request: TaskFilter): Promise<Count>; TryGetResultStream(request: ResultRequest): Observable<ResultReply>; TryGetTaskOutput(request: TaskOutputRequest): Promise<Output>; WaitForAvailability(request: ResultRequest): Promise<AvailabilityReply>; WaitForCompletion(request: WaitRequest): Promise<Count>; CancelTasks(request: TaskFilter): Promise<Empty>; GetTaskStatus(request: GetTaskStatusRequest): Promise<GetTaskStatusReply>; GetResultStatus(request: GetResultStatusRequest): Promise<GetResultStatusReply>; WatchResults(request: Observable<WatchResultRequest>): Observable<WatchResultStream>; } interface Rpc { request(service: string, method: string, data: Uint8Array): Promise<Uint8Array>; clientStreamingRequest(service: string, method: string, data: Observable<Uint8Array>): Promise<Uint8Array>; serverStreamingRequest(service: string, method: string, data: Uint8Array): Observable<Uint8Array>; bidirectionalStreamingRequest(service: string, method: string, data: Observable<Uint8Array>): Observable<Uint8Array>; } export { Submitter, SubmitterClientImpl, SubmitterServiceName, protobufPackage };