com.siemens.mindsphere.sdk.analytics.apiclient

Class EventAnalyticsClient

Object

MindsphereAPIClient

EventAnalyticsClient

public class EventAnalyticsClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EventAnalyticsClient.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
EventAnalyticsClient(EventAnalyticsClient.ClientBuilder builder)

Method Summary

Modifier and Type	Method and Description
static EventAnalyticsClient.ClientBuilder	builder()
List<EventAnalyticsResponse>	findTopEvents(EventAnalyticsRequest eventAnalyticsRequest) Finds the most frequent top N events, which are sorted by 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

EventAnalyticsClient

public EventAnalyticsClient(EventAnalyticsClient.ClientBuilder builder)

Method Detail

builder

public static EventAnalyticsClient.ClientBuilder builder()

findTopEvents

public List<EventAnalyticsResponse> findTopEvents(EventAnalyticsRequest eventAnalyticsRequest)
                                           throws MindsphereException

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

200 - OK

400 - Wrong parameters

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

503 - Internal error

Parameters:

eventAnalyticsRequest - Data structure with three parts

• numberOfTopPositionsRequired
  Number of top events that will be returned in the response. Has to be a positive integer. Default value is 10.
• eventsMetadata
  Metadata for the events list specifying the property name of the item in the events list that contains the text of the event.
• events
  List with the events that will be processed.

Returns:

List of EventAnalyticsResponse List of top N events : the text and the number of appearances

Throws:

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