Class ComponentData

Generated

from message cyclonedx.v1_5.ComponentData

Hierarchy

Constructors

Properties

bomRef?: string

An optional identifier which can be used to reference the dataset elsewhere in the BOM. Every bom-ref MUST be unique within the BOM.

Generated

from field: optional string bom_ref = 1;

classification?: string

Data classification tags data according to its type, sensitivity, and value if altered, stolen, or destroyed.

Generated

from field: optional string classification = 5;

The contents or references to the contents of the data being described.

Generated

from field: optional cyclonedx.v1_5.ComponentData.ComponentDataContents contents = 4;

description?: string

A description of the dataset. Can describe size of dataset, whether it's used for source code, training, testing, or validation, etc.

Generated

from field: optional string description = 8;

governance?: cdx_15.DataGovernance

Data Governance

Generated

from field: optional cyclonedx.v1_5.DataGovernance governance = 9;

A collection of graphics that represent various measurements.

Generated

from field: optional cyclonedx.v1_5.GraphicsCollection graphics = 7;

name?: string

The name of the dataset.

Generated

from field: optional string name = 3;

sensitiveData: string[] = []

A description of any sensitive data in a dataset.

Generated

from field: repeated string sensitiveData = 6;

type: cdx_15.ComponentDataType = ComponentDataType.SOURCE_CODE

The general theme or subject matter of the data being specified.

Generated

from field: cyclonedx.v1_5.ComponentDataType type = 2;

fields: FieldList = ...
runtime: ProtoRuntime = proto3
typeName: "cyclonedx.v1_5.ComponentData" = "cyclonedx.v1_5.ComponentData"

Methods

  • Compare with a message of the same type.

    Parameters

    Returns boolean

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting existing keys.

    If a message field is already present, it will be merged with the new data.

    Parameters

    • bytes: Uint8Array
    • Optional options: Partial<BinaryReadOptions>

    Returns this

  • Parse a message from a JSON value.

    Parameters

    • jsonValue: JsonValue
    • Optional options: Partial<JsonReadOptions>

    Returns this

  • Parse a message from a JSON string.

    Parameters

    • jsonString: string
    • Optional options: Partial<JsonReadOptions>

    Returns this

  • Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.

    Returns MessageType<cdx_15.ComponentData>

  • Serialize the message to binary data.

    Parameters

    • Optional options: Partial<BinaryWriteOptions>

    Returns Uint8Array

  • Override for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).

    Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.

    This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.

    Returns JsonValue

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

  • Serialize the message to a JSON string.

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string