You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streampipes.apache.org by fj...@apache.org on 2020/09/28 15:41:41 UTC
[incubator-streampipes-extensions] branch dev updated: Update to
the Documentation of Processors
This is an automated email from the ASF dual-hosted git repository.
fjohn pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/incubator-streampipes-extensions.git
The following commit(s) were added to refs/heads/dev by this push:
new c6ac440 Update to the Documentation of Processors
c6ac440 is described below
commit c6ac440a1d60f78557e525d7f839e53887935d9d
Author: Felix John <jo...@axantu.com>
AuthorDate: Mon Sep 28 17:41:25 2020 +0200
Update to the Documentation of Processors
---
.../documentation.md | 32 ++++++++++++++--------
.../documentation.md | 19 ++++++++-----
.../documentation.md | 14 ++++++----
.../documentation.md | 19 +++++++++----
.../documentation.md | 18 ++++++------
.../documentation.md | 28 ++++++++++++++-----
.../documentation.md | 16 +++++------
7 files changed, 93 insertions(+), 53 deletions(-)
diff --git a/streampipes-processors-aggregation-flink/src/main/resources/org.apache.streampipes.processors.aggregation.flink.count/documentation.md b/streampipes-processors-aggregation-flink/src/main/resources/org.apache.streampipes.processors.aggregation.flink.count/documentation.md
index 38c4d1e..9faa128 100644
--- a/streampipes-processors-aggregation-flink/src/main/resources/org.apache.streampipes.processors.aggregation.flink.count/documentation.md
+++ b/streampipes-processors-aggregation-flink/src/main/resources/org.apache.streampipes.processors.aggregation.flink.count/documentation.md
@@ -29,22 +29,32 @@
Performs an aggregation based on a given field and outputs the number of occurrences.
Example: Count the number of vehicle positions per vehicleId.
The Count aggregation requires a time window, used to perform the count aggregation and a field used to aggregate
- values.
+values.
***
## Required input
-
+There is no specific input required.
***
## Configuration
-
-Describe the configuration parameters here
-
-### 1st parameter
-
-
-### 2nd parameter
-
-## Output
\ No newline at end of file
+### FieldToCount
+Specifies the field containing the values that should be counted.
+
+### TimeWindowSize
+Specifies the size of the time window and consequently the number of values that are aggregated each time.
+
+### Time Window Scale
+Specifies the scale/unit of the time window. There are three different time scales to choose from: seconds, minutes or hours.
+
+## Output
+The output event is composed of two fields. The field "value" specifies the value to count.
+The second field "count" returns the number of occurrences.
+Example:
+```
+{
+ 'value': 'vehicleId',
+ 'count': 12
+}
+```
\ No newline at end of file
diff --git a/streampipes-processors-aggregation-flink/src/main/resources/org.apache.streampipes.processors.aggregation.flink.eventcount/documentation.md b/streampipes-processors-aggregation-flink/src/main/resources/org.apache.streampipes.processors.aggregation.flink.eventcount/documentation.md
index 2506f5d..ed7b28b 100644
--- a/streampipes-processors-aggregation-flink/src/main/resources/org.apache.streampipes.processors.aggregation.flink.eventcount/documentation.md
+++ b/streampipes-processors-aggregation-flink/src/main/resources/org.apache.streampipes.processors.aggregation.flink.eventcount/documentation.md
@@ -23,23 +23,28 @@
***
## Description
-
Counts the number of events arriving within a time window. An event is emitted every time the time window expires.
***
## Required input
-
+There is no specific input required.
***
## Configuration
-
Time Window: The scale and size of the time window.
-### 1st parameter
-
+### TimeWindowSize
+Specifies the size of the time window.
-### 2nd parameter
+### Time Window Scale
+Specifies the scale/unit of the time window. There are three different time scales to choose from: seconds, minutes or hours.
-## Output
\ No newline at end of file
+## Output
+```
+{
+ 'timestamp': 1601301980014,
+ 'count': 12
+}
+```
\ No newline at end of file
diff --git a/streampipes-processors-aggregation-flink/src/main/resources/org.apache.streampipes.processors.aggregation.flink.rate/documentation.md b/streampipes-processors-aggregation-flink/src/main/resources/org.apache.streampipes.processors.aggregation.flink.rate/documentation.md
index 8bf544d..e748e95 100644
--- a/streampipes-processors-aggregation-flink/src/main/resources/org.apache.streampipes.processors.aggregation.flink.rate/documentation.md
+++ b/streampipes-processors-aggregation-flink/src/main/resources/org.apache.streampipes.processors.aggregation.flink.rate/documentation.md
@@ -25,20 +25,24 @@
***
## Description
-
Computes the current event rate. Output is a number representing events per second.
***
## Required input
-
The event rate processor works with any stream and does not have any specific requirements.
***
## Configuration
-### Time Baseline
-Time window size used for calculating the rate in seconds, also defines the output rate
-## Output
\ No newline at end of file
+### Time Baseline
+Specifies the size of the window used used for calculating the rate in seconds. This parameters also determines the output rate.
+
+## Output
+```
+{
+ 'rate': 0.8
+}
+```
\ No newline at end of file
diff --git a/streampipes-processors-geo-jvm/src/main/resources/org.apache.streampipes.processors.geo.jvm.processor.distancecalculator/documentation.md b/streampipes-processors-geo-jvm/src/main/resources/org.apache.streampipes.processors.geo.jvm.processor.distancecalculator/documentation.md
index f221b91..fe5bdcf 100644
--- a/streampipes-processors-geo-jvm/src/main/resources/org.apache.streampipes.processors.geo.jvm.processor.distancecalculator/documentation.md
+++ b/streampipes-processors-geo-jvm/src/main/resources/org.apache.streampipes.processors.geo.jvm.processor.distancecalculator/documentation.md
@@ -25,23 +25,30 @@
***
## Description
-
Calculates the distance between two latitude/longitude pairs in a single event.
***
## Required input
-
+Requires a position of point on the Earth's surface specified by the two geographic coordinates: the longitude and latitude of the point.
***
## Configuration
-Describe the configuration parameters here
+### First Longitude
+This is the first geographic coordinate that specifies the east-west position of a point on the Earth's surface.
-### 1st parameter
+### First Latitude
+This is the second geographic coordinate that specifies the north-south position of a point on the Earth's surface.
+### First Longitude
+This is the first geographic coordinate that specifies the east-west position of a point on the Earth's surface.
-### 2nd parameter
+### Second Longitude
+This is the second geographic coordinate that specifies the east-west position of a point on the Earth's surface.
-## Output
\ No newline at end of file
+## Output
+{
+ 'distance': 12.2
+}
\ No newline at end of file
diff --git a/streampipes-processors-transformation-flink/src/main/resources/org.apache.streampipes.processors.transformation.flink.field-converter/documentation.md b/streampipes-processors-transformation-flink/src/main/resources/org.apache.streampipes.processors.transformation.flink.field-converter/documentation.md
index 3f55773..5119975 100644
--- a/streampipes-processors-transformation-flink/src/main/resources/org.apache.streampipes.processors.transformation.flink.field-converter/documentation.md
+++ b/streampipes-processors-transformation-flink/src/main/resources/org.apache.streampipes.processors.transformation.flink.field-converter/documentation.md
@@ -26,23 +26,23 @@
## Description
-Converts a string value to a number data type
-Add a detailed description here
+Converts a string value to a number data type.
+
***
## Required input
-
+This processor requires an event that contains at least one string valued field.
***
## Configuration
-Describe the configuration parameters here
-
-### 1st parameter
-
+### Field
+Specifies the string field that is converted.
-### 2nd parameter
+### Datatype
+Specifies the target datatype depending on the previously specified string field.
-## Output
\ No newline at end of file
+## Output
+Output event in the specified target datatype.
\ No newline at end of file
diff --git a/streampipes-processors-transformation-flink/src/main/resources/org.apache.streampipes.processors.transformation.flink.field-renamer/documentation.md b/streampipes-processors-transformation-flink/src/main/resources/org.apache.streampipes.processors.transformation.flink.field-renamer/documentation.md
index aad1d02..dcd655b 100644
--- a/streampipes-processors-transformation-flink/src/main/resources/org.apache.streampipes.processors.transformation.flink.field-renamer/documentation.md
+++ b/streampipes-processors-transformation-flink/src/main/resources/org.apache.streampipes.processors.transformation.flink.field-renamer/documentation.md
@@ -26,23 +26,37 @@
## Description
-Replaces the runtime name of an event property with a custom defined name. Useful for data ingestion purposes where a specific event schema is needed.
-Add a detailed description here
+Replaces the runtime name of an event property with a custom defined name. Useful for data ingestion purposes where a specific event schema is required.
+
***
## Required input
-
+There is no specific input required.
***
## Configuration
-Describe the configuration parameters here
+### Field
+Specifies the field to rename.
-### 1st parameter
+### NewFieldName
+Specifies the new runtime name of the field.
+## Output
+Example:
-### 2nd parameter
+Old Output:
+```
+{
+ 'timestamp': 16003000,
+}
+```
-## Output
\ No newline at end of file
+New Ouput:
+```
+{
+ 'time': 16003000,
+}
+```
\ No newline at end of file
diff --git a/streampipes-processors-transformation-flink/src/main/resources/org.apache.streampipes.processors.transformation.flink.fieldhasher/documentation.md b/streampipes-processors-transformation-flink/src/main/resources/org.apache.streampipes.processors.transformation.flink.fieldhasher/documentation.md
index 2848ab4..4049b6d 100644
--- a/streampipes-processors-transformation-flink/src/main/resources/org.apache.streampipes.processors.transformation.flink.fieldhasher/documentation.md
+++ b/streampipes-processors-transformation-flink/src/main/resources/org.apache.streampipes.processors.transformation.flink.fieldhasher/documentation.md
@@ -27,22 +27,22 @@
## Description
The Field Hasher uses an algorithm to encode values in a field. The Field Hasher can use MD5, SHA1 or SHA2 to hash field values.
-Add a detailed description here
***
## Required input
-Any field of type string
+This processor requires at least one field of type string.
***
## Configuration
-Describe the configuration parameters here
+### Field
+Specifies the string field that will be encoded.
-### 1st parameter
+### Hash Algorithm
+Specifies the algorithm used to encode the string field. The following algorithms
+are available: SHA2, MD5 or SHA1.
-
-### 2nd parameter
-
-## Output
\ No newline at end of file
+## Output
+The encoded string field.
\ No newline at end of file