com.siemens.mindsphere.sdk.mindconnect.apiclient

Class DiagnosticActivationsClient

Object

MindsphereAPIClient

DiagnosticActivationsClient

public class DiagnosticActivationsClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static DiagnosticActivationsClient.ClientBuilder	builder()
PagedDiagnosticActivation	diagnosticActivationsGet(DiagnosticActivationsGetRequest requestObject) Gets diagnostic activations Get diagnostic activations.
void	diagnosticActivationsIdDelete(DiagnosticActivationsIdDeleteRequest requestObject) Deletes a diagnostic activation Delete a diagnostic activation.
DiagnosticActivation	diagnosticActivationsIdGet(DiagnosticActivationsIdGetRequest requestObject) Gets a diagnostic activation.
PagedDiagnosticInformationMessages	diagnosticActivationsIdMessagesGet(DiagnosticActivationsIdMessagesGetRequest requestObject) Get a diagnostic messages of specific activation resource Get a diagnostic messages of specific activation resource.
DiagnosticActivation	diagnosticActivationsIdPut(DiagnosticActivationsIdPutRequest requestObject) Update status of Diagnostic Activation Updates status of Diagnostic Activation.
DiagnosticActivation	diagnosticActivationsPost(DiagnosticActivationsPostRequest requestObject) Creates a new diagnostic activation Create a new diagnostic activation.

Methods inherited from class Object

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

Constructor Detail

DiagnosticActivationsClient

public DiagnosticActivationsClient(DiagnosticActivationsClient.ClientBuilder builder)

Method Detail

builder

public static DiagnosticActivationsClient.ClientBuilder builder()

diagnosticActivationsGet

public PagedDiagnosticActivation diagnosticActivationsGet(DiagnosticActivationsGetRequest requestObject)
                                                   throws MindsphereException

Gets diagnostic activations Get diagnostic activations. Agents are allowed to get their own activation. Users with sufficient scopes are allowed to get all activations in the same tenant as in the token.

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

0 - unexpected error

Parameters:

requestObject - - Object of type DiagnosticActivationsGetRequest {Parameters are size,page,sort}

Returns:

PagedDiagnosticActivation

Throws:

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

diagnosticActivationsIdDelete

public void diagnosticActivationsIdDelete(DiagnosticActivationsIdDeleteRequest requestObject)
                                   throws MindsphereException

Deletes a diagnostic activation Delete a diagnostic activation. Agents are allowed to delete their own activation. Users with sufficient scopes are allowed to delete any activation in the same tenant as in the token.

204 - No Content

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not Found

0 - unexpected error

Parameters:

requestObject - - Object of type DiagnosticActivationsIdDeleteRequest {Parameters are id*}

Throws:

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

diagnosticActivationsIdGet

public DiagnosticActivation diagnosticActivationsIdGet(DiagnosticActivationsIdGetRequest requestObject)
                                                throws MindsphereException

Gets a diagnostic activation. Get a diagnostic activation with given id. Agents are allowed to get their own activation. Users with sufficient scopes are allowed to get any activation in the same tenant as in the token.

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not Found

0 - unexpected error

Parameters:

requestObject - - Object of type DiagnosticActivationsIdGetRequest {Parameters are id*}

Returns:

DiagnosticActivation

Throws:

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

diagnosticActivationsIdMessagesGet

public PagedDiagnosticInformationMessages diagnosticActivationsIdMessagesGet(DiagnosticActivationsIdMessagesGetRequest requestObject)
                                                                      throws MindsphereException

Get a diagnostic messages of specific activation resource Get a diagnostic messages of specific activation resource. Agents are allowed to get their own activations' messages. Users with sufficient scopes are allowed to get any activations messages in the same tenant as in the token.

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not Found

0 - unexpected error

Parameters:

requestObject - - Object of type DiagnosticActivationsIdMessagesGetRequest {Parameters are id*,filter,size,page,sort}

Returns:

PagedDiagnosticInformationMessages

Throws:

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

diagnosticActivationsIdPut

public DiagnosticActivation diagnosticActivationsIdPut(DiagnosticActivationsIdPutRequest requestObject)
                                                throws MindsphereException

Update status of Diagnostic Activation Updates status of Diagnostic Activation.

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not Found

0 - unexpected error

Parameters:

requestObject - - Object of type DiagnosticActivationsIdPutRequest {Parameters are id*,diagnosticActivationStatus*}

Returns:

DiagnosticActivation

Throws:

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

diagnosticActivationsPost

public DiagnosticActivation diagnosticActivationsPost(DiagnosticActivationsPostRequest requestObject)
                                               throws MindsphereException

Creates a new diagnostic activation Create a new diagnostic activation. Agents are allowed to create activation for itself only. Users with sufficient scopes are allowed to create activations of the agents in the same tenant as in the token.

201 - Created

400 - Bad Request

401 - Unauthorized

403 - Forbidden

409 - Resource is already available.

0 - unexpected error

Parameters:

requestObject - - Object of type DiagnosticActivationsPostRequest {Parameters are diagnosticActivation*}

Returns:

DiagnosticActivation

Throws:

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