- integrations
- Python
- ocx_sdk
SbomSummaryOut
SbomSummaryOutclassdataclass#
Re-exported from
ocx_sdk._resultsView sourceclass 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
| Name | Type | Description |
|---|---|---|
spec_version | str | The CycloneDX spec version this document declares. |
component_count | int | How many components the document lists. |
serial_number | str | None | The document’s serial number, when it declares one. |
top_level_component | str | None | The root component’s name, when the document declares one. |
component_countattributeinstance attribute#
component_count: intserial_numberattributeclass attributeinstance attribute#
serial_number: str | None = Nonespec_versionattributeinstance attribute#
spec_version: strtop_level_componentattributeclass attributeinstance attribute#
top_level_component: str | None = Nonefrom_dictmethodclassmethod#
def from_dict(data: Mapping[str, Any]) -> SbomSummaryOutBuild from the decoded summary object of one SbomEntry.