doc/SDM/Relay.html in strongdm-1.0.0 vs doc/SDM/Relay.html in strongdm-1.0.1

- old
+ new

@@ -6,20 +6,25 @@ <title>class SDM::Relay - RDoc Documentation</title> <script type="text/javascript"> var rdoc_rel_prefix = "../"; + var index_rel_prefix = "../"; </script> -<script src="../js/jquery.js"></script> -<script src="../js/darkfish.js"></script> +<script src="../js/navigation.js" defer></script> +<script src="../js/search.js" defer></script> +<script src="../js/search_index.js" defer></script> +<script src="../js/searcher.js" defer></script> +<script src="../js/darkfish.js" defer></script> <link href="../css/fonts.css" rel="stylesheet"> <link href="../css/rdoc.css" rel="stylesheet"> + <body id="top" role="document" class="class"> <nav role="navigation"> <div id="project-navigation"> <div id="home-section" role="region" title="Quick navigation" class="nav-section"> <h2> @@ -70,10 +75,12 @@ <ul class="link-list" role="directory"> <li ><a href="#method-c-new">::new</a> + <li ><a href="#method-i-to_json">#to_json</a> + </ul> </div> </div> </nav> @@ -83,18 +90,15 @@ class SDM::Relay </h1> <section class="description"> -<p><a href="Relay.html">Relay</a> represents a StrongDM CLI installation -running in relay mode.</p> +<p><a href="Relay.html"><code>Relay</code></a> represents a StrongDM CLI installation running in relay mode.</p> </section> - - <section id="5Buntitled-5D" class="documentation-section"> @@ -113,11 +117,11 @@ class="attribute-access-type">[RW]</span> </div> <div class="method-description"> - <p>Unique identifier of the <a href="Relay.html">Relay</a>.</p> + <p>Unique identifier of the <a href="Relay.html"><code>Relay</code></a>.</p> </div> </div> <div id="attribute-i-name" class="method-detail"> @@ -126,12 +130,11 @@ class="attribute-access-type">[RW]</span> </div> <div class="method-description"> - <p>Unique human-readable name of the <a href="Relay.html">Relay</a>. Generated -if not provided on create.</p> + <p>Unique human-readable name of the <a href="Relay.html"><code>Relay</code></a>. Generated if not provided on create.</p> </div> </div> <div id="attribute-i-state" class="method-detail"> @@ -140,12 +143,11 @@ class="attribute-access-type">[RW]</span> </div> <div class="method-description"> - <p>The current state of the relay. One of: “new”, “verifying_restart”, -“restarting”, “started”, “stopped”, “dead”, “unknown”,</p> + <p>The current state of the relay. One of: “new”, “verifying_restart”, “restarting”, “started”, “stopped”, “dead”, “unknown”,</p> </div> </div> </section> @@ -175,24 +177,72 @@ <div class="method-source-code" id="new-source"> - <pre><span class="ruby-comment"># File lib/models/porcelain.rb, line 3555</span> -<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>( - <span class="ruby-identifier">id</span><span class="ruby-value">:nil</span> , - <span class="ruby-identifier">name</span><span class="ruby-value">:nil</span> , - <span class="ruby-identifier">state</span><span class="ruby-value">:nil</span> ) - <span class="ruby-keyword">if</span> <span class="ruby-identifier">id</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span> - <span class="ruby-ivar">@id</span> = <span class="ruby-identifier">id</span> + <pre><span class="ruby-comment"># File lib/models/porcelain.rb, line 4031</span> + <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>( + <span class="ruby-value">id:</span><span class="ruby-keyword">nil</span> \ +, + <span class="ruby-value">name:</span><span class="ruby-keyword">nil</span> \ +, + <span class="ruby-value">state:</span><span class="ruby-keyword">nil</span> \ + ) + <span class="ruby-keyword">if</span> <span class="ruby-identifier">id</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span> + <span class="ruby-ivar">@id</span> = <span class="ruby-identifier">id</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">name</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span> + <span class="ruby-ivar">@name</span> = <span class="ruby-identifier">name</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">state</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span> + <span class="ruby-ivar">@state</span> = <span class="ruby-identifier">state</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span></pre> + </div> + + </div> + + + + + </div> + + + </section> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> + <header> + <h3>Public Instance Methods</h3> + </header> + + + <div id="method-i-to_json" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">to_json</span><span + class="method-args">(options={})</span> + + <span class="method-click-advice">click to toggle source</span> + + </div> + + + <div class="method-description"> + + + + + + + <div class="method-source-code" id="to_json-source"> + <pre><span class="ruby-comment"># File lib/models/porcelain.rb, line 4048</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">to_json</span>(<span class="ruby-identifier">options</span>={}) + <span class="ruby-identifier">hash</span> = {} + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">instance_variables</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">var</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">hash</span>[<span class="ruby-identifier">var</span>.<span class="ruby-identifier">id2name</span>.<span class="ruby-identifier">delete_prefix</span>(<span class="ruby-string">&#39;@&#39;</span>)] = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">instance_variable_get</span> <span class="ruby-identifier">var</span> <span class="ruby-keyword">end</span> - <span class="ruby-keyword">if</span> <span class="ruby-identifier">name</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span> - <span class="ruby-ivar">@name</span> = <span class="ruby-identifier">name</span> - <span class="ruby-keyword">end</span> - <span class="ruby-keyword">if</span> <span class="ruby-identifier">state</span> <span class="ruby-operator">!=</span> <span class="ruby-keyword">nil</span> - <span class="ruby-ivar">@state</span> = <span class="ruby-identifier">state</span> - <span class="ruby-keyword">end</span> + <span class="ruby-identifier">hash</span>.<span class="ruby-identifier">to_json</span> <span class="ruby-keyword">end</span></pre> </div> </div> @@ -203,14 +253,15 @@ </section> </section> + </main> <footer id="validator-badges" role="contentinfo"> - <p><a href="http://validator.w3.org/check/referer">Validate</a> - <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.1. + <p><a href="https://validator.w3.org/check/referer">Validate</a> + <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2. <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>. </footer>