com.siemens.mindsphere.sdk.eventanalytics.apiclient

Class EventOperationsClient

Object

MindsphereAPIClient

EventOperationsClient

public class EventOperationsClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EventOperationsClient.ClientBuilder

Nested classes/interfaces inherited from class MindsphereAPIClient

MindsphereAPIClient.Builder<T extends MindsphereAPIClient.Builder<T>>

Field Summary

Fields inherited from class MindsphereAPIClient

credentials, restClientConfig, restTemplate

Constructor Summary

Constructors

Constructor and Description
EventOperationsClient(EventOperationsClient.ClientBuilder builder)

Method Summary

Modifier and Type	Method and Description
static EventOperationsClient.ClientBuilder	builder()
EventCountOutput	countEvents(CountEventsRequest requestObject) Determines the number of events for a required time resolution.
EventCountOutput	countEvents(EventInput data) Determines the number of events for a required time resolution.
EventArrayOutput	filterEvents(EventSearchInputDataModel data) Simplifies the dataset to the most meaningful data Filtering the dataset based on the text of the event
EventArrayOutput	filterEvents(FilterEventsRequest requestObject) Simplifies the dataset to the most meaningful data Filtering the dataset based on the text of the event
DuplicateEventArrayOutput	removeDuplicateEvents(EventInput data) Removes the duplicate events Determine pre-existing relationships between events for a requested temporal resolution (example 500ms) and reduce the data set by aggregating events with duplicate value.
DuplicateEventArrayOutput	removeDuplicateEvents(RemoveDuplicateEventsRequest requestObject) Removes the duplicate events Determine pre-existing relationships between events for a requested temporal resolution (example 500ms) and reduce the data set by aggregating events with duplicate value.
TopEventOutput	topEvents(TopEventsInputDataModel data) Find most frequent top N events Finds the most frequent events, which are sorted by the number of appearances in a dataset in a descending order.
TopEventOutput	topEvents(TopEventsRequest requestObject) Find most frequent top N events Finds the most frequent events, which are sorted by the number of appearances in a dataset in a descending order.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EventOperationsClient

public EventOperationsClient(EventOperationsClient.ClientBuilder builder)

Method Detail

builder

public static EventOperationsClient.ClientBuilder builder()

countEvents

public EventCountOutput countEvents(CountEventsRequest requestObject)
                             throws MindsphereException

Determines the number of events for a required time resolution. The microservice takes as an input the entire dataset and the time resolution (example 100ms). The micro service will output the given time interval (startTime, endTime) and the resulted number of event occurrences.

200 - OK

400 - Wrong parameters

403 - Not Authorized. Missing security scope \\\"as.ea.u\\\"

503 - Internal error

Parameters:

requestObject - - Object of type CountEventsRequest {Parameters are data*}

Returns:

EventCountOutput

Throws:

MindsphereException - if an error occurs while attempting to invoke the API

filterEvents

public EventArrayOutput filterEvents(FilterEventsRequest requestObject)
                              throws MindsphereException

Simplifies the dataset to the most meaningful data Filtering the dataset based on the text of the event

200 - OK

400 - Wrong parameters

403 - Not Authorized. Missing security scope \\\"as.ea.u\\\"

503 - Internal error

Parameters:

requestObject - - Object of type FilterEventsRequest {Parameters are data*}

Returns:

EventArrayOutput

Throws:

MindsphereException - if an error occurs while attempting to invoke the API

removeDuplicateEvents

public DuplicateEventArrayOutput removeDuplicateEvents(RemoveDuplicateEventsRequest requestObject)
                                                throws MindsphereException

Removes the duplicate events Determine pre-existing relationships between events for a requested temporal resolution (example 500ms) and reduce the data set by aggregating events with duplicate value.

200 - OK

400 - Wrong parameters

403 - Not Authorized. Missing security scope \\\"as.ea.u\\\"

503 - Internal error

Parameters:

requestObject - - Object of type RemoveDuplicateEventsRequest {Parameters are data*}

Returns:

DuplicateEventArrayOutput

Throws:

MindsphereException - if an error occurs while attempting to invoke the API

topEvents

public TopEventOutput topEvents(TopEventsRequest requestObject)
                         throws MindsphereException

Find most frequent top N events Finds the most frequent events, which are sorted by the number of appearances in a dataset in a descending order.

200 - Array of TopEventOutput List

400 - Wrong parameters

403 - Not Authorized. Missing security scope \\\"as.ea.u\\\"

503 - Internal error

Parameters:

requestObject - - Object of type TopEventsRequest {Parameters are data*}

Returns:

TopEventOutput

Throws:

MindsphereException - if an error occurs while attempting to invoke the API

countEvents

public EventCountOutput countEvents(EventInput data)
                             throws MindsphereException

Determines the number of events for a required time resolution. The microservice takes as an input the entire dataset and the time resolution (example 100ms). The micro service will output the given time interval (startTime, endTime) and the resulted number of event occurrences.

200 - OK

400 - Wrong parameters

403 - Not Authorized. Missing security scope \\\"as.ea.u\\\"

503 - Internal error

Parameters:

data - Data structure with two parts <b>eventsMetadata</b>, <b>events</b>. <ul> <li> <b>eventsMetadata</b> Metadata for the events list specifying the property name of the item in the events list that contains the text of the event (<b>eventTextPropertyName</b>) and time window length in miliseconds of the period in which time interval will be split (<b>splitInterval</b>).</li> <li> <b>events</b> List with the events that will be processed.</li> </ul>

Returns:

EventCountOutput

Throws:

MindsphereException - if an error occurs while attempting to invoke the API

filterEvents

public EventArrayOutput filterEvents(EventSearchInputDataModel data)
                              throws MindsphereException

Simplifies the dataset to the most meaningful data Filtering the dataset based on the text of the event

200 - OK

400 - Wrong parameters

403 - Not Authorized. Missing security scope \\\"as.ea.u\\\"

503 - Internal error

Parameters:

data - Data structure with three parts - <b>eventsMetadata</b>, <b>filterList</b>, and <b>events</b>.<ul> <li> <b>eventsMetadata</b> Metadata for the events list specifying the property name of the item in the events list that contains the text of the event. </li> <li> <b>filterList</b> Types of events to be removed </li> <li> <b>events</b> List with the events that will be processed.</li> </ul>

Returns:

EventArrayOutput

Throws:

MindsphereException - if an error occurs while attempting to invoke the API

removeDuplicateEvents

public DuplicateEventArrayOutput removeDuplicateEvents(EventInput data)
                                                throws MindsphereException

Removes the duplicate events Determine pre-existing relationships between events for a requested temporal resolution (example 500ms) and reduce the data set by aggregating events with duplicate value.

200 - OK

400 - Wrong parameters

403 - Not Authorized. Missing security scope \\\"as.ea.u\\\"

503 - Internal error

Parameters:

data - Data structure with two parts <b>eventsMetadata</b>, <b>events</b>. <ul> <li> <b>eventsMetadata</b> Metadata for the events list specifying the property name of the item in the events list that contains the text of the event (<b>eventTextPropertyName</b>) and time window length in miliseconds of the period in which time interval will be split (<b>splitInterval</b>). </li> <li> <b>events</b> List with the events that will be processed.</li> </ul>

Returns:

DuplicateEventArrayOutput

Throws:

MindsphereException - if an error occurs while attempting to invoke the API

topEvents

public TopEventOutput topEvents(TopEventsInputDataModel data)
                         throws MindsphereException

Find most frequent top N events Finds the most frequent events, which are sorted by the number of appearances in a dataset in a descending order.

200 - Array of TopEventOutput List

400 - Wrong parameters

403 - Not Authorized. Missing security scope \\\"as.ea.u\\\"

503 - Internal error

Parameters:

data - Data structure with three parts - <b>numberOfTopPositionsRequired</b>, <b>eventsMetadata</b>, and <b>events</b>. <ul> <li> <b>numberOfTopPositionsRequired</b> How many top positions will be returned in the response. Has to be a positive integer. If not specified, the default value 10 will be used.</li> <li> <b>eventsMetadata</b> Metadata for the events list specifying the property name of the item in the events list that contains the text of the event.</li> <li> <b>events</b> List with the events that will be processed.</li> </ul>

Returns:

TopEventOutput

Throws:

MindsphereException - if an error occurs while attempting to invoke the API