com.siemens.mindsphere.sdk.agentmanagement.apiclient

Class DataSourceConfigurationClient

Object

MindsphereAPIClient

DataSourceConfigurationClient

public class DataSourceConfigurationClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static DataSourceConfigurationClient.ClientBuilder	builder()
DataSourceConfiguration	createDataSourceConfiguration(String agentID, DataSourceConfigurationInput configuration) Creates Data Source Configuration.
DataSourceConfiguration	getDataSourceConfiguration(String agentId) Fetches data source configuration object for the agent.
DataSourceConfiguration	updateDataSourceConfiguration(String agentID, DataSourceConfigurationInput configuration, String ifMatch) Updates Data Source Configuration.

Methods inherited from class Object

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

Constructor Detail

DataSourceConfigurationClient

public DataSourceConfigurationClient(DataSourceConfigurationClient.ClientBuilder builder)

Method Detail

builder

public static DataSourceConfigurationClient.ClientBuilder builder()

getDataSourceConfiguration

public DataSourceConfiguration getDataSourceConfiguration(String agentId)
                                                   throws MindsphereException

Fetches data source configuration object for the agent.

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not Found

0 - unexpected error

Parameters:

agentId - Unique identifier of the agent.

Returns:

DataSourceConfiguration

Throws:

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

updateDataSourceConfiguration

public DataSourceConfiguration updateDataSourceConfiguration(String agentID,
                                                             DataSourceConfigurationInput configuration,
                                                             String ifMatch)
                                                      throws MindsphereException

Updates Data Source Configuration. object.

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not Found

412 - Precondition Failed

0 - unexpected error

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

createDataSourceConfiguration

public DataSourceConfiguration createDataSourceConfiguration(String agentID,
                                                             DataSourceConfigurationInput configuration)
                                                      throws MindsphereException

Creates Data Source Configuration. object.

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not Found

412 - Precondition Failed

0 - unexpected error

Parameters:

agentID - Unique identifier of the agent.

configuration - Data source configuration object.

Returns:

DataSourceConfiguration

Throws:

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