File

pydantic model File[source]

The file block contains references to this data object as a file on a disk. A filename in this context can be actual, or abstract. Particularly the relative_path is, and will most likely remain, an important identifier for individual file objects within an FMU case - irrespective of the existance of an actual file system. For this reason, the relative_path - as well as the checksum_md5 will be generated even if a file is not saved to disk. The absolute_path will only be generated in the case of actually creating a file on disk and is not required under this schema.

Fields:
field absolute_path: Optional[Path] = None

The absolute path of a file, e.g. /scratch/field/user/case/etc.

field relative_path: Path [Required]

The path of a file relative to the case root.

field checksum_md5: MD5HashStr [Required]

A valid MD5 checksum of the file.

Constraints:

  • pattern = ^([a-fd]{32}|[A-Fd]{32})$

field size_bytes: Optional[int] = None

Size of file object in bytes