com.siemens.mindsphere.sdk.integrateddatalake.apiclient

Class ObjectOperationsWithAccessTokenClient

Object

MindsphereAPIClient

ObjectOperationsWithAccessTokenClient

public class ObjectOperationsWithAccessTokenClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
AccessTokenPermissionResource	accessTokenPermissions(AccessTokenPermissionsRequest requestObject) Allows to give write premission on folder/path Allows users (tenant) to give write permission on folder/path.
static ObjectOperationsWithAccessTokenClient.ClientBuilder	builder()
void	deleteAccessTokenPermissions(DeleteAccessTokenPermissionsRequest requestObject) Delete write permission on folder for the given id Delete write permission on folder for the given id This API can be accessed by tenant admin only
AccessTokens	generateAccessToken(GenerateAccessTokenRequest requestObject) Generate AWS STS token Allows users to request temporary, limited-privilege AWS credentials to get read-only or write-only access on the URI returned in the response.
AccessTokenPermissionResource	getAccessTokenPermissions(GetAccessTokenPermissionsRequest requestObject) Details of the write folder request for the given id Details of the write folder request for the given id This API can be accessed by tenant admin, to get details of the request including for subtenants.
AccessTokenPermissionResources	listAccessTokenPermissions(ListAccessTokenPermissionsRequest requestObject) List all folders having write premission List all folders having write permission.

Methods inherited from class Object

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

Constructor Detail

ObjectOperationsWithAccessTokenClient

public ObjectOperationsWithAccessTokenClient(ObjectOperationsWithAccessTokenClient.ClientBuilder builder)

Method Detail

builder

public static ObjectOperationsWithAccessTokenClient.ClientBuilder builder()

accessTokenPermissions

public AccessTokenPermissionResource accessTokenPermissions(AccessTokenPermissionsRequest requestObject)
                                                     throws MindsphereException

Allows to give write premission on folder/path Allows users (tenant) to give write permission on folder/path. This API can only be accessed by tenant admin. Tenant admin can also provide write permission on subtenant folder. Write permission on root folder can also be given, except TSI folder

201 - Created.

400 - Bad request. Possible errors: <br><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>accessNotAllowedForPath</td> <td>Access not allowed for given path {path}.</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>pathTooLong</td> <td>Path must be no longer than 1024 characters.</td> </tr> <tr> <td>noSuchSubtenant</td> <td>Provided subtenant does not belong to tenant.</td> </tr> <tr> <td>invalidPermission</td> <td>Invalid input parameter permission {permission}.</td> </tr> <tr> <td>tooManyAccessTokenPermissions&nbsp;</td> <td>For Tenant/Subtenant access on more than {max} prefix is not allowed.</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 AccessTokenPermissionsRequest {Parameters are writePathPayload}

Returns:

AccessTokenPermissionResource

Throws:

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

deleteAccessTokenPermissions

public void deleteAccessTokenPermissions(DeleteAccessTokenPermissionsRequest requestObject)
                                  throws MindsphereException

Delete write permission on folder for the given id Delete write permission on folder for the given id This API can be accessed by tenant admin only

204 - deleted

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>subtenantNotAllowed</td> <td>Only tenants can address a subtenant's resource.</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>accessTokenPermissionsNotFound&nbsp;</td> <td>Access Token Permissions Not Found.</td> </tr> </table>

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

Parameters:

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

Throws:

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

generateAccessToken

public AccessTokens generateAccessToken(GenerateAccessTokenRequest requestObject)
                                 throws MindsphereException

Generate AWS STS token Allows users to request temporary, limited-privilege AWS credentials to get read-only or write-only access on the URI returned in the response. * Read permission will always be on the root level. * Path field is optional for READ permission - If value for path is not provided then it will be considered on root level (\"/\"). * Ensure to enable write access on the path before requesting token with write permission. * Write access can be enabled using POST /accessTokenPermissions endpoint. * An access token requested for a given path also automatically gives access to all subpaths of the path. For example, if an access token is requested for path /a and there are subpaths /a/b and /a/b/c, the token allows to access those too. * An access token with write permissions can only be requested for the paths defined by resource accessTokenPermissions. An acecss token with read permissions can only be requested for the root path /.

200 - STS Token (temporary access token to access S3) and AWS S3 bucket Name

400 - Bad request. Possible errors: <br><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 must be no longer than 1024 characters.</td> </tr> <tr> <td>pathHasInvalidCharacters&nbsp;</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>noSuchSubtenant</td> <td>Provided subtenant does not belong to tenant.</td> </tr> <tr> <td>invalidDurationSeconds</td> <td>Input parameter durationSeconds must be between {minDurationSeconds} and {maxDurationSeconds} seconds.</td> </tr> <tr> <td>invalidPermission</td> <td>Invalid input parameter permission {permission}.</td> </tr> <tr> <td>accessTokenNotEnabled</td> <td>Access token permission {permission} is not enabled for path {path}.</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 GenerateAccessTokenRequest {Parameters are stsPayload}

Returns:

AccessTokens

Throws:

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

getAccessTokenPermissions

public AccessTokenPermissionResource getAccessTokenPermissions(GetAccessTokenPermissionsRequest requestObject)
                                                        throws MindsphereException

Details of the write folder request for the given id Details of the write folder request for the given id This API can be accessed by tenant admin, to get details of the request including for subtenants. Subtenant can access this API, to get details of the request belongs to their write folder.

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>accessTokenPermissionsNotFound&nbsp;</td> <td>Access Token Permissions Not Found.</td> </tr> </table>

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

Parameters:

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

Returns:

AccessTokenPermissionResource

Throws:

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

listAccessTokenPermissions

public AccessTokenPermissionResources listAccessTokenPermissions(ListAccessTokenPermissionsRequest requestObject)
                                                          throws MindsphereException

List all folders having write premission List all folders having write permission. This API can be accessed by tenant admin, to list all write permission folders including of subtenants. Subtenant can access this API, to get list write permission folders owned by subtenant. <h3>Limitations</h3> * <h4>Size parameter value should not be more than 1000.</h4>

200 - OK

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

Parameters:

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

Returns:

AccessTokenPermissionResources

Throws:

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