Skip to main content

@terascope/job-components / index / DataEntityMetadata

Interface: DataEntityMetadata

Defined in: packages/utils/dist/src/entities/interfaces.d.ts:20

DataEntities have conventional metadata properties that can track source, destination and other process information.

NOTE Time values are set in UNIX Epoch time, to reduce memory footput, the DataEntity has convenience apis for getting and setting the time given and handling the conversion between unix milliseconds to Date format.

Properties

PropertyModifierTypeDescriptionDefined in
_createTime?readonlynumberThe time at which this entity was created (this is automatically set on DataEntity creation)packages/utils/dist/src/entities/interfaces.d.ts:26
_eventTime?publicnumberThe time associated with this data entity, usually off of a specific field on source data or messagepackages/utils/dist/src/entities/interfaces.d.ts:35
_ingestTime?publicnumberThe time at which the data was ingested into the source datapackages/utils/dist/src/entities/interfaces.d.ts:28
_key?publicstring | numberA unique key for the data which will be can be used to key the datapackages/utils/dist/src/entities/interfaces.d.ts:37
_processTime?publicnumberThe time at which the data was consumed by the readerpackages/utils/dist/src/entities/interfaces.d.ts:30