com.datadog.api.client.v2.model

Class SBOMComponent

java.lang.Object

com.datadog.api.client.v2.model.SBOMComponent

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

Software or hardware component.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_BOM_REF
static String	JSON_PROPERTY_LICENSES
static String	JSON_PROPERTY_NAME
static String	JSON_PROPERTY_PROPERTIES
static String	JSON_PROPERTY_PURL
static String	JSON_PROPERTY_SUPPLIER
static String	JSON_PROPERTY_TYPE
static String	JSON_PROPERTY_VERSION
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
SBOMComponent()
SBOMComponent(String name, SBOMComponentSupplier supplier, SBOMComponentType type, String version)

Method Summary

Modifier and Type	Method and Description
SBOMComponent	addLicensesItem(SBOMComponentLicense licensesItem)
SBOMComponent	addPropertiesItem(SBOMComponentProperty propertiesItem)
SBOMComponent	bomRef(String bomRef)
boolean	equals(Object o) Return true if this SBOMComponent 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	getBomRef() An optional identifier that can be used to reference the component elsewhere in the BOM.
List<SBOMComponentLicense>	getLicenses() The software licenses of the SBOM component.
String	getName() The name of the component.
List<SBOMComponentProperty>	getProperties() The custom properties of the component of the SBOM.
String	getPurl() Specifies the package-url (purl).
SBOMComponentSupplier	getSupplier() The supplier of the component.
SBOMComponentType	getType() The SBOM component type
String	getVersion() The component version.
int	hashCode()
SBOMComponent	licenses(List<SBOMComponentLicense> licenses)
SBOMComponent	name(String name)
SBOMComponent	properties(List<SBOMComponentProperty> properties)
SBOMComponent	purl(String purl)
SBOMComponent	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
void	setBomRef(String bomRef)
void	setLicenses(List<SBOMComponentLicense> licenses)
void	setName(String name)
void	setProperties(List<SBOMComponentProperty> properties)
void	setPurl(String purl)
void	setSupplier(SBOMComponentSupplier supplier)
void	setType(SBOMComponentType type)
void	setVersion(String version)
SBOMComponent	supplier(SBOMComponentSupplier supplier)
String	toString()
SBOMComponent	type(SBOMComponentType type)
SBOMComponent	version(String 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_REF

public static final String JSON_PROPERTY_BOM_REF

See Also:

Constant Field Values

JSON_PROPERTY_LICENSES

public static final String JSON_PROPERTY_LICENSES

See Also:

Constant Field Values

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

Constant Field Values

JSON_PROPERTY_PROPERTIES

public static final String JSON_PROPERTY_PROPERTIES

See Also:

Constant Field Values

JSON_PROPERTY_PURL

public static final String JSON_PROPERTY_PURL

See Also:

Constant Field Values

JSON_PROPERTY_SUPPLIER

public static final String JSON_PROPERTY_SUPPLIER

See Also:

Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

Constant Field Values

JSON_PROPERTY_VERSION

public static final String JSON_PROPERTY_VERSION

See Also:

Constant Field Values

Constructor Detail

SBOMComponent

public SBOMComponent()

SBOMComponent

public SBOMComponent(String name,
                     SBOMComponentSupplier supplier,
                     SBOMComponentType type,
                     String version)

Method Detail

bomRef

public SBOMComponent bomRef(String bomRef)

getBomRef

@Nullable
public String getBomRef()

An optional identifier that can be used to reference the component elsewhere in the BOM.

Returns:

bomRef

setBomRef

public void setBomRef(String bomRef)

licenses

public SBOMComponent licenses(List<SBOMComponentLicense> licenses)

addLicensesItem

public SBOMComponent addLicensesItem(SBOMComponentLicense licensesItem)

getLicenses

@Nullable
public List<SBOMComponentLicense> getLicenses()

The software licenses of the SBOM component.

Returns:

licenses

setLicenses

public void setLicenses(List<SBOMComponentLicense> licenses)

name

public SBOMComponent name(String name)

getName

public String getName()

The name of the component. This will often be a shortened, single name of the component.

Returns:

name

setName

public void setName(String name)

properties

public SBOMComponent properties(List<SBOMComponentProperty> properties)

addPropertiesItem

public SBOMComponent addPropertiesItem(SBOMComponentProperty propertiesItem)

getProperties

@Nullable
public List<SBOMComponentProperty> getProperties()

The custom properties of the component of the SBOM.

Returns:

properties

setProperties

public void setProperties(List<SBOMComponentProperty> properties)

purl

public SBOMComponent purl(String purl)

getPurl

@Nullable
public String getPurl()

Specifies the package-url (purl). The purl, if specified, MUST be valid and conform to the specification.

Returns:

purl

setPurl

public void setPurl(String purl)

supplier

public SBOMComponent supplier(SBOMComponentSupplier supplier)

getSupplier

public SBOMComponentSupplier getSupplier()

The supplier of the component.

Returns:

supplier

setSupplier

public void setSupplier(SBOMComponentSupplier supplier)

type

public SBOMComponent type(SBOMComponentType type)

getType

public SBOMComponentType getType()

The SBOM component type

Returns:

type

setType

public void setType(SBOMComponentType type)

version

public SBOMComponent version(String version)

getVersion

public String getVersion()

The component version.

Returns:

version

setVersion

public void setVersion(String version)

putAdditionalProperty

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

SBOMComponent

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