mirror of
https://github.com/ocaml-tracing/ocaml-opentelemetry.git
synced 2026-03-07 18:37:56 -05:00
7 lines
8.5 KiB
HTML
7 lines
8.5 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Resource (opentelemetry.Opentelemetry_proto.Resource)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../../index.html">Index</a> » <a href="../../index.html">opentelemetry</a> » <a href="../index.html">Opentelemetry_proto</a> » Resource</nav><header class="odoc-preamble"><h1>Module <code><span>Opentelemetry_proto.Resource</span></code></h1><p>Code for resource.proto</p></header><div class="odoc-tocs"><nav class="odoc-toc odoc-local-toc"><ul><li><a href="#types">Types</a></li><li><a href="#basic-values">Basic values</a></li><li><a href="#make-functions">Make functions</a></li><li><a href="#formatters">Formatters</a></li><li><a href="#protobuf-encoding">Protobuf Encoding</a></li><li><a href="#protobuf-decoding">Protobuf Decoding</a></li></ul></nav></div><div class="odoc-content"><h3 id="types"><a href="#types" class="anchor"></a>Types</h3><div class="odoc-spec"><div class="spec type anchored" id="type-resource"><a href="#type-resource" class="anchor"></a><code><span><span class="keyword">type</span> resource</span><span> = <span class="keyword">private</span> </span><span>{</span></code><ol><li id="type-resource._presence" class="def record field anchored"><a href="#type-resource._presence" class="anchor"></a><code><span><span class="keyword">mutable</span> _presence : <a href="../../../pbrt/Pbrt/Bitfield/index.html#type-t">Pbrt.Bitfield.t</a>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>presence for 1 fields</p><span class="comment-delim">*)</span></div></li><li id="type-resource.attributes" class="def record field anchored"><a href="#type-resource.attributes" class="anchor"></a><code><span><span class="keyword">mutable</span> attributes : <span><a href="../Common/index.html#type-key_value">Common.key_value</a> list</span>;</span></code></li><li id="type-resource.dropped_attributes_count" class="def record field anchored"><a href="#type-resource.dropped_attributes_count" class="anchor"></a><code><span><span class="keyword">mutable</span> dropped_attributes_count : int32;</span></code></li><li id="type-resource.entity_refs" class="def record field anchored"><a href="#type-resource.entity_refs" class="anchor"></a><code><span><span class="keyword">mutable</span> entity_refs : <span><a href="../Common/index.html#type-entity_ref">Common.entity_ref</a> list</span>;</span></code></li></ol><code><span>}</span></code></div></div><h3 id="basic-values"><a href="#basic-values" class="anchor"></a>Basic values</h3><div class="odoc-spec"><div class="spec value anchored" id="val-default_resource"><a href="#val-default_resource" class="anchor"></a><code><span><span class="keyword">val</span> default_resource : <span>unit <span class="arrow">-></span></span> <a href="#type-resource">resource</a></span></code></div><div class="spec-doc"><p><code>default_resource ()</code> is a new empty value for type <code>resource</code></p></div></div><h3 id="make-functions"><a href="#make-functions" class="anchor"></a>Make functions</h3><div class="odoc-spec"><div class="spec value anchored" id="val-make_resource"><a href="#val-make_resource" class="anchor"></a><code><span><span class="keyword">val</span> make_resource :
|
||
<span><span class="optlabel">?attributes</span>:<span><a href="../Common/index.html#type-key_value">Common.key_value</a> list</span> <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?dropped_attributes_count</span>:int32 <span class="arrow">-></span></span>
|
||
<span><span class="optlabel">?entity_refs</span>:<span><a href="../Common/index.html#type-entity_ref">Common.entity_ref</a> list</span> <span class="arrow">-></span></span>
|
||
<span>unit <span class="arrow">-></span></span>
|
||
<a href="#type-resource">resource</a></span></code></div><div class="spec-doc"><p><code>make_resource … ()</code> is a builder for type <code>resource</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-copy_resource"><a href="#val-copy_resource" class="anchor"></a><code><span><span class="keyword">val</span> copy_resource : <span><a href="#type-resource">resource</a> <span class="arrow">-></span></span> <a href="#type-resource">resource</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-resource_set_attributes"><a href="#val-resource_set_attributes" class="anchor"></a><code><span><span class="keyword">val</span> resource_set_attributes : <span><a href="#type-resource">resource</a> <span class="arrow">-></span></span> <span><span><a href="../Common/index.html#type-key_value">Common.key_value</a> list</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>set field attributes in resource</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-resource_has_dropped_attributes_count"><a href="#val-resource_has_dropped_attributes_count" class="anchor"></a><code><span><span class="keyword">val</span> resource_has_dropped_attributes_count : <span><a href="#type-resource">resource</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p>presence of field "dropped_attributes_count" in <code>resource</code></p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-resource_set_dropped_attributes_count"><a href="#val-resource_set_dropped_attributes_count" class="anchor"></a><code><span><span class="keyword">val</span> resource_set_dropped_attributes_count : <span><a href="#type-resource">resource</a> <span class="arrow">-></span></span> <span>int32 <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>set field dropped_attributes_count in resource</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-resource_set_entity_refs"><a href="#val-resource_set_entity_refs" class="anchor"></a><code><span><span class="keyword">val</span> resource_set_entity_refs : <span><a href="#type-resource">resource</a> <span class="arrow">-></span></span> <span><span><a href="../Common/index.html#type-entity_ref">Common.entity_ref</a> list</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>set field entity_refs in resource</p></div></div><h3 id="formatters"><a href="#formatters" class="anchor"></a>Formatters</h3><div class="odoc-spec"><div class="spec value anchored" id="val-pp_resource"><a href="#val-pp_resource" class="anchor"></a><code><span><span class="keyword">val</span> pp_resource : <span><a href="../../../ocaml/Stdlib/Format/index.html#type-formatter">Stdlib.Format.formatter</a> <span class="arrow">-></span></span> <span><a href="#type-resource">resource</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>pp_resource v</code> formats v</p></div></div><h3 id="protobuf-encoding"><a href="#protobuf-encoding" class="anchor"></a>Protobuf Encoding</h3><div class="odoc-spec"><div class="spec value anchored" id="val-encode_pb_resource"><a href="#val-encode_pb_resource" class="anchor"></a><code><span><span class="keyword">val</span> encode_pb_resource : <span><a href="#type-resource">resource</a> <span class="arrow">-></span></span> <span><a href="../../../pbrt/Pbrt/Encoder/index.html#type-t">Pbrt.Encoder.t</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>encode_pb_resource v encoder</code> encodes <code>v</code> with the given <code>encoder</code></p></div></div><h3 id="protobuf-decoding"><a href="#protobuf-decoding" class="anchor"></a>Protobuf Decoding</h3><div class="odoc-spec"><div class="spec value anchored" id="val-decode_pb_resource"><a href="#val-decode_pb_resource" class="anchor"></a><code><span><span class="keyword">val</span> decode_pb_resource : <span><a href="../../../pbrt/Pbrt/Decoder/index.html#type-t">Pbrt.Decoder.t</a> <span class="arrow">-></span></span> <a href="#type-resource">resource</a></span></code></div><div class="spec-doc"><p><code>decode_pb_resource decoder</code> decodes a <code>resource</code> binary value from <code>decoder</code></p></div></div></div></body></html>
|