Era.Common.DataDefinition.Trigger.TriggerThrottle

Description

Trigger throttling configuration. Throttling is active if at least one of the following fields is set:
[occurrences], [occurrencesWithinTime], [uniqueValues], [timeRange], [timeFrequency].

Properties

Name	JsonSchemaType	Description
concatenateSuppressedTicks	integer	Obsolete. Do not use. Any values provided here, will be ignored.
occurrences	reference to Era.Common.DataDefinition.Trigger.TriggerThrottle_Occurrences	Group: Statistical criteria. Throttling for every [x] occurrences. If the field is initialized, Occurrences throttling is activated.
occurrencesWithinTime	reference to Era.Common.DataDefinition.Trigger.TriggerThrottle_OccurrencesWithinTime	Group: Statistical criteria. Throttling for [x] occurrences within a specified time [y]. If the field is initialized, OccurrencesWithinTime throttling is activated.
operatorForStatistical	enum of Era.Common.DataDefinition.Trigger.TriggerThrottle_LogicOperator	Logic operator for combining multiple statistical criteria.
timeFrequency	reference to Era.Common.DataDefinition.Trigger.TriggerThrottle_TimeFrequency	Group: Time-based criteria. Throttling allowing only one tick within a time range. If the field is initialized, TimeFrequency throttling is activated.
timeRange	reference to Era.Common.DataDefinition.Trigger.TriggerThrottle_TimeRange	Group: Time-based criteria. Throttling based on allowed time ranges. If the field is initialized, TimeRange throttling is activated.
uniqueValues	reference to Era.Common.DataDefinition.Trigger.TriggerThrottle_UniqueValues	Group: Statistical criteria. Throttling for unique symbol values. If the field is initialized, UniqueValues throttling is activated.

Dual message (request/response)

No dual message.

Referenced in messages

Era.Common.DataDefinition.Trigger.ClientTriggerConfiguration
Era.Common.DataDefinition.Trigger.ServerTriggerConfiguration

JsonSchema

{
    "title": "Era.Common.DataDefinition.Trigger.TriggerThrottle",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.DataDefinition.Trigger.TriggerThrottle"
    ],
    "properties": {
        "Era.Common.DataDefinition.Trigger.TriggerThrottle": {
            "$ref": "#/definitions/TriggerThrottle"
        }
    },
    "definitions": {
        "TriggerThrottle": {
            "additionalProperties": false,
            "type": "object",
            "properties": {
                "concatenateSuppressedTicks": {
                    "type": "integer"
                },
                "occurrences": {
                    "$ref": "Era.Common.DataDefinition.Trigger.TriggerThrottle_Occurrences#/definitions/TriggerThrottle_Occurrences"
                },
                "occurrencesWithinTime": {
                    "$ref": "Era.Common.DataDefinition.Trigger.TriggerThrottle_OccurrencesWithinTime#/definitions/TriggerThrottle_OccurrencesWithinTime"
                },
                "operatorForStatistical": {
                    "enum": [
                        1,
                        2
                    ]
                },
                "timeFrequency": {
                    "$ref": "Era.Common.DataDefinition.Trigger.TriggerThrottle_TimeFrequency#/definitions/TriggerThrottle_TimeFrequency"
                },
                "timeRange": {
                    "$ref": "Era.Common.DataDefinition.Trigger.TriggerThrottle_TimeRange#/definitions/TriggerThrottle_TimeRange"
                },
                "uniqueValues": {
                    "$ref": "Era.Common.DataDefinition.Trigger.TriggerThrottle_UniqueValues#/definitions/TriggerThrottle_UniqueValues"
                }
            }
        }
    }
}