@twin.org/standards-w3c-dcat
Version:
Models which define the structure of W3C DCAT Standard
282 lines (142 loc) • 5.54 kB
Markdown
# Interface: IDistribution
Interface for DCAT Distribution.
A specific representation of a dataset. A dataset might be available in multiple
serializations that may differ in various ways.
## See
https://www.w3.org/TR/vocab-dcat-3/#Class:Distribution
## Extends
- `IJsonLdNodeObject`
## Indexable
\[`key`: `string`\]: `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{\[`key`: `string`\]: `string`; \} \| `null` \| `undefined`
## Properties
### @context?
> `optional` **@context**: [`DcatContextType`](../type-aliases/DcatContextType.md)
The JSON-LD context for the resource.
#### Overrides
`IJsonLdNodeObject.@context`
***
### @type
> **@type**: `"Distribution"`
The type identifier, typically "Distribution".
#### Overrides
`IJsonLdNodeObject.@type`
***
### dcterms:title?
> `optional` **dcterms:title**: [`LiteralType`](../type-aliases/LiteralType.md)
A name given to the distribution.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_title
***
### dcterms:description?
> `optional` **dcterms:description**: [`LiteralType`](../type-aliases/LiteralType.md)
A free-text account of the distribution.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_description
***
### dcterms:issued?
> `optional` **dcterms:issued**: `string`
Date of formal issuance of the distribution.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_release_date
***
### dcterms:modified?
> `optional` **dcterms:modified**: `string`
Most recent date on which the distribution was changed, updated or modified.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_update_date
***
### dcterms:license?
> `optional` **dcterms:license**: `string`
A legal document under which the distribution is made available.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_license
***
### dcterms:accessRights?
> `optional` **dcterms:accessRights**: `string`
Information about who can access the distribution.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_access_rights
***
### dcterms:rights?
> `optional` **dcterms:rights**: `string`
Information about rights held in and over the distribution.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_rights
***
### dcat:accessURL?
> `optional` **dcat:accessURL**: `string`
A URL of the resource that gives access to a distribution of the dataset.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_access_url
***
### dcat:accessService?
> `optional` **dcat:accessService**: `string`
A data service that gives access to the distribution.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_access_service
***
### dcat:downloadURL?
> `optional` **dcat:downloadURL**: `string`
The URL of the downloadable file in a given format.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_download_url
***
### dcat:byteSize?
> `optional` **dcat:byteSize**: `number`
The size of the distribution in bytes.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_byte_size
***
### dcat:spatialResolutionInMeters?
> `optional` **dcat:spatialResolutionInMeters**: `number`
The minimum spatial separation resolvable in a distribution, measured in meters.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_spatial_resolution
***
### dcat:temporalResolution?
> `optional` **dcat:temporalResolution**: `string`
Minimum time period resolvable in the distribution.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_temporal_resolution
***
### dcterms:conformsTo?
> `optional` **dcterms:conformsTo**: `ObjectOrArray`\<`string`\>
An established standard to which the distribution conforms.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_conforms_to
***
### dcat:mediaType?
> `optional` **dcat:mediaType**: `string`
The media type of the distribution as defined by IANA.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_media_type
***
### dcterms:format?
> `optional` **dcterms:format**: `string`
The file format of the distribution.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_format
***
### dcat:compressFormat?
> `optional` **dcat:compressFormat**: `string`
The compression format of the distribution.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_compression_format
***
### dcat:packageFormat?
> `optional` **dcat:packageFormat**: `string`
The package format of the distribution.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_packaging_format
***
### spdx:checksum?
> `optional` **spdx:checksum**: `string`
The checksum property provides a mechanism to verify the data integrity.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_checksum
***
### odrl:hasPolicy?
> `optional` **odrl:hasPolicy**: `IOdrlPolicy`
An ODRL conformant policy expressing the rights associated with the distribution.
#### See
https://www.w3.org/TR/vocab-dcat-3/#Property:distribution_has_policy