Skip to content
ocx
install

SbomSummaryOut

SbomSummaryOutclassdataclass#

Re-exported from ocx_sdk._resultsView source
class SbomSummaryOut(spec_version: str, component_count: int, serial_number: str | None = None, top_level_component: str | None = None)

CycloneDX component counts for one SBOM entry, under --summary (C-014, sbom.rs:166-177).

Not a second top-level shape. --summary does not change sbom’s JSON root — it populates this struct per-entry, at SbomEntry.summary, for each entry that parsed successfully as CycloneDX 1.5-1.7. Nothing like ListingSummary’s seven fields: sbom() needs no overload, and this is built with from_dict, never from_json, because it never sits at a JSON root.

Attributes

NameTypeDescription
spec_versionstrThe CycloneDX spec version this document declares.
component_countintHow many components the document lists.
serial_numberstr | NoneThe document’s serial number, when it declares one.
top_level_componentstr | NoneThe root component’s name, when the document declares one.

component_countattributeinstance attribute#

component_count: int

serial_numberattributeclass attributeinstance attribute#

serial_number: str | None = None

spec_versionattributeinstance attribute#

spec_version: str

top_level_componentattributeclass attributeinstance attribute#

top_level_component: str | None = None

from_dictmethodclassmethod#

def from_dict(data: Mapping[str, Any]) -> SbomSummaryOut

Build from the decoded summary object of one SbomEntry.