com.siemens.mindsphere.sdk.eventmanagement.apiclient

Class JobsClient

Object

MindsphereAPIClient

JobsClient

public class JobsClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static JobsClient.ClientBuilder	builder()
JobResource	createCreateEventsJob(CreateEventsJob createEventsJob) Create a create events job.
JobResource	createDeleteEventsJob(DeleteEventsJob deleteEventsJob) Create a delete events job.
CreateJobResource	getCreateEventsJobById(String jobId) Get a create events job Returns a create events job state by ID.
DeleteJobResource	getDeleteEventsJobById(String jobId) Get a delete events job.

Methods inherited from class Object

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

Constructor Detail

JobsClient

public JobsClient(JobsClient.ClientBuilder builder)

Method Detail

builder

public static JobsClient.ClientBuilder builder()

createCreateEventsJob

public JobResource createCreateEventsJob(CreateEventsJob createEventsJob)
                                  throws MindsphereException

Create a create events job. Creates an asynchronous job which creates events with the provided content. Maximum 50 events can be created at once. The job status can be queried for 2 hours at most after the jobID is returned.

202 - ACCEPTED

400 - The request will return 400 BAD REQUEST if there are more than 50 events in the payload

401 - Unauthorized

403 - The user does not have the right permission

500 - Internal Server Error

Parameters:

createEventsJob - - CreateEventsJob instance with operation content to perform asynchronous create events job

Returns:

JobResource

Throws:

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

createDeleteEventsJob

public JobResource createDeleteEventsJob(DeleteEventsJob deleteEventsJob)
                                  throws MindsphereException

Create a delete events job. 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. If the latest event instance in a history of an event is deleted then the history of the event will be deleted. \\ **!Restriction!** Job will result in `FINISHED_WITH_ERROR` state in cases you can find below - **Concurrent event deletion on the same event type is not allowed.** - **Concurrent event deletion and event type modification for the same event type is not allowed.**

202 - ACCEPTED

400 - The request will return 400 BAD REQUEST if filter is not valid JSON or there is no 'typeId' in the filter expression

401 - Unauthorized

403 - The user does not have the right permission

500 - Internal Server Error

Parameters:

deleteEventsJob - - CreateEventsJob instance with operation content to perform asynchronous delete events job

Returns:

JobResource

Throws:

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

getCreateEventsJobById

public CreateJobResource getCreateEventsJobById(String jobId)
                                         throws MindsphereException

Get a create events job Returns a create events job 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 - - Job Id of the job to be fetched

Returns:

CreateJobResource

Throws:

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

getDeleteEventsJobById

public DeleteJobResource getDeleteEventsJobById(String jobId)
                                         throws MindsphereException

Get a delete events job. Returns a delete events job 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 - - Job Id of the job to be fetched

Returns:

DeleteJobResource

Throws:

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