RecordStatusFilter

pydantic model openff.qcsubmit.results.filters.RecordStatusFilter[source]

A filter which will only retain records if their status matches a specified value.

Show JSON schema

{
   "title": "RecordStatusFilter",
   "description": "A filter which will only retain records if their status matches a specified\nvalue.",
   "type": "object",
   "properties": {
      "status": {
         "description": "Records whose status match this value will be retained.",
         "default": "COMPLETE",
         "allOf": [
            {
               "$ref": "#/definitions/RecordStatusEnum"
            }
         ]
      }
   },
   "definitions": {
      "RecordStatusEnum": {
         "title": "RecordStatusEnum",
         "description": "The state of a record object. The states which are available are a finite set.",
         "enum": [
            "COMPLETE",
            "INCOMPLETE",
            "RUNNING",
            "ERROR"
         ],
         "type": "string"
      }
   }
}

Fields

status (qcportal.models.records.RecordStatusEnum)

field status: qcportal.models.records.RecordStatusEnum = RecordStatusEnum.complete: Records whose status match this value will be retained.

apply(result_collection)

Apply this filter to a results collection, returning a new collection containing only the retained entries.

Parameters: result_collection (openff.qcsubmit.results.filters.T) – The collection to apply the filter to.
Returns: The collection containing only the retained entries.
Return type: openff.qcsubmit.results.filters.T