otupy.profiles.xbom.data.link.Link

class Link(link: object = None, name: ~otupy.profiles.xbom.data.name.Name = None, sid: ~otupy.profiles.xbom.data.service.SId = None, description: str = None, link_type: ~otupy.profiles.xbom.data.link_type.LinkType = None, role: ~otupy.profiles.xbom.data.peer_role.PeerRole = None, peers: ~otupy.types.base.array_of.ArrayOf.__new__.<locals>.ArrayOf = None)

Bases: Record

A Link is a relationship between Services. A relationship is made between a subject (the name) and one or more objects (the peers).

The Link class contains all Peers of a given LinkType for the given service Name. Implementations might instantiate multiple Links for different Peers of the same LinkType or provide all Peers in the same instance.

Methods

`as_cyclonedx`	Convert Link to CycloneDX properties format.
`fromdict`	Builds instance from dictionary
`todict`	Converts to dictionary
`validate_fields`

Attributes

`description`	Generic description of the relationship
`link_type`	Type of the link
`name`	Id of the link
`peers`	Services connected on the link
`role`	Role of service in the link relationship
`sid`	Service ID of the owner of this link

__init__(link: object = None, name: ~otupy.profiles.xbom.data.name.Name = None, sid: ~otupy.profiles.xbom.data.service.SId = None, description: str = None, link_type: ~otupy.profiles.xbom.data.link_type.LinkType = None, role: ~otupy.profiles.xbom.data.peer_role.PeerRole = None, peers: ~otupy.types.base.array_of.ArrayOf.__new__.<locals>.ArrayOf = None)

as_cyclonedx(link_id: str | None = None) → List[Property]

Convert Link to CycloneDX properties format.

Args:: link_id: The unique identifier for this link. If None, a UUID will be generated.
Returns:: List[Property]: List of CycloneDX Property objects.

description: str = None: Generic description of the relationship

classmethod fromdict(dic, e)

Builds instance from dictionary

It is used during deserialization to create an otupy instance from the text message. It takes an Encoder instance that is used to recursively build instances of the inner objects (the Encoder provides standard methods to create instances of base objects like strings, integers, boolean).

Parameters:

dic – The intermediary dictionary representation from which the object is built.
e – The Encoder that is being used.

Returns:

An instance of this class initialized from the dictionary values.

link_type: LinkType = None: Type of the link

name: Name = None: Id of the link

peers: ArrayOf = None: Services connected on the link

role: PeerRole = None: Role of service in the link relationship

sid: SId = None: Service ID of the owner of this link

todict(e)

Converts to dictionary

It is used to convert this object to an intermediary representation during serialization. It takes an Encoder argument that is used to recursively serialize inner data and structures (the Encoder provides standard methods for converting base types to dictionaries)..

Parameters:: e – The Encoder that is being used.
Returns:: A dictionary compliants to the Language Specification’s serialization rules.