otupy.profiles.ctxd.data.service.Service

class Service(service: object = None, name: ~otupy.profiles.ctxd.data.name.Name = None, domain: str = None, namespace: str = None, sid: ~otupy.profiles.ctxd.data.service.SId = None, type: ~otupy.profiles.ctxd.data.service_type.ServiceType = None, subservices: ~otupy.types.base.array_of.ArrayOf.__new__.<locals>.ArrayOf = None, owner: str = None, release: str = None)

Bases: Record

Service components

The Service is any digital resource present in a system, including software, APIs, devices, infrastructures and their elementary components. `Service`s have dependencies between them (aka `Link`s), which describe how they are related and how vulnerabilities might propagate.

A Service may also be an composition of more elementary subservices. In this case, both the Service and its sub`Service`s are described and linked, which allows to expose the system composition and topology with different level of granularity according to the trust level.

The domain and namespace field are kept for backward compatibility, but may be removed in future versions because they are already included in the SId. Do not rely or use these fields.

Methods

fromdict	Builds instance from dictionary
todict	Converts to dictionary

Attributes

domain	Domain of the service (e.g. OpenStack domain).
name	Name of the service
namespace	Tenant/namespace of the service
owner	owner of the service
release	Release version of the service
sid	Id of the service, to be create as unique as possible
subservices	Subservices of the main service
type	It identifies the type of the service

__init__(service: object = None, name: ~otupy.profiles.ctxd.data.name.Name = None, domain: str = None, namespace: str = None, sid: ~otupy.profiles.ctxd.data.service.SId = None, type: ~otupy.profiles.ctxd.data.service_type.ServiceType = None, subservices: ~otupy.types.base.array_of.ArrayOf.__new__.<locals>.ArrayOf = None, owner: str = None, release: str = None)

domain: str = None

Domain of the service (e.g. OpenStack domain)

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.

name: Name = None

Name of the service

namespace: str = None

Tenant/namespace of the service

owner: str = None

owner of the service

release: str = None

Release version of the service

sid: SId = None

Id of the service, to be create as unique as possible

subservices: ArrayOf = None

Subservices of the main service

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.

type: ServiceType = None

It identifies the type of the service