Era.Common.NetworkMessage.ConsoleApi.RpcPendingExceptionData

Description

Returned if processing of some request lasts too long.
After recieving this exception as a result of a request, please wait for some time (recommended 1 second or more) and then poll for the result using [RpcGetPendingMessageRequest].
Not all requests support this mechanism.

Properties

Name JsonSchemaType Description
jobId integer ID of the job to be used with all subsequent calls to [RpcGetPendingMessageRequest].
processedSize integer For some requests, progress may be indicated. In that case, this value shows the total count of subtasks already processed.
totalSize integer For some requests, progress may be indicated. In that case, this value shows the total count of subtasks.

Dual message (request/response)

No dual message.

Referenced in messages

No references.

JsonSchema

{
    "title": "Era.Common.NetworkMessage.ConsoleApi.RpcPendingExceptionData",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.NetworkMessage.ConsoleApi.RpcPendingExceptionData"
    ],
    "properties": {
        "Era.Common.NetworkMessage.ConsoleApi.RpcPendingExceptionData": {
            "$ref": "#/definitions/RpcPendingExceptionData"
        }
    },
    "definitions": {
        "RpcPendingExceptionData": {
            "additionalProperties": false,
            "required": [
                "jobId"
            ],
            "type": "object",
            "properties": {
                "jobId": {
                    "type": "integer"
                },
                "processedSize": {
                    "type": "integer"
                },
                "totalSize": {
                    "type": "integer"
                }
            }
        }
    }
}