credmark.cmf.types.compose.MapBlockResult
- DTO class MapBlockResult(*, blockNumber, output=None, error=None)[source]
Bases:
GenericModel
,Generic
[DTOCLS
]A data row in a block series. The generic type specifies the class to use as the output.
For example
row = MapBlockResult[MyOutputClass](**data)
whererow.output
will be an instance ofMyOutputClass
.Show JSON schema
{ "title": "MapBlockResult", "description": "A data row in a block series.\nThe generic type specifies the class to use as the output.\n\nFor example ``row = MapBlockResult[MyOutputClass](**data)``\nwhere ``row.output`` will be an instance of ``MyOutputClass``.", "type": "object", "properties": { "blockNumber": { "title": "Blocknumber", "description": "Block number of result.", "type": "integer" }, "output": { "title": "Output", "description": "Model output of result. Will not be present if there is an error." }, "error": { "title": "Error", "description": "Error DTO from model run. Will not be present if output exists.", "allOf": [ { "$ref": "#/definitions/ModelErrorDTO" } ] } }, "required": [ "blockNumber" ], "definitions": { "ModelCallStackEntry": { "title": "ModelCallStackEntry", "description": "An item in an error's call stack.", "type": "object", "properties": { "slug": { "title": "Slug", "description": "Model slug", "type": "string" }, "version": { "title": "Version", "description": "Model version", "type": "string" }, "chainId": { "title": "Chainid", "description": "Context chain id", "type": "integer" }, "blockNumber": { "title": "Blocknumber", "description": "Context block number", "type": "integer" }, "input": { "title": "Input", "description": "Context input" }, "trace": { "title": "Trace", "description": "Trace of code that generated the error", "type": "string" } }, "required": [ "slug", "version" ] }, "ModelErrorDTO": { "title": "ModelErrorDTO", "description": "Data fields common to all error types:\nModelDataError, ModelRunError, ModelInputError etc.", "type": "object", "properties": { "type": { "title": "Type", "description": "Error type", "type": "string" }, "message": { "title": "Message", "description": "Error message", "type": "string" }, "stack": { "title": "Stack", "description": "Model call stack. Last element is the model that raised the error.", "default": [], "type": "array", "items": { "$ref": "#/definitions/ModelCallStackEntry" } }, "code": { "title": "Code", "description": "Short identifier for the type of error", "default": "generic", "type": "string" }, "detail": { "title": "Detail", "description": "Arbitrary data object related to the error." }, "permanent": { "title": "Permanent", "description": "If true, the error will always give the same result for the same context.", "default": false, "type": "boolean" } }, "required": [ "type", "message" ] } } }
- Fields
- Parameters
blockNumber (BlockNumber) –
output (Optional[DTOCLS]) –
error (Optional[ModelErrorDTO]) –
- Return type
None
- field blockNumber: BlockNumber [Required]
Block number of result.
- field error: Optional[ModelErrorDTO] = None
Error DTO from model run. Will not be present if output exists.