com.datadog.api.client.v2.model

Class SBOMAttributes

java.lang.Object

com.datadog.api.client.v2.model.SBOMAttributes

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

The JSON:API attributes of the SBOM.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
SBOMAttributes()
SBOMAttributes(String bomFormat, List<SBOMComponent> components, List<SBOMComponentDependency> dependencies, SBOMMetadata metadata, String serialNumber, SpecVersion specVersion, Long version)

Method Summary

Modifier and Type	Method and Description
SBOMAttributes	addComponentsItem(SBOMComponent componentsItem)
SBOMAttributes	addDependenciesItem(SBOMComponentDependency dependenciesItem)
SBOMAttributes	bomFormat(String bomFormat)
SBOMAttributes	components(List<SBOMComponent> components)
SBOMAttributes	dependencies(List<SBOMComponentDependency> dependencies)
boolean	equals(Object o) Return true if this SBOMAttributes 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() Specifies the format of the BOM.
List<SBOMComponent>	getComponents() A list of software and hardware components.
List<SBOMComponentDependency>	getDependencies() List of dependencies between components of the SBOM.
SBOMMetadata	getMetadata() Provides additional information about a BOM.
String	getSerialNumber() Every BOM generated has a unique serial number, even if the contents of the BOM have not changed overt time.
SpecVersion	getSpecVersion() The version of the CycloneDX specification a BOM conforms to.
Long	getVersion() It increments when a BOM is modified.
int	hashCode()
SBOMAttributes	metadata(SBOMMetadata metadata)
SBOMAttributes	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
SBOMAttributes	serialNumber(String serialNumber)
void	setBomFormat(String bomFormat)
void	setComponents(List<SBOMComponent> components)
void	setDependencies(List<SBOMComponentDependency> dependencies)
void	setMetadata(SBOMMetadata metadata)
void	setSerialNumber(String serialNumber)
void	setSpecVersion(SpecVersion specVersion)
void	setVersion(Long version)
SBOMAttributes	specVersion(SpecVersion specVersion)
String	toString()
SBOMAttributes	version(Long version)

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_DEPENDENCIES

public static final String JSON_PROPERTY_DEPENDENCIES

See Also:

Constant Field Values

JSON_PROPERTY_METADATA

public static final String JSON_PROPERTY_METADATA

See Also:

Constant Field Values

JSON_PROPERTY_SERIAL_NUMBER

public static final String JSON_PROPERTY_SERIAL_NUMBER

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

Constructor Detail

SBOMAttributes

public SBOMAttributes()

SBOMAttributes

public SBOMAttributes(String bomFormat,
                      List<SBOMComponent> components,
                      List<SBOMComponentDependency> dependencies,
                      SBOMMetadata metadata,
                      String serialNumber,
                      SpecVersion specVersion,
                      Long version)

Method Detail

bomFormat

public SBOMAttributes bomFormat(String bomFormat)

getBomFormat

public String getBomFormat()

Specifies the format of the BOM. This helps to identify the file as CycloneDX since BOM do not have a filename convention nor does JSON schema support namespaces. This value MUST be CycloneDX.

Returns:

bomFormat

setBomFormat

public void setBomFormat(String bomFormat)

components

public SBOMAttributes components(List<SBOMComponent> components)

addComponentsItem

public SBOMAttributes addComponentsItem(SBOMComponent componentsItem)

getComponents

public List<SBOMComponent> getComponents()

A list of software and hardware components.

Returns:

components

setComponents

public void setComponents(List<SBOMComponent> components)

dependencies

public SBOMAttributes dependencies(List<SBOMComponentDependency> dependencies)

addDependenciesItem

public SBOMAttributes addDependenciesItem(SBOMComponentDependency dependenciesItem)

getDependencies

public List<SBOMComponentDependency> getDependencies()

List of dependencies between components of the SBOM.

Returns:

dependencies

setDependencies

public void setDependencies(List<SBOMComponentDependency> dependencies)

metadata

public SBOMAttributes metadata(SBOMMetadata metadata)

getMetadata

public SBOMMetadata getMetadata()

Provides additional information about a BOM.

Returns:

metadata

setMetadata

public void setMetadata(SBOMMetadata metadata)

serialNumber

public SBOMAttributes serialNumber(String serialNumber)

getSerialNumber

public String getSerialNumber()

Every BOM generated has a unique serial number, even if the contents of the BOM have not changed overt time. The serial number follows RFC-4122

Returns:

serialNumber

setSerialNumber

public void setSerialNumber(String serialNumber)

specVersion

public SBOMAttributes specVersion(SpecVersion specVersion)

getSpecVersion

public SpecVersion getSpecVersion()

The version of the CycloneDX specification a BOM conforms to.

Returns:

specVersion

setSpecVersion

public void setSpecVersion(SpecVersion specVersion)

version

public SBOMAttributes version(Long version)

getVersion

public Long getVersion()

It increments when a BOM is modified. The default value is 1.

Returns:

version

setVersion

public void setVersion(Long version)

putAdditionalProperty

public SBOMAttributes 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:

SBOMAttributes

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 SBOMAttributes 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