Show / Hide Table of Contents

Class Bom

Inheritance
object
Bom
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: CycloneDX.Models
Assembly: CycloneDX.Core.dll
Syntax
[ProtoContract]
public class Bom

Properties

| Edit this page View Source

Annotations

Declaration
[ProtoMember(11)]
public List<Annotation> Annotations { get; set; }
Property Value
Type Description
List<Annotation>
| Edit this page View Source

BomFormat

Declaration
public string BomFormat { get; }
Property Value
Type Description
string
| Edit this page View Source

Components

Declaration
[ProtoMember(5)]
public List<Component> Components { get; set; }
Property Value
Type Description
List<Component>
| Edit this page View Source

Compositions

Declaration
[ProtoMember(9)]
public List<Composition> Compositions { get; set; }
Property Value
Type Description
List<Composition>
| Edit this page View Source

Declarations

Declaration
[ProtoMember(14)]
public Declarations Declarations { get; set; }
Property Value
Type Description
Declarations
| Edit this page View Source

Definitions

Declaration
[ProtoMember(15)]
public Definitions Definitions { get; set; }
Property Value
Type Description
Definitions
| Edit this page View Source

Dependencies

Declaration
[ProtoMember(8)]
public List<Dependency> Dependencies { get; set; }
Property Value
Type Description
List<Dependency>
| Edit this page View Source

ExternalReferences

Declaration
[ProtoMember(7)]
public List<ExternalReference> ExternalReferences { get; set; }
Property Value
Type Description
List<ExternalReference>
| Edit this page View Source

Formulation

Declaration
[ProtoMember(13)]
public List<Formula> Formulation { get; set; }
Property Value
Type Description
List<Formula>
| Edit this page View Source

Metadata

Declaration
[ProtoMember(4)]
public Metadata Metadata { get; set; }
Property Value
Type Description
Metadata
| Edit this page View Source

NonNullableVersion

Declaration
[JsonIgnore]
public int NonNullableVersion { get; set; }
Property Value
Type Description
int
| Edit this page View Source

Properties

Declaration
[ProtoMember(12)]
public List<Property> Properties { get; set; }
Property Value
Type Description
List<Property>
| Edit this page View Source

SerialNumber

Declaration
[ProtoMember(3)]
public string SerialNumber { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Services

Declaration
[ProtoMember(6)]
public List<Service> Services { get; set; }
Property Value
Type Description
List<Service>
| Edit this page View Source

Signature

Declaration
public SignatureChoice Signature { get; set; }
Property Value
Type Description
SignatureChoice
| Edit this page View Source

SpecVersion

Declaration
[JsonIgnore]
public SpecificationVersion SpecVersion { get; set; }
Property Value
Type Description
SpecificationVersion
| Edit this page View Source

SpecVersionString

Declaration
[ProtoMember(1)]
[JsonPropertyName("specVersion")]
public string SpecVersionString { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Version

Declaration
[ProtoMember(2)]
public int? Version { get; set; }
Property Value
Type Description
int?
| Edit this page View Source

Vulnerabilities

Declaration
[ProtoMember(10)]
public List<Vulnerability> Vulnerabilities { get; set; }
Property Value
Type Description
List<Vulnerability>
| Edit this page View Source

XmlSignature

Declaration
[JsonIgnore]
public XmlElement XmlSignature { get; set; }
Property Value
Type Description
XmlElement

Methods

| Edit this page View Source

ShouldSerializeAnnotations()

Declaration
public bool ShouldSerializeAnnotations()
Returns
Type Description
bool
| Edit this page View Source

ShouldSerializeDeclarations()

Declaration
public bool ShouldSerializeDeclarations()
Returns
Type Description
bool
| Edit this page View Source

ShouldSerializeDependencies()

Declaration
public bool ShouldSerializeDependencies()
Returns
Type Description
bool
| Edit this page View Source

ShouldSerializeExternalReferences()

Declaration
public bool ShouldSerializeExternalReferences()
Returns
Type Description
bool
| Edit this page View Source

ShouldSerializeFormulation()

Declaration
public bool ShouldSerializeFormulation()
Returns
Type Description
bool
| Edit this page View Source

ShouldSerializeNonNullableVersion()

Declaration
public bool ShouldSerializeNonNullableVersion()
Returns
Type Description
bool
| Edit this page View Source

ShouldSerializeProperties()

Declaration
public bool ShouldSerializeProperties()
Returns
Type Description
bool
| Edit this page View Source

ShouldSerializeServices()

Declaration
public bool ShouldSerializeServices()
Returns
Type Description
bool
| Edit this page View Source

ShouldSerializeVulnerabilities()

Declaration
public bool ShouldSerializeVulnerabilities()
Returns
Type Description
bool

Extension Methods

BomUtils.Copy(Bom)
Creators.AddSpdxCreators(Bom, List<string>)
Creators.GetSpdxCreators(Bom)
CycloneDXBomHelpers.AddSpdxPackages(Bom, SpdxDocument)
Files.AddSpdxFiles(Bom, List<File>)
Files.GetSpdxFiles(Bom)
SpdxDocumentConverters.ToSpdx(Bom)
  • Edit this page
  • View Source
In this article
Back to top Generated by DocFX