Kaspersky Industrial CyberSecurity for Networks API Developer's Guide

EventProvider

Event provider service.

Defined in

This service is defined in the event_provider_service.proto file.

Syntax

service EventProvider

{

rpc GetItem(EventId) returns(Event);

rpc RequestItems(Filter) returns(Cookie);

rpc GetItems(ItemsRequest) returns(stream Event);

rpc GetRequestState(Cookie) returns(RequestStateResponse);

rpc CancelItemsRequest(Cookie) returns(google.protobuf.Empty);

rpc GetItemsById(ItemsByIdRequest) returns(stream Event);

}

Service methods

The EventProvider service has the following service methods.

EventProvider service methods

Name

Request message

Response message

Description

GetItem

EventId

Event

Returns a single event according to its identifier.

Receives the event identifier and returns an event with the specified identifier.

RequestItems

Filter

Cookie

Makes an asynchronous request for a specific number of events in a certain time span.

Receives the parameters of an event request and returns a request cookie.

GetItems

ItemsRequest

stream Event

Returns the results of an asynchronous request.

Receives a request cookie and range parameters, and returns a stream of events.

After the events are received, you must make a CancelItemsRequest call to avoid resource leakage.

GetRequestState

Cookie

RequestStateResponse

Returns the state of an asynchronous request.

Receives a request cookie and returns the status of the request.

CancelItemsRequest

Cookie

google.protobuf.Empty

Cancels the processing of an asynchronous request (if processing is not yet complete) and frees resources allocated for the request.

Receives a request cookie.

GetItemsById

ItemsByIdRequest

stream Event

Returns a specified number of events starting from a certain event (but not including this event).

Receives request parameters (filter, identifier of the starting event, and maximum number of events) and returns a stream of events.