Type Alias EventsResource 

pub type EventsResource = Resource<Event>;

Event objects store complex information about multiple assets over a time period. Typical types of events might include Alarms, Process Data, and Logs.

For storage of low volume, manually generated, schedulable activities such as maintenance schedules, work orders, or other “appointment” type activities. The Data Modelling service is now recommended.

For storage of very high volume discrete events, consider using time series.

Aliased Type

pub struct EventsResource {
    pub api_client: Arc<ApiClient>,
    /* private fields */
}

Fields

api_client: Arc<ApiClient>

A reference to the shared API Client.

Implementations

impl EventsResource

pub async fn aggregate( &self, aggregate: EventAggregateRequest, ) -> Result<Vec<EventAggregateResponse>>

Compute aggregates over events, such as getting the count of all events in a project, checking different names and descriptions of events in your project, etc.

Arguments

• aggregate - Aggregate to compute

The returned aggregates depend on which aggregates were requested.

Trait Implementations

impl CleanResource<Event> for EventsResource

async fn clean_resource(&self, resources: Vec<Event>) -> Result<(), Error>

Delete the provided resources.

impl Create<AddEvent, Event> for EventsResource

fn create( &self, creates: &[TCreate], ) -> impl Future<Output = Result<Vec<TResponse>>> + Send

Create a list of resources.

fn create_from( &self, creates: &[impl Into<TCreate> + Sync + Clone], ) -> impl Future<Output = Result<Vec<TResponse>>> + Send

Create a list of resources, converting from a different type.

fn create_ignore_duplicates( &self, creates: &[TCreate], ) -> impl Future<Output = Result<Vec<TResponse>>> + Send

where TCreate: EqIdentity,

Create a list of resources, ignoring any that fail with general “conflict” errors.

fn create_from_ignore_duplicates<'a, T: 'a>( &self, creates: &'a [impl Into<TCreate> + Sync + Clone], ) -> impl Future<Output = Result<Vec<TResponse>>> + Send

where TCreate: EqIdentity,

Create a list of resources, converting from a different type, and ignoring any that fail with general “conflict” errors.

impl<R> DeleteWithIgnoreUnknownIds<IdentityList<R>> for EventsResource

where IdentityList<R>: Serialize, R: Send + Sync,

fn delete( &self, deletes: impl Into<TIdt> + Send, ignore_unknown_ids: bool, ) -> impl Future<Output = Result<()>> + Send

where Self: Sync,

Delete a list of resources, optionally ignore unknown ids.

impl FilterWithRequest<EventFilterQuery, Event> for EventsResource

fn filter( &self, filter: TFilter, ) -> impl Future<Output = Result<ItemsVec<TResponse, Cursor>>> + Send

Filter resources.

fn filter_all( &self, filter: TFilter, ) -> impl Future<Output = Result<Vec<TResponse>>> + Send

where TFilter: SetCursor, TResponse: Send,

Filter resources, following cursors until they are exhausted.

fn filter_all_stream( &self, filter: TFilter, ) -> impl TryStream<Ok = TResponse, Error = Error, Item = Result<TResponse>> + Send

where TFilter: SetCursor, TResponse: Send + 'static,

Filter resources, following cursors. This returns a stream, you can abort the stream whenever you want and only resources retrieved up to that point will be returned.

fn filter_all_partitioned( &self, filter: TFilter, num_partitions: u32, ) -> impl Future<Output = Result<Vec<TResponse>>> + Send

where TFilter: SetCursor + WithPartition, TResponse: Send,

Filter resources using partitioned reads, following cursors until all partitions are exhausted.

fn filter_all_partitioned_stream( &self, filter: TFilter, num_partitions: u32, ) -> impl TryStream<Ok = TResponse, Error = Error, Item = Result<TResponse>> + Send

where TFilter: SetCursor + WithPartition, TResponse: Send + 'static,

Filter resources using partitioned reads, following cursors until all partitions are exhausted. This returns a stream.

impl<R> RetrieveWithIgnoreUnknownIds<IdentityList<R>, Event> for EventsResource

where IdentityList<R>: Serialize, R: Send + Sync,

fn retrieve( &self, ids: impl Into<TIdt> + Send, ignore_unknown_ids: bool, ) -> impl Future<Output = Result<Vec<TResponse>>> + Send

Retrieve a list of items from CDF. If ignore_unknown_ids is false, this will fail if any items are missing from CDF.

impl SearchItems<'_, EventFilter, EventSearch, Event> for EventsResource

fn search( &'a self, filter: TFilter, search: TSearch, limit: Option<u32>, ) -> impl Future<Output = Result<Vec<TResponse>>> + Send

Fuzzy search resources.

impl Update<Patch<PatchEvent>, Event> for EventsResource

fn update( &self, updates: &[TUpdate], ) -> impl Future<Output = Result<Vec<TResponse>>> + Send

Update a list of resources.

fn update_from<'a, T>( &self, updates: &'a [T], ) -> impl Future<Output = Result<Vec<TResponse>>> + Send

where T: Sync + Clone + 'a, TUpdate: From<T>,

Update a list of resources by converting to the update from a different type.

fn update_ignore_unknown_ids( &self, updates: &[TUpdate], ) -> impl Future<Output = Result<Vec<TResponse>>> + Send

where TUpdate: EqIdentity, TResponse: Send,

Update a list of resources, ignoring any that fail due to items missing in CDF.

fn update_from_ignore_unknown_ids<'a, T>( &self, updates: &'a [T], ) -> impl Future<Output = Result<Vec<TResponse>>> + Send

where T: Sync + Clone + 'a, TUpdate: From<T> + EqIdentity, TResponse: Send,

Update a list of resources by converting from a different type, ignoring any that fail due items missing in CDF.

impl WithBasePath for EventsResource

const BASE_PATH: &'static str = "events"

Base path for this resource type.