com.siemens.mindsphere.sdk.mindconnect.apiclient

Class MappingsClient

Object

MindsphereAPIClient

MappingsClient

public class MappingsClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static MappingsClient.ClientBuilder	builder()
PagedMapping	dataPointMappingsGet(DataPointMappingsGetRequest requestObject) Get mappings.
void	dataPointMappingsIdDelete(DataPointMappingsIdDeleteRequest requestObject) Delete a mapping Deletes a mapping.
Mapping	dataPointMappingsIdGet(DataPointMappingsIdGetRequest requestObject) Get a mapping by id Gets a mapping by given id.
Mapping	dataPointMappingsPost(DataPointMappingsPostRequest requestObject) Create single mapping Creates a single mapping.

Methods inherited from class Object

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

Constructor Detail

MappingsClient

public MappingsClient(MappingsClient.ClientBuilder builder)

Method Detail

builder

public static MappingsClient.ClientBuilder builder()

dataPointMappingsGet

public PagedMapping dataPointMappingsGet(DataPointMappingsGetRequest requestObject)
                                  throws MindsphereException

Get mappings. Retrieves a list of mappings.

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

0 - unexpected error

Parameters:

requestObject - - Object of type DataPointMappingsGetRequest {Parameters are filter,size,page,sort}

Returns:

PagedMapping

Throws:

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

dataPointMappingsIdDelete

public void dataPointMappingsIdDelete(DataPointMappingsIdDeleteRequest requestObject)
                               throws MindsphereException

Delete a mapping Deletes a mapping.

204 - Deleted

400 - Bad Request

401 - unauthorized

403 - Forbidden

404 - Mapping not found

0 - unexpected error

Parameters:

requestObject - - Object of type DataPointMappingsIdDeleteRequest {Parameters are id*}

Throws:

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

dataPointMappingsIdGet

public Mapping dataPointMappingsIdGet(DataPointMappingsIdGetRequest requestObject)
                               throws MindsphereException

Get a mapping by id Gets a mapping by given id.

200 - OK

400 - Bad Request

401 - unauthorized

403 - Forbidden

404 - Mapping not found

0 - unexpected error

Parameters:

requestObject - - Object of type DataPointMappingsIdGetRequest {Parameters are id*}

Returns:

Mapping

Throws:

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

dataPointMappingsPost

public Mapping dataPointMappingsPost(DataPointMappingsPostRequest requestObject)
                              throws MindsphereException

Create single mapping Creates a single mapping.

201 - Created

400 - Bad Request. Request validations failed.

401 - Unauthorized

403 - Forbidden

409 - Conflict

0 - unexpected error

Parameters:

requestObject - - Object of type DataPointMappingsPostRequest {Parameters are mapping*}

Returns:

Mapping

Throws:

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