Describes workflows and resources that captures rules and other aspects of how the associated BOM component or service was formed.

Generated

from message cyclonedx.v1_5.Formula

Hierarchy

Constructors

Properties

bomRef?: string

BOM unique reference to the resource.

Generated

from field: optional string bom_ref = 1;

components: cdx_15.Component[] = []

Transient components that are used in tasks that constitute one or more of this formula's workflows

Generated

from field: repeated cyclonedx.v1_5.Component components = 2;

properties: cdx_15.Property[] = []

Domain-specific formula properties.

Generated

from field: repeated cyclonedx.v1_5.Property properties = 5;

services: cdx_15.Service[] = []

Transient services that are used in tasks that constitute one or more of this formula's workflows

Generated

from field: repeated cyclonedx.v1_5.Service services = 3;

workflows: cdx_15.Workflow[] = []

List of workflows that can be declared to accomplish specific orchestrated goals and independently triggered.

Generated

from field: repeated cyclonedx.v1_5.Workflow workflows = 4;

fields: FieldList = ...
runtime: ProtoRuntime = proto3
typeName: "cyclonedx.v1_5.Formula" = "cyclonedx.v1_5.Formula"

Methods

  • Create a deep copy.

    Returns cdx_15.Formula

  • 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_15.Formula>

  • 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