aito.client.responses.schema_api_response.TableSchemaResponse

class aito.client.responses.schema_api_response.TableSchemaResponse(json: Dict)

Bases: _SchemaResponse

Response that contains a table schema

Parameters:

json (Dict) – the original JSON response of the request

Methods

from_deserialized_object(obj)	create a class object from a JSON deserialized object
from_json_string(json_string, **kwargs)	create an class object from a JSON string
json_schema()	the JSON schema of the class
json_schema_validate(obj)	Validate an object with the class json_schema Returns the object if validation success, else raise JsonValidationError
json_schema_validate_with_schema(obj, schema)	Validate an object with the given schema
to_json_serializable()	convert the object to an object that can be serialized to a JSON formatted string
to_json_string(**kwargs)	convert the object to a JSON string

Attributes

json	the original JSON response of the request
schema	return an instance of the appropriate AitoSchema
schema_cls	the class of the schema component

classmethod from_deserialized_object(obj: Any)

create a class object from a JSON deserialized object

classmethod from_json_string(json_string: str, **kwargs)

create an class object from a JSON string

Parameters:

• json_string (str) – the JSON string

• kwargs – the keyword arguments for json.loads method

property json

the original JSON response of the request

Return type:

Dict

classmethod json_schema()

the JSON schema of the class

Return type:

Dict

classmethod json_schema_validate(obj: Any)

Validate an object with the class json_schema Returns the object if validation success, else raise JsonValidationError

Parameters:

obj (Any) – the object to be validated

Returns:

the object if validation succeed

Return type:

Any

json_schema_validate_with_schema(obj: Any, schema: Dict)

Validate an object with the given schema

Parameters:

• obj (Any) – the object to be validated

• schema (Dict) – the schema to be validate against

Returns:

the object if validation succeed

Return type:

Any

property schema: AitoSchema

return an instance of the appropriate AitoSchema

Return type:

AitoSchema

property schema_cls: Type[AitoSchema]

the class of the schema component

Return type:

Type[AitoSchema]

to_json_serializable()

convert the object to an object that can be serialized to a JSON formatted string

to_json_string(**kwargs)

convert the object to a JSON string

Parameters:

kwargs – the keyword arguments for json.dumps method

Return type:

str