BloombergPipeProcessor¶
Definition¶
Extends¶
Extended By¶
None
Description¶
A Realtime Event Processor.
Method Summary¶
| Owner | Name | Return Type | Description |
|---|---|---|---|
| DashboardResource | getCallback(callbackName) | Callback | Returns a callback by name |
| DashboardResource | getCallbacks() | Map | Returns a map of all callback definitions. |
| DashboardResource | getChildren() | List | Returns a list of the child dashboard resources. |
| Object | getClassName() | String | Returns the string name of this object's class type. |
| DashboardResource | getDRI() | String | Returns the Dashboard Resource Indicator (DRI) as a string. DRI is the unique identifier of this resources within the entire dashboard. |
| DashboardResource | getDashboardResourceType() | String | Returns the Dashboard Resource Type as a string |
| DashboardResource | getFormula(formulaName) | Formula | Returns a Formula given the formula name. |
| DashboardResource | getFormulaNames() | Set | Returns a set of the names of all formulas for this object. |
| DashboardResource | getFormulas() | Map | Returns a map of all available formulas for this object. The key is the formula name. |
| Processor | getId() | String | Returns the user-assigned ID for this relationship. |
| DashboardResource | getLRI() | String | Returns the Localized Resource Indicator (LRI) as a string. LRI is the unique identifier of this resource with the parent element. |
| Processor | getLayout() | Layout | Returns the layout that owns this relationship. |
| DashboardResource | getOwner() | DashboardResource | Returns the DashboardResource that owns this object. |
| BloombergPipeProcessor | getSubscriptions() | List | Returns the list of active subscriptions |
| DashboardResource | invokeCallback(callbackName, args) | Object | Executes the specified callback definition and returns the result from the callback. |
| DashboardResource | isTransient() | Boolean | Returns true if this is transient, false otherwise. Transient objects are not saved to the layout. |
| BloombergPipeProcessor | subscribe(ticker, fields) | Boolean | For BPIPE processors, it subscribes to the given input. Example) //blp/mktdata/ticker/BBHBEAT Index?fields=TIME,LAST_PRICE |
| BloombergPipeProcessor | subscribeLevel2(ticker, type) | Boolean | For BPIPE processors, it subscribes to the given input for level 2 streaming. Example) ticker=BBHBEAT Index type=MBO |
| Object | toJson() | String | Returns a json representation of this object. |
| Processor | toTable() | Table | Returns the underlying table that this processor is handling. |
| BloombergPipeProcessor | unsubscribe(subscription) | Boolean | For BPIPE processors, it unsubscribes for the given input. Example) //blp/mktdata/ticker/BBHBEAT Index?fields=TIME,LAST_PRICE |
| BloombergPipeProcessor | unsubscribeAll() | Boolean | For BPIPE processors, it unsubscribes from all active subscriptions. |
Method Definitions¶
getCallback(callbackName)¶
Callback DashboardResource::getCallback(String callbackName)
Description¶
Returns a callback by name
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| callbackName | String | method name of callback |
getCallbacks()¶
Map DashboardResource::getCallbacks()
Description¶
Returns a map of all callback definitions.
getChildren()¶
List DashboardResource::getChildren()
Description¶
Returns a list of the child dashboard resources.
getClassName()¶
Description¶
Returns the string name of this object's class type.
getDRI()¶
String DashboardResource::getDRI()
Description¶
Returns the Dashboard Resource Indicator (DRI) as a string. DRI is the unique identifier of this resources within the entire dashboard.
getDashboardResourceType()¶
String DashboardResource::getDashboardResourceType()
Description¶
Returns the Dashboard Resource Type as a string
getFormula(formulaName)¶
Formula DashboardResource::getFormula(String formulaName)
Description¶
Returns a Formula given the formula name.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| formulaName | String | name of the formula to return |
getFormulaNames()¶
Set DashboardResource::getFormulaNames()
Description¶
Returns a set of the names of all formulas for this object.
getFormulas()¶
Map DashboardResource::getFormulas()
Description¶
Returns a map of all available formulas for this object. The key is the formula name.
getId()¶
Description¶
Returns the user-assigned ID for this relationship.
getLRI()¶
String DashboardResource::getLRI()
Description¶
Returns the Localized Resource Indicator (LRI) as a string. LRI is the unique identifier of this resource with the parent element.
getLayout()¶
Description¶
Returns the layout that owns this relationship.
getOwner()¶
DashboardResource DashboardResource::getOwner()
Description¶
Returns the DashboardResource that owns this object.
getSubscriptions()¶
List BloombergPipeProcessor::getSubscriptions()
Description¶
Returns the list of active subscriptions
invokeCallback(callbackName,args)¶
Object DashboardResource::invokeCallback(String callbackName, Object ... args)
Description¶
Executes the specified callback definition and returns the result from the callback.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| callbackName | String | method name of callback |
| args | Object ... | arguments |
isTransient()¶
Boolean DashboardResource::isTransient()
Description¶
Returns true if this is transient, false otherwise. Transient objects are not saved to the layout.
subscribe(ticker,fields)¶
Boolean BloombergPipeProcessor::subscribe(String ticker, String fields)
Description¶
For BPIPE processors, it subscribes to the given input. Example) //blp/mktdata/ticker/BBHBEAT Index?fields=TIME,LAST_PRICE
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| ticker | String | |
| fields | String |
subscribeLevel2(ticker,type)¶
Boolean BloombergPipeProcessor::subscribeLevel2(String ticker, String type)
Description¶
For BPIPE processors, it subscribes to the given input for level 2 streaming. Example) ticker=BBHBEAT Index type=MBO
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| ticker | String | |
| type | String | type can be MBO or MBL |
toJson()¶
Description¶
Returns a json representation of this object.
toTable()¶
Description¶
Returns the underlying table that this processor is handling.
unsubscribe(subscription)¶
Boolean BloombergPipeProcessor::unsubscribe(String subscription)
Description¶
For BPIPE processors, it unsubscribes for the given input. Example) //blp/mktdata/ticker/BBHBEAT Index?fields=TIME,LAST_PRICE
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| subscription | String |
unsubscribeAll()¶
Boolean BloombergPipeProcessor::unsubscribeAll()
Description¶
For BPIPE processors, it unsubscribes from all active subscriptions.