Current section
Files
Jump to
Current section
Files
docs/Consul.KV.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.14.3">
<title>Consul.KV – Consul v0.1.6</title>
<link rel="stylesheet" href="dist/app-091c05798a.css" />
<link rel="canonical" href="https://hexdocs.pm/consul_client/Consul.KV.html" />
<script src="dist/sidebar_items.js"></script>
</head>
<body data-type="modules">
<script>if(localStorage.getItem('night-mode')) document.body.className += ' night-mode';</script>
<div class="main">
<button class="sidebar-toggle">
<i class="icon-menu"></i>
</button>
<section class="sidebar">
<a href="readme.html" class="sidebar-projectLink">
<div class="sidebar-projectDetails">
<h1 class="sidebar-projectName">
Consul
</h1>
<h2 class="sidebar-projectVersion">
v0.1.6
</h2>
</div>
</a>
<div class="sidebar-search">
<i class="icon-search"></i>
<input type="text" class="sidebar-searchInput" placeholder="search" autocomplete="off" />
</div>
<ul class="sidebar-listNav">
<li><a id="extras-list" href="#full-list">Pages</a></li>
<li><a id="modules-list" href="#full-list">Modules</a></li>
</ul>
<div class="gradient"></div>
<ul id="full-list" class="sidebar-fullList"></ul>
</section>
<section class="content">
<div class="content-outer">
<div id="content" class="content-inner">
<h1>
<small class="visible-xs">Consul v0.1.6</small>
Consul.KV
<a href="https://github.com/Toady00/consul/blob/master/lib/consul/kv.ex#L1" title="View Source" class="view-source" rel="help">
<i class="icon-code"></i>
</a>
</h1>
<section id="moduledoc">
<p>Higher level abstraction on top of Consul’s Key Value api.</p>
</section>
<section id="summary" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#summary">
<i class="icon-link"></i>
</a>
Summary
</h1>
<div class="summary-types summary">
<h2>
<a href="#types">Types</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#t:flags/0">flags()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#t:index/0">index()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#t:key/0">key()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#t:options/0">options()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#t:path/0">path()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#t:t/0">t()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#t:value/0">value()</a>
</div>
</div>
</div>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#get/2">get(obj, options \\ [])</a>
</div>
<div class="summary-synopsis"><p>Get a new <a href="Consul.KV.html#content"><code class="inline">Consul.KV</code></a> struct</p>
</div>
</div>
</div>
</section>
<section id="types" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#types">
<i class="icon-link"></i>
</a>
Types
</h1>
<div class="types-list">
<div class="detail" id="t:flags/0">
<div class="detail-header">
<a href="#t:flags/0" class="detail-link" title="Link to this type">
<i class="icon-link"></i>
</a>
<span class="signature">flags()</span>
<a href="https://github.com/Toady00/consul/blob/master/lib/consul/kv.ex#L9" class="view-source" rel="help" title="View Source">
<i class="icon-code"></i>
</a>
<div class="specs">
<pre><a href="#t:flags/0">flags</a> :: non_neg_integer</pre>
</div>
</div>
<section class="docstring">
</section>
</div>
<div class="detail" id="t:index/0">
<div class="detail-header">
<a href="#t:index/0" class="detail-link" title="Link to this type">
<i class="icon-link"></i>
</a>
<span class="signature">index()</span>
<a href="https://github.com/Toady00/consul/blob/master/lib/consul/kv.ex#L10" class="view-source" rel="help" title="View Source">
<i class="icon-code"></i>
</a>
<div class="specs">
<pre><a href="#t:index/0">index</a> :: non_neg_integer</pre>
</div>
</div>
<section class="docstring">
</section>
</div>
<div class="detail" id="t:key/0">
<div class="detail-header">
<a href="#t:key/0" class="detail-link" title="Link to this type">
<i class="icon-link"></i>
</a>
<span class="signature">key()</span>
<a href="https://github.com/Toady00/consul/blob/master/lib/consul/kv.ex#L7" class="view-source" rel="help" title="View Source">
<i class="icon-code"></i>
</a>
<div class="specs">
<pre><a href="#t:key/0">key</a> :: <a href="http://elixir-lang.org/docs/stable/elixir/String.html#t:t/0">String.t</a></pre>
</div>
</div>
<section class="docstring">
</section>
</div>
<div class="detail" id="t:options/0">
<div class="detail-header">
<a href="#t:options/0" class="detail-link" title="Link to this type">
<i class="icon-link"></i>
</a>
<span class="signature">options()</span>
<a href="https://github.com/Toady00/consul/blob/master/lib/consul/kv.ex#L11" class="view-source" rel="help" title="View Source">
<i class="icon-code"></i>
</a>
<div class="specs">
<pre><a href="#t:options/0">options</a> :: keyword</pre>
</div>
</div>
<section class="docstring">
</section>
</div>
<div class="detail" id="t:path/0">
<div class="detail-header">
<a href="#t:path/0" class="detail-link" title="Link to this type">
<i class="icon-link"></i>
</a>
<span class="signature">path()</span>
<a href="https://github.com/Toady00/consul/blob/master/lib/consul/kv.ex#L6" class="view-source" rel="help" title="View Source">
<i class="icon-code"></i>
</a>
<div class="specs">
<pre><a href="#t:path/0">path</a> :: <a href="http://elixir-lang.org/docs/stable/elixir/String.html#t:t/0">String.t</a></pre>
</div>
</div>
<section class="docstring">
</section>
</div>
<div class="detail" id="t:t/0">
<div class="detail-header">
<a href="#t:t/0" class="detail-link" title="Link to this type">
<i class="icon-link"></i>
</a>
<span class="signature">t()</span>
<a href="https://github.com/Toady00/consul/blob/master/lib/consul/kv.ex#L13" class="view-source" rel="help" title="View Source">
<i class="icon-code"></i>
</a>
<div class="specs">
<pre><a href="#t:t/0">t</a> :: %Consul.KV{create_index: <a href="#t:index/0">index</a>, flags: <a href="#t:flags/0">flags</a>, key: <a href="#t:key/0">key</a>, lock_index: <a href="#t:index/0">index</a>, modify_index: <a href="#t:index/0">index</a>, value: <a href="#t:value/0">value</a>}</pre>
</div>
</div>
<section class="docstring">
</section>
</div>
<div class="detail" id="t:value/0">
<div class="detail-header">
<a href="#t:value/0" class="detail-link" title="Link to this type">
<i class="icon-link"></i>
</a>
<span class="signature">value()</span>
<a href="https://github.com/Toady00/consul/blob/master/lib/consul/kv.ex#L8" class="view-source" rel="help" title="View Source">
<i class="icon-code"></i>
</a>
<div class="specs">
<pre><a href="#t:value/0">value</a> :: any</pre>
</div>
</div>
<section class="docstring">
</section>
</div>
</div>
</section>
<section id="functions" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#functions">
<i class="icon-link"></i>
</a>
Functions
</h1>
<div class="detail" id="get/2">
<span id="get/1" />
<div class="detail-header">
<a href="#get/2" class="detail-link" title="Link to this function">
<i class="icon-link"></i>
</a>
<span class="signature">get(obj, options \\ [])</span>
<a href="https://github.com/Toady00/consul/blob/master/lib/consul/kv.ex#L33" class="view-source" rel="help" title="View Source">
<i class="icon-code"></i>
</a>
<div class="specs">
<pre>get(<a href="#t:t/0">t</a>, <a href="#t:options/0">options</a>) :: <a href="#t:t/0">t</a></pre>
<pre>get(<a href="#t:path/0">path</a>, <a href="#t:options/0">options</a>) :: <a href="#t:t/0">t</a></pre>
</div>
</div>
<section class="docstring">
<p>Get a new <a href="Consul.KV.html#content"><code class="inline">Consul.KV</code></a> struct.</p>
<p>Takes either a <a href="Consul.KV.html#content"><code class="inline">Consul.KV</code></a> struct with a valid <code class="inline">key</code> field or a string path.</p>
<p><code class="inline">options</code> are optional. These are the same options the <a href="Consul.HTTP.Raw.html"><code class="inline">Consul.HTTP.Raw</code></a>
client will take. They are passed through.</p>
<h2 id="get/2-examples" class="section-heading">
<a href="#get/2-examples" class="hover-link"><i class="icon-link"></i></a>
Examples
</h2>
<pre><code class="iex elixir">iex> Consul.KV.get(%Consul.KV{key: "wat"})
%Consul.KV{}
iex> Consul.KV.get("wat")
%Consul.KV{}</code></pre>
</section>
</div>
</section>
<footer class="footer">
<p>
<span class="line">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.14.3),
</span>
<span class="line">
designed by
<a href="https://twitter.com/dignifiedquire" target="_blank" title="@dignifiedquire">Friedel Ziegelmayer</a>.
</span>
</p>
<button class="night-mode-toggle" />
</footer>
</div>
</div>
</section>
</div>
<script src="dist/app-574613960f.js"></script>
</body>
</html>