NamespaceAssetUpdateProperties interface
The updatable properties of the NamespaceAsset.
Properties
| asset |
URIs or type definition IDs. |
| attributes | A set of key-value pairs that contain custom attributes set by the customer. |
| datasets | Array of datasets that are part of the asset. Each dataset describes the data points that make up the set. |
| default |
Stringified JSON that contains connector-specific default configuration for all datasets. Each dataset can have its own configuration that overrides the default settings here. |
| default |
Default destinations for a dataset. |
| default |
Stringified JSON that contains connector-specific default configuration for all events. Each event can have its own configuration that overrides the default settings here. |
| default |
Default destinations for an event. |
| default |
Stringified JSON that contains connector-specific default configuration for all management groups. Each management group can have its own configuration that overrides the default settings here. |
| default |
Stringified JSON that contains connector-specific default configuration for all streams. Each stream can have its own configuration that overrides the default settings here. |
| default |
Default destinations for a stream. |
| description | Human-readable description of the asset. |
| display |
Human-readable display name. |
| documentation |
Asset documentation reference. |
| enabled | Enabled/disabled status of the asset. |
| event |
Array of event groups that are part of the asset. Each event group can have per-event group configuration. |
| hardware |
Asset hardware revision number. |
| management |
Array of management groups that are part of the asset. Each management group can have a per-group configuration. |
| manufacturer | Asset manufacturer. |
| manufacturer |
Asset manufacturer URI. |
| model | Asset model. |
| product |
Asset product code. |
| serial |
Asset serial number. |
| software |
Asset software revision number. |
| streams | Array of streams that are part of the asset. Each stream can have a per-stream configuration. |
Property Details
assetTypeRefs
URIs or type definition IDs.
assetTypeRefs?: string[]
Property Value
string[]
attributes
A set of key-value pairs that contain custom attributes set by the customer.
attributes?: Record<string, any>
Property Value
Record<string, any>
datasets
Array of datasets that are part of the asset. Each dataset describes the data points that make up the set.
datasets?: NamespaceDataset[]
Property Value
defaultDatasetsConfiguration
Stringified JSON that contains connector-specific default configuration for all datasets. Each dataset can have its own configuration that overrides the default settings here.
defaultDatasetsConfiguration?: string
Property Value
string
defaultDatasetsDestinations
Default destinations for a dataset.
defaultDatasetsDestinations?: DatasetDestinationUnion[]
Property Value
defaultEventsConfiguration
Stringified JSON that contains connector-specific default configuration for all events. Each event can have its own configuration that overrides the default settings here.
defaultEventsConfiguration?: string
Property Value
string
defaultEventsDestinations
Default destinations for an event.
defaultEventsDestinations?: EventDestinationUnion[]
Property Value
defaultManagementGroupsConfiguration
Stringified JSON that contains connector-specific default configuration for all management groups. Each management group can have its own configuration that overrides the default settings here.
defaultManagementGroupsConfiguration?: string
Property Value
string
defaultStreamsConfiguration
Stringified JSON that contains connector-specific default configuration for all streams. Each stream can have its own configuration that overrides the default settings here.
defaultStreamsConfiguration?: string
Property Value
string
defaultStreamsDestinations
Default destinations for a stream.
defaultStreamsDestinations?: StreamDestinationUnion[]
Property Value
description
Human-readable description of the asset.
description?: string
Property Value
string
displayName
Human-readable display name.
displayName?: string
Property Value
string
documentationUri
Asset documentation reference.
documentationUri?: string
Property Value
string
enabled
Enabled/disabled status of the asset.
enabled?: boolean
Property Value
boolean
eventGroups
Array of event groups that are part of the asset. Each event group can have per-event group configuration.
eventGroups?: NamespaceEventGroup[]
Property Value
hardwareRevision
Asset hardware revision number.
hardwareRevision?: string
Property Value
string
managementGroups
Array of management groups that are part of the asset. Each management group can have a per-group configuration.
managementGroups?: ManagementGroup[]
Property Value
manufacturer
Asset manufacturer.
manufacturer?: string
Property Value
string
manufacturerUri
Asset manufacturer URI.
manufacturerUri?: string
Property Value
string
model
Asset model.
model?: string
Property Value
string
productCode
Asset product code.
productCode?: string
Property Value
string
serialNumber
Asset serial number.
serialNumber?: string
Property Value
string
softwareRevision
Asset software revision number.
softwareRevision?: string
Property Value
string
streams
Array of streams that are part of the asset. Each stream can have a per-stream configuration.
streams?: NamespaceStream[]