TapQuery#

pydantic model mobu.events.TapQuery#

Reported when a TAP query is executed.

Parameters:: data (Any)

Show JSON schema

{
   "title": "TapQuery",
   "description": "Reported when a TAP query is executed.",
   "type": "object",
   "properties": {
      "flock": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "title": "Flock"
      },
      "business": {
         "title": "Business",
         "type": "string"
      },
      "username": {
         "title": "Username",
         "type": "string"
      },
      "success": {
         "title": "Success",
         "type": "boolean"
      },
      "duration": {
         "anyOf": [
            {
               "format": "duration",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "title": "Duration"
      },
      "sync": {
         "title": "Sync",
         "type": "boolean"
      }
   },
   "required": [
      "flock",
      "business",
      "username",
      "success",
      "duration",
      "sync"
   ]
}

Fields:

business ()
duration (datetime.timedelta | None)
flock ()
success (bool)
sync (bool)
username ()

field business: str [Required]#

field duration: timedelta | None [Required]#

field flock: str | None [Required]#

field success: bool [Required]#

field sync: bool [Required]#

field username: str [Required]#

asdict()#

Returns this model in dictionary form. This method differs from pydantic’s dict by converting all values to their Avro representation. It also doesn’t provide the exclude, include, by_alias, etc. parameters that dict provides.

Return type:: Dict[str, Any]

classmethod fake(**data)#

Creates a fake instance of the model.

Attributes:: data: Dict[str, Any] represent the user values to use in the instance

Parameters:: data (Any)
Return type:: AvroBaseModel

classmethod json_schema(*args, **kwargs)#

Parameters:

args (Any)
kwargs (Any)

Return type:

str

serialize(serialization_type='avro')#

Overrides the base AvroModel’s serialize method to inject this class’s standardization factory method

Parameters:: serialization_type (Literal['avro', 'avro-json'], default: 'avro')
Return type:: bytes

to_dict()#

Return type:: Dict[str, Any]

validate_avro()#

Validate that instance matches the avro schema

Return type:: bool

classmethod validate_structure()#

Do runtime validation of fields.

Make sure all of the fields are compatible with the backing datastore (InfluxDB at the moment).

Return type:: None