com.siemens.mindsphere.sdk.integrateddatalake.apiclient

Class ObjectEventSubscriptionOperationsClient

Object

MindsphereAPIClient

ObjectEventSubscriptionOperationsClient

public class ObjectEventSubscriptionOperationsClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ObjectEventSubscriptionOperationsClient.ClientBuilder	builder()
SubscriptionResponse	createObjectEventSubscription(CreateObjectEventSubscriptionRequest requestObject) Create object event subscription.
void	deleteObjectEventSubscription(DeleteObjectEventSubscriptionRequest requestObject) Delete object event subscription by id.
SubscriptionResponse	patchObjectEventSubscription(PatchObjectEventSubscriptionRequest requestObject) Update object event subscription by id.
SubscriptionListResource	queryObjectEventSubscriptions(QueryObjectEventSubscriptionsRequest requestObject) List event subscriptions for the tenant or subtenant.
SubscriptionResponse	retrieveObjectEventSubscription(RetrieveObjectEventSubscriptionRequest requestObject) Read object event subscription by id.

Methods inherited from class Object

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

Constructor Detail

ObjectEventSubscriptionOperationsClient

public ObjectEventSubscriptionOperationsClient(ObjectEventSubscriptionOperationsClient.ClientBuilder builder)

Method Detail

builder

public static ObjectEventSubscriptionOperationsClient.ClientBuilder builder()

createObjectEventSubscription

public SubscriptionResponse createObjectEventSubscription(CreateObjectEventSubscriptionRequest requestObject)
                                                   throws MindsphereException

Create object event subscription. Allows users to subscribe for event notifications generated when the objects of a tenant or subtenant are created, updated, or deleted. Multiple subscriptions for the same path can be created when each has a different destination. Similarly, multiple subscriptions for the same destination can be created when each has a different path. Maximum 15 subscriptions can be created for a tenant or for a subtenant. Path in request payload should be upto folders and not upto object e.g. \"myfolder/mysubfolder\" ### Notification Content Based on the configured subscriptions, event notification messages are published to the destination. The event notification content is formatted in JSON according to this example. If object operation happened in subtenant folder, both tenantId and subtenantId will be part of the message. If object operation happened in tenant folder, only tenantId will be part of the message.: { \"path\" : \"/myfolder/mysubfolder/myobj.ext\", \"storageAccount\" : \"dlbucketname\", \"storagePath\" : \"/data/ten=mytenid/myfolder/mysubfolder/myobj.ext\" \"tenantId\" : \"mytenid\", \"subtenantId\" : \"204a896c-a23a-11e9-a2a3-2a2ae2dbcce4\" \"eventType\" : \"MODIFY\", \"timestamp\" : \"2019-05-17T14:47:44.351Z\" } where - 'path' path applicable for supplying to Data Lake APIs like /objectMetadata - 'storageAccount' Bucket name in case of AWS S3 - 'storagePath' Complete S3 prefix path including the object name. Clients should not rely on a given path structure, but should treat storagePath as opaque. - 'tenantId' Tenant Id on whose bucket the object operation happened, resulting in notification message - 'subtenantId' Optional. Subtenant Id, in case the object operation happened for a subtenant, resuling in notification message - 'eventType' is either 'MODIFY' in case of creation or update, and 'DELETE' in case of object deletion. - 'timestamp' records the time when the event happened. It is formatted according to ISO 8601 extended date/time format 'YYYY-MM-DDThh:mm:ss.sssZ'.

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>destinationSyntaxIncorrect</td> <td>Destination syntax is not correct.</td> </tr> <tr> <td>maxLimitReached</td> <td>Maximum limit, 15 reached for subscriptions for the tenant/subtenant.</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>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>

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>destinationConflict</td> <td>Existing subscription with id {id} found for same destination with exact or partial path match.</td> </tr> </table>

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

Parameters:

requestObject - - Object of type CreateObjectEventSubscriptionRequest {Parameters are subscription*}

Returns:

SubscriptionResponse

Throws:

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

deleteObjectEventSubscription

public void deleteObjectEventSubscription(DeleteObjectEventSubscriptionRequest requestObject)
                                   throws MindsphereException

Delete object event subscription by id. Delete object event subscription (Unsubscribe).

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>subscriptionNotFound</td> <td>Subscription 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>subsriptionConflict</td> <td>Subscription record changed in the background.</td> </tr> </table>

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

Parameters:

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

Throws:

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

patchObjectEventSubscription

public SubscriptionResponse patchObjectEventSubscription(PatchObjectEventSubscriptionRequest requestObject)
                                                  throws MindsphereException

Update object event subscription by id. Update object event subscription.

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>destinationSyntaxIncorrect</td> <td>Destination syntax is not correct.</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> </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>subscriptionNotFound</td> <td>Subscription 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>destinationConflict</td> <td>Existing subscription with id {id} found for same destination with exact or partial path match.</td> </tr> <tr> <td>subscriptionUpdated</td> <td>A different subscription version is available.</td> </tr> </table>

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

Parameters:

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

Returns:

SubscriptionResponse

Throws:

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

queryObjectEventSubscriptions

public SubscriptionListResource queryObjectEventSubscriptions(QueryObjectEventSubscriptionsRequest requestObject)
                                                       throws MindsphereException

List event subscriptions for the tenant or subtenant. List object event subscriptions for the tenant or subtenant. If requester is tenant, all the subscriptions for the tenant as well as its all subtenants are returned. If requester is a subtenant, all the subscriptions 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 QueryObjectEventSubscriptionsRequest {Parameters are page,size,filter}

Returns:

SubscriptionListResource

Throws:

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

retrieveObjectEventSubscription

public SubscriptionResponse retrieveObjectEventSubscription(RetrieveObjectEventSubscriptionRequest requestObject)
                                                     throws MindsphereException

Read object event subscription by id. Read object event subscription for the tenant.

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>subscriptionNotFound</td> <td>Subscription Not Found.</td> </tr> </table>

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

Parameters:

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

Returns:

SubscriptionResponse

Throws:

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