DataViewAddDefinition

FRAMES NO FRAMES

Overview

Package

Deprecated

Help

API Reference for EPL (ApamaDoc) 10.15.0.2

SUMMARY: IMPORT | CONSTANT | MEMBER | ACTION

DETAIL: IMPORT | CONSTANT | MEMBER | ACTION

com.apama.dataview
Event DataViewAddDefinition

Define a new DataView type.

Expect either a DataViewDefinition or a DataViewException in response.

See Also:: com.apama.dataview.DataViewDefinition - , DataViewException, DataViewAddItem

Direction: From the application monitor to the DataViewService.

Member summary
`string`	`msgId` Optional application-defined message identifier used to correlate requests and responses.
`string`	`dvName` The name that uniquely identifies this DataView (e.g. DataView_XXX).
`string`	`dvDisplayName` The display name of the DataView (e.g. "XXX manager").
`string`	`dvDescription` Optional field containing a description of this DataView (e.g. "This DataView exposes XXX objects").
`sequence<string>`	`fieldNames` Specifies the names of each field exposed by the DataView.
`sequence<string>`	`fieldTypes` Specifies the types corresponding to each field in the fieldNames sequence. Supported types are: string, float, integer, boolean, decimal.
`sequence<string>`	`keyFields` Optional set of field names whose values in an Item are to be combined to make a unique key that can be used instead of the dvItemId field of DataViewDeleteItem, DataViewUpdateItem, and DataViewUpdateDelta events.
`dictionary<string, string>`	`extraParams` Optional dictionary of extra information about this definition, some of which may be available for display in dashboards and clients.

Member detail

dvDescription

            string dvDescription

Optional field containing a description of this DataView (e.g. "This DataView exposes XXX objects").

dvDisplayName

            string dvDisplayName

The display name of the DataView (e.g. "XXX manager").

dvName

            string dvName

The name that uniquely identifies this DataView (e.g. DataView_XXX).

extraParams

            dictionary<string, string> extraParams

Optional dictionary of extra information about this definition, some of which may be available for display in dashboards and clients.

DataView implementation-specific parameters may also be stored here.

To avoid collisions with keys that may be added to the product in future, all user-defined extraParams should start with a prefix identifying the application or organisation they were added for.

fieldNames

            sequence<string> fieldNames

Specifies the names of each field exposed by the DataView.

fieldTypes

            sequence<string> fieldTypes

Specifies the types corresponding to each field in the fieldNames sequence. Supported types are: string, float, integer, boolean, decimal.

keyFields

            sequence<string> keyFields

Optional set of field names whose values in an Item are to be combined to make a unique key that can be used instead of the dvItemId field of DataViewDeleteItem, DataViewUpdateItem, and DataViewUpdateDelta events.

msgId

            string msgId

Optional application-defined message identifier used to correlate requests and responses.