Class Declarations_Evidence

Generated

from message cyclonedx.v1_6.Declarations.Evidence

Hierarchy

Constructors

Properties

The author of the evidence.

Generated

from field: optional cyclonedx.v1_6.OrganizationalContact author = 7;

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;

created?: Timestamp

The date and time (timestamp) when the evidence was created.

Generated

from field: optional google.protobuf.Timestamp created = 5;

The output or analysis that supports claims.

Generated

from field: repeated cyclonedx.v1_6.Declarations.Evidence.Data data = 4;

description?: string

The written description of what this evidence is and how it was created.

Generated

from field: optional string description = 3;

expires?: Timestamp

The optional date and time (timestamp) when the evidence is no longer valid.

Generated

from field: optional google.protobuf.Timestamp expires = 6;

propertyName?: string

The reference to the property name as defined in the CycloneDX Property Taxonomy: https://github.com/CycloneDX/cyclonedx-property-taxonomy/.

Generated

from field: optional string propertyName = 2;

The reviewer of the evidence.

Generated

from field: optional cyclonedx.v1_6.OrganizationalContact reviewer = 8;

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

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

  • 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