Specifies a tool (manual or automated).

Generated

from message cyclonedx.v1_6.Tool

Hierarchy

Constructors

Properties

components: cdx_16.Component[] = []

A list of software and hardware components used as tools

Generated

from field: repeated cyclonedx.v1_6.Component components = 6;

externalReferences: cdx_16.ExternalReference[] = []

DEPRECATED - DO NOT USE - Provides the ability to document external references related to the tool.

Generated

from field: repeated cyclonedx.v1_6.ExternalReference external_references = 5 [deprecated = true];

Deprecated

hashes: cdx_16.Hash[] = []

DEPRECATED - DO NOT USE

Generated

from field: repeated cyclonedx.v1_6.Hash hashes = 4 [deprecated = true];

Deprecated

name?: string

DEPRECATED - DO NOT USE - The name of the tool used to create the BOM.

Generated

from field: optional string name = 2 [deprecated = true];

Deprecated

services: cdx_16.Service[] = []

A list of services used as tools. This may include microservices, function-as-a-service, and other types of network or intra-process services.

Generated

from field: repeated cyclonedx.v1_6.Service services = 7;

vendor?: string

DEPRECATED - DO NOT USE - The vendor of the tool used to create the BOM.

Generated

from field: optional string vendor = 1 [deprecated = true];

Deprecated

version?: string

DEPRECATED - DO NOT USE - The version of the tool used to create the BOM.

Generated

from field: optional string version = 3 [deprecated = true];

Deprecated

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

Methods

  • Create a deep copy.

    Returns cdx_16.Tool

  • 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.Tool>

  • 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