pip_services3_commons.validate.ValidationResult module

pip_services3_commons.validate.ValidationResult

Validation result implementation

copyright

Conceptual Vision Consulting LLC 2018-2019, see AUTHORS for more details.

license

MIT, see LICENSE for more details.

class pip_services3_commons.validate.ValidationResult.ValidationResult(path: str = None, type: pip_services3_commons.validate.ValidationResultType.ValidationResultType = None, code: str = None, message: str = None, expected: Any = None, actual: Any = None)

Bases: object

Result generated by schema validation

get_actual() → Any

Gets the actual args found by schema validation.

Returns

the actual args.

get_code()str

Gets the error code.

Returns

the error code

get_expected() → Any

Gets the args expected by schema validation.

Returns

the expected args.

get_message()str

Gets the human readable message.

Returns

the result message.

get_path()str

Gets dot notation path of the validated element.

Returns

the path of the validated element.

get_type()pip_services3_commons.validate.ValidationResultType.ValidationResultType

Gets the type of the validation result: Information, Warning, or Error. See :class: ValidationResultType

Returns

the type of the validation result.

to_json() → Dict[str, Any]