com.siemens.mindsphere.sdk.mindconnect.apiclient

Class RecordRecoveryClient

Object

MindsphereAPIClient

RecordRecoveryClient

public class RecordRecoveryClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static RecordRecoveryClient.ClientBuilder	builder()
PagedRecoverableRecords	recoverableRecordsGet(RecoverableRecordsGetRequest requestObject) Get all recoverable records Gets all recoverable records
void	recoverableRecordsIdDelete(RecoverableRecordsIdDeleteRequest requestObject) Delete a recoverable record Deletes a recoverable record.
String	recoverableRecordsIdDownloadLinkGet(RecoverableRecordsIdDownloadLinkGetRequest requestObject) Get download link of record payload.
void	recoverableRecordsIdReplayPost(RecoverableRecordsIdReplayPostRequest requestObject) Re-play a recoverable record Re-play a recoverable record.

Methods inherited from class Object

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

Constructor Detail

RecordRecoveryClient

public RecordRecoveryClient(RecordRecoveryClient.ClientBuilder builder)

Method Detail

builder

public static RecordRecoveryClient.ClientBuilder builder()

recoverableRecordsGet

public PagedRecoverableRecords recoverableRecordsGet(RecoverableRecordsGetRequest requestObject)
                                              throws MindsphereException

Get all recoverable records Gets all recoverable records

200 - OK

400 - Bad Request

401 - unauthorized

403 - Forbidden

0 - unexpected error

Parameters:

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

Returns:

PagedRecoverableRecords

Throws:

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

recoverableRecordsIdDelete

public void recoverableRecordsIdDelete(RecoverableRecordsIdDeleteRequest requestObject)
                                throws MindsphereException

Delete a recoverable record Deletes a recoverable record.

204 - Deleted

400 - Bad Request

401 - unauthorized

403 - Forbidden

404 - Recoverable record not found

0 - unexpected error

Parameters:

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

Throws:

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

recoverableRecordsIdDownloadLinkGet

public String recoverableRecordsIdDownloadLinkGet(RecoverableRecordsIdDownloadLinkGetRequest requestObject)
                                           throws MindsphereException

Get download link of record payload. Gets download link of record payload

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not Found

0 - unexpected error

Parameters:

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

Returns:

String

Throws:

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

recoverableRecordsIdReplayPost

public void recoverableRecordsIdReplayPost(RecoverableRecordsIdReplayPostRequest requestObject)
                                    throws MindsphereException

Re-play a recoverable record Re-play a recoverable record.

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not Found

0 - unexpected error

Parameters:

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

Throws:

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