geofence params Schema #
undefined#/properties/postProcess/items/allOf/7/properties/params
Parameters to be passed to the geofence 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 (geofence params)
geofence params Properties #
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| geofences | Flexible | Optional | cannot be null | specSchema (Unified Pipeline Specification) |
| mode | Not specified | Optional | cannot be null | specSchema (Unified Pipeline Specification) |
| multi | Not specified | Optional | cannot be null | specSchema (Unified Pipeline Specification) |
| criteria | Not specified | Optional | cannot be null | specSchema (Unified Pipeline Specification) |
| annotate | object |
Optional | cannot be null | specSchema (Unified Pipeline Specification) |
| rowGeometry | Not specified | Optional | cannot be null | specSchema (Unified Pipeline Specification) |
geofences #
geofences TODO
geofences
- is optional
- type: any of the folllowing:
arrayorobject(geofences) - cannot be null
- defined in: geofences
mode #
Enumeration of strings with constraints below
mode
mode Constraints #
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"filter" |
|
"annotate" |
multi #
Enumeration of strings with constraints below
multi
multi Constraints #
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"disabled" |
|
"adaptive" |
|
"always" |
criteria #
Enumeration of strings with constraints below
criteria
criteria Constraints #
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"contains" |
|
"notContains" |
annotate #
annotate TODO
annotate
rowGeometry #
Enumeration of strings with constraints below
rowGeometry
- is optional
- type: unknown (rowGeometry)
- cannot be null
- defined in: rowGeometry
rowGeometry Constraints #
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"row" |
|
"geofence" |