Trait AsyncEventService

pub trait AsyncEventService {
    // Required methods
    fn create_event(
        &self,
        auth_: BearerToken,
        request: CreateEvent,
    ) -> impl Future<Output = Result<Event, Error>> + Send;
    fn get_events(
        &self,
        auth_: BearerToken,
        request: GetEvents,
    ) -> impl Future<Output = Result<BTreeSet<Event>, Error>> + Send;
    fn batch_get_events(
        &self,
        auth_: BearerToken,
        request: BTreeSet<EventRid>,
    ) -> impl Future<Output = Result<BTreeSet<Event>, Error>> + Send;
    fn update_event(
        &self,
        auth_: BearerToken,
        request: UpdateEvent,
    ) -> impl Future<Output = Result<Event, Error>> + Send;
    fn batch_update_event(
        &self,
        auth_: BearerToken,
        request: BatchUpdateEventRequest,
    ) -> impl Future<Output = Result<BatchUpdateEventResponse, Error>> + Send;
    fn batch_update_disposition(
        &self,
        auth_: BearerToken,
        request: BatchUpdateDispositionRequest,
    ) -> impl Future<Output = Result<BatchUpdateDispositionResponse, Error>> + Send;
    fn archive_event(
        &self,
        auth_: BearerToken,
        request: ArchiveEvent,
    ) -> impl Future<Output = Result<(), Error>> + Send;
    fn batch_archive_event(
        &self,
        auth_: BearerToken,
        request: BTreeSet<EventRid>,
    ) -> impl Future<Output = Result<(), Error>> + Send;
    fn search_events(
        &self,
        auth_: BearerToken,
        request: SearchEventsRequest,
    ) -> impl Future<Output = Result<SearchEventsResponse, Error>> + Send;
    fn get_events_histogram(
        &self,
        auth_: BearerToken,
        request: EventsHistogramRequest,
    ) -> impl Future<Output = Result<EventsHistogramResponse, Error>> + Send;
}

An Event is an annotated moment or time range. The Event Service is responsible for creating and retrieving events for a particular data source.

Required Methods

fn create_event( &self, auth_: BearerToken, request: CreateEvent, ) -> impl Future<Output = Result<Event, Error>> + Send

Creates an event.

fn get_events( &self, auth_: BearerToken, request: GetEvents, ) -> impl Future<Output = Result<BTreeSet<Event>, Error>> + Send

Gets a set of events by UUIDs

fn batch_get_events( &self, auth_: BearerToken, request: BTreeSet<EventRid>, ) -> impl Future<Output = Result<BTreeSet<Event>, Error>> + Send

Gets a set of events by RID.

fn update_event( &self, auth_: BearerToken, request: UpdateEvent, ) -> impl Future<Output = Result<Event, Error>> + Send

Updates the fields of an event. Empty fields are left unchanged.

fn batch_update_event( &self, auth_: BearerToken, request: BatchUpdateEventRequest, ) -> impl Future<Output = Result<BatchUpdateEventResponse, Error>> + Send

Updates the fields of an event specified by each request in the batch. Empty fields in the UpdateEventRequest are left unchanged.

fn batch_update_disposition( &self, auth_: BearerToken, request: BatchUpdateDispositionRequest, ) -> impl Future<Output = Result<BatchUpdateDispositionResponse, Error>> + Send

Updates the disposition of an event.

fn archive_event( &self, auth_: BearerToken, request: ArchiveEvent, ) -> impl Future<Output = Result<(), Error>> + Send

Archives an event

fn batch_archive_event( &self, auth_: BearerToken, request: BTreeSet<EventRid>, ) -> impl Future<Output = Result<(), Error>> + Send

Archives a set of events

fn search_events( &self, auth_: BearerToken, request: SearchEventsRequest, ) -> impl Future<Output = Result<SearchEventsResponse, Error>> + Send

Searches for events that match the given filters.

fn get_events_histogram( &self, auth_: BearerToken, request: EventsHistogramRequest, ) -> impl Future<Output = Result<EventsHistogramResponse, Error>> + Send

Gets a histogram of events that match the given filters.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors