Class: Checksum¶

A checksum of a File object (orig: DrsObject). Exact copy of the Checksum object of the GA4GH DRS data model (https://ga4gh.github.io/data-repository-service-schemas/preview/release/drs-1.4.0/docs/#tag/ChecksumModel).

URI: https://w3id.org/fga-wg/schema/bundle/Checksum

 classDiagram
    class Checksum
    click Checksum href "../Checksum/"
      Checksum : checksum

      Checksum : checksum_type

Example¶

Example JSON

{
  "checksum": "535bc9628a1c5e5215226f9996e4eaca",
  "checksum_type": "md5"
}

Slots¶

Name	Cardinality and Range	Description	Inheritance
checksum	0..1 String	The hex-string encoded checksum for the data.	direct
checksum_type	1 String	The digest method used to create the checksum. The value (e.g. `sha-256`) SHOULD be listed as `Hash Name String` in the https://www.iana.org/assignments/named-information/named-information.xhtml#hash-alg [IANA Named Information Hash Algorithm Registry]. Other values MAY be used, as long as implementors are aware of the issues discussed in https://tools.ietf.org/html/rfc6920#section-9.4 [RFC6920]. GA4GH may provide more explicit guidance for use of non-IANA-registered algorithms in the future. Until then, if implementors do choose such an algorithm (e.g. because it's implemented by their storage provider), they SHOULD use an existing standard `type` value such as `md5`, `etag`, `crc32c`, `trunc512`, or `sha1`.	direct

Usages¶

used by	used in	type	used
File	checksums	range	Checksum
GenomicAnnotationFile	checksums	range	Checksum

Identifier and Mapping Information¶

Schema Source¶

from schema: https://w3id.org/fga-wg/schema/bundle

Mappings¶

Mapping Type	Mapped Value
self	https://w3id.org/fga-wg/schema/bundle/Checksum
native	https://w3id.org/fga-wg/schema/bundle/Checksum

LinkML Source¶

Direct¶

name: Checksum
description: 'A checksum of a File object (orig: DrsObject). Exact copy of the Checksum
  object of the GA4GH DRS data model (https://ga4gh.github.io/data-repository-service-schemas/preview/release/drs-1.4.0/docs/#tag/ChecksumModel).'
from_schema: https://w3id.org/fga-wg/schema/bundle
slots:
- checksum
- checksum_type

Induced¶

name: Checksum
description: 'A checksum of a File object (orig: DrsObject). Exact copy of the Checksum
  object of the GA4GH DRS data model (https://ga4gh.github.io/data-repository-service-schemas/preview/release/drs-1.4.0/docs/#tag/ChecksumModel).'
from_schema: https://w3id.org/fga-wg/schema/bundle
attributes:
  checksum:
    name: checksum
    description: The hex-string encoded checksum for the data.
    examples:
    - value: 535bc9628a1c5e5215226f9996e4eaca
    from_schema: https://w3id.org/fga-wg/schema/bundle
    rank: 1000
    owner: Checksum
    domain_of:
    - Checksum
    range: string
  checksum_type:
    name: checksum_type
    description: The digest method used to create the checksum. The value (e.g. `sha-256`)
      SHOULD be listed as `Hash Name String` in the https://www.iana.org/assignments/named-information/named-information.xhtml#hash-alg
      [IANA Named Information Hash Algorithm Registry]. Other values MAY be used,
      as long as implementors are aware of the issues discussed in https://tools.ietf.org/html/rfc6920#section-9.4
      [RFC6920]. GA4GH may provide more explicit guidance for use of non-IANA-registered
      algorithms in the future. Until then, if implementors do choose such an algorithm
      (e.g. because it's implemented by their storage provider), they SHOULD use an
      existing standard `type` value such as `md5`, `etag`, `crc32c`, `trunc512`,
      or `sha1`.
    examples:
    - value: md5
    from_schema: https://w3id.org/fga-wg/schema/bundle
    rank: 1000
    owner: Checksum
    domain_of:
    - Checksum
    range: string
    required: true