public class BoardingClient extends MindsphereAPIClient
Modifier and Type | Class and Description |
---|---|
static class |
BoardingClient.ClientBuilder |
MindsphereAPIClient.Builder<T extends MindsphereAPIClient.Builder<T>>
credentials, restClientConfig, restTemplate
Constructor and Description |
---|
BoardingClient(BoardingClient.ClientBuilder builder) |
Modifier and Type | Method and Description |
---|---|
static BoardingClient.ClientBuilder |
builder() |
BoardingConfiguration |
getBoardingConfiguration(String agentID)
Gets boarding configuration for the agent.
|
OnboardingStatus |
getBoardingStatus(String agentID)
Gets boarding status.
|
OnboardingStatus |
offBoard(String agentID)
Offboards the agent.
|
public BoardingClient(BoardingClient.ClientBuilder builder)
public static BoardingClient.ClientBuilder builder()
public BoardingConfiguration getBoardingConfiguration(String agentID) throws MindsphereException
200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
0 - unexpected error
agentID
- Unique identifier of the agent.MindsphereException
- if an error occurs while attempting to invoke the
APIpublic OnboardingStatus offBoard(String agentID) throws MindsphereException
200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
409 - Resource in conflicting state.
0 - unexpected error
agentID
- Unique identifier of the agent.MindsphereException
- if an error occurs while attempting to invoke the
APIpublic OnboardingStatus getBoardingStatus(String agentID) throws MindsphereException
200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
0 - unexpected error
agentID
- Unique identifier of the agent.MindsphereException
- if an error occurs while attempting to invoke the
API