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

Class EventJobClient

Object

MindsphereAPIClient

EventJobClient

public class EventJobClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static EventJobClient.ClientBuilder	builder()
JobResource	createDeleteEventsJob(DeleteEventsJobDto deleteEventsJobDto) Returns Job's id based on request.
JobResource	getDeleteEventsJobById(String jobId) Returns a delete events job's state by ID

Methods inherited from class Object

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

Constructor Detail

EventJobClient

protected EventJobClient(EventJobClient.ClientBuilder builder)

Method Detail

builder

public static EventJobClient.ClientBuilder builder()

createDeleteEventsJob

public JobResource createDeleteEventsJob(DeleteEventsJobDto deleteEventsJobDto)
                                  throws MindsphereException

Returns Job's id based on request. Creates an asynchronous job which deletes events based on filter expression. Maximum 1.000.000 events can be deleted at once. The job status can be queried for 2 hours at most after the jobID is returned.

202 - ACCEPTED

Parameters:

deleteEventsJobDto - Operation content to perform asynchronous delete events job.

Returns:

JobResource Returns created job's id and status.

Throws:

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

getDeleteEventsJobById

public JobResource getDeleteEventsJobById(String jobId)
                                   throws MindsphereException

Returns a delete events job's state by ID

200 - OK

401 - Unauthorized

403 - The user does not have the right permission

404 - Not Found

500 - Internal Server Error

Parameters:

jobId - ID of a job

Returns:

JobResource Returns job's id and status.

Throws:

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