Show / Hide Table of Contents

Class Component

Inheritance
object
Component
Implements
IEquatable<Component>
IHasBomRef
Inherited Members
object.Equals(object, object)
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: CycloneDX.Models
Assembly: CycloneDX.Core.dll
Syntax
[ProtoContract]
public class Component : IEquatable<Component>, IHasBomRef

Properties

| Edit this page View Source

Author

Declaration
[Obsolete("This will be removed in a future version. Use @.authors or @.manufacturer instead.")]
[ProtoMember(5)]
public string Author { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Authors

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

BomRef

Declaration
[JsonPropertyName("bom-ref")]
[ProtoMember(3)]
public string BomRef { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Components

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

Copyright

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

Cpe

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

CryptoProperties

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

Data

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

Description

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

Evidence

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

ExternalReferences

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

Group

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

Hashes

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

Licenses

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

Manufacturer

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

MimeType

Declaration
[JsonPropertyName("mime-type")]
[ProtoMember(2)]
public string MimeType { get; set; }
Property Value
Type Description
string
| Edit this page View Source

ModelCard

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

Modified

Declaration
[ProtoMember(18)]
public bool? Modified { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

Name

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

NonNullableModified

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

NonNullableScope

Declaration
[JsonIgnore]
public Component.ComponentScope NonNullableScope { get; set; }
Property Value
Type Description
Component.ComponentScope
| Edit this page View Source

OmniborId

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

Pedigree

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

Properties

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

Publisher

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

Purl

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

ReleaseNotes

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

Scope

Declaration
[ProtoMember(11)]
public Component.ComponentScope? Scope { get; set; }
Property Value
Type Description
Component.ComponentScope?
| Edit this page View Source

Signature

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

Supplier

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

Swhid

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

Swid

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

Tags

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

Type

Declaration
[ProtoMember(1, IsRequired = true)]
public Component.Classification Type { get; set; }
Property Value
Type Description
Component.Classification
| Edit this page View Source

Version

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

XmlSignature

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

Methods

| Edit this page View Source

Equals(Component)

Declaration
public bool Equals(Component obj)
Parameters
Type Name Description
Component obj
Returns
Type Description
bool
| Edit this page View Source

Equals(object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides
object.Equals(object)
| Edit this page View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides
object.GetHashCode()
| Edit this page View Source

ShouldSerializeAuthor_Xml()

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

ShouldSerializeAuthors()

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

ShouldSerializeComponents()

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

ShouldSerializeExternalReferences()

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

ShouldSerializeHashes()

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

ShouldSerializeManufacturer()

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

ShouldSerializeNonNullableModified()

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

ShouldSerializeNonNullableScope()

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

ShouldSerializeOmniborId()

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

ShouldSerializeProperties()

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

ShouldSerializeReleaseNotes()

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

ShouldSerializeSwhid()

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

ShouldSerializeTags()

Declaration
public bool ShouldSerializeTags()
Returns
Type Description
bool

Implements

IEquatable<T>
IHasBomRef

Extension Methods

AttributionTexts.AddSpdxAttributionTexts(Component, List<string>)
AttributionTexts.GetSpdxAttributionTexts(Component)
Checksums.AddSpdxChecksums(Component, List<Checksum>)
Checksums.GetSpdxChecksums(Component)
ExternalRefs.AddSpdxExternalRefs(Component, List<ExternalRef>)
ExternalRefs.GetSpdxExternalRefs(Component)
  • Edit this page
  • View Source
In this article
  • Properties
    • Author
    • Authors
    • BomRef
    • Components
    • Copyright
    • Cpe
    • CryptoProperties
    • Data
    • Description
    • Evidence
    • ExternalReferences
    • Group
    • Hashes
    • Licenses
    • Manufacturer
    • MimeType
    • ModelCard
    • Modified
    • Name
    • NonNullableModified
    • NonNullableScope
    • OmniborId
    • Pedigree
    • Properties
    • Publisher
    • Purl
    • ReleaseNotes
    • Scope
    • Signature
    • Supplier
    • Swhid
    • Swid
    • Tags
    • Type
    • Version
    • XmlSignature
  • Methods
    • Equals(Component)
    • Equals(object)
    • GetHashCode()
    • ShouldSerializeAuthor_Xml()
    • ShouldSerializeAuthors()
    • ShouldSerializeComponents()
    • ShouldSerializeExternalReferences()
    • ShouldSerializeHashes()
    • ShouldSerializeManufacturer()
    • ShouldSerializeNonNullableModified()
    • ShouldSerializeNonNullableScope()
    • ShouldSerializeOmniborId()
    • ShouldSerializeProperties()
    • ShouldSerializeReleaseNotes()
    • ShouldSerializeSwhid()
    • ShouldSerializeTags()
  • Implements
  • Extension Methods
Back to top Generated by DocFX