com.siemens.mindsphere.sdk.agentmanagement.apiclient

Class BoardingOperationsClient

Object

MindsphereAPIClient

BoardingOperationsClient

public class BoardingOperationsClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
ModelConfiguration	agentsIdBoardingConfigurationGet(String agentId) Get boarding configuration Boarding configuration holds necessary information of the agent to onboard it.(ex; iat, clientCredentialProfile).
OnboardingStatus	agentsIdBoardingOffboardPost(String agentId) Offboard agent Offboards the agent.
OnboardingStatus	agentsIdBoardingStatusGet(String agentId) Get boarding status Gets boarding status.
static BoardingOperationsClient.ClientBuilder	builder()

Methods inherited from class Object

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

Constructor Detail

BoardingOperationsClient

public BoardingOperationsClient(BoardingOperationsClient.ClientBuilder builder)

Method Detail

builder

public static BoardingOperationsClient.ClientBuilder builder()

agentsIdBoardingConfigurationGet

public ModelConfiguration agentsIdBoardingConfigurationGet(String agentId)
                                                    throws MindsphereException

Get boarding configuration Boarding configuration holds necessary information of the agent to onboard it.(ex; iat, clientCredentialProfile). Generating a Boarding Configuration action is an asynchronous operation therefore it may take a few seconds. In case Boarding Configuration is not generated, try to read the configuration again after a couple of seconds.

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:

ModelConfiguration

Throws:

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

agentsIdBoardingOffboardPost

public OnboardingStatus agentsIdBoardingOffboardPost(String agentId)
                                              throws MindsphereException

Offboard agent Offboards the agent.

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not Found

409 - Resource in conflicting state.

422 - Not supported.

500 - unexpected error

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

Parameters:

agentId - Unique identifier of the agent.

Returns:

OnboardingStatus

Throws:

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

agentsIdBoardingStatusGet

public OnboardingStatus agentsIdBoardingStatusGet(String agentId)
                                           throws MindsphereException

Get boarding status Gets boarding 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:

OnboardingStatus

Throws:

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