aito.client.responses.job_api_response.CreateJobResponse¶
-
class
aito.client.responses.job_api_response.
CreateJobResponse
(json: Dict)¶ Bases:
aito.client.responses.aito_response.BaseResponse
Response of the Create job containing the job information
- Parameters
json (Dict) – the original JSON response of the request
Methods
create a class object from a JSON deserialized object
from_json_string
(json_string, **kwargs)create an class object from a JSON string
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
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
the id of a job
the original JSON response of the request
when the job was started
-
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
id
¶ the id of a job
-
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
started_at
¶ when the job was started
-
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