Data Resource Fields

The specification for Data Resource has these fields:

id

Optional-String
human-readable identifier, unique within a Microservice

Example

"MY_SINK"

kind

Optional-List[DATA_KIND]
supported types of the data resource (e.g. file/object storage, database management system, streaming broker). FILE can mean a single file or a folder.

Example

["FILE", "STREAM"]

direction

Optional-List[DATA_DIRECTION]
supported direction of data flow (source: data provider, sink: data consumer/storage)

Example

["SOURCE", "BIDIRECTIONAL"]

format

Optional-List[DATA_FORMAT]
supported format/encoding of the data produced or consumed by the data resource as a MIME type (IETF RFC 6838 https://www.sitepoint.com/mime-types-complete-list/). More than one can appear here (remote directory with several files).

Example

["application/zip", "image/jpg"]

source_type

Optional-List[DATA_SOURCE_TYPE]
supported exact type of the data resource. Typically corresponds to the scheme part (protocol://) of DATA_URI

Example

["MYSQL", "KAFKA"]

auth_type

Optional-List[DATA_AUTH_TYPE]
supported authentication type

Example

["tls_mutual", "userpass"]

schema

Optional-List[DATA_SCHEMA]
supported internal message structure, semantics, ontology. It can be any file (doc, rdf, owl, etc.). Asset Administration Shell, IEC 61360 - Common Data Dictionary, …

Example

["jpg"]

aux_info

Optional-Map[String, String]
List of key-value pairs (JSON object/YAML dictionary) supported by the data resource. New keys can be added on demand, a list of known keys is available.

Example

{"PROTOCOL": "http", "MYSQL_DIALECT": "mariadbdialect", "MQTT_PROTOCOL_VERSION": "3.1.1", "KAFKA_BROKER_VERSION": "2.7.0", "S3_REGION": "eu-central-1"}