Mocker Commands Configurations Table View¶
TL;DR — Use this generated field table to check property paths, types, required status, defaults, and descriptions.
When to use¶
Use this page when you need the exact field path or value type for a configuration section before editing YAML.
YAML configuration¶
The table below mirrors the schema used by the YAML scaffold page. Nested rows use dotted paths and [] for list items.
| Property Path | Type | Required | Default | Description |
|---|---|---|---|---|
Sessions[].MockerCommands | list or string or null | ✖ | List of all mocker commands to run for this session. Mocker Commands trigger the mocker instance through redis api to act specific actions | |
Sessions[].MockerCommands[] | object or string | ✖ | ||
Sessions[].MockerCommands[].Name | string | ✔ | The name of the mocker command | |
Sessions[].MockerCommands[].ServerName | string | ✔ | The name of the mocker server to interact with | |
Sessions[].MockerCommands[].RequestDurationMs | integer or string | ✖ | 3000 | The duration the runner will try to request the mocker server instances |
Sessions[].MockerCommands[].RequestRetries | integer or string | ✖ | 3 | The amount of retries the runner will try to request the mocker server instances |
Sessions[].MockerCommands[].Stage | integer or string | ✖ | 4 | The stage in which the Mocker Command runs at |
Sessions[].MockerCommands[].Command | object or string | ✔ | The command action to commit | |
Sessions[].MockerCommands[].Command.ChangeActionStub | object or string | ✖ | Mocker 'ChangeActionStub' command properties | |
Sessions[].MockerCommands[].Command.ChangeActionStub.ActionName | string | ✔ | The Action's name that is being changed | |
Sessions[].MockerCommands[].Command.ChangeActionStub.StubName | string | ✔ | The Stub's Name attached to the action | |
Sessions[].MockerCommands[].Command.Consume | object or string | ✖ | Mocker 'Consume' command properties | |
Sessions[].MockerCommands[].Command.Consume.TimeoutMs | integer or string | ✔ | The Timeout (ms) while consuming data from Mock Servers | |
Sessions[].MockerCommands[].Command.Consume.ActionName | string or null | ✖ | The Action name to consume, if not given consumes all action | |
Sessions[].MockerCommands[].Command.Consume.InputDataFilter | object or string | ✖ | How to filter the properties of each returned Mocker Input data | |
Sessions[].MockerCommands[].Command.Consume.InputDataFilter.Body | string or true/false | ✖ | True | Whether to keep the Body in the data (true) or filter it (false) |
Sessions[].MockerCommands[].Command.Consume.InputDataFilter.MetaData | string or true/false | ✖ | True | Whether to keep the MetaData in the data (true) or filter it (false) |
Sessions[].MockerCommands[].Command.Consume.InputDataFilter.Timestamp | string or true/false | ✖ | True | Whether to keep the Timestamp in the data (true) or filter it (false) |
Sessions[].MockerCommands[].Command.Consume.InputDeserialize | object or string | ✖ | The deserializer to use to deserialize the consumed input data received by the mocker | |
Sessions[].MockerCommands[].Command.Consume.InputDeserialize.Deserializer | one of [Binary / Json / MessagePack / Xml / Yaml / ProtobufMessage / XmlElement] | ✖ | The deserializer type to use for deserializing. Null means no deserialization will happen. Options are all available QaaS.Framework.Serialization deserializers | |
Sessions[].MockerCommands[].Command.Consume.InputDeserialize.SpecificType | object or string | ✖ | Configuration for making deserializer deserialize into a specific C# object, if set to null will deserialize to default deserilizer's C# object | |
Sessions[].MockerCommands[].Command.Consume.InputDeserialize.SpecificType.TypeFullName | string | ✔ | The full name (including path) of the type | |
Sessions[].MockerCommands[].Command.Consume.InputDeserialize.SpecificType.AssemblyName | string or null | ✖ | The name of the assembly the type is located in, If no value is given by default tries to take the entry assembly | |
Sessions[].MockerCommands[].Command.Consume.OutputDataFilter | object or string | ✖ | How to filter the properties of each returned Mocker Output data | |
Sessions[].MockerCommands[].Command.Consume.OutputDataFilter.Body | string or true/false | ✖ | True | Whether to keep the Body in the data (true) or filter it (false) |
Sessions[].MockerCommands[].Command.Consume.OutputDataFilter.MetaData | string or true/false | ✖ | True | Whether to keep the MetaData in the data (true) or filter it (false) |
Sessions[].MockerCommands[].Command.Consume.OutputDataFilter.Timestamp | string or true/false | ✖ | True | Whether to keep the Timestamp in the data (true) or filter it (false) |
Sessions[].MockerCommands[].Command.Consume.OutputDeserialize | object or string | ✖ | The deserializer to use to deserialize the consumed output data published by the mocker | |
Sessions[].MockerCommands[].Command.Consume.OutputDeserialize.Deserializer | one of [Binary / Json / MessagePack / Xml / Yaml / ProtobufMessage / XmlElement] | ✖ | The deserializer type to use for deserializing. Null means no deserialization will happen. Options are all available QaaS.Framework.Serialization deserializers | |
Sessions[].MockerCommands[].Command.Consume.OutputDeserialize.SpecificType | object or string | ✖ | Configuration for making deserializer deserialize into a specific C# object, if set to null will deserialize to default deserilizer's C# object | |
Sessions[].MockerCommands[].Command.Consume.OutputDeserialize.SpecificType.TypeFullName | string | ✔ | The full name (including path) of the type | |
Sessions[].MockerCommands[].Command.Consume.OutputDeserialize.SpecificType.AssemblyName | string or null | ✖ | The name of the assembly the type is located in, If no value is given by default tries to take the entry assembly | |
Sessions[].MockerCommands[].Command.TriggerAction | object or string | ✖ | Mocker 'TriggerAction' command properties | |
Sessions[].MockerCommands[].Command.TriggerAction.ActionName | string | ✔ | The Action's name that is being triggered | |
Sessions[].MockerCommands[].Command.TriggerAction.TimeoutMs | integer or string | ✖ | 0 | The time to enable the action for in milliseconds |
Sessions[].MockerCommands[].Redis | object or string | ✔ | The server controller redis API | |
Sessions[].MockerCommands[].Redis.Host | string | ✔ | Redis hostname (should contain the port too for example: - 'host1:8080') | |
Sessions[].MockerCommands[].Redis.AbortOnConnectFail | string or true/false | ✖ | True | If true, connect will not create connection while no servers are available |
Sessions[].MockerCommands[].Redis.AsyncTimeoutMs | integer or string | ✖ | 5000 | Timeout to allow for asynchronous operations |
Sessions[].MockerCommands[].Redis.ClientName | string or null | ✖ | Identification for the connection within redis | |
Sessions[].MockerCommands[].Redis.ConnectRetry | integer or string | ✖ | 3 | The number of times to repeat connect attempts during initial connect |
Sessions[].MockerCommands[].Redis.KeepAliveSeconds | integer or string | ✖ | 60 | Time at which to send a message to help keep alive |
Sessions[].MockerCommands[].Redis.Password | string or null | ✖ | Password for the redis server | |
Sessions[].MockerCommands[].Redis.RedisDataBase | integer or string | ✖ | 0 | Redis database to use |
Sessions[].MockerCommands[].Redis.Ssl | string or true/false | ✖ | False | Specifies whether SSL encryption should be used |
Sessions[].MockerCommands[].Redis.SslHost | string or null | ✖ | Enforces a preticular SSL host identity on the server's certificate | |
Sessions[].MockerCommands[].Redis.Username | string or null | ✖ | User for the redis server | |
Sessions[].MockerCommands[].Configuration | object or string | ✖ | ||
Sessions[].MockerCommands[].Configuration.ChangeActionStub | object or string | ✖ | Mocker 'ChangeActionStub' command properties | |
Sessions[].MockerCommands[].Configuration.ChangeActionStub.ActionName | string | ✔ | The Action's name that is being changed | |
Sessions[].MockerCommands[].Configuration.ChangeActionStub.StubName | string | ✔ | The Stub's Name attached to the action | |
Sessions[].MockerCommands[].Configuration.Consume | object or string | ✖ | Mocker 'Consume' command properties | |
Sessions[].MockerCommands[].Configuration.Consume.TimeoutMs | integer or string | ✔ | The Timeout (ms) while consuming data from Mock Servers | |
Sessions[].MockerCommands[].Configuration.Consume.ActionName | string or null | ✖ | The Action name to consume, if not given consumes all action | |
Sessions[].MockerCommands[].Configuration.Consume.InputDataFilter | object or string | ✖ | How to filter the properties of each returned Mocker Input data | |
Sessions[].MockerCommands[].Configuration.Consume.InputDataFilter.Body | string or true/false | ✖ | True | Whether to keep the Body in the data (true) or filter it (false) |
Sessions[].MockerCommands[].Configuration.Consume.InputDataFilter.MetaData | string or true/false | ✖ | True | Whether to keep the MetaData in the data (true) or filter it (false) |
Sessions[].MockerCommands[].Configuration.Consume.InputDataFilter.Timestamp | string or true/false | ✖ | True | Whether to keep the Timestamp in the data (true) or filter it (false) |
Sessions[].MockerCommands[].Configuration.Consume.InputDeserialize | object or string | ✖ | The deserializer to use to deserialize the consumed input data received by the mocker | |
Sessions[].MockerCommands[].Configuration.Consume.InputDeserialize.Deserializer | one of [Binary / Json / MessagePack / Xml / Yaml / ProtobufMessage / XmlElement] | ✖ | The deserializer type to use for deserializing. Null means no deserialization will happen. Options are all available QaaS.Framework.Serialization deserializers | |
Sessions[].MockerCommands[].Configuration.Consume.InputDeserialize.SpecificType | object or string | ✖ | Configuration for making deserializer deserialize into a specific C# object, if set to null will deserialize to default deserilizer's C# object | |
Sessions[].MockerCommands[].Configuration.Consume.InputDeserialize.SpecificType.TypeFullName | string | ✔ | The full name (including path) of the type | |
Sessions[].MockerCommands[].Configuration.Consume.InputDeserialize.SpecificType.AssemblyName | string or null | ✖ | The name of the assembly the type is located in, If no value is given by default tries to take the entry assembly | |
Sessions[].MockerCommands[].Configuration.Consume.OutputDataFilter | object or string | ✖ | How to filter the properties of each returned Mocker Output data | |
Sessions[].MockerCommands[].Configuration.Consume.OutputDataFilter.Body | string or true/false | ✖ | True | Whether to keep the Body in the data (true) or filter it (false) |
Sessions[].MockerCommands[].Configuration.Consume.OutputDataFilter.MetaData | string or true/false | ✖ | True | Whether to keep the MetaData in the data (true) or filter it (false) |
Sessions[].MockerCommands[].Configuration.Consume.OutputDataFilter.Timestamp | string or true/false | ✖ | True | Whether to keep the Timestamp in the data (true) or filter it (false) |
Sessions[].MockerCommands[].Configuration.Consume.OutputDeserialize | object or string | ✖ | The deserializer to use to deserialize the consumed output data published by the mocker | |
Sessions[].MockerCommands[].Configuration.Consume.OutputDeserialize.Deserializer | one of [Binary / Json / MessagePack / Xml / Yaml / ProtobufMessage / XmlElement] | ✖ | The deserializer type to use for deserializing. Null means no deserialization will happen. Options are all available QaaS.Framework.Serialization deserializers | |
Sessions[].MockerCommands[].Configuration.Consume.OutputDeserialize.SpecificType | object or string | ✖ | Configuration for making deserializer deserialize into a specific C# object, if set to null will deserialize to default deserilizer's C# object | |
Sessions[].MockerCommands[].Configuration.Consume.OutputDeserialize.SpecificType.TypeFullName | string | ✔ | The full name (including path) of the type | |
Sessions[].MockerCommands[].Configuration.Consume.OutputDeserialize.SpecificType.AssemblyName | string or null | ✖ | The name of the assembly the type is located in, If no value is given by default tries to take the entry assembly | |
Sessions[].MockerCommands[].Configuration.TriggerAction | object or string | ✖ | Mocker 'TriggerAction' command properties | |
Sessions[].MockerCommands[].Configuration.TriggerAction.ActionName | string | ✔ | The Action's name that is being triggered | |
Sessions[].MockerCommands[].Configuration.TriggerAction.TimeoutMs | integer or string | ✖ | 0 | The time to enable the action for in milliseconds |
Edge cases¶
- Empty default cells mean the schema does not define a default value for that field.
- Required status applies to the immediate parent object shown by the property path.