diff options
Diffstat (limited to 'dcae-analytics-cdap-plugins/docs')
5 files changed, 95 insertions, 95 deletions
diff --git a/dcae-analytics-cdap-plugins/docs/DMaaPMRSink-batchsink.md b/dcae-analytics-cdap-plugins/docs/DMaaPMRSink-batchsink.md index c55ad60..53377cc 100644 --- a/dcae-analytics-cdap-plugins/docs/DMaaPMRSink-batchsink.md +++ b/dcae-analytics-cdap-plugins/docs/DMaaPMRSink-batchsink.md @@ -1,13 +1,13 @@ -# DMaaP MR Streaming Sink - -Description ------------ - -Publishes messages to DMaaP MR Topic using AAF Authentication. - -Use Case --------- - -This plugin should be used to publish messages from DMaaP MR Topic using AAF Authentication - - +# DMaaP MR Streaming Sink
+
+Description
+-----------
+
+Publishes messages to DMaaP MR Topic using AAF Authentication.
+
+Use Case
+--------
+
+This plugin should be used to publish messages from DMaaP MR Topic using AAF Authentication
+
+
diff --git a/dcae-analytics-cdap-plugins/docs/DMaaPMRSource-streamingsource.md b/dcae-analytics-cdap-plugins/docs/DMaaPMRSource-streamingsource.md index fe96638..2cf597b 100644 --- a/dcae-analytics-cdap-plugins/docs/DMaaPMRSource-streamingsource.md +++ b/dcae-analytics-cdap-plugins/docs/DMaaPMRSource-streamingsource.md @@ -1,13 +1,13 @@ -# DMaaP MR Streaming Source - -Description ------------ - -Fetches messages from DMaaP MR Topic using AAF Authentication at regular intervals. - -Use Case --------- - -This plugin should be used to fetch messages from DMaaP MR Topic using AAF Authentication - - +# DMaaP MR Streaming Source
+
+Description
+-----------
+
+Fetches messages from DMaaP MR Topic using AAF Authentication at regular intervals.
+
+Use Case
+--------
+
+This plugin should be used to fetch messages from DMaaP MR Topic using AAF Authentication
+
+
diff --git a/dcae-analytics-cdap-plugins/docs/JsonPathFilter-transform.md b/dcae-analytics-cdap-plugins/docs/JsonPathFilter-transform.md index ec9bb20..8d691bc 100644 --- a/dcae-analytics-cdap-plugins/docs/JsonPathFilter-transform.md +++ b/dcae-analytics-cdap-plugins/docs/JsonPathFilter-transform.md @@ -1,42 +1,42 @@ -# JSON Path Filter - -## Description - -Filters incoming JSON based on given filter mappings. - -The mappings in the plugin will be: - - +================================================+ - | JSON Path Expression | Expected Values | - |---------------------------|--------------------| - |$.employee.name.first | rajiv;manjesh | - |$.employee.name.last | singla;gowda | - |$.employee.email | johndoe@xyz.com | - +================================================+ - -The above filter mappings will inside json path $.employee.name.first and check if value matches rajiv or manjesh. -Only if path does exist and matches any of the expected values rajiv or manjesh then first filter mapping will be true. - -If multiple mappings are provided all mapping must be true for result to be matched. - -If incoming json is null or empty then output result will be null as no matching is possible. - -### Expression - -The "root member object" for parsing any JSON is referred to as ```$```, regardless of -whether it's an array or an object. It also uses either dot notation or bracket notation for -defining the levels of parsing. For example: ```$.employee.name``` or ```$[employee][name]```. - -#### Supported Operators - -These operators are supported: - - +========================================================================+ - | Operator | Description | - |-------------------|----------------------------------------------------| - | $ | The root element of the query | - | * | Wildcard | - | .. | Deep scan | - | .<name> | Dot notation representing child | - | [?(<expression>)] | Filter expression, should be boolean result always | - +========================================================================+ +# JSON Path Filter
+
+## Description
+
+Filters incoming JSON based on given filter mappings.
+
+The mappings in the plugin will be:
+
+ +================================================+
+ | JSON Path Expression | Expected Values |
+ |---------------------------|--------------------|
+ |$.employee.name.first | rajiv;manjesh |
+ |$.employee.name.last | singla;gowda |
+ |$.employee.email | johndoe@xyz.com |
+ +================================================+
+
+The above filter mappings will inside json path $.employee.name.first and check if value matches rajiv or manjesh.
+Only if path does exist and matches any of the expected values rajiv or manjesh then first filter mapping will be true.
+
+If multiple mappings are provided all mapping must be true for result to be matched.
+
+If incoming json is null or empty then output result will be null as no matching is possible.
+
+### Expression
+
+The "root member object" for parsing any JSON is referred to as ```$```, regardless of
+whether it's an array or an object. It also uses either dot notation or bracket notation for
+defining the levels of parsing. For example: ```$.employee.name``` or ```$[employee][name]```.
+
+#### Supported Operators
+
+These operators are supported:
+
+ +========================================================================+
+ | Operator | Description |
+ |-------------------|----------------------------------------------------|
+ | $ | The root element of the query |
+ | * | Wildcard |
+ | .. | Deep scan |
+ | .<name> | Dot notation representing child |
+ | [?(<expression>)] | Filter expression, should be boolean result always |
+ +========================================================================+
diff --git a/dcae-analytics-cdap-plugins/docs/MockDMaaPMRSource-streamingsource.md b/dcae-analytics-cdap-plugins/docs/MockDMaaPMRSource-streamingsource.md index 73906ae..0f21c48 100644 --- a/dcae-analytics-cdap-plugins/docs/MockDMaaPMRSource-streamingsource.md +++ b/dcae-analytics-cdap-plugins/docs/MockDMaaPMRSource-streamingsource.md @@ -1,13 +1,13 @@ -# DMaaP MR Streaming Source - -Description ------------ - -Mocks DMaaP MR Subscriber and send mock CEF Message used for testing without DMaaP MR - -Use Case --------- - -This plugin should be used to fetch messages from DMaaP MR Topic using AAF Authentication - - +# DMaaP MR Streaming Source
+
+Description
+-----------
+
+Mocks DMaaP MR Subscriber and send mock CEF Message used for testing without DMaaP MR
+
+Use Case
+--------
+
+This plugin should be used to fetch messages from DMaaP MR Topic using AAF Authentication
+
+
diff --git a/dcae-analytics-cdap-plugins/docs/SimpleTCAPlugin-sparkcompute.md b/dcae-analytics-cdap-plugins/docs/SimpleTCAPlugin-sparkcompute.md index d28f8ca..f29834a 100644 --- a/dcae-analytics-cdap-plugins/docs/SimpleTCAPlugin-sparkcompute.md +++ b/dcae-analytics-cdap-plugins/docs/SimpleTCAPlugin-sparkcompute.md @@ -1,14 +1,14 @@ -# Simple TCA Spark Compute Plugin - -Description ------------ -Transforms and generates alert message for input CEF (Common Event Format) based on given TCA Policy - -Use Case --------- - -Properties ----------- - -Example -------- +# Simple TCA Spark Compute Plugin
+
+Description
+-----------
+Transforms and generates alert message for input CEF (Common Event Format) based on given TCA Policy
+
+Use Case
+--------
+
+Properties
+----------
+
+Example
+-------
|