Class LicenseChoice

Generated

from message cyclonedx.v1_6.LicenseChoice

Hierarchy

Constructors

Properties

This field must only be used when "expression" is chosen as the License object has its own acknowledgement.

Generated

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

choice: {
    case: "license";
    value: cdx_16.License;
} | {
    case: "expression";
    value: string;
} | {
    case: undefined;
    value?: undefined;
} = ...

Type declaration

  • case: "license"
  • value: cdx_16.License

    Generated

    from field: cyclonedx.v1_6.License license = 1;

Type declaration

  • case: "expression"
  • value: string

    A valid SPDX license expression. Refer to https://spdx.org/specifications for syntax requirements

    Generated

    from field: string expression = 2;

Type declaration

  • case: undefined
  • Optional value?: undefined

Generated

from oneof cyclonedx.v1_6.LicenseChoice.choice

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

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.LicenseChoice>

  • 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