SimulatorStatus

class pystclient.models.SimulatorStatus(*, id: Annotated[str | UUID, PlainSerializer(func=str, return_type=str, when_used=always)], type: str, display_name: str, status: str, project_id: Annotated[str | UUID, PlainSerializer(func=str, return_type=str, when_used=always)], simulation: Simulation | None = None, is_connected: bool = False, end_time: float | None = None, simulation_time: float | None = None, batch_id: Annotated[str | UUID, PlainSerializer(func=str, return_type=str, when_used=always)] | None = None)

Bases: BaseModel

Status information for a simulator.

Notes:

For type == CENTRALIZED, API does not include simulation in a status for the first few seconds after simulator creation.

__init__(**data: Any) → None

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Methods

__init__(**data)	Create a new model by parsing and validating input data from keyword arguments.
construct([_fields_set])
copy(*[, include, exclude, update, deep])	Returns a copy of the model.
dict(*[, include, exclude, by_alias, ...])
from_orm(obj)
json(*[, include, exclude, by_alias, ...])
model_construct([_fields_set])	Creates a new instance of the Model class with validated data.
model_copy(*[, update, deep])	!!! abstract "Usage Documentation"
model_dump(*[, mode, include, exclude, ...])	!!! abstract "Usage Documentation"
model_dump_json(*[, indent, ensure_ascii, ...])	!!! abstract "Usage Documentation"
model_json_schema([by_alias, ref_template, ...])	Generates a JSON schema for a model class.
model_parametrized_name(params)	Compute the class name for parametrizations of generic classes.
model_post_init(context, /)	Override this method to perform additional initialization after __init__ and model_construct.
model_rebuild(*[, force, raise_errors, ...])	Try to rebuild the pydantic-core schema for the model.
model_validate(obj, *[, strict, extra, ...])	Validate a pydantic model instance.
model_validate_json(json_data, *[, strict, ...])	!!! abstract "Usage Documentation"
model_validate_strings(obj, *[, strict, ...])	Validate the given object with string data against the Pydantic model.
parse_file(path, *[, content_type, ...])
parse_obj(obj)
parse_raw(b, *[, content_type, encoding, ...])
schema([by_alias, ref_template])
schema_json(*[, by_alias, ref_template])
update_forward_refs(**localns)
validate(value)

Attributes

model_computed_fields
model_config	Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
model_extra	Get extra fields set during validation.
model_fields
model_fields_set	Returns the set of fields that have been explicitly set on this model instance.
id
type
display_name
status
project_id
simulation
is_connected
end_time
simulation_time
batch_id

batch_id: Annotated[Annotated[str | UUID, PlainSerializer(func=str, return_type=str, when_used=always)] | None, FieldInfo(annotation=NoneType, required=True, alias='simulator/batch-id', alias_priority=2)]

display_name: Annotated[str, FieldInfo(annotation=NoneType, required=True, alias='simulator/display-name', alias_priority=2)]

end_time: Annotated[float | None, FieldInfo(annotation=NoneType, required=True, alias='simulator/end-time', alias_priority=2)]

id: Annotated[str | UUID, PlainSerializer(func=str, return_type=str, when_used=always), FieldInfo(annotation=NoneType, required=True, alias='simulator/id', alias_priority=2)]

is_connected: Annotated[bool, FieldInfo(annotation=NoneType, required=True, alias='simulator/connected?', alias_priority=2)]

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

project_id: Annotated[str | UUID, PlainSerializer(func=str, return_type=str, when_used=always), FieldInfo(annotation=NoneType, required=True, alias='simulator/project-id', alias_priority=2)]

simulation: Annotated[Simulation | None, FieldInfo(annotation=NoneType, required=True, alias='simulator/simulation', alias_priority=2)]

simulation_time: Annotated[float | None, FieldInfo(annotation=NoneType, required=True, alias='simulator/simulation-time', alias_priority=2)]

status: Annotated[str, FieldInfo(annotation=NoneType, required=True, alias='simulator/status', alias_priority=2)]

type: Annotated[str, FieldInfo(annotation=NoneType, required=True, alias='simulator/type', alias_priority=2)]