Class Definition_Standard

Generated

from message cyclonedx.v1_6.Definition.Standard

Hierarchy

Constructors

Properties

bomRef?: string

An optional identifier which can be used to reference the component elsewhere in the BOM. Uniqueness is enforced within all elements and children of the root-level bom element.

Generated

from field: optional string bom_ref = 1;

description?: string

The description of the standard.

Generated

from field: optional string description = 4;

externalReferences: cdx_16.ExternalReference[] = []

External references provide a way to document systems, sites, and information that may be relevant but are not included with the BOM. They may also establish specific relationships within or external to the BOM.

Generated

from field: repeated cyclonedx.v1_6.ExternalReference externalReferences = 8;

The list of levels associated with the standard. Some standards have different levels of compliance.

Generated

from field: repeated cyclonedx.v1_6.Definition.Standard.Level levels = 7;

name?: string

The name of the standard. This will often be a shortened, single name of the standard.

Generated

from field: optional string name = 2;

owner?: string

The owner of the standard, often the entity responsible for its release.

Generated

from field: optional string owner = 5;

requirements: Definition_Standard_Requirement[] = []

The list of requirements comprising the standard.

Generated

from field: repeated cyclonedx.v1_6.Definition.Standard.Requirement requirements = 6;

version?: string

The version of the standard.

Generated

from field: optional string version = 3;

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

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<Definition_Standard>

  • 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