Generated

from message cyclonedx.v1_6.License

Hierarchy

Constructors

Properties

Declared licenses and concluded licenses represent two different stages in the licensing process within software development. Declared licenses refer to the initial intention of the software authors regarding the licensing terms under which their code is released. On the other hand, concluded licenses are the result of a comprehensive analysis of the project's codebase to identify and confirm the actual licenses of the components used, which may differ from the initially declared licenses. While declared licenses provide an upfront indication of the licensing intentions, concluded licenses offer a more thorough understanding of the actual licensing within a project, facilitating proper compliance and risk management. Observed licenses are defined in @.evidence.licenses. Observed licenses form the evidence necessary to substantiate a concluded license.

Generated

from field: optional cyclonedx.v1_6.LicenseAcknowledgementEnumeration acknowledgement = 8;

bomRef?: string

An optional identifier which can be used to reference the license 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 = 5;

license: {
    case: "id";
    value: string;
} | {
    case: "name";
    value: string;
} | {
    case: undefined;
    value?: undefined;
} = ...

Type declaration

  • case: "id"
  • value: string

    A valid SPDX license ID

    Generated

    from field: string id = 1;

Type declaration

  • case: "name"
  • value: string

    If SPDX does not define the license used, this field may be used to provide the license name

    Generated

    from field: string name = 2;

Type declaration

  • case: undefined
  • Optional value?: undefined

Generated

from oneof cyclonedx.v1_6.License.license

licensing?: cdx_16.Licensing

Licensing details describing the licensor/licensee, license type, renewal and expiration dates, and other important metadata

Generated

from field: optional cyclonedx.v1_6.Licensing licensing = 6;

properties: cdx_16.Property[] = []

Specifies optional, custom, properties

Generated

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

Specifies the optional full text of the attachment

Generated

from field: optional cyclonedx.v1_6.AttachedText text = 3;

url?: string

The URL to the attachment file. If the attachment is a license or BOM, an externalReference should also be specified for completeness.

Generated

from field: optional string url = 4;

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

Methods

  • Create a deep copy.

    Returns cdx_16.License

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

  • 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