94 lines
25 KiB
HTML
94 lines
25 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CloudEventV1 | cloudevents</title><meta name="description" content="Documentation for cloudevents"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">cloudevents</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">cloudevents</a></li><li><a href="CloudEventV1.html">CloudEventV1</a></li></ul><h1>Interface CloudEventV1<T> </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The object interface for CloudEvents 1.0.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>see</dt><dd><p><a href="https://github.com/cloudevents/spec/blob/v1.0/spec.md">https://github.com/cloudevents/spec/blob/v1.0/spec.md</a></p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-type-parameters"><h3>Type Parameters</h3><ul class="tsd-type-parameters"><li><h4>T</h4></li></ul></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">CloudEventV1Attributes</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">CloudEventV1</span><ul class="tsd-hierarchy"><li><a href="KafkaEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">KafkaEvent</a></li></ul></li></ul></li></ul></section><section class="tsd-panel"><h3>Implemented by</h3><ul class="tsd-hierarchy"><li><a href="../classes/CloudEvent.html" class="tsd-signature-type" data-tsd-kind="Class">CloudEvent</a></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CloudEventV1.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CloudEventV1.html#data_base64" class="tsd-kind-icon">data_<wbr/>base64</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CloudEventV1.html#datacontenttype" class="tsd-kind-icon">datacontenttype</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CloudEventV1.html#dataschema" class="tsd-kind-icon">dataschema</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CloudEventV1.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CloudEventV1.html#source" class="tsd-kind-icon">source</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CloudEventV1.html#specversion" class="tsd-kind-icon">specversion</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CloudEventV1.html#subject" class="tsd-kind-icon">subject</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CloudEventV1.html#time" class="tsd-kind-icon">time</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CloudEventV1.html#type" class="tsd-kind-icon">type</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="data" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> data<a href="#data" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></div><aside class="tsd-sources"><p>Inherited from CloudEventV1Attributes.data</p><ul><li>Defined in <a href="https://github.com/cloudevents/sdk-javascript/blob/fc76097/src/event/interfaces.ts#L129">src/event/interfaces.ts:129</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>[OPTIONAL] The event payload. This specification does not place any restriction
|
|
on the type of this information. It is encoded into a media format which is
|
|
specified by the datacontenttype attribute (e.g. application/json), and adheres
|
|
to the dataschema format when those respective attributes are present.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="data_base64" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> data_<wbr/>base64<a href="#data_base64" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">data_<wbr/>base64<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from CloudEventV1Attributes.data_base64</p><ul><li>Defined in <a href="https://github.com/cloudevents/sdk-javascript/blob/fc76097/src/event/interfaces.ts#L136">src/event/interfaces.ts:136</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>[OPTIONAL] The event payload encoded as base64 data. This is used when the
|
|
data is in binary form.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>see</dt><dd><p><a href="https://github.com/cloudevents/spec/blob/v1.0/json-format.md#31-handling-of-data">https://github.com/cloudevents/spec/blob/v1.0/json-format.md#31-handling-of-data</a></p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="datacontenttype" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> datacontenttype<a href="#datacontenttype" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">datacontenttype<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from CloudEventV1Attributes.datacontenttype</p><ul><li>Defined in <a href="https://github.com/cloudevents/sdk-javascript/blob/fc76097/src/event/interfaces.ts#L84">src/event/interfaces.ts:84</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>[OPTIONAL] Content type of <code>data</code> value. This attribute enables <code>data</code> to
|
|
carry any type of content, whereby format and encoding might differ from that
|
|
of the chosen event format. For example, an event rendered using the
|
|
<a href="./json-format.md#3-envelope">JSON envelope</a> format might carry an XML payload
|
|
in <code>data</code>, and the consumer is informed by this attribute being set to
|
|
"application/xml". The rules for how <code>data</code> content is rendered for different
|
|
<code>datacontenttype</code> values are defined in the event format specifications; for
|
|
example, the JSON event format defines the relationship in
|
|
<a href="./json-format.md#31-handling-of-data">section 3.1</a>.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="dataschema" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> dataschema<a href="#dataschema" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">dataschema<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from CloudEventV1Attributes.dataschema</p><ul><li>Defined in <a href="https://github.com/cloudevents/sdk-javascript/blob/fc76097/src/event/interfaces.ts#L92">src/event/interfaces.ts:92</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>[OPTIONAL] Identifies the schema that <code>data</code> adheres to. Incompatible
|
|
changes to the schema SHOULD be reflected by a different URI. See
|
|
<a href="primer.md#versioning-of-attributes">Versioning of Attributes in the Primer</a>
|
|
for more information.
|
|
If present, MUST be a non-empty URI.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link">id<a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/cloudevents/sdk-javascript/blob/fc76097/src/event/interfaces.ts#L21">src/event/interfaces.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>[REQUIRED] Identifies the event. Producers MUST ensure that <code>source</code> + <code>id</code>
|
|
is unique for each distinct event. If a duplicate event is re-sent (e.g. due
|
|
to a network error) it MAY have the same <code>id</code>. Consumers MAY assume that
|
|
Events with identical <code>source</code> and <code>id</code> are duplicates.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>required</dt><dd><p>Non-empty string. Unique within producer.</p>
|
|
</dd><dt>example</dt><dd><p>An event counter maintained by the producer</p>
|
|
</dd><dt>example</dt><dd><p>A UUID</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="source" class="tsd-anchor"></a><h3 class="tsd-anchor-link">source<a href="#source" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">source<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from CloudEventV1Attributes.source</p><ul><li>Defined in <a href="https://github.com/cloudevents/sdk-javascript/blob/fc76097/src/event/interfaces.ts#L49">src/event/interfaces.ts:49</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>[REQUIRED] Identifies the context in which an event happened. Often this
|
|
will include information such as the type of the event source, the
|
|
organization publishing the event or the process that produced the event. The
|
|
exact syntax and semantics behind the data encoded in the URI is defined by
|
|
the event producer.
|
|
Producers MUST ensure that <code>source</code> + <code>id</code> is unique for each distinct event.
|
|
An application MAY assign a unique <code>source</code> to each distinct producer, which
|
|
makes it easy to produce unique IDs since no other producer will have the same
|
|
source. The application MAY use UUIDs, URNs, DNS authorities or an
|
|
application-specific scheme to create unique <code>source</code> identifiers.
|
|
A source MAY include more than one producer. In that case the producers MUST
|
|
collaborate to ensure that <code>source</code> + <code>id</code> is unique for each distinct event.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>required</dt><dd><p>Non-empty URI-reference</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="specversion" class="tsd-anchor"></a><h3 class="tsd-anchor-link">specversion<a href="#specversion" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">specversion<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/cloudevents/sdk-javascript/blob/fc76097/src/event/interfaces.ts#L30">src/event/interfaces.ts:30</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>[REQUIRED] The version of the CloudEvents specification which the event
|
|
uses. This enables the interpretation of the context. Compliant event
|
|
producers MUST use a value of <code>1.0</code> when referring to this version of the
|
|
specification.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>required</dt><dd><p>MUST be a non-empty string.</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="subject" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> subject<a href="#subject" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">subject<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from CloudEventV1Attributes.subject</p><ul><li>Defined in <a href="https://github.com/cloudevents/sdk-javascript/blob/fc76097/src/event/interfaces.ts#L112">src/event/interfaces.ts:112</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>[OPTIONAL] This describes the subject of the event in the context of the
|
|
event producer (identified by <code>source</code>). In publish-subscribe scenarios, a
|
|
subscriber will typically subscribe to events emitted by a <code>source</code>, but the
|
|
<code>source</code> identifier alone might not be sufficient as a qualifier for any
|
|
specific event if the <code>source</code> context has internal sub-structure.</p>
|
|
</div><div><p>Identifying the subject of the event in context metadata (opposed to only in
|
|
the <code>data</code> payload) is particularly helpful in generic subscription filtering
|
|
scenarios where middleware is unable to interpret the <code>data</code> content. In the
|
|
above example, the subscriber might only be interested in blobs with names
|
|
ending with '.jpg' or '.jpeg' and the <code>subject</code> attribute allows for
|
|
constructing a simple and efficient string-suffix filter for that subset of
|
|
events.</p>
|
|
<p>If present, MUST be a non-empty string.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>example</dt><dd><p>"<a href="https://example.com/storage/tenant/container">https://example.com/storage/tenant/container</a>"</p>
|
|
</dd><dt>example</dt><dd><p>"mynewfile.jpg"</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="time" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> time<a href="#time" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">time<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from CloudEventV1Attributes.time</p><ul><li>Defined in <a href="https://github.com/cloudevents/sdk-javascript/blob/fc76097/src/event/interfaces.ts#L122">src/event/interfaces.ts:122</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>[OPTIONAL] Timestamp of when the occurrence happened. If the time of the
|
|
occurrence cannot be determined then this attribute MAY be set to some other
|
|
time (such as the current time) by the CloudEvents producer, however all
|
|
producers for the same <code>source</code> MUST be consistent in this respect. In other
|
|
words, either they all use the actual time of the occurrence or they all use
|
|
the same algorithm to determine the value used.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>example</dt><dd><p>"2020-08-08T14:48:09.769Z"</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link">type<a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from CloudEventV1Attributes.type</p><ul><li>Defined in <a href="https://github.com/cloudevents/sdk-javascript/blob/fc76097/src/event/interfaces.ts#L65">src/event/interfaces.ts:65</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>[REQUIRED] This attribute contains a value describing the type of event
|
|
related to the originating occurrence. Often this attribute is used for
|
|
routing, observability, policy enforcement, etc. The format of this is
|
|
producer defined and might include information such as the version of the
|
|
<code>type</code> - see
|
|
<a href="primer.md#versioning-of-attributes">Versioning of Attributes in the Primer</a>
|
|
for more information.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>required</dt><dd><p>MUST be a non-empty string</p>
|
|
</dd><dt>should</dt><dd><p>SHOULD be prefixed with a reverse-DNS name. The prefixed domain dictates the
|
|
organization which defines the semantics of this event type.</p>
|
|
</dd><dt>example</dt><dd><p>com.github.pull.create</p>
|
|
</dd><dt>example</dt><dd><p>com.example.object.delete.v2</p>
|
|
</dd></dl></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-has-type-parameter"><a href="CloudEventV1.html" class="tsd-kind-icon">Cloud<wbr/>Event<wbr/>V1</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CloudEventV1.html#data" class="tsd-kind-icon">data</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CloudEventV1.html#data_base64" class="tsd-kind-icon">data_<wbr/>base64</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CloudEventV1.html#datacontenttype" class="tsd-kind-icon">datacontenttype</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CloudEventV1.html#dataschema" class="tsd-kind-icon">dataschema</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CloudEventV1.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CloudEventV1.html#source" class="tsd-kind-icon">source</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="CloudEventV1.html#specversion" class="tsd-kind-icon">specversion</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CloudEventV1.html#subject" class="tsd-kind-icon">subject</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CloudEventV1.html#time" class="tsd-kind-icon">time</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="CloudEventV1.html#type" class="tsd-kind-icon">type</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html> |