aggregation params Schema #
undefined#/properties/postProcess/items/allOf/4/properties/params
Parameters to be passed to the aggregation module
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | specSchema.schema.json* |
params Type #
object (aggregation params)
all of
aggregation params Properties #
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| library | string |
Required | cannot be null | specSchema (Unified Pipeline Specification) |
| identity | string |
Optional | cannot be null | specSchema (Unified Pipeline Specification) |
| timeBucket | Not specified | Optional | cannot be null | specSchema (Unified Pipeline Specification) |
library #
library TODO
library
- is required
- type:
string - cannot be null
- Unstructured type
identity #
The property to aggregate
identity
- is optional
- type:
string - cannot be null
- Unstructured type
timeBucket #
The time period to aggregate across
timeBucket
- is optional
- type: unknown (timeBucket)
- cannot be null
- defined in: timeBucket
timeBucket Constraints #
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"year" |
|
"month" |
|
"quarter" |
|
"week" |
|
"isoweek" |
|
"day" |
|
"hour" |
|
"minute" |
|
"second" |
|
"all" |