ResourceDefinition

class tracdap.rt.metadata.ResourceDefinition

Definition of a platform resource

properties: Dict[str, str]

Configuration properties for this resource, not visible to client applications

protocol: str

The protocol used to communicate with this resource (usually corresponds to a TRAC plugin)

publicProperties: Dict[str, str]

Configuration properties for this resource, made visible to client applications

resourceType: ResourceType

The type of this resource

secrets: Dict[str, str]

Configuration properties that are stored as secrets using TRAC’s secret handling mechanism

Only the secret alias is stored in metadata, handling of secret storage is delegated to the configured secrets plugin. Secret values may be sent by clients when resource definitions are created / updated, in which case they will be written to the configured secret store and metadata values will be replaced with an alias.

subProtocol: str | None

Optional sub-protocol, to further distinguish the behavior of resources within a protocol