Record Class CbomDocument

java.lang.Object
java.lang.Record
co.cryptoservice.sdk.CbomDocument
Record Components:
bomFormat - always CycloneDX
components - the components
metadata - the key metadata, or null
serialNumber - A fresh urn:uuid for every document
specVersion - cycloneDX specification version
version - BOM version

public record CbomDocument(String bomFormat, List<CbomComponent> components, com.fasterxml.jackson.databind.JsonNode metadata, String serialNumber, String specVersion, int version) extends Record
What GET /v2/compliance/cbom answers: cryptographic Bill of Materials (CBOM) in CycloneDX 1.6 format.
  • Constructor Details

    • CbomDocument

      public CbomDocument(String bomFormat, List<CbomComponent> components, com.fasterxml.jackson.databind.JsonNode metadata, String serialNumber, String specVersion, int version)
      Creates an instance of a CbomDocument record class.
      Parameters:
      bomFormat - the value for the bomFormat record component
      components - the value for the components record component
      metadata - the value for the metadata record component
      serialNumber - the value for the serialNumber record component
      specVersion - the value for the specVersion record component
      version - the value for the version record component
  • Method Details

    • toString

      public String toString()
      Names the members; values that may be secret (keys, plaintexts, passwords, signatures) are redacted.
      Specified by:
      toString in class Record
      Returns:
      a description safe to log
    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object
    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.
    • bomFormat

      public String bomFormat()
      Returns the value of the bomFormat record component.
      Returns:
      the value of the bomFormat record component
    • components

      public List<CbomComponent> components()
      Returns the value of the components record component.
      Returns:
      the value of the components record component
    • metadata

      public com.fasterxml.jackson.databind.JsonNode metadata()
      Returns the value of the metadata record component.
      Returns:
      the value of the metadata record component
    • serialNumber

      public String serialNumber()
      Returns the value of the serialNumber record component.
      Returns:
      the value of the serialNumber record component
    • specVersion

      public String specVersion()
      Returns the value of the specVersion record component.
      Returns:
      the value of the specVersion record component
    • version

      public int version()
      Returns the value of the version record component.
      Returns:
      the value of the version record component