ts_ids_core.schema.related_file module

Model Checksum

Bases: IdsElement

Checksum value and algorithm associated with a file.

Show JSON schema

{
   "description": "Checksum value and algorithm associated with a file.",
   "type": "object",
   "properties": {
      "value": {
         "description": "Checksum string value.",
         "type": "string"
      },
      "algorithm": {
         "description": "Checksum algorithm, e.g. 'md5', 'sha256'.",
         "type": [
            "string",
            "null"
         ]
      }
   },
   "additionalProperties": false,
   "required": [
      "value",
      "algorithm"
   ]
}

Validators:

• all_abstract_fields_implemented » all fields

field algorithm: Required[Nullable[str]]

Checksum algorithm, e.g. ‘md5’, ‘sha256’.

field value: Required[str]

Checksum string value.

Model Pointer

Bases: IdsElement

A pointer stores the location metadata of the file on TDP.

Show JSON schema

{
   "description": "A pointer stores the location metadata of the file on TDP.",
   "type": "object",
   "properties": {
      "fileKey": {
         "description": "AWS S3 file key.",
         "type": "string"
      },
      "version": {
         "description": "AWS S3 file version number.",
         "type": "string"
      },
      "bucket": {
         "description": "AWS S3 bucket.",
         "type": "string"
      },
      "type": {
         "description": "Type of the file, e.g. 's3file', 'parquet'.",
         "type": "string"
      },
      "fileId": {
         "description": "File ID (UUID) in TDP.",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "fileKey",
      "version",
      "bucket",
      "type",
      "fileId"
   ]
}

Validators:

• all_abstract_fields_implemented » all fields

field bucket: Required[str]

AWS S3 bucket.

field fileId: Required[str]

File ID (UUID) in TDP.

field fileKey: Required[str]

AWS S3 file key.

field type_: Required[str] (alias 'type')

Type of the file, e.g. ‘s3file’, ‘parquet’.

field version: Required[str]

AWS S3 file version number.

Model RelatedFile

Bases: IdsElement

A reference to a file related to this IDS stored on the Tetra Data Platform.

Show JSON schema

{
   "description": "A reference to a file related to this IDS stored on the Tetra Data Platform.",
   "type": "object",
   "properties": {
      "name": {
         "description": "File name.",
         "type": [
            "string",
            "null"
         ]
      },
      "path": {
         "description": "File path.",
         "type": [
            "string",
            "null"
         ]
      },
      "size": {
         "$ref": "#/definitions/ValueUnit",
         "description": "File size."
      },
      "checksum": {
         "$ref": "#/definitions/Checksum",
         "description": "File checksum."
      },
      "pointer": {
         "$ref": "#/definitions/Pointer",
         "description": "File pointer to location on TDP."
      }
   },
   "additionalProperties": false,
   "required": [
      "pointer"
   ],
   "definitions": {
      "Checksum": {
         "additionalProperties": false,
         "description": "Checksum value and algorithm associated with a file.",
         "properties": {
            "value": {
               "description": "Checksum string value.",
               "type": "string"
            },
            "algorithm": {
               "description": "Checksum algorithm, e.g. 'md5', 'sha256'.",
               "type": [
                  "string",
                  "null"
               ]
            }
         },
         "required": [
            "value",
            "algorithm"
         ],
         "type": "object"
      },
      "Pointer": {
         "additionalProperties": false,
         "description": "A pointer stores the location metadata of the file on TDP.",
         "properties": {
            "fileKey": {
               "description": "AWS S3 file key.",
               "type": "string"
            },
            "version": {
               "description": "AWS S3 file version number.",
               "type": "string"
            },
            "bucket": {
               "description": "AWS S3 bucket.",
               "type": "string"
            },
            "type": {
               "description": "Type of the file, e.g. 's3file', 'parquet'.",
               "type": "string"
            },
            "fileId": {
               "description": "File ID (UUID) in TDP.",
               "type": "string"
            }
         },
         "required": [
            "fileKey",
            "version",
            "bucket",
            "type",
            "fileId"
         ],
         "type": "object"
      },
      "ValueUnit": {
         "additionalProperties": false,
         "description": "A quantity, represented by a value with a unit.",
         "properties": {
            "value": {
               "description": "A numerical value.",
               "type": [
                  "number",
                  "null"
               ]
            },
            "unit": {
               "description": "Unit for the numerical value.",
               "type": [
                  "string",
                  "null"
               ]
            }
         },
         "required": [
            "value",
            "unit"
         ],
         "type": "object"
      }
   }
}

Validators:

• all_abstract_fields_implemented » all fields

field checksum: Checksum

File checksum.

field name: Nullable[str]

File name.

field path: Nullable[str]

File path.

field pointer: Required[Pointer]

File pointer to location on TDP.

field size: ValueUnit

File size.