codacy-plugins-api
API
Generated with
codacy-plugins-api/com.codacy.plugins.api/com.codacy.plugins.api.results/Result/SBOM

SBOM

com.codacy.plugins.api.results.Result.SBOM
See theSBOM companion class
object SBOM

Attributes

Companion
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
SBOM.type

Members list

Type members

Classlikes

object BOMFormat extends Enumeration

Attributes

Supertypes
class Enumeration
trait Serializable
class Object
trait Matchable
class Any
Self type
BOMFormat.type
case class Component(bom-ref: String, `type`: Type, name: String, group: Option[String], version: Option[String], purl: Option[String], properties: List[Property], licenses: Option[List[LicenseWrapper]])

A software or hardware component used to build a software artifact.

A software or hardware component used to build a software artifact.

Value parameters

`bom-ref`

An identifier used to reference the component elsewhere in the SBOM. Unique within the SBOM.

`type`

The type of component.

group

The component group.

licenses

Component licenses.

name

The component name.

properties

A list of component properties as name-value pairs.

purl

The package URL. See https://github.com/package-url/purl-spec

version

The component version.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Component

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Component.type
case class Dependency(ref: String, dependsOn: List[String])

Documents a dependency relationship between components.

Documents a dependency relationship between components.

Value parameters

dependsOn

References to other components this component depends on.

ref

The reference to a component. Same as Component.bom-ref.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class License(id: Option[String], name: Option[String])

A software license.

A software license.

id and name cannot both be undefined.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class LicenseWrapper(license: License)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Metadata(timestamp: Instant, tools: Tools, component: Component)

SBOM metadata.

SBOM metadata.

Value parameters

component

The artifact that the SBOM describes.

timestamp

When the SBOM file was generated.

tools

The tools used in the SBOM creation.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Property(name: String, value: String)

A name-value pair representing a piece of information not officially supported by the SBOM schema.

A name-value pair representing a piece of information not officially supported by the SBOM schema.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Tool(`type`: Type, name: String, group: String, version: String)

A tool used in SBOM generation. E.g. Trivy.

A tool used in SBOM generation. E.g. Trivy.

Value parameters

`type`

The tool type.

group

The tool group. E.g. com.codacy.

name

The tool name.

version

The tool version.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Tools(components: List[Tool])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Types

type BOMFormat = Value

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror
Generated with