com.siemens.mindsphere.sdk.iot.event.apiclient

Class EventTypeClient

Object

MindsphereAPIClient

EventTypeClient

public class EventTypeClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EventTypeClient.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

Modifier	Constructor and Description
protected	EventTypeClient(EventTypeClient.ClientBuilder builder)

Method Summary

Modifier and Type	Method and Description
EventType	addNewFieldToEventType(String eventTypeId, String ifMatch, Field field) Updates an Event type of specified ID by adding a new field
static EventTypeClient.ClientBuilder	builder()
EventType	createEventType(EventType eventType) Creates an Event Type with the provided content.
EventTypes	getEventTypes() Lists all Event types based on the request parameters
EventTypes	getEventTypes(Integer page, Integer size) Lists all Event types based on the request parameters
EventTypes	getEventTypes(Integer page, Integer size, String sort, String filter, String ifNoneMatch) Lists all Event types based on the request parameters
EventTypes	getEventTypes(String sort, String filter) Lists all Event types based on the request parameters
EventType	getEventTypesById(String eventTypeId) Get an Event Type of the requested ID
EventType	getEventTypesById(String eventTypeId, String ifNoneMatch) Get an Event Type of the requested ID
EventType	updateEventType(String eventTypeId, String ifMatch, EventTypePatch eventTypePatch) Updates an Event type of specified ID by only sending the changed content

Methods inherited from class Object

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

Constructor Detail

EventTypeClient

protected EventTypeClient(EventTypeClient.ClientBuilder builder)

Method Detail

builder

public static EventTypeClient.ClientBuilder builder()

getEventTypes

public EventTypes getEventTypes(Integer page,
                                Integer size,
                                String sort,
                                String filter,
                                String ifNoneMatch)
                         throws MindsphereException

Lists all Event types based on the request parameters

200 - A page of event types.

304 - Not Modified

400 - The request will return 400 BAD REQUEST in following cases:

• Filter event types by a not filterable field
• Sorting event types by a not sortable field

401 - Unauthorized

403 - Forbidden

500 - Internal Server Error

Parameters:

size - Specifies the number of elements in a page. Default is 20

page - Specifies the requested page index. Default is 0

filter - Filter parameter (JSON) encoded format. Event types can be filtered by fields - id, name, owner, scope

sort - Order in which event types are returned. Supported only on filterable fields. Default is by name in ascending order

ifNoneMatch - ETag hash of previous request to allow caching

Returns:

List of Event Types

Throws:

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

getEventTypes

public EventTypes getEventTypes()
                         throws MindsphereException

Lists all Event types based on the request parameters

200 - A page of event types.

304 - Not Modified

400 - The request will return 400 BAD REQUEST in following cases:

• Filter event types by a not filterable field
• Sorting event types by a not sortable field

401 - Unauthorized

403 - Forbidden

500 - Internal Server Error

Returns:

List of Event Types

Throws:

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

getEventTypes

public EventTypes getEventTypes(Integer page,
                                Integer size)
                         throws MindsphereException

Lists all Event types based on the request parameters

200 - A page of event types.

304 - Not Modified

400 - The request will return 400 BAD REQUEST in following cases:

• Filter event types by a not filterable field
• Sorting event types by a not sortable field

401 - Unauthorized

403 - Forbidden

500 - Internal Server Error

Parameters:

size - Specifies the number of elements in a page. Default is 20

page - Specifies the requested page index. Default is 0

Returns:

List of Event Types

Throws:

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

getEventTypes

public EventTypes getEventTypes(String sort,
                                String filter)
                         throws MindsphereException

Lists all Event types based on the request parameters

200 - A page of event types.

304 - Not Modified

400 - The request will return 400 BAD REQUEST in following cases:

• Filter event types by a not filterable field
• Sorting event types by a not sortable field

401 - Unauthorized

403 - Forbidden

500 - Internal Server Error

Parameters:

filter - Filter parameter (JSON) encoded format. Event types can be filtered by fields - id, name, owner, scope

sort - Order in which event types are returned. Supported only on filterable fields. Default is by name in ascending order

Returns:

List of Event Types

Throws:

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

getEventTypesById

public EventType getEventTypesById(String eventTypeId,
                                   String ifNoneMatch)
                            throws MindsphereException

Get an Event Type of the requested ID

200 - OK

304 - Not Modified

401 - Unauthorized

403 - Forbidden

404 - The request will return 404 BAD REQUEST in cases you can find below. - There is no event type stored in the database with the given event type ID

500 - Internal Server Error

Parameters:

eventTypeId - ID of an event type

ifNoneMatch - ETag hash of previous request to allow caching

Returns:

Event Type with the specified id

Throws:

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

getEventTypesById

public EventType getEventTypesById(String eventTypeId)
                            throws MindsphereException

Get an Event Type of the requested ID

200 - OK

304 - Not Modified

401 - Unauthorized

403 - Forbidden

404 - The request will return 404 BAD REQUEST in cases you can find below. - There is no event type stored in the database with the given event type ID

500 - Internal Server Error

Parameters:

eventTypeId - ID of an event type

Returns:

Event Type with the specified id

Throws:

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

createEventType

public EventType createEventType(EventType eventType)
                          throws MindsphereException

Creates an Event Type with the provided content.

Default 'parentId' is 'BaseEvent'

Default 'ttl' value is 35

Default 'scope' is LOCAL

Default 'filterable' value for a field is false

Default 'required' value for a field is false

Default 'updatable' value for a field is true

201 - Created

400 - The request will return 400 BAD REQUEST in following cases

• Reserved words of MySQL cannot be used as event type or field name
• Name of the event type is missing - ttl is bigger than 100
• Type of a field is missing
• Name of the event type longer than 64 characters
• Field name is duplicated
• Field name is longer than 64 characters
• Field already exists for one of the parents
• Number of fields are more than 100
• Inheritance depth exceeds 4
• Field definition is missing
• Filterable fields are more than 10

401 - Unauthorized

403 - Forbidden

409 - Conflict. An event type already exists with the given name

500 - Internal Server Error

Parameters:

eventType - Event type content to be created

Returns:

Created Event Type

Throws:

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

updateEventType

public EventType updateEventType(String eventTypeId,
                                 String ifMatch,
                                 EventTypePatch eventTypePatch)
                          throws MindsphereException

Updates an Event type of specified ID by only sending the changed content

200 - OK

400 - The request will return 400 BAD REQUEST in cases you violate any of the below circumstances.

• The event type is updated by user other than the owner.
• More than 300.000 events exist based on the event type that the user wants to update.
• Changing event type scope from 'GLOBAL' to 'LOCAL' is only allowed when there are no events created from the event type which belongs to another tenant than the event type was created from.
• The additional fields cannot be filterable and required.
• A required field can be turned into an optional field by an update but the opposite operation is not allowed.
• The type of a custom field cannot be changed.
• The updatable property of a custom field cannot be changed.
• The filterable property of a custom field cannot be changed.
• The owner of the event type cannot be changed.
• The parent of the event type cannot be changed.
• An event type can only be modified if there are no child event types derived from.
• BaseEvent and MindSphereStandardEvent cannot be updated.

401 - Unauthorized

403 - The user does not have the right permission

404 - The request will return 404 BAD REQUEST if attempted to update non-existing event type

409 - The request will return 409 CONFLICT if there is Concurrent modification of the same event type

412 - Precondition Failed

500 - Internal Server Error

Parameters:

eventTypeId - ID of an event type

ifMatch - Used for optimistic concurrency control

eventTypePatch - New value for the given attribute or the field, that should be applied, depending on the *op* value. Possible Structures:

• If patch operation would modify attribute properties (*ttl*, *scope*, *required*) then *value* property of the patch content must be the type of the specified attribute (eg. *SCOPE*, *45*, *false*)
• If patch operation would add new field then *value* property of the patch content must be an object describing field properties
  Example 1:
  {
  "op": "replace",
  "path": "/scope",
  "value": "GLOBAL"
  }
  Example 2:
  {
  "op": "add",
  "path": "/fields",
  "value": {
  "name": "newFieldName",
  "updatable": false,
  "type": "INTEGER"
  }
  }
  Example 3:
  {
  "op": "replace",
  "path": "/fields/originalField/required",
  "value": false
  }

Returns:

Updated Event Type

Throws:

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

addNewFieldToEventType

public EventType addNewFieldToEventType(String eventTypeId,
                                        String ifMatch,
                                        Field field)
                                 throws MindsphereException

Updates an Event type of specified ID by adding a new field

200 - OK

400 - The request will return 400 BAD REQUEST in cases you violate any of the below circumstances.

• The event type is updated by user other than the owner.
• More than 300.000 events exist based on the event type that the user wants to update.
• The additional fields cannot be filterable and required.
• An event type can only be modified if there are no child event types derived from.

401 - Unauthorized

403 - The user does not have the right permission

404 - The request will return 404 BAD REQUEST if attempted to update non-existing event type

409 - The request will return 409 CONFLICT if there is Concurrent modification of the same event type

412 - Precondition Failed

500 - Internal Server Error

Parameters:

eventTypeId - ID of an event type

ifMatch - Used for optimistic concurrency control

field - New Field that has to be added to the Event Type

Returns:

Updated Event Type

Throws:

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