SshResourceResolver

<p>SSH Resource resolver</p>
<p>SSH Resource resolver</p>

A resource represents some data or a computation unit. It is
described by a URL and credentials. This package proposes a Resource model
with "resolver" and "client" classes to facilitate the access and the usage of the
resources.

Yannick Marcon

resourcer

Resource Resolver

OBiBa group 

SshResourceResolver function

<p>A R6 object of class SshResourceResolver</p>

Format

<p><code>resourcer::ResourceResolver</code> -&gt; <code>SshResourceResolver</code></p>

Super class


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/SshResourceResolver%24isFor()?package=resourcer&version=1.3.0" data-mini-rdoc="resourcer::SshResourceResolver$isFor()"><code>SshResourceResolver$isFor()</code></a></p></li>
<li><p><a href="/link/SshResourceResolver%24newClient()?package=resourcer&version=1.3.0" data-mini-rdoc="resourcer::SshResourceResolver$newClient()"><code>SshResourceResolver$newClient()</code></a></p></li>
<li><p><a href="/link/SshResourceResolver%24clone()?package=resourcer&version=1.3.0" data-mini-rdoc="resourcer::SshResourceResolver$clone()"><code>SshResourceResolver$clone()</code></a></p></li>
</ul></p><p></p></div><p><details open><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="resourcer" data-topic="ResourceResolver" data-id="initialize"><a href="/link/resourcer%3A%3AResourceResolver%24initialize()?package=resourcer&version=1.3.0" data-mini-rdoc="resourcer::resourcer::ResourceResolver$initialize()"><code>resourcer::ResourceResolver$initialize()</code></a></span></li>
</ul>
</details></p><p><hr>
<a id="method-SshResourceResolver-isFor"></a></p><div class="section" id="method-isfor-">
<h3>Method <code>isFor()</code></h3>
<p>Check that the provided resource is a computation resource accessible by ssh commands. The resource URL scheme is expected to be "ssh".</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>SshResourceResolver$isFor(x)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>x</code></dt>
<dd><p>The resource object.</p></dd></dl></div></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>A logical.</p>
</div><p></p><p></p><p><hr>
<a id="method-SshResourceResolver-newClient"></a></p><div class="section" id="method-newclient-">
<h3>Method <code>newClient()</code></h3>
<p>Create a SshResourceClient instance from the provided resource.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>SshResourceResolver$newClient(x)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>x</code></dt>
<dd><p>A valid resource object.</p></dd></dl></div></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>A SshResourceClient object.</p>
</div><p></p><p></p><p><hr>
<a id="method-SshResourceResolver-clone"></a></p><div class="section" id="method-clone-">
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>SshResourceResolver$clone(deep = FALSE)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p>
</p>

Methods

SSH Resource resolver — SshResourceResolver


<div class='section' id='public-methods'>
<h3>Public methods</h3>

<ul>
<li><p><a href='#method-SshResourceResolver-isFor'><code>SshResourceResolver$isFor()</code></a></p></li>
<li><p><a href='#method-SshResourceResolver-newClient'><code>SshResourceResolver$newClient()</code></a></p></li>
<li><p><a href='#method-SshResourceResolver-clone'><code>SshResourceResolver$clone()</code></a></p></li>
</ul>

</div><p><details open><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="resourcer" data-topic="ResourceResolver" data-id="initialize"><a href='../../resourcer/html/ResourceResolver.html#method-ResourceResolver-initialize'><code>resourcer::ResourceResolver$initialize()</code></a></span></li>
</ul>
</details>

<hr>
<a id="method-SshResourceResolver-isFor"></a></p><div class='section' id='method-isfor-'>
<h3>Method <code>isFor()</code></h3>
<p>Check that the provided resource is a computation resource accessible by ssh commands. The resource URL scheme is expected to be "ssh".</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>SshResourceResolver$isFor(x)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>x</code></dt>
<dd><p>The resource object.</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>A logical.</p>
</div>

</div><p><hr>
<a id="method-SshResourceResolver-newClient"></a></p><div class='section' id='method-newclient-'>
<h3>Method <code>newClient()</code></h3>
<p>Create a SshResourceClient instance from the provided resource.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>SshResourceResolver$newClient(x)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>x</code></dt>
<dd><p>A valid resource object.</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>A SshResourceClient object.</p>
</div>

</div><p><hr>
<a id="method-SshResourceResolver-clone"></a></p><div class='section' id='method-clone-'>
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>SshResourceResolver$clone(deep = FALSE)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd>


</dl><p></div></p>
</div>

</div>


SshResourceResolver: SSH Resource resolver

Description

Arguments

Format

Super class

Methods

Public methods

Method `isFor()`

Usage

Arguments

Returns

Method `newClient()`

Usage

Arguments

Returns

Method `clone()`

Usage

Arguments

Details

Description

Arguments

Format

Super class

Methods

Public methods

Method isFor()

Usage

Arguments

Returns

Method newClient()

Usage

Arguments

Returns

Method clone()

Usage

Arguments

Details

Method `isFor()`

Method `newClient()`

Method `clone()`