@aneoconsultingfr/armonik.api
Version:
gRPC API to interact with ArmoniK built for the web
48 lines (45 loc) • 2.06 kB
TypeScript
import { Observable } from 'rxjs';
import { EventSubscriptionRequest, EventSubscriptionResponse } from './events_common.js';
import './results_filters.js';
import './filters_common.js';
import 'protobufjs/minimal.js';
import './google/protobuf/duration.js';
import './results_fields.js';
import './result_status.js';
import './tasks_filters.js';
import './tasks_fields.js';
import './task_status.js';
declare const protobufPackage = "armonik.api.grpc.v1.events";
/**
* Events subscription related methods within a service.
*
* This service can be used to receive events related to the update of tasks
* and results whithin a session.
* The endpoint can be called to listen to the modifications of multiple sessions
* if needed.
*
* Note: As for now, all the events of a session will be sent whithout filtering.
* It is possible that the API will evolve to a more refined way to filter the events
* to be received.
*/
/** Service for subscribing to events representing modifications to ArmoniK result and task data */
interface Events {
/** Get events that represents updates of result and tasks data. */
GetEvents(request: EventSubscriptionRequest): Observable<EventSubscriptionResponse>;
}
declare const EventsServiceName = "armonik.api.grpc.v1.events.Events";
declare class EventsClientImpl implements Events {
private readonly rpc;
private readonly service;
constructor(rpc: Rpc, opts?: {
service?: string;
});
GetEvents(request: EventSubscriptionRequest): Observable<EventSubscriptionResponse>;
}
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 { Events, EventsClientImpl, EventsServiceName, protobufPackage };