EventPayload#

pydantic model safir.metrics.EventPayload#

All event payloads should inherit from this.

Parameters:

data (Any)

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:
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