com.datadog.api.client.v2.model

Class CycloneDXBom

java.lang.Object

com.datadog.api.client.v2.model.CycloneDXBom

@Generated(value="https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class CycloneDXBom
extends Object

A CycloneDX 1.5 Bill of Materials (BOM) document containing vulnerability data.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_BOM_FORMAT
static String	JSON_PROPERTY_COMPONENTS
static String	JSON_PROPERTY_METADATA
static String	JSON_PROPERTY_SPEC_VERSION
static String	JSON_PROPERTY_VERSION
static String	JSON_PROPERTY_VULNERABILITIES
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
CycloneDXBom()
CycloneDXBom(String bomFormat, List<CycloneDXComponent> components, CycloneDXMetadata metadata, String specVersion, List<CycloneDXVulnerability> vulnerabilities)

Method Summary

Modifier and Type	Method and Description
CycloneDXBom	addComponentsItem(CycloneDXComponent componentsItem)
CycloneDXBom	addVulnerabilitiesItem(CycloneDXVulnerability vulnerabilitiesItem)
CycloneDXBom	bomFormat(String bomFormat)
CycloneDXBom	components(List<CycloneDXComponent> components)
boolean	equals(Object o) Return true if this CycloneDXBom object is equal to o.
Map<String,Object>	getAdditionalProperties() Return the additional (undeclared) property.
Object	getAdditionalProperty(String key) Return the additional (undeclared) property with the specified name.
String	getBomFormat() The BOM format identifier.
List<CycloneDXComponent>	getComponents() The list of scanned software components.
CycloneDXMetadata	getMetadata() Metadata about the BOM, including the scanned asset and the scanner tool.
String	getSpecVersion() The CycloneDX specification version.
Long	getVersion() The version number of the BOM document.
List<CycloneDXVulnerability>	getVulnerabilities() The list of detected vulnerabilities.
int	hashCode()
CycloneDXBom	metadata(CycloneDXMetadata metadata)
CycloneDXBom	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
void	setBomFormat(String bomFormat)
void	setComponents(List<CycloneDXComponent> components)
void	setMetadata(CycloneDXMetadata metadata)
void	setSpecVersion(String specVersion)
void	setVersion(Long version)
void	setVulnerabilities(List<CycloneDXVulnerability> vulnerabilities)
CycloneDXBom	specVersion(String specVersion)
String	toString()
CycloneDXBom	version(Long version)
CycloneDXBom	vulnerabilities(List<CycloneDXVulnerability> vulnerabilities)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_BOM_FORMAT

public static final String JSON_PROPERTY_BOM_FORMAT

See Also:

Constant Field Values

JSON_PROPERTY_COMPONENTS

public static final String JSON_PROPERTY_COMPONENTS

See Also:

Constant Field Values

JSON_PROPERTY_METADATA

public static final String JSON_PROPERTY_METADATA

See Also:

Constant Field Values

JSON_PROPERTY_SPEC_VERSION

public static final String JSON_PROPERTY_SPEC_VERSION

See Also:

Constant Field Values

JSON_PROPERTY_VERSION

public static final String JSON_PROPERTY_VERSION

See Also:

Constant Field Values

JSON_PROPERTY_VULNERABILITIES

public static final String JSON_PROPERTY_VULNERABILITIES

See Also:

Constant Field Values

Constructor Detail

CycloneDXBom

public CycloneDXBom()

CycloneDXBom

public CycloneDXBom(String bomFormat,
                    List<CycloneDXComponent> components,
                    CycloneDXMetadata metadata,
                    String specVersion,
                    List<CycloneDXVulnerability> vulnerabilities)

Method Detail

bomFormat

public CycloneDXBom bomFormat(String bomFormat)

getBomFormat

public String getBomFormat()

The BOM format identifier. Must be CycloneDX.

Returns:

bomFormat

setBomFormat

public void setBomFormat(String bomFormat)

components

public CycloneDXBom components(List<CycloneDXComponent> components)

addComponentsItem

public CycloneDXBom addComponentsItem(CycloneDXComponent componentsItem)

getComponents

public List<CycloneDXComponent> getComponents()

The list of scanned software components. Cannot be empty.

Returns:

components

setComponents

public void setComponents(List<CycloneDXComponent> components)

metadata

public CycloneDXBom metadata(CycloneDXMetadata metadata)

getMetadata

public CycloneDXMetadata getMetadata()

Metadata about the BOM, including the scanned asset and the scanner tool.

Returns:

metadata

setMetadata

public void setMetadata(CycloneDXMetadata metadata)

specVersion

public CycloneDXBom specVersion(String specVersion)

getSpecVersion

public String getSpecVersion()

The CycloneDX specification version. Must be 1.5.

Returns:

specVersion

setSpecVersion

public void setSpecVersion(String specVersion)

version

public CycloneDXBom version(Long version)

getVersion

@Nullable
public Long getVersion()

The version number of the BOM document.

Returns:

version

setVersion

public void setVersion(Long version)

vulnerabilities

public CycloneDXBom vulnerabilities(List<CycloneDXVulnerability> vulnerabilities)

addVulnerabilitiesItem

public CycloneDXBom addVulnerabilitiesItem(CycloneDXVulnerability vulnerabilitiesItem)

getVulnerabilities

public List<CycloneDXVulnerability> getVulnerabilities()

The list of detected vulnerabilities. Cannot be empty.

Returns:

vulnerabilities

setVulnerabilities

public void setVulnerabilities(List<CycloneDXVulnerability> vulnerabilities)

putAdditionalProperty

public CycloneDXBom putAdditionalProperty(String key,
                                          Object value)

Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.

Parameters:

key - The arbitrary key to set

value - The associated value

Returns:

CycloneDXBom

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

Return the additional (undeclared) property.

Returns:

The additional properties

getAdditionalProperty

public Object getAdditionalProperty(String key)

Return the additional (undeclared) property with the specified name.

Parameters:

key - The arbitrary key to get

Returns:

The specific additional property for the given key

equals

public boolean equals(Object o)

Return true if this CycloneDXBom object is equal to o.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object