@appthreat/cdx-proto

Version:

Library to serialize/deserialize CycloneDX BOM with protocol buffers

85 lines • 74.6 kB

HTML

<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Workflow | cdx-proto</title><meta name="description" content="Documentation for cdx-proto"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">cdx-proto</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">cdx-proto</a></li><li><a href="../modules/cdx_15.html">cdx_15</a></li><li><a href="cdx_15.Workflow.html">Workflow</a></li></ul><h1>Class Workflow</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A specialized orchestration task.</p> </div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from message cyclonedx.v1_5.Workflow</p> </div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Message</span><span class="tsd-signature-symbol"><</span><a href="../modules/cdx_15.html" class="tsd-signature-type tsd-kind-namespace">cdx_15</a><span class="tsd-signature-symbol">.</span><a href="cdx_15.Workflow.html" class="tsd-signature-type tsd-kind-class">Workflow</a><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">Workflow</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.5_pb.ts#L6164">source/lib/bom-1.5_pb.ts:6164</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="cdx_15.Workflow.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="cdx_15.Workflow.html#bomRef" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bom<wbr/>Ref</span></a> <a href="cdx_15.Workflow.html#description" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>description?</span></a> <a href="cdx_15.Workflow.html#inputs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>inputs</span></a> <a href="cdx_15.Workflow.html#name" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name?</span></a> <a href="cdx_15.Workflow.html#outputs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>outputs</span></a> <a href="cdx_15.Workflow.html#properties" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>properties</span></a> <a href="cdx_15.Workflow.html#resourceReferences" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>resource<wbr/>References</span></a> <a href="cdx_15.Workflow.html#runtimeTopology" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>runtime<wbr/>Topology</span></a> <a href="cdx_15.Workflow.html#steps" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>steps</span></a> <a href="cdx_15.Workflow.html#taskDependencies" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>task<wbr/>Dependencies</span></a> <a href="cdx_15.Workflow.html#taskTypes" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>task<wbr/>Types</span></a> <a href="cdx_15.Workflow.html#tasks" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tasks</span></a> <a href="cdx_15.Workflow.html#timeEnd" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>time<wbr/>End?</span></a> <a href="cdx_15.Workflow.html#timeStart" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>time<wbr/>Start?</span></a> <a href="cdx_15.Workflow.html#trigger" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>trigger?</span></a> <a href="cdx_15.Workflow.html#uid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>uid</span></a> <a href="cdx_15.Workflow.html#workspaces" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workspaces</span></a> <a href="cdx_15.Workflow.html#fields" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>fields</span></a> <a href="cdx_15.Workflow.html#runtime" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>runtime</span></a> <a href="cdx_15.Workflow.html#typeName" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type<wbr/>Name</span></a> </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="cdx_15.Workflow.html#clone" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clone</span></a> <a href="cdx_15.Workflow.html#equals" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>equals</span></a> <a href="cdx_15.Workflow.html#fromBinary" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Binary</span></a> <a href="cdx_15.Workflow.html#fromJson" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Json</span></a> <a href="cdx_15.Workflow.html#fromJsonString" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Json<wbr/>String</span></a> <a href="cdx_15.Workflow.html#getType" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Type</span></a> <a href="cdx_15.Workflow.html#toBinary" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Binary</span></a> <a href="cdx_15.Workflow.html#toJSON" class="tsd-index-link tsd-is-protected tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toJSON</span></a> <a href="cdx_15.Workflow.html#toJson-2" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Json</span></a> <a href="cdx_15.Workflow.html#toJsonString" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Json<wbr/>String</span></a> <a href="cdx_15.Workflow.html#equals-2" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>equals</span></a> <a href="cdx_15.Workflow.html#fromBinary-2" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Binary</span></a> <a href="cdx_15.Workflow.html#fromJson-2" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Json</span></a> <a href="cdx_15.Workflow.html#fromJsonString-2" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>from<wbr/>Json<wbr/>String</span></a> </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_Workflow" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Workflow</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/cdx_15.html" class="tsd-signature-type tsd-kind-namespace">cdx_15</a><span class="tsd-signature-symbol">.</span><a href="cdx_15.Workflow.html" class="tsd-signature-type tsd-kind-class">Workflow</a><a href="#constructor.new_Workflow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">PartialMessage</span><span class="tsd-signature-symbol"><</span><a href="../modules/cdx_15.html" class="tsd-signature-type tsd-kind-namespace">cdx_15</a><span class="tsd-signature-symbol">.</span><a href="cdx_15.Workflow.html" class="tsd-signature-type tsd-kind-class">Workflow</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../modules/cdx_15.html" class="tsd-signature-type tsd-kind-namespace">cdx_15</a><span class="tsd-signature-symbol">.</span><a href="cdx_15.Workflow.html" class="tsd-signature-type tsd-kind-class">Workflow</a></h4><aside class="tsd-sources"><p>Overrides Message<Workflow>.constructor</p><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.5_pb.ts#L6284">source/lib/bom-1.5_pb.ts:6284</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="bomRef" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>bom<wbr/>Ref</span><a href="#bomRef" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">bom<wbr/>Ref</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></div><div class="tsd-comment tsd-typography"><p>BOM unique reference to the resource.</p> </div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: string bom_ref = 1;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.5_pb.ts#L6170">source/lib/bom-1.5_pb.ts:6170</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="description" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>description</span><a href="#description" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">description</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>A description of the resource instance.</p> </div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: optional string description = 4;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.5_pb.ts#L6191">source/lib/bom-1.5_pb.ts:6191</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="inputs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>inputs</span><a href="#inputs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">inputs</span><span class="tsd-signature-symbol">:</span> <a href="../modules/cdx_15.html" class="tsd-signature-type tsd-kind-namespace">cdx_15</a><span class="tsd-signature-symbol">.</span><a href="cdx_15.InputType.html" class="tsd-signature-type tsd-kind-class">InputType</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><div class="tsd-comment tsd-typography"><p>Represents resources and data brought into a task at runtime by executor or task commands</p> </div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: repeated cyclonedx.v1_5.InputType inputs = 12;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.5_pb.ts#L6247">source/lib/bom-1.5_pb.ts:6247</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The name of the resource instance.</p> </div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: optional string name = 3;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.5_pb.ts#L6184">source/lib/bom-1.5_pb.ts:6184</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="outputs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>outputs</span><a href="#outputs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">outputs</span><span class="tsd-signature-symbol">:</span> <a href="../modules/cdx_15.html" class="tsd-signature-type tsd-kind-namespace">cdx_15</a><span class="tsd-signature-symbol">.</span><a href="cdx_15.OutputType.html" class="tsd-signature-type tsd-kind-class">OutputType</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><div class="tsd-comment tsd-typography"><p>Represents resources and data output from a task at runtime by executor or task commands</p> </div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: repeated cyclonedx.v1_5.OutputType outputs = 13;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.5_pb.ts#L6254">source/lib/bom-1.5_pb.ts:6254</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="properties" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>properties</span><a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">properties</span><span class="tsd-signature-symbol">:</span> <a href="../modules/cdx_15.html" class="tsd-signature-type tsd-kind-namespace">cdx_15</a><span class="tsd-signature-symbol">.</span><a href="cdx_15.Property.html" class="tsd-signature-type tsd-kind-class">Property</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><div class="tsd-comment tsd-typography"><p>Domain-specific resource instance properties.</p> </div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: repeated cyclonedx.v1_5.Property properties = 5;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.5_pb.ts#L6198">source/lib/bom-1.5_pb.ts:6198</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="resourceReferences" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>resource<wbr/>References</span><a href="#resourceReferences" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">resource<wbr/>References</span><span class="tsd-signature-symbol">:</span> <a href="../modules/cdx_15.html" class="tsd-signature-type tsd-kind-namespace">cdx_15</a><span class="tsd-signature-symbol">.</span><a href="cdx_15.ResourceReferenceChoice.html" class="tsd-signature-type tsd-kind-class">ResourceReferenceChoice</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><div class="tsd-comment tsd-typography"><p>References to component or service resources that are used to realize the resource instance.</p> </div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: repeated cyclonedx.v1_5.ResourceReferenceChoice resourceReferences = 6;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.5_pb.ts#L6205">source/lib/bom-1.5_pb.ts:6205</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="runtimeTopology" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>runtime<wbr/>Topology</span><a href="#runtimeTopology" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">runtime<wbr/>Topology</span><span class="tsd-signature-symbol">:</span> <a href="../modules/cdx_15.html" class="tsd-signature-type tsd-kind-namespace">cdx_15</a><span class="tsd-signature-symbol">.</span><a href="cdx_15.Dependency.html" class="tsd-signature-type tsd-kind-class">Dependency</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><div class="tsd-comment tsd-typography"><p>A graph of the component runtime topology for workflow's instance.</p> </div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: repeated cyclonedx.v1_5.Dependency runtimeTopology = 17;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.5_pb.ts#L6282">source/lib/bom-1.5_pb.ts:6282</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="steps" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>steps</span><a href="#steps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">steps</span><span class="tsd-signature-symbol">:</span> <a href="../modules/cdx_15.html" class="tsd-signature-type tsd-kind-namespace">cdx_15</a><span class="tsd-signature-symbol">.</span><a href="cdx_15.Step.html" class="tsd-signature-type tsd-kind-class">Step</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><div class="tsd-comment tsd-typography"><p>The sequence of steps for the task.</p> </div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: repeated cyclonedx.v1_5.Step steps = 11;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.5_pb.ts#L6240">source/lib/bom-1.5_pb.ts:6240</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="taskDependencies" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>task<wbr/>Dependencies</span><a href="#taskDependencies" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">task<wbr/>Dependencies</span><span class="tsd-signature-symbol">:</span> <a href="../modules/cdx_15.html" class="tsd-signature-type tsd-kind-namespace">cdx_15</a><span class="tsd-signature-symbol">.</span><a href="cdx_15.Dependency.html" class="tsd-signature-type tsd-kind-class">Dependency</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><div class="tsd-comment tsd-typography"><p>The graph of dependencies between tasks within the workflow.</p> </div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: repeated cyclonedx.v1_5.Dependency taskDependencies = 8;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.5_pb.ts#L6219">source/lib/bom-1.5_pb.ts:6219</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="taskTypes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>task<wbr/>Types</span><a href="#taskTypes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">task<wbr/>Types</span><span class="tsd-signature-symbol">:</span> <a href="../modules/cdx_15.html" class="tsd-signature-type tsd-kind-namespace">cdx_15</a><span class="tsd-signature-symbol">.</span><a href="../enums/cdx_15.TaskType.html" class="tsd-signature-type tsd-kind-enum">TaskType</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><div class="tsd-comment tsd-typography"><p>Indicates the types of activities performed by the set of workflow tasks.</p> </div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: repeated cyclonedx.v1_5.TaskType taskTypes = 9;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.5_pb.ts#L6226">source/lib/bom-1.5_pb.ts:6226</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="tasks" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>tasks</span><a href="#tasks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">tasks</span><span class="tsd-signature-symbol">:</span> <a href="../modules/cdx_15.html" class="tsd-signature-type tsd-kind-namespace">cdx_15</a><span class="tsd-signature-symbol">.</span><a href="cdx_15.Task.html" class="tsd-signature-type tsd-kind-class">Task</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><div class="tsd-comment tsd-typography"><p>The tasks that comprise the workflow.</p> </div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: repeated cyclonedx.v1_5.Task tasks = 7;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.5_pb.ts#L6212">source/lib/bom-1.5_pb.ts:6212</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="timeEnd" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>time<wbr/>End</span><a href="#timeEnd" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">time<wbr/>End</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Timestamp</span></div><div class="tsd-comment tsd-typography"><p>The date and time (timestamp) when the task ended.</p> </div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: optional google.protobuf.Timestamp timeEnd = 15;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.5_pb.ts#L6268">source/lib/bom-1.5_pb.ts:6268</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="timeStart" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>time<wbr/>Start</span><a href="#timeStart" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">time<wbr/>Start</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Timestamp</span></div><div class="tsd-comment tsd-typography"><p>The date and time (timestamp) when the task started.</p> </div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: optional google.protobuf.Timestamp timeStart = 14;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.5_pb.ts#L6261">source/lib/bom-1.5_pb.ts:6261</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="trigger" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>trigger</span><a href="#trigger" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">trigger</span><span class="tsd-signature-symbol">?:</span> <a href="../modules/cdx_15.html" class="tsd-signature-type tsd-kind-namespace">cdx_15</a><span class="tsd-signature-symbol">.</span><a href="cdx_15.Trigger.html" class="tsd-signature-type tsd-kind-class">Trigger</a></div><div class="tsd-comment tsd-typography"><p>The trigger that initiated the task.</p> </div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: optional cyclonedx.v1_5.Trigger trigger = 10;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.5_pb.ts#L6233">source/lib/bom-1.5_pb.ts:6233</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="uid" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>uid</span><a href="#uid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">uid</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></div><div class="tsd-comment tsd-typography"><p>The unique identifier for the resource instance within its deployment context.</p> </div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: string uid = 2;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.5_pb.ts#L6177">source/lib/bom-1.5_pb.ts:6177</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="workspaces" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>workspaces</span><a href="#workspaces" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">workspaces</span><span class="tsd-signature-symbol">:</span> <a href="../modules/cdx_15.html" class="tsd-signature-type tsd-kind-namespace">cdx_15</a><span class="tsd-signature-symbol">.</span><a href="cdx_15.Workspace.html" class="tsd-signature-type tsd-kind-class">Workspace</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><div class="tsd-comment tsd-typography"><p>A set of named filesystem or data resource shareable by workflow tasks.</p> </div><div class="tsd-comment tsd-typography"><h4>Generated</h4><p>from field: repeated cyclonedx.v1_5.Workspace workspaces = 16;</p> </div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.5_pb.ts#L6275">source/lib/bom-1.5_pb.ts:6275</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fields" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>fields</span><a href="#fields" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">fields</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">FieldList</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.5_pb.ts#L6291">source/lib/bom-1.5_pb.ts:6291</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="runtime" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>runtime</span><a href="#runtime" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">runtime</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ProtoRuntime</span><span class="tsd-signature-symbol"> = proto3</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.5_pb.ts#L6289">source/lib/bom-1.5_pb.ts:6289</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="typeName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>type<wbr/>Name</span><a href="#typeName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">type<wbr/>Name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"cyclonedx.v1_5.Workflow"</span><span class="tsd-signature-symbol"> = "cyclonedx.v1_5.Workflow"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/AppThreat/cdx-proto/blob/e7571efab03a060ab4120afe3444ae672da7dae6/source/lib/bom-1.5_pb.ts#L6290">source/lib/bom-1.5_pb.ts:6290</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="clone" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>clone</span><a href="#clone" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="clone.clone-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">clone</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/cdx_15.html" class="tsd-signature-type tsd-kind-namespace">cdx_15</a><span class="tsd-signature-symbol">.</span><a href="cdx_15.Workflow.html" class="tsd-signature-type tsd-kind-class">Workflow</a><a href="#clone.clone-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a deep copy.</p> </div><h4 class="tsd-returns-title">Returns <a href="../modules/cdx_15.html" class="tsd-signature-type tsd-kind-namespace">cdx_15</a><span class="tsd-signature-symbol">.</span><a href="cdx_15.Workflow.html" class="tsd-signature-type tsd-kind-class">Workflow</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Message.clone</p><ul><li>Defined in node_modules/@bufbuild/protobuf/dist/cjs/message.d.ts:27</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="equals" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>equals</span><a href="#equals" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="equals.equals-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">equals</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">other</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#equals.equals-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Compare with a message of the same type.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">other</span>: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules/cdx_15.html" class="tsd-signature-type tsd-kind-namespace">cdx_15</a><span class="tsd-signature-symbol">.</span><a href="cdx_15.Workflow.html" class="tsd-signature-type tsd-kind-class">Workflow</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PlainMessage</span><span class="tsd-signature-symbol"><</span><a href="../modules/cdx_15.html" class="tsd-signature-type tsd-kind-namespace">cdx_15</a><span class="tsd-signature-symbol">.</span><a href="cdx_15.Workflow.html" class="tsd-signature-type tsd-kind-class">Workflow</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Message.equals</p><ul><li>Defined in node_modules/@bufbuild/protobuf/dist/cjs/message.d.ts:23</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="fromBinary" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>from<wbr/>Binary</span><a href="#fromBinary" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="fromBinary.fromBinary-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Binary</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">bytes</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#fromBinary.fromBinary-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Parse from binary data, merging fields.</p> <p>Repeated fields are appended. Map entries are added, overwriting existing keys.</p> <p>If a message field is already present, it will be merged with the new data.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">bytes</span>: <span class="tsd-signature-type">Uint8Array</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">BinaryReadOptions</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Message.fromBinary</p><ul><li>Defined in node_modules/@bufbuild/protobuf/dist/cjs/message.d.ts:37</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="fromJson" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>from<wbr/>Json</span><a href="#fromJson" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="fromJson.fromJson-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Json</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">jsonValue</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#fromJson.fromJson-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Parse a message from a JSON value.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">jsonValue</span>: <span class="tsd-signature-type">JsonValue</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">JsonReadOptions</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Message.fromJson</p><ul><li>Defined in node_modules/@bufbuild/protobuf/dist/cjs/message.d.ts:41</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="fromJsonString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>from<wbr/>Json<wbr/>String</span><a href="#fromJsonString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="fromJsonString.fromJsonString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Json<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">jsonString</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#fromJsonString.fromJsonString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Parse a message from a JSON string.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">jsonString</span>: <span class="tsd-signature-type">string</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">JsonReadOptions</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Message.fromJsonString</p><ul><li>Defined in node_modules/@bufbuild/protobuf/dist/cjs/message.d.ts:45</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="getType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Type</span><a href="#getType" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="getType.getType-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Type</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MessageType</span><span class="tsd-signature-symbol"><</span><a href="../modules/cdx_15.html" class="tsd-signature-type tsd-kind-namespace">cdx_15</a><span class="tsd-signature-symbol">.</span><a href="cdx_15.Workflow.html" class="tsd-signature-type tsd-kind-class">Workflow</a><span class="tsd-signature-symbol">></span><a href="#getType.getType-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">MessageType</span><span class="tsd-signature-symbol"><</span><a href="../modules/cdx_15.html" class="tsd-signature-type tsd-kind-namespace">cdx_15</a><span class="tsd-signature-symbol">.</span><a href="cdx_15.Workflow.html" class="tsd-signature-type tsd-kind-class">Workflow</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Message.getType</p><ul><li>Defined in node_modules/@bufbuild/protobuf/dist/cjs/message.d.ts:80</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toBinary" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Binary</span><a href="#toBinary" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="toBinary.toBinary-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>Binary</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span><a href="#toBinary.toBinary-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Serialize the message to binary data.</p> </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">BinaryWriteOptions</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Uint8Array</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from Message.toBinary</p><ul><li>Defined in node_modules/@bufbuild/protobuf/dist/cjs/message.d.ts:49</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited tsd-is-external"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-protected tsd-is-inherited tsd-is-external"><li class="tsd