com.siemens.mindsphere.sdk.agentmanagement.apiclient

Class AgentOperationsClient

Object

MindsphereAPIClient

AgentOperationsClient

public class AgentOperationsClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
PagedAgent	agentsGet(String filter, Integer size, Integer page, String sort) Get agents Gets the agents for the given filter.
void	agentsIdDelete(String agentId, String ifMatch) Delete agent Deletes the agent for the given agent id.
Agent	agentsIdGet(String agentId) Get agent Gets the agent for the given agent id.
Agent	agentsIdPut(String agentId, AgentUpdate agent, String ifMatch) Update agent Updates the agent for the given agent id with given parameters.
OnlineStatus	agentsIdStatusGet(String agentId) Get online status Gets online status.
Agent	agentsPost(AgentInput agent) Create agent Creates a new agent.
static AgentOperationsClient.ClientBuilder	builder()

Methods inherited from class Object

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

Constructor Detail

AgentOperationsClient

public AgentOperationsClient(AgentOperationsClient.ClientBuilder builder)

Method Detail

builder

public static AgentOperationsClient.ClientBuilder builder()

agentsGet

public PagedAgent agentsGet(String filter,
                            Integer size,
                            Integer page,
                            String sort)
                     throws MindsphereException

Get agents Gets the agents for the given filter.

200 - Array of agents

400 - Bad Request

401 - Unauthorized

403 - Forbidden

500 - unexpected error

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

Parameters:

filter - JSON based filter.

size - The maximum number of elements in a page.

page - The (0-based) index of page.

sort - The order of returned elements. Multiple fields could be used separated by commas (e.g. ''field1,field2''). Descending order could be requested by appending '',desc'' at the end of parameter.(e.g. ''field1,field2,desc'')'

Returns:

PagedAgent

Throws:

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

agentsIdDelete

public void agentsIdDelete(String agentId,
                           String ifMatch)
                    throws MindsphereException

Delete agent Deletes the agent for the given agent id.

204 - No Content

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.

ifMatch - ETag number of resource.

Throws:

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

agentsIdGet

public Agent agentsIdGet(String agentId)
                  throws MindsphereException

Get agent Gets the agent for the given agent id.

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.

Returns:

Agent

Throws:

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

agentsIdPut

public Agent agentsIdPut(String agentId,
                         AgentUpdate agent,
                         String ifMatch)
                  throws MindsphereException

Update agent Updates the agent for the given agent id with given parameters.

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not Found

409 - Resource is already available.

412 - Precondition Failed

500 - unexpected error

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

Parameters:

agentId - Unique identifier of the agent.

agent - Agent update dto to update agent.

ifMatch - ETag number of resource.

Returns:

Agent

Throws:

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

agentsIdStatusGet

public OnlineStatus agentsIdStatusGet(String agentId)
                               throws MindsphereException

Get online status Gets online status.

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.

Returns:

OnlineStatus

Throws:

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

agentsPost

public Agent agentsPost(AgentInput agent)
                 throws MindsphereException

Create agent Creates a new agent.

201 - Created

400 - Bad Request

401 - Unauthorized

403 - Forbidden

409 - Resource is already available.

500 - unexpected error

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

Parameters:

agent - Object describing new agent resource.

Returns:

Agent

Throws:

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