tracdap.rt.metadata.object_id
¶
Module Contents¶
Classes¶
Enumeration of TRAC's core object types. |
|
A tag header describes the identity and version of an object. |
|
A tag selector describes the selection of a unique object at a point in time. |
- class tracdap.rt.metadata.object_id.ObjectType¶
Bases:
enum.Enum
Enumeration of TRAC’s core object types.
See also
ObjectDefinition
- CUSTOM = [6]¶
- DATA = [1]¶
- FILE = [5]¶
- FLOW = [3]¶
- JOB = [4]¶
- MODEL = [2]¶
- OBJECT_TYPE_NOT_SET = [0]¶
- SCHEMA = [8]¶
- STORAGE = [7]¶
- class tracdap.rt.metadata.object_id.TagHeader¶
A tag header describes the identity and version of an object.
See also
Tag
,ObjectDefinition
- objectId¶
Object ID of the object this tag is associated with.
Object IDs are UUIDs (RFC4122, https://www.ietf.org/rfc/rfc4122.txt)
- Type
str
- objectTimestamp¶
Timestamp for when this version of the object was created.
- Type
- objectType¶
Object type of the object this tag is associated with.
See also
- Type
- objectVersion¶
Version of the object this tag is associated with.
- Type
int
- tagTimestamp¶
Timestamp for when this version of the tag was created.
- Type
- tagVersion¶
Version of this tag.
- Type
int
- class tracdap.rt.metadata.object_id.TagSelector¶
A tag selector describes the selection of a unique object at a point in time.
A tag selector refers to a single object ID and provides criteria for selecting the object version and tag version. The available selection criteria are:
Select an explicit version number
Select the latest available version
Select the version that was live at specific point in time
A selector for an explicit version number will always match that exact version number. These “fixed” types of selector can be used to refer to elements of a repeatable job, because the versions they refer to will never change.
A selector for the latest version will select different versions over time, as they become available. These “variable” types of selector can be used by client applications that want to query the latest state of an object. If a job is set up using variable selectors, TRAC will convert them to fixed selectors for the particular versions that were selected before saving the job definition.
Criteria for object versions and tag versions can be “mixed and matched”, so e.g. latestObject = true with tagVersion = 1 is allowed.
See also
Tag
,TagHeader
- latestObject¶
Select the latest version of the object (the version that is live now).
If this flag is specified, it must be set to true.
- Type
Optional[bool]
- latestTag¶
Select the latest version of the tag (the version that is live now).
If this flag is specified, it must be set to true.
- Type
Optional[bool]
- objectAsOf¶
Select the version of the object that was live as of a particular point in time. Represented using ISO 8601.
- Type
Optional[DatetimeValue]
- objectId¶
Object ID of the tag being selected.
Object IDs are UUIDs (RFC4122, https://www.ietf.org/rfc/rfc4122.txt)
- Type
str
- objectType¶
Object type of the tag being selected.
See also
- Type
- objectVersion¶
Select an explicit version of the object.
- Type
Optional[int]
- tagAsOf¶
Select the version of the tag that was live as of a particular point in time. Represented using ISO 8601.
- Type
Optional[DatetimeValue]
- tagVersion¶
Select an explicit version of the tag.
- Type
Optional[int]