Era.Common.NetworkMessage.ConsoleApi.RpcGetPendingMessageResponse

Description

Is recieved as a response to [RpcGetPendingMessageRequest] if the result is still not available.
If the [state] is [WAITING], [RpcGetPendingMessageRequest] should be called again with the same job ID later. All other values of [state] indicate failure.
If the result is available, the result is returned instead of this message. (The same applies if the result is an error.)

Properties

Name	JsonSchemaType	Description
processedSize	integer	For some requests, progress may be indicated. In that case, this value shows the total count of subtasks already processed.
state	enum of Era.Common.NetworkMessage.ConsoleApi.RpcPendingMessageState	Current state of the pending operation.
totalSize	integer	For some requests, progress may be indicated. In that case, this value shows the total count of subtasks.

Dual message (request/response)

Era.Common.NetworkMessage.ConsoleApi.RpcGetPendingMessageRequest

Referenced in messages

No references.

JsonSchema

{
    "title": "Era.Common.NetworkMessage.ConsoleApi.RpcGetPendingMessageResponse",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.NetworkMessage.ConsoleApi.RpcGetPendingMessageResponse"
    ],
    "properties": {
        "Era.Common.NetworkMessage.ConsoleApi.RpcGetPendingMessageResponse": {
            "$ref": "#/definitions/RpcGetPendingMessageResponse"
        }
    },
    "definitions": {
        "RpcGetPendingMessageResponse": {
            "additionalProperties": false,
            "required": [
                "state"
            ],
            "type": "object",
            "properties": {
                "processedSize": {
                    "type": "integer"
                },
                "state": {
                    "enum": [
                        1,
                        2,
                        3,
                        4
                    ]
                },
                "totalSize": {
                    "type": "integer"
                }
            }
        }
    }
}