bayesline.api.equity.UploadStagingResult

pydantic model bayesline.api.equity.UploadStagingResult

Result of a staging operation.

Parameters

namestr

The name of the staged item.

timestampdt.datetime

When the staging occurred.

successbool

Whether the staging was successful.

resultslist[UploadParserResult]

Results from the parsing operation.

Show JSON schema

{
   "title": "UploadStagingResult",
   "description": "Result of a staging operation.\n\nParameters\n----------\nname : str\n    The name of the staged item.\ntimestamp : dt.datetime\n    When the staging occurred.\nsuccess : bool\n    Whether the staging was successful.\nresults : list[UploadParserResult]\n    Results from the parsing operation.",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "type": "string"
      },
      "timestamp": {
         "format": "date-time",
         "title": "Timestamp",
         "type": "string"
      },
      "success": {
         "title": "Success",
         "type": "boolean"
      },
      "results": {
         "items": {
            "$ref": "#/$defs/UploadParserResult"
         },
         "title": "Results",
         "type": "array"
      }
   },
   "$defs": {
      "UploadParserResult": {
         "additionalProperties": false,
         "description": "Result of a parser operation.\n\nParameters\n----------\nparser : str | None\n    The name of the parser that was used.\nsuccess : bool\n    Whether the parsing was successful.\nmessages : list[str]\n    List of messages from the parsing operation.",
         "properties": {
            "parser": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Parser"
            },
            "success": {
               "title": "Success",
               "type": "boolean"
            },
            "messages": {
               "items": {
                  "type": "string"
               },
               "title": "Messages",
               "type": "array"
            }
         },
         "required": [
            "success",
            "messages"
         ],
         "title": "UploadParserResult",
         "type": "object"
      }
   },
   "additionalProperties": false,
   "required": [
      "name",
      "timestamp",
      "success",
      "results"
   ]
}

Config:

• frozen: bool = True

• extra: str = forbid

Fields:

• name (str)

• results (list[bayesline.api._src.equity.upload.UploadParserResult])

• success (bool)

• timestamp (datetime.datetime)

field name: str [Required]

field timestamp: datetime [Required]

field success: bool [Required]

field results: list[UploadParserResult] [Required]

property success_parser: UploadParserResult | None

Get the first successful parser result.