com.siemens.mindsphere.sdk.agentmanagement.apiclient

Class DataSourceConfigurationOperationsClient

Object

MindsphereAPIClient

DataSourceConfigurationOperationsClient

public class DataSourceConfigurationOperationsClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
DataSourceConfiguration	agentsIdDataSourceConfigurationGet(String agentId) Get Data Source Configuration Data source configuration is needed for interpreting the data received from an agent.
DataSourceConfiguration	agentsIdDataSourceConfigurationPut(String agentId, DataSourceConfigurationInput configuration, String ifMatch) Update Data Source Configuration Creates or updates data source configuration object.
static DataSourceConfigurationOperationsClient.ClientBuilder	builder()

Methods inherited from class Object

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

Constructor Detail

DataSourceConfigurationOperationsClient

public DataSourceConfigurationOperationsClient(DataSourceConfigurationOperationsClient.ClientBuilder builder)

Method Detail

builder

public static DataSourceConfigurationOperationsClient.ClientBuilder builder()

agentsIdDataSourceConfigurationGet

public DataSourceConfiguration agentsIdDataSourceConfigurationGet(String agentId)
                                                           throws MindsphereException

Get Data Source Configuration Data source configuration is needed for interpreting the data received from an agent. It is crucial for Mindsphere to interpret the data sent by an agent. The data source configuration contains data sources and data points. Data sources are logical groups of data points, e.g. a sensor or a machine. Fetches data source configuration object.

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not Found

500 - unexpected error

0 - Other error with any status code and response body format.

Parameters:

agentId - Unique identifier of the agent.* @return DataSourceConfiguration

Throws:

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

agentsIdDataSourceConfigurationPut

public DataSourceConfiguration agentsIdDataSourceConfigurationPut(String agentId,
                                                                  DataSourceConfigurationInput configuration,
                                                                  String ifMatch)
                                                           throws MindsphereException

Update Data Source Configuration Creates or updates data source configuration object.

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not Found

412 - Precondition Failed

500 - unexpected error

0 - Other error with any status code and response body format.

Parameters:

agentId - Unique identifier of the agent.

configuration - Data source configuration object.

ifMatch - ETag number of resource.

Returns:

DataSourceConfiguration

Throws:

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