Era.Common.DataDefinition.Trigger.ClientTriggerConfiguration

Description

Client trigger configuration. Provide only one configuration corresponding to the picked [triggerType].

Properties

Name	JsonSchemaType	Description
asapTriggerCfg	reference to Era.Common.DataDefinition.Trigger.Client.AsapTrigger	Configuration for [triggerType]=ASAP.
createdAt	integer	For internal use only. Leave unchanged.
eventLogTriggerCfg	reference to Era.Common.DataDefinition.Trigger.EventLogTrigger	Configuration for [triggerType]=EVENT_LOG.
schedulerTriggerCfg	reference to Era.Common.DataDefinition.Trigger.SchedulerTrigger	Configuration for [triggerType]=SCHEDULER.
triggerThrottle	reference to Era.Common.DataDefinition.Trigger.TriggerThrottle	Throttling configuration (suppress certain ticks).
triggerType	enum of Era.Common.DataDefinition.Trigger.ClientTriggerConfiguration_Type	Type of the trigger. For details refer to the enum documentation.

Dual message (request/response)

No dual message.

Referenced in messages

Era.Common.NetworkMessage.ConsoleApi.TasksTriggers.RpcCreateClientTriggerRequest
Era.Common.NetworkMessage.ConsoleApi.TasksTriggers.RpcGetClientTriggerResponse
Era.Common.NetworkMessage.ConsoleApi.TasksTriggers.RpcModifyClientTriggerRequest

JsonSchema

{
    "title": "Era.Common.DataDefinition.Trigger.ClientTriggerConfiguration",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.DataDefinition.Trigger.ClientTriggerConfiguration"
    ],
    "properties": {
        "Era.Common.DataDefinition.Trigger.ClientTriggerConfiguration": {
            "$ref": "#/definitions/ClientTriggerConfiguration"
        }
    },
    "definitions": {
        "ClientTriggerConfiguration": {
            "additionalProperties": false,
            "required": [
                "triggerType"
            ],
            "type": "object",
            "properties": {
                "asapTriggerCfg": {
                    "$ref": "Era.Common.DataDefinition.Trigger.Client.AsapTrigger#/definitions/AsapTrigger"
                },
                "createdAt": {
                    "type": "integer"
                },
                "eventLogTriggerCfg": {
                    "$ref": "Era.Common.DataDefinition.Trigger.EventLogTrigger#/definitions/EventLogTrigger"
                },
                "schedulerTriggerCfg": {
                    "$ref": "Era.Common.DataDefinition.Trigger.SchedulerTrigger#/definitions/SchedulerTrigger"
                },
                "triggerThrottle": {
                    "$ref": "Era.Common.DataDefinition.Trigger.TriggerThrottle#/definitions/TriggerThrottle"
                },
                "triggerType": {
                    "enum": [
                        1,
                        2,
                        3,
                        4,
                        5,
                        6,
                        7,
                        8,
                        9,
                        10
                    ]
                }
            }
        }
    }
}