com.siemens.mindsphere.sdk.integrateddatalake.apiclient

Class ObjectOperationsClient

Object

MindsphereAPIClient

ObjectOperationsClient

public class ObjectOperationsClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ObjectOperationsClient.ClientBuilder	builder()
DeleteObjectsJobResponse	createDeleteObjectsJob(CreateDeleteObjectsJobRequest requestObject) Delete multiple objects in bulk.
void	deleteObject(DeleteObjectRequest requestObject) delete an object.
DeleteObjectsJobList	getAllDeleteObjectsJob(GetAllDeleteObjectsJobRequest requestObject) Fetch details of all the Delete Objects Jobs.
DeleteObjectsJobResponse	getDeleteObjectsJob(GetDeleteObjectsJobRequest requestObject) Fetch status and details of Delete Objects Job.
DeleteObjectsJobErrorDetailsResponse	getDeleteObjectsJobErrors(GetDeleteObjectsJobErrorsRequest requestObject) Fetch errors of Delete Objects Job.
ObjectListResponse	queryObjects(QueryObjectsRequest requestObject) Query objects.

Methods inherited from class Object

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

Constructor Detail

ObjectOperationsClient

public ObjectOperationsClient(ObjectOperationsClient.ClientBuilder builder)

Method Detail

builder

public static ObjectOperationsClient.ClientBuilder builder()

createDeleteObjectsJob

public DeleteObjectsJobResponse createDeleteObjectsJob(CreateDeleteObjectsJobRequest requestObject)
                                                throws MindsphereException

Delete multiple objects in bulk. Create asynchronous job to delete multiple objects for the specified paths. If any of the given paths doesn't exist then job will return status as COMPLETED_WITH_ERRORS. <br/><br/>Jobs which are completed with or without errors would be deleted periodically. <br/><br/>Data once deleted cannot be recovered.

202 - Accepted

400 - Bad request. Possible errors: <br> <table> <colgroup> <col span=\"1\" style=\"width: 30%;\"> <col span=\"1\" style=\"width: 70%;\"> </colgroup> <tr> <th align=\"left\">Code Suffix</th> <th align=\"left\">Message (parametrized)</th> </tr> <tr> <td>pathTooLong</td> <td>Path '{path}' must be no longer than 1024 characters.</td> </tr> <tr> <td>pathInvalid</td> <td>Provided path '{path}' is invalid.</td> </tr> <tr> <td>pathDuplicate</td> <td>Provided path '{path}' is duplicate.</td> </tr> <tr> <td>noSuchSubtenant</td> <td>Provided subtenant does not belong to tenant.</td> </tr> </table>

403 - Forbidden. Possible errors: <br> <table> <colgroup> <col span=\"1\" style=\"width: 30%;\"> <col span=\"1\" style=\"width: 70%;\"> </colgroup> <tr> <th align=\"left\">Code Suffix</th> <th align=\"left\">Message (parametrized)</th> </tr> <tr> <td>subtenantIdNotAllowed</td> <td>Only tenants can address a subtenant's resource using subtenantId.</td> </tr> </table>

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

Parameters:

requestObject - - Object of type CreateDeleteObjectsJobRequest {Parameters are DeleteObjectsJob*}

Returns:

DeleteObjectsJobResponse

Throws:

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

deleteObject

public void deleteObject(DeleteObjectRequest requestObject)
                  throws MindsphereException

delete an object. Delete the object for the specified path.

204 - deleted

400 - Bad request. Possible errors: <br> <table> <colgroup> <col span=\"1\" style=\"width: 30%;\"> <col span=\"1\" style=\"width: 70%;\"> </colgroup> <tr> <th align=\"left\">Code Suffix</th> <th align=\"left\">Message (parametrized)</th> </tr> <tr> <td>parameterPathTooLong</td> <td>Parameter complete path, which is, the default path {defaultpath} and input path must be no longer than 1024 characters.</td> </tr> <tr> <td>parameterPathInvalid</td> <td>Provided parameter path is invalid.</td> </tr> <tr> <td>noSuchSubtenant</td> <td>Provided subtenant does not belong to tenant.</td> </tr> </table>

403 - Forbidden. Possible errors: <br> <table> <colgroup> <col span=\"1\" style=\"width: 30%;\"> <col span=\"1\" style=\"width: 70%;\"> </colgroup> <tr> <th align=\"left\">Code Suffix</th> <th align=\"left\">Message (parametrized)</th> </tr> <tr> <td>subtenantIdNotAllowed</td> <td>Only tenants can address a subtenant's resource using subtenantId.</td> </tr> </table>

404 - Not Found. Possible errors: <br> <table> <colgroup> <col span=\"1\" style=\"width: 30%;\"> <col span=\"1\" style=\"width: 70%;\"> </colgroup> <tr> <th align=\"left\">Code Suffix</th> <th align=\"left\">Message (parametrized)</th> </tr> <tr> <td>objectNotFoundError</td> <td>Object not found.</td> </tr> </table>

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

Parameters:

requestObject - - Object of type DeleteObjectRequest {Parameters are path*,subtenantId}

Throws:

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

getAllDeleteObjectsJob

public DeleteObjectsJobList getAllDeleteObjectsJob(GetAllDeleteObjectsJobRequest requestObject)
                                            throws MindsphereException

Fetch details of all the Delete Objects Jobs. Retrieve list of all the Delete Objects Jobs.

200 - List of Delete Objects Jobs.

400 - Bad request. Possible errors: <br> <table> <colgroup> <col span=\"1\" style=\"width: 30%;\"> <col span=\"1\" style=\"width: 70%;\"> </colgroup> <tr> <th align=\"left\">Code Suffix</th> <th align=\"left\">Message (parametrized)</th> </tr> <tr> <td>noSuchSubtenant</td> <td>Provided subtenant does not belong to tenant.</td> </tr> <tr> <td>invalidPageSize</td> <td>Page size cannot exceed {maxPageSize}.</td> </tr> <tr> <td>invalidStatus</td> <td>Provided job status is not valid.</td> </tr> </table>

403 - Forbidden. Possible errors: <br> <table> <colgroup> <col span=\"1\" style=\"width: 30%;\"> <col span=\"1\" style=\"width: 70%;\"> </colgroup> <tr> <th align=\"left\">Code Suffix</th> <th align=\"left\">Message (parametrized)</th> </tr> <tr> <td>subtenantIdNotAllowed</td> <td>Only tenants can address a subtenant's resource using subtenantId.</td> </tr> </table>

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

Parameters:

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

Returns:

DeleteObjectsJobList

Throws:

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

getDeleteObjectsJob

public DeleteObjectsJobResponse getDeleteObjectsJob(GetDeleteObjectsJobRequest requestObject)
                                             throws MindsphereException

Fetch status and details of Delete Objects Job. Retrieve information of given Delete Objects Job. <br/> Only the objects of one tenant or subtenant are returned. In case a tenant wants to retrieve information on a subtenant's objects, the subtenantId query parameter must be used.

200 - List of folders and objects.

400 - Bad request. Possible errors: <br> <table> <colgroup> <col span=\"1\" style=\"width: 30%;\"> <col span=\"1\" style=\"width: 70%;\"> </colgroup> <tr> <th align=\"left\">Code Suffix</th> <th align=\"left\">Message (parametrized)</th> </tr> <tr> <td>noSuchSubtenant</td> <td>Provided subtenant does not belong to tenant.</td> </tr> </table>

403 - Forbidden. Possible errors: <br> <table> <colgroup> <col span=\"1\" style=\"width: 30%;\"> <col span=\"1\" style=\"width: 70%;\"> </colgroup> <tr> <th align=\"left\">Code Suffix</th> <th align=\"left\">Message (parametrized)</th> </tr> <tr> <td>subtenantIdNotAllowed</td> <td>Only tenants can address a subtenant's resource using subtenantId.</td> </tr> </table>

404 - Not Found. Possible errors: <br> <table> <colgroup> <col span=\"1\" style=\"width: 30%;\"> <col span=\"1\" style=\"width: 70%;\"> </colgroup> <tr> <th align=\"left\">Code Suffix</th> <th align=\"left\">Message (parametrized)</th> </tr> <tr> <td>jobNotFound</td> <td>Requested job not found.</td> </tr> </table>

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

Parameters:

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

Returns:

DeleteObjectsJobResponse

Throws:

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

getDeleteObjectsJobErrors

public DeleteObjectsJobErrorDetailsResponse getDeleteObjectsJobErrors(GetDeleteObjectsJobErrorsRequest requestObject)
                                                               throws MindsphereException

Fetch errors of Delete Objects Job. Retrieve errors of given Delete Objects Job. This endpoint should be called only when /deleteObjectsJobs/{id} returns status as COMPLETED_WITH_ERRORS<br/> Only the objects of one tenant or subtenant are returned. In case a tenant wants to retrieve information on a subtenant's objects, the subtenantId query parameter must be used.

200 - Status of Delete Objects Job and list of objects for which delete failed..

400 - Bad request. Possible errors: <br> <table> <colgroup> <col span=\"1\" style=\"width: 30%;\"> <col span=\"1\" style=\"width: 70%;\"> </colgroup> <tr> <th align=\"left\">Code Suffix</th> <th align=\"left\">Message (parametrized)</th> </tr> <tr> <td>noSuchSubtenant</td> <td>Provided subtenant does not belong to tenant.</td> </tr> <tr> <td>invalidJobStatus</td> <td>Provided Job doesn't have status as COMPLETED_WITH_ERRORS.</td> </tr> </table>

403 - Forbidden. Possible errors: <br> <table> <colgroup> <col span=\"1\" style=\"width: 30%;\"> <col span=\"1\" style=\"width: 70%;\"> </colgroup> <tr> <th align=\"left\">Code Suffix</th> <th align=\"left\">Message (parametrized)</th> </tr> <tr> <td>subtenantIdNotAllowed</td> <td>Only tenants can address a subtenant's resource using subtenantId.</td> </tr> </table>

404 - Not Found. Possible errors: <br> <table> <colgroup> <col span=\"1\" style=\"width: 30%;\"> <col span=\"1\" style=\"width: 70%;\"> </colgroup> <tr> <th align=\"left\">Code Suffix</th> <th align=\"left\">Message (parametrized)</th> </tr> <tr> <td>jobNotFound</td> <td>Requested job not found.</td> </tr> </table>

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

Parameters:

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

Returns:

DeleteObjectsJobErrorDetailsResponse

Throws:

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

queryObjects

public ObjectListResponse queryObjects(QueryObjectsRequest requestObject)
                                throws MindsphereException

Query objects. Retrieve information on existing objects. In case a folder is specified as input path, all child objects within the folder are returned. Objects in sub-folders of the given folder are not returned. In case a file is specified as input path, only the file is returned. Only the objects of one tenant or subtenant are returned. In case a tenant wants to retrieve information on a subtenant's objects, the subtenantId query parameter must be used.

200 - List of folders and objects.

400 - Bad request. Possible errors: <br> <table> <colgroup> <col span=\"1\" style=\"width: 30%;\"> <col span=\"1\" style=\"width: 70%;\"> </colgroup> <tr> <th align=\"left\">Code Suffix</th> <th align=\"left\">Message (parametrized)</th> </tr> <tr> <td>parameterPathTooLong</td> <td>Parameter complete path, which is, the default path {defaultpath} and input path must be no longer than 1024 characters.</td> </tr> <tr> <td>parameterPathInvalid</td> <td>Provided parameter path is invalid.</td> </tr> <tr> <td>noSuchSubtenant</td> <td>Provided subtenant does not belong to tenant.</td> </tr> </table>

403 - Forbidden. Possible errors: <br> <table> <colgroup> <col span=\"1\" style=\"width: 30%;\"> <col span=\"1\" style=\"width: 70%;\"> </colgroup> <tr> <th align=\"left\">Code Suffix</th> <th align=\"left\">Message (parametrized)</th> </tr> <tr> <td>subtenantIdNotAllowed</td> <td>Only tenants can address a subtenant's resource using subtenantId.</td> </tr> </table>

404 - Not Found. Possible errors: <br> <table> <colgroup> <col span=\"1\" style=\"width: 30%;\"> <col span=\"1\" style=\"width: 70%;\"> </colgroup> <tr> <th align=\"left\">Code Suffix</th> <th align=\"left\">Message (parametrized)</th> </tr> <tr> <td>pathNotFound</td> <td>Requested path not found.</td> </tr> </table>

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

Parameters:

requestObject - - Object of type QueryObjectsRequest {Parameters are path,subtenantId,pageToken}

Returns:

ObjectListResponse

Throws:

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