ManagedObject

FRAMES NO FRAMES

Overview

Package

Deprecated

Help

API Reference for EPL (ApamaDoc) 10.15.3.4

SUMMARY: IMPORT | CONSTANT | MEMBER | ACTION

DETAIL: IMPORT | CONSTANT | MEMBER | ACTION

com.apama.cumulocity
Event ManagedObject

Represents a Cumulocity managed object (typically a device).

This event can be sent to Cumulocity to update an existing managed object, or can be received to notify of changes to a managed object.

Notifications are sent on the SUBSCRIBE_CHANNEL in various situations: on startup, in response to a RequestAllDevices event, or if a new ManagedObject is detected (and the configuration property subscribeToDevices is enabled). Here is an example of one of these notification events:

 com.apama.cumulocity.ManagedObject("49","","temp_sensor",["c8y_Restart"],["c8y_Temperature","c8y_Light"], ["childDevRefIds"],["childAstRefIds"],["devParentIds"],["assetParentIds"],{"lat":1.0},{"c8y_IsDevice":{}})

To create/update a ManagedObject, send a ManagedObject event object to ManagedObject.SEND_CHANNEL. For example:


// Create a ManagedObject:

ManagedObject createManagedObject := new ManagedObject;
createManagedObject.name := "myDevice";
createManagedObject.params.add("c8y_IsDevice", new dictionary<any, any>);
send createManagedObject to ManagedObject.SEND_CHANNEL;


// Update the name:

ManagedObject updateManagedObject := new ManagedObject;
updateManagedObject.id := "deviceId";
updateManagedObject.name := "myDevice_UpdatedName";
send updateManagedObject to ManagedObject.SEND_CHANNEL;

When listening for events of this type from Cumulocity, use the isCreate() and/or isUpdate() actions within the listener to distinguish between create and update events.

See Also:: com.apama.cumulocity.RequestAllDevices -

Constant summary
`string`	`CHANNEL := "cumulocity.devices"` The channel to which `ManagedObject` events are sent from the transport. Deprecated: [This channel constant has been deprecated. Use SUBSCRIBE_CHANNEL instead.]
`string`	`NOTIFICATION_CREATED := "CREATED"` Value of PARAM_NOTIFICATION that indicates this is a new object.
`string`	`NOTIFICATION_UPDATED := "UPDATED"` Value of PARAM_NOTIFICATION that indicates this is an update to an existing object.
`string`	`PARAM_NOTIFICATION := ".apama_notificationType"` Entry in params that identifies if this is a new object or an update to an existing object. Entry will have a value matching either NOTIFICATION_CREATED or NOTIFICATION_UPDATED.
`string`	`SEND_CHANNEL := "CumulocityIoTGenericChain"` The channel to send a `ManagedObject` event to update an existing managed object in Cumulocity.
`string`	`SUBSCRIBE_CHANNEL := "cumulocity.devices"` The channel to which `ManagedObject` events are sent from the transport.
`string`	`UPDATE_CHANNEL := "CumulocityIoTGenericChain"` The channel to send a `ManagedObject` event to update an existing managed object in Cumulocity. Deprecated: [This channel constant has been deprecated. Use SEND_CHANNEL instead.]

Member summary
`string`	`id` The unique identifier for this specific managed object (device).
`string`	`type` The type of the device.
`string`	`name` The name of this ManagedObject. Note: This does not have to be a unique value.
`sequence<string>`	`supportedOperations` List of supported operations for this device.
`sequence<string>`	`supportedMeasurements` List of supported measurements for this device.
`sequence<string>`	`childDeviceIds` Ids of child devices. Note: This field cannot be set by sending ManagedObject events.
`sequence<string>`	`childAssetIds` Ids of child devices. Note: This field cannot be set by sending ManagedObject events.
`sequence<string>`	`deviceParentIds` Ids of parent devices. Note: This field cannot be set by sending ManagedObject events.
`sequence<string>`	`assetParentIds` Ids of parent assets. Note: This field cannot be set by sending ManagedObject events.
`dictionary<string, float>`	`position` If known, contains lat, lng, altitude and accuracy.
`dictionary<string, any>`	`params` Other fragments for this ManagedObject.

Action summary
`boolean`	`isCreate()` Check if this ManagedObject instance was as a result of a managed object being created in Cumulocity.
`boolean`	`isUpdate()` Check if this ManagedObject instance was as a result of a managed object being updated in Cumulocity.
`com.apama.cumulocity.ResponseWrapper`	`withChannelResponse(integer reqId, dictionary<string, string> headers)` Create or update a ManagedObject in Cumulocity and receive a response event confirming the change on ManagedObject.SUBSCRIBE_CHANNEL channel.
`com.apama.cumulocity.ResponseWrapper`	`withResponse(integer reqId, dictionary<string, string> headers)` Create or update a ManagedObject in Cumulocity and receive a response event on default channel, confirming the change. Deprecated: [This API has been deprecated. Use withChannelResponse API to receive confirmation on ManagedObject.SUBSCRIBE_CHANNEL channel.]

Constant detail

CHANNEL

string CHANNEL := "cumulocity.devices"

Deprecated:: [This channel constant has been deprecated. Use SUBSCRIBE_CHANNEL instead.]

The channel to which ManagedObject events are sent from the transport.

NOTIFICATION_CREATED

string NOTIFICATION_CREATED := "CREATED"

Value of PARAM_NOTIFICATION that indicates this is a new object.

Since:: 10.5.4.0

NOTIFICATION_UPDATED

string NOTIFICATION_UPDATED := "UPDATED"

Value of PARAM_NOTIFICATION that indicates this is an update to an existing object.

Since:: 10.5.4.0

PARAM_NOTIFICATION

string PARAM_NOTIFICATION := ".apama_notificationType"

Entry in params that identifies if this is a new object or an update to an existing object. Entry will have a value matching either NOTIFICATION_CREATED or NOTIFICATION_UPDATED.

Since:: 10.5.4.0

SEND_CHANNEL

string SEND_CHANNEL := "CumulocityIoTGenericChain"

The channel to send a ManagedObject event to update an existing managed object in Cumulocity.

Since:: 10.5.2.0

SUBSCRIBE_CHANNEL

string SUBSCRIBE_CHANNEL := "cumulocity.devices"

The channel to which ManagedObject events are sent from the transport.

Since:: 10.5.2.0

UPDATE_CHANNEL

string UPDATE_CHANNEL := "CumulocityIoTGenericChain"

Deprecated:: [This channel constant has been deprecated. Use SEND_CHANNEL instead.]

The channel to send a ManagedObject event to update an existing managed object in Cumulocity.

Member detail

assetParentIds

sequence<string> assetParentIds

Ids of parent assets. Note: This field cannot be set by sending ManagedObject events.

childAssetIds

sequence<string> childAssetIds

Ids of child devices. Note: This field cannot be set by sending ManagedObject events.

childDeviceIds

sequence<string> childDeviceIds

Ids of child devices. Note: This field cannot be set by sending ManagedObject events.

deviceParentIds

sequence<string> deviceParentIds

Ids of parent devices. Note: This field cannot be set by sending ManagedObject events.

id

string id

The unique identifier for this specific managed object (device).

Supply as empty if creating a new managed object.

name

string name

The name of this ManagedObject. Note: This does not have to be a unique value.

params

dictionary<string, any> params

Other fragments for this ManagedObject.

position

dictionary<string, float> position

If known, contains lat, lng, altitude and accuracy.

supportedMeasurements

sequence<string> supportedMeasurements

List of supported measurements for this device.

supportedOperations

sequence<string> supportedOperations

List of supported operations for this device.

type

string type

The type of the device.

Action detail

isCreate

boolean isCreate()

Check if this ManagedObject instance was as a result of a managed object being created in Cumulocity.

For ManagedObject events that have come from Cumulocity, only one of isCreate() or isUpdate() will return true.

Throws:: Throws IllegalStateException if called on an instance that did not come from Cumulocity.

Since:: 10.7.1.0

See Also:: com.apama.cumulocity.ManagedObject#isUpdate() -

isUpdate

boolean isUpdate()

Check if this ManagedObject instance was as a result of a managed object being updated in Cumulocity.

For ManagedObject events that have come from Cumulocity, only one of isCreate() or isUpdate() will return true.

Throws:: Throws IllegalStateException if called on ManagedObject events that did not come from Cumulocity

Since:: 10.7.1.0

See Also:: com.apama.cumulocity.ManagedObject#isCreate() -

withChannelResponse

com.apama.cumulocity.ResponseWrapper withChannelResponse(integer reqId, dictionary<string, string> headers)

Create or update a ManagedObject in Cumulocity and receive a response event confirming the change on ManagedObject.SUBSCRIBE_CHANNEL channel.

Just sending a ManagedObject is fire and forget. If your application requires an acknowledgement or the ID of the ManagedObject created or updated on ManagedObject.SUBSCRIBE_CHANNEL channel, then use the withChannelResponse API. You will need to subscribe to ManagedObject.SUBSCRIBE_CHANNEL channel. This API will create an event that can be sent as normal and get a response from Cumulocity for the newly created or updated ManagedObject. The responses are either an ObjectCommitted event or an ObjectCommitFailed event. The withChannelResponse API also allows you to provide headers to the create or update request. For example:


monitor.subscribe(ManagedObject.SUBSCRIBE_CHANNEL);
ManagedObject m := new ManagedObject;
// set fields in m
integer reqId := com.apama.cumulocity.Util.generateReqId();
// myapp is the user application key
on ObjectCommitted(reqId=reqId) as commit and not ObjectCommitFailed(reqId=reqId) {
	// do something
}
on ObjectCommitFailed(reqId=reqId) as failure and not ObjectCommitted(reqId=reqId) {
	// do something
}
send m.withChannelResponse(reqId, {"X-Cumulocity-Application-Key": "myapp"}) to ManagedObject.SEND_CHANNEL;

Parameters:: reqId - A request identifier generated from Util.generateReqId(). The response from Cumulocity will have the matching request identifier.; headers - Set headers of the create/update request. This can be used to explicitly control the processing mode of the create/update request.

See Also:: com.apama.cumulocity.ObjectCommitted - Successfully created or updated a ManagedObject.; com.apama.cumulocity.ObjectCommitFailed - Failed to create or update a ManagedObject.

withResponse

com.apama.cumulocity.ResponseWrapper withResponse(integer reqId, dictionary<string, string> headers)

Deprecated:: [This API has been deprecated. Use withChannelResponse API to receive confirmation on ManagedObject.SUBSCRIBE_CHANNEL channel.]

Create or update a ManagedObject in Cumulocity and receive a response event on default channel, confirming the change.

Just sending a ManagedObject is fire and forget. If your application requires an acknowledgement or the ID of the ManagedObject created or updated, then use the withResponse API. This API will create an event that can be sent as normal and get a response from Cumulocity for the newly created or updated ManagedObject. The responses are sent to default channel and hence can be listened for only in the main context. The responses are either an ObjectCommitted event or an ObjectCommitFailed event. The withResponse API also allows you to provide headers to the create or update request. For example:


ManagedObject m := new ManagedObject;
// set fields in m
integer reqId := com.apama.cumulocity.Util.generateReqId();
// myapp is the user application key
on ObjectCommitted(reqId=reqId) as commit and not ObjectCommitFailed(reqId=reqId) {
	// do something
}
on ObjectCommitFailed(reqId=reqId) as failure and not ObjectCommitted(reqId=reqId) {
	// do something
}
send m.withResponse(reqId, {"X-Cumulocity-Application-Key": "myapp"}) to ManagedObject.SEND_CHANNEL;

Parameters:: reqId - A request identifier generated from Util.generateReqId(). The response from Cumulocity will have the matching request identifier.; headers - Set headers of the create/update request. This can be used to explicitly control the processing mode of the create/update request.

See Also:: com.apama.cumulocity.ObjectCommitted - Successfully created or updated a ManagedObject.; com.apama.cumulocity.ObjectCommitFailed - Failed to create or update a ManagedObject.; com.apama.cumulocity.ManagedObject#withChannelResponse() - to receive confirmation on ManagedObject.SUBSCRIBE_CHANNEL channel.