com.siemens.mindsphere.sdk.integrateddatalake.apiclient

Class ObjectAccessOperationsClient

Object

MindsphereAPIClient

ObjectAccessOperationsClient

public class ObjectAccessOperationsClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ObjectAccessOperationsClient.ClientBuilder	builder()
CrossAccount	createCrossAccount(CreateCrossAccountRequest requestObject) Create a cross account Create a cross account on which access needs to be given for paths.
CrossAccountAccess	createCrossAccountAccess(CreateCrossAccountAccessRequest requestObject) Create a cross account access Create a cross account access.
void	deleteCrossAccount(DeleteCrossAccountRequest requestObject) Delete cross account and corresponding accesses.
void	deleteCrossAccountAccess(DeleteCrossAccountAccessRequest requestObject) Delete a cross account access.
SignedUrlResponse	generateDownloadObjectUrls(GenerateDownloadObjectUrlsRequest requestObject) Generate signed URLs to download for single object.
SignedUrlResponse	generateUploadObjectUrls(GenerateUploadObjectUrlsRequest requestObject) Generate signed URLs to upload an object.
CrossAccount	getCrossAccount(GetCrossAccountRequest requestObject) Get details of selected cross account Get details of selected cross account.
CrossAccountAccess	getCrossAccountAccess(GetCrossAccountAccessRequest requestObject) Get a selected access for a selected cross account Get a selected access for a selected cross account.
CrossAccountListResource	listCrossAccount(ListCrossAccountRequest requestObject) Get a list of cross accounts Get list of cross accounts on which access was given.
CrossAccountAccessListResource	listCrossAccountAccess(ListCrossAccountAccessRequest requestObject) Get a list of cross account accesses Get list of cross account accesses.
CrossAccount	updateCrossAccount(UpdateCrossAccountRequest requestObject) Update a cross account Update a cross account on which access needs to be managed.
CrossAccountAccess	updateCrossAccountAccess(UpdateCrossAccountAccessRequest requestObject) Update a cross account access Update a cross account access.

Methods inherited from class Object

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

Constructor Detail

ObjectAccessOperationsClient

public ObjectAccessOperationsClient(ObjectAccessOperationsClient.ClientBuilder builder)

Method Detail

builder

public static ObjectAccessOperationsClient.ClientBuilder builder()

createCrossAccount

public CrossAccount createCrossAccount(CreateCrossAccountRequest requestObject)
                                throws MindsphereException

Create a cross account Create a cross account on which access needs to be given for paths. * If, in request body subtenant is denoted as \"**\", it is a special cross account. In this case, on this cross account, tenant implicitly gets Read Only access to the storage account's root level data path for itself and for all its subtenants. For this case, the authorization token should be that of the tenant.

201 - created

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>invalidAccessorAccountId</td> <td>Accessor account Id is invalid.</td> </tr> <tr> <td>noSuchSubtenant</td> <td>Provided subtenant does not belong to tenant.</td> </tr> <tr> <td>parameterTooLong</td> <td>Input parameter {name} must be no longer than {length} characters.</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>

409 - Conflict. 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>accessorAccountIdConflict</td> <td>Cross account with given accessor account ID already exists.</td> </tr> <tr> <td>nameConflict</td> <td>Cross account with given name already exists.</td> </tr> </table>

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

Parameters:

requestObject - - Object of type CreateCrossAccountRequest {Parameters are crossAccountRequest*}

Returns:

CrossAccount

Throws:

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

createCrossAccountAccess

public CrossAccountAccess createCrossAccountAccess(CreateCrossAccountAccessRequest requestObject)
                                            throws MindsphereException

Create a cross account access Create a cross account access. If the cross account is created for tenant and all subtenants (**), then this operation is implicitly handled and not allowed through API. Maximum 5 cross account accesses can be created with ENABLED status. Maximum 10 cross accounts can be created with DISABLED status.

201 - created

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>maxEnabledLimitReached</td> <td>Maximum limit, {limit} reached for the enabled cross account accesses.</td> </tr> <tr> <td>maxDisabledLimitReached</td> <td>Maximum limit, {limit} reached for the disabled cross account accesses.</td> </tr> <tr> <td>pathLengthExceedError</td> <td>Path in request body property, must not be more than 500 characters long.</td> </tr> <tr> <td>pathHasInvalidCharacters</td> <td>Characters used for values of request body property path must be in the character set '[a-zA-Z0-9.!*'() _-/=]'.Spaces are not allowed at beginning or at end. Also, consecutive spaces are not allowed.</td> </tr> <tr> <td>immutableAccess</td> <td>Special Read Only access at root level for the storage account is already present. Create of a new access is not supported for this cross account.</td> </tr> <tr> <td>parameterTooLong</td> <td>Input parameter {name} must be no longer than {length} characters.</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>crossAccountNotFound</td> <td>Cross account not found.</td> </tr> </table>

409 - Conflict. 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>accessConflict</td> <td>Access with matching or overlapping path already exists.</td> </tr> </table>

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

Parameters:

requestObject - - Object of type CreateCrossAccountAccessRequest {Parameters are id*,crossAccountAccessRequest*}

Returns:

CrossAccountAccess

Throws:

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

deleteCrossAccount

public void deleteCrossAccount(DeleteCrossAccountRequest requestObject)
                        throws MindsphereException

Delete cross account and corresponding accesses. Delete cross account and corresponding accesses.

204 - Deleted

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>crossAccountNotFound</td> <td>Cross account not found.</td> </tr> </table>

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

Parameters:

requestObject - - Object of type DeleteCrossAccountRequest {Parameters are id*,If-Match*}

Throws:

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

deleteCrossAccountAccess

public void deleteCrossAccountAccess(DeleteCrossAccountAccessRequest requestObject)
                              throws MindsphereException

Delete a cross account access. Delete a cross account access. If the cross account is created for tenant and all subtenants (**), then this operation is implicitly handled by deletion of cross account and not allowed through API

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>immutableAccess</td> <td>Special Read Only access at root level for the storag account. Delete is not supported for this access. Delete the cross account if required.</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>crossAccountNotFound</td> <td>Cross account not found.</td> </tr> <tr> <td>crossAccountAccessNotFound</td> <td>Cross account access not found.</td> </tr> </table>

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

Parameters:

requestObject - - Object of type DeleteCrossAccountAccessRequest {Parameters are id*,accessId*,If-Match*}

Throws:

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

generateDownloadObjectUrls

public SignedUrlResponse generateDownloadObjectUrls(GenerateDownloadObjectUrlsRequest requestObject)
                                             throws MindsphereException

Generate signed URLs to download for single object. Generate signed URLs to download one or more objects.

201 - Signed URL response for download

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>Value of request body property complete path, which is, the default path {defaultpath} and input path must be no longer than 1024 characters.</td> </tr> <tr> <td>pathHasInvalidCharacters</td> <td>Characters used for values of request body property paths[].path must be in the character set '[a-zA-Z0-9.!*'() _-/=]'.Spaces are not allowed at beginning or at end. Also, consecutive spaces are not allowed.</td> </tr> <tr> <td>pathInvalid</td> <td>Provided property paths[].path is invalid.</td> </tr> <tr> <td>noSuchSubtenant</td> <td>Provided subtenant does not belong to tenant.</td> </tr> <tr> <td>tooManyPaths</td> <td>A maximum of 30 paths can be provided per request.</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 GenerateDownloadObjectUrlsRequest {Parameters are generateUrlPayload}

Returns:

SignedUrlResponse

Throws:

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

generateUploadObjectUrls

public SignedUrlResponse generateUploadObjectUrls(GenerateUploadObjectUrlsRequest requestObject)
                                           throws MindsphereException

Generate signed URLs to upload an object. Generate signed URLs to upload one or more objects.

201 - Signed URL response for upload

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>Value of request body property complete path, which is, the default path {defaultpath} and input path must be no longer than 1024 characters.</td> </tr> <tr> <td>pathHasInvalidCharacters</td> <td>Characters used for values of request body property paths[].path must be in the character set '[a-zA-Z0-9.!*'() _-/=]'.Spaces are not allowed at beginning or at end. Also, consecutive spaces are not allowed.</td> </tr> <tr> <td>pathInvalid</td> <td>Provided property paths[].path is invalid.</td> </tr> <tr> <td>noSuchSubtenant</td> <td>Provided subtenant does not belong to tenant.</td> </tr> <tr> <td>tooManyPaths</td> <td>A maximum of 30 paths can be provided per request.</td> </tr> <tr> <td>agentPathMismatch</td> <td>Agent ID from agent authorization token and path requested for upload do not match.</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 GenerateUploadObjectUrlsRequest {Parameters are generateUrlPayload}

Returns:

SignedUrlResponse

Throws:

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

getCrossAccount

public CrossAccount getCrossAccount(GetCrossAccountRequest requestObject)
                             throws MindsphereException

Get details of selected cross account Get details of selected cross account.

200 - OK

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>crossAccountNotFound</td> <td>Cross account not found.</td> </tr> </table>

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

Parameters:

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

Returns:

CrossAccount

Throws:

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

getCrossAccountAccess

public CrossAccountAccess getCrossAccountAccess(GetCrossAccountAccessRequest requestObject)
                                         throws MindsphereException

Get a selected access for a selected cross account Get a selected access for a selected cross account.

200 - OK

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>crossAccountNotFound</td> <td>Cross account not found.</td> </tr> <tr> <td>crossAccountAccessNotFound</td> <td>Cross account access not found.</td> </tr> </table>

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

Parameters:

requestObject - - Object of type GetCrossAccountAccessRequest {Parameters are id*,accessId*}

Returns:

CrossAccountAccess

Throws:

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

listCrossAccount

public CrossAccountListResource listCrossAccount(ListCrossAccountRequest requestObject)
                                          throws MindsphereException

Get a list of cross accounts Get list of cross accounts on which access was given. * If requester is tenant, all the cross account for the tenant as well as its all subtenants are returned. * If requester is a subtenant, all the cross accounts for the subtenant are returned. * If tenant wants to filter results for a particular subtenant, filter query parameter subtenantId can be used. This filter query parameter is applicable only if the requester is tenant.

200 - OK

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>

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

Parameters:

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

Returns:

CrossAccountListResource

Throws:

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

listCrossAccountAccess

public CrossAccountAccessListResource listCrossAccountAccess(ListCrossAccountAccessRequest requestObject)
                                                      throws MindsphereException

Get a list of cross account accesses Get list of cross account accesses.

200 - OK

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>crossAccountNotFound</td> <td>Cross account not found.</td> </tr> </table>

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

Parameters:

requestObject - - Object of type ListCrossAccountAccessRequest {Parameters are id*,page,size}

Returns:

CrossAccountAccessListResource

Throws:

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

updateCrossAccount

public CrossAccount updateCrossAccount(UpdateCrossAccountRequest requestObject)
                                throws MindsphereException

Update a cross account Update a cross account on which access needs to be managed.

200 - OK

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>parameterTooLong</td> <td>Input parameter {name} must be no longer than {length} characters.</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>crossAccountNotFound</td> <td>Cross account not found.</td> </tr> </table>

409 - 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>nameConflict</td> <td>Cross account with given name already exists.</td> </tr> </table>

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

Parameters:

requestObject - - Object of type UpdateCrossAccountRequest {Parameters are id*,If-Match*,crossAccountRequest*}

Returns:

CrossAccount

Throws:

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

updateCrossAccountAccess

public CrossAccountAccess updateCrossAccountAccess(UpdateCrossAccountAccessRequest requestObject)
                                            throws MindsphereException

Update a cross account access Update a cross account access. This operation is not allowed when the cross account is created for special case of tenant and all subtenants (**). Maximum 5 cross account accesses can be present with ENABLED status. Maximum 10 cross accounts can be present with DISABLED status.

200 - OK

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>maxEnabledLimitReached</td> <td>Maximum limit, {limit} reached for the enabled cross account accesses.</td> </tr> <tr> <td>maxDisabledLimitReached</td> <td>Maximum limit, {limit} reached for the disabled cross account accesses.</td> </tr> <tr> <td>pathTooLong</td> <td>Value of request body property path must be no longer than 500 characters.</td> </tr> <tr> <td>pathHasInvalidCharacters</td> <td>Characters used for values of request body property path must be in the character set '[a-zA-Z0-9.!*'() _-/=]'.Spaces are not allowed at beginning or at end. Also, consecutive spaces are not allowed.</td> </tr> <tr> <td>immutableAccess</td> <td>Special Read Only access at root level for the storage account. Update is not supported for this access.</td> </tr> <tr> <td>parameterTooLong</td> <td>Input parameter {name} must be no longer than {length} characters.</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>crossAccountNotFound</td> <td>Cross account not found.</td> </tr> <tr> <td>crossAccountAccessNotFound</td> <td>Cross account access not found.</td> </tr> </table>

409 - Conflict. 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>accessConflict</td> <td>Access with matching or overlapping path already exists.</td> </tr> </table>

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

Parameters:

requestObject - - Object of type UpdateCrossAccountAccessRequest {Parameters are id*,accessId*,If-Match*,crossAccountAccessRequest*}

Returns:

CrossAccountAccess

Throws:

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