FmuModelInformation

class pystclient.models.FmuModelInformation(*, id: UUID, version: UUID, filename: str, allows_multiple_instances: bool = False, fmu_version: Annotated[str | UUID, PlainSerializer(func=str, return_type=str, when_used=always)] | None = None, model_name: str, access_rights: list[str] = [], platforms: list[str], fmu_description: str = '', fmi_version: str | None = None)

Bases: BaseModel

Information about an FMU model.

__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
version
filename
allows_multiple_instances
fmu_version
model_name
access_rights
platforms
fmu_description
fmi_version

access_rights: Annotated[list[str], FieldInfo(annotation=NoneType, required=True, alias='user/access-rights', alias_priority=2)]

allows_multiple_instances: Annotated[bool, FieldInfo(annotation=NoneType, required=True, alias='fmu/allows-multiple-instances?', alias_priority=2)]

filename: str

fmi_version: Annotated[str | None, FieldInfo(annotation=NoneType, required=True, alias='fmi/fmi-version', alias_priority=2)]

fmu_description: Annotated[str, FieldInfo(annotation=NoneType, required=True, alias='fmu/description', alias_priority=2)]

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

id: UUID

model_config = {}

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

model_name: str

platforms: list[str]

version: UUID