Class EvidenceIdentity

Generated

from message cyclonedx.v1_6.EvidenceIdentity

Hierarchy

Constructors

Properties

concludedValue?: string

The value of the field (cpe, purl, etc) that has been concluded based on the aggregate of all methods (if available).

Generated

from field: optional string concludedValue = 5;

confidence?: number

The overall confidence of the evidence from 0 - 1, where 1 is 100% confidence.

Generated

from field: optional float confidence = 2;

field: cdx_16.EvidenceFieldType = EvidenceFieldType.EVIDENCE_FIELD_NULL

The identity field of the component which the evidence describes.

Generated

from field: cyclonedx.v1_6.EvidenceFieldType field = 1;

methods: cdx_16.EvidenceMethods[] = []

The methods used to extract and/or analyze the evidence.

Generated

from field: repeated cyclonedx.v1_6.EvidenceMethods methods = 3;

tools: string[] = []

The object in the BOM identified by its bom-ref. This is often a component or service, but may be any object type supporting bom-refs. Tools used for analysis should already be defined in the BOM, either in the metadata/tools, components, or formulation.

Generated

from field: repeated string tools = 4;

fields: FieldList = ...
runtime: ProtoRuntime = proto3
typeName: "cyclonedx.v1_6.EvidenceIdentity" = "cyclonedx.v1_6.EvidenceIdentity"

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_16.EvidenceIdentity>

  • 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