com.apama.dataview
Event DataViewDefinition


Confirmation that a specific DataView definition has been added.

Direction: From the DataViewService to the customer Monitor.
Constant summary
 stringEXTRA_PARAMS_METADATA_PREFIX := "Metadata:"

Prefix for identifying metadata entries in the extraParams dictionary. Entries with key names prefixed by the EXTRA_PARAMS_METADATA_PREFIX string are considered metadata entries.
 
Member summary
 stringmsgId

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

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

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

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<stringstring>extraParams

Optional dictionary of extra parameters. DataView implementation-specific parameters may also be stored here.
 
Constant detail

EXTRA_PARAMS_METADATA_PREFIX

string EXTRA_PARAMS_METADATA_PREFIX := "Metadata:"
Prefix for identifying metadata entries in the extraParams dictionary. Entries with key names prefixed by the EXTRA_PARAMS_METADATA_PREFIX string are considered metadata entries.
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<stringstringextraParams
Optional dictionary of extra parameters. DataView implementation-specific parameters may also be stored here.

fieldNames

sequence<stringfieldNames
Specifies the names of each field exposed by the DataView.

fieldTypes

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

keyFields

sequence<stringkeyFields
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.