Generated

from message cyclonedx.v1_6.Service

Hierarchy

Constructors

Properties

authenticated?: boolean

A boolean value indicating if the service requires authentication. A value of true indicates the service requires authentication prior to use. A value of false indicates the service does not require authentication.

Generated

from field: optional bool authenticated = 8;

bomRef?: string

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

data: cdx_16.DataFlow[] = []

Generated

from field: repeated cyclonedx.v1_6.DataFlow data = 10;

description?: string

Specifies a description for the service.

Generated

from field: optional string description = 6;

endpoints: string[] = []

Generated

from field: repeated string endpoints = 7;

externalReferences: cdx_16.ExternalReference[] = []

Provides the ability to document external references related to the service.

Generated

from field: repeated cyclonedx.v1_6.ExternalReference external_references = 12;

group?: string

The grouping name, namespace, or identifier. This will often be a shortened, single name of the company or project that produced the service or domain name. Whitespace and special characters should be avoided.

Generated

from field: optional string group = 3;

licenses: cdx_16.LicenseChoice[] = []

Generated

from field: repeated cyclonedx.v1_6.LicenseChoice licenses = 11;

name: string = ""

The name of the service. This will often be a shortened, single name of the service.

Generated

from field: string name = 4;

properties: cdx_16.Property[] = []

Specifies optional, custom, properties

Generated

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

The organization that provides the service.

Generated

from field: optional cyclonedx.v1_6.OrganizationalEntity provider = 2;

releaseNotes?: cdx_16.ReleaseNotes

Specifies optional release notes.

Generated

from field: optional cyclonedx.v1_6.ReleaseNotes releaseNotes = 15;

services: cdx_16.Service[] = []

Specifies optional sub-service. This is not a dependency tree. It provides a way to specify a hierarchical representation of service assemblies, similar to system -> subsystem -> parts assembly in physical supply chains.

Generated

from field: repeated cyclonedx.v1_6.Service services = 13;

tags: string[] = []

Textual strings that aid in the discovery, search, and retrieval of the associated object. Tags often serve as a way to group or categorize similar or related objects by various attributes. Examples include "json-parser", "object-persistence", "text-to-image", "translation", and "object-detection".

Generated

from field: repeated string tags = 17;

trustZone?: string

The name of the trust zone the service resides in.

Generated

from field: optional string trustZone = 16;

version?: string

The service version.

Generated

from field: optional string version = 5;

xTrustBoundary?: boolean

A boolean value indicating if the use of the service crosses a trust zone or boundary. A value of true indicates that by using the service, a trust boundary is crossed. A value of false indicates that by using the service, a trust boundary is not crossed.

Generated

from field: optional bool x_trust_boundary = 9;

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

Methods

  • Create a deep copy.

    Returns cdx_16.Service

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

  • 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