Generated

from message cyclonedx.v1_6.Metadata

Hierarchy

Constructors

Properties

The person(s) who created the BOM. Authors are common in BOMs created through manual processes. BOMs created through automated means may have '.manufacturer' instead.

Generated

from field: repeated cyclonedx.v1_6.OrganizationalContact authors = 3;

component?: cdx_16.Component

The component that the BOM describes.

Generated

from field: optional cyclonedx.v1_6.Component component = 4;

licenses: cdx_16.LicenseChoice[] = []

The license information for the BOM document. This may be different from the license(s) of the component(s) that the BOM describes.

Generated

from field: repeated cyclonedx.v1_6.LicenseChoice licenses = 7;

lifecycles: cdx_16.Lifecycles[] = []

Lifecycles communicate the stage(s) in which data in the BOM was captured. Different types of data may be available at various phases of a lifecycle, such as the Software Development Lifecycle (SDLC), IT Asset Management (ITAM), and Software Asset Management (SAM). Thus, a BOM may include data specific to or only obtainable in a given lifecycle.

Generated

from field: repeated cyclonedx.v1_6.Lifecycles lifecycles = 9;

DEPRECATED - DO NOT USE - This will be removed in a future version - Use the .component.manufacturer instead. The organization that manufactured the component that the BOM describes.

Generated

from field: optional cyclonedx.v1_6.OrganizationalEntity manufacture = 5 [deprecated = true];

Deprecated

The organization that created the BOM. Manufacturer is common in BOMs created through automated processes. BOMs created through manual means may have '.authors' instead.

Generated

from field: optional cyclonedx.v1_6.OrganizationalEntity manufacturer = 10;

properties: cdx_16.Property[] = []

Specifies optional, custom, properties

Generated

from field: repeated cyclonedx.v1_6.Property properties = 8;

The organization that supplied the component that the BOM describes. The supplier may often be the manufacture, but may also be a distributor or repackager.

Generated

from field: optional cyclonedx.v1_6.OrganizationalEntity supplier = 6;

timestamp?: Timestamp

The date and time (timestamp) when the document was created.

Generated

from field: optional google.protobuf.Timestamp timestamp = 1;

tools?: cdx_16.Tool

The tool(s) used in the creation of the BOM.

Generated

from field: optional cyclonedx.v1_6.Tool tools = 2;

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

Methods

  • Create a deep copy.

    Returns cdx_16.Metadata

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

  • 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