InputStreamInstance
This is a specialization of the DataStreamInstance for producing output.
Attributes
- consumer:ref - consumer that recieves data from the stream.
- name:string - Name of the Data Stream
- direction:string - In or Out
Associations
| Name | Cardinality | Class | Composition | Owner | Description |
|---|---|---|---|---|---|
| parent | 1 | DataStream | This is the parent of the data stream instance. | ||
| bundle | 1 | SABundleInstance | This is the Bundle instance that the data stream instance is connected. | ||
| channels | n | DataChannelInstance | true | true | This is the collection of channel instances that are attached to this data stream |
| policies | n | DataChannelInstance | false | This is the list of policies that are controlling the channels of the stream. They can come from the DataStream, the Resource, or the system overall. | |
| transforms | n | DataTransformInstance | false | These are the transforms to run on the stream before it goes to the output streams. |
Users of the Model
| Name | Cardinality | Class | Composition | Owner | Description |
|---|---|---|---|---|---|
| inputs | n | DataTransformInstance | Inputs of the transformation. | ||
| inputs | n | SABundleInstance | false | false | Input Data Streams for the SABR |
| learningInStream | 1 | SABundleInstance | Learning Corpus Input Stream receives updates to the aimodel | ||
| adminInStream | 1 | SABundleInstance | Administration Stream to handle registration of SABRS to Capabilities |
State Net
The InputStreamInstance has a state net corresponding to instances of the class. Each state transistion will emit an event that can be caught with a websocket client. The name of the event is the name of the state in all lower case. The following diagram is the state net for this class.
| Name | Description | Events |
|---|---|---|
| Init | Initial State | create->Created, |
| Created | Stream Instance created but not connected. | provision->Provisioned, |
| Provisioned | The input stream is provisioned are ready to be deployed | deploy->Deploying, |
| Deploying | Stream Instance is connecting to the message queues | deployed->Enabled, |
| Enabled | Stream Instance is ready to receive information to the message queues. | disable->Disabled, send->Enabled, |
| Disabled | Stream Instance cannot receive information at this time and no transformations are working. | enable->Enabled, |
Methods
- deploy() - Deploy a Data Stream Instance
- process() - Process data on the stream
- provision() - Provison a Data Stream Instance which will create the channelinstances that need to be deployed.
Method Details
Action inputstreaminstance deploy
- REST - inputstreaminstance/deploy?policies=ref
- bin - inputstreaminstance deploy –policies ref
- js - inputstreaminstance.deploy({ policies:ref })
Description
Deploy a Data Stream Instance
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| policies | ref | true | Policies to use for deploying the Bundle. |
Action inputstreaminstance process
- REST - inputstreaminstance/process?data=json&properties=json&channel=ref
- bin - inputstreaminstance process –data json –properties json –channel ref
- js - inputstreaminstance.process({ data:json,properties:json,channel:ref })
Description
Process data on the stream
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| data | json | true | Data to process. |
| properties | json | true | Properties of the data |
| channel | ref | true | Channel the data came on |
Action inputstreaminstance provision
- REST - inputstreaminstance/provision?policies=ref
- bin - inputstreaminstance provision –policies ref
- js - inputstreaminstance.provision({ policies:ref })
Description
Provison a Data Stream Instance which will create the channelinstances that need to be deployed.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| policies | ref | true | Policies to use for deploying the Bundle. |