Represents something that happened that may trigger a response.

Generated

from message cyclonedx.v1_6.Event

Hierarchy

Constructors

Properties

Encoding of the raw event data.

Generated

from field: optional cyclonedx.v1_6.AttachedText data = 4;

description?: string

A description of the event.

Generated

from field: optional string description = 2;

properties: cdx_16.Property[] = []

Additional properties of the event.

Generated

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

References the component or service that was the source of the event

Generated

from field: optional cyclonedx.v1_6.ResourceReferenceChoice source = 5;

References the component or service that was the target of the event

Generated

from field: optional cyclonedx.v1_6.ResourceReferenceChoice target = 6;

timeReceived?: Timestamp

The date and time (timestamp) when the event was received.

Generated

from field: optional google.protobuf.Timestamp timeReceived = 3;

uid?: string

The unique identifier of the event.

Generated

from field: optional string uid = 1;

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

Methods

  • Create a deep copy.

    Returns cdx_16.Event

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

  • 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