Optional
authenticatedA 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.
from field: optional bool authenticated = 8;
Optional
bomAn 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.
from field: optional string bom_ref = 1;
from field: repeated cyclonedx.v1_6.DataFlow data = 10;
Optional
descriptionSpecifies a description for the service.
from field: optional string description = 6;
from field: repeated string endpoints = 7;
Provides the ability to document external references related to the service.
from field: repeated cyclonedx.v1_6.ExternalReference external_references = 12;
Optional
groupThe 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.
from field: optional string group = 3;
from field: repeated cyclonedx.v1_6.LicenseChoice licenses = 11;
The name of the service. This will often be a shortened, single name of the service.
from field: string name = 4;
Specifies optional, custom, properties
from field: repeated cyclonedx.v1_6.Property properties = 14;
Optional
providerThe organization that provides the service.
from field: optional cyclonedx.v1_6.OrganizationalEntity provider = 2;
Optional
releaseSpecifies optional release notes.
from field: optional cyclonedx.v1_6.ReleaseNotes releaseNotes = 15;
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.
from field: repeated cyclonedx.v1_6.Service services = 13;
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".
from field: repeated string tags = 17;
Optional
trustThe name of the trust zone the service resides in.
from field: optional string trustZone = 16;
Optional
versionThe service version.
from field: optional string version = 5;
Optional
xA 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.
from field: optional bool x_trust_boundary = 9;
Static
Readonly
fieldsStatic
Readonly
runtimeStatic
Readonly
typeParse 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.
Optional
options: Partial<BinaryReadOptions>Protected
toJSONOverride 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.
Static
equalsStatic
fromStatic
fromStatic
from
Generated
from message cyclonedx.v1_6.Service