blob: f1f9b71f822a627b611380af035660cb2b603f5a [file] [log] [blame]
<!DOCTYPE html >
<html>
<head>
<title>LivyScalaClient - livy-scala-api-parent 0.7.0-incubating API - org.apache.livy.scalaapi.LivyScalaClient</title>
<meta name="description" content="LivyScalaClient - livy - scala - api - parent 0.7.0 - incubating API - org.apache.livy.scalaapi.LivyScalaClient" />
<meta name="keywords" content="LivyScalaClient livy scala api parent 0.7.0 incubating API org.apache.livy.scalaapi.LivyScalaClient" />
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<link href="../../../../lib/template.css" media="screen" type="text/css" rel="stylesheet" />
<link href="../../../../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css" />
<script type="text/javascript" src="../../../../lib/jquery.js" id="jquery-js"></script>
<script type="text/javascript" src="../../../../lib/jquery-ui.js"></script>
<script type="text/javascript" src="../../../../lib/template.js"></script>
<script type="text/javascript" src="../../../../lib/tools.tooltip.js"></script>
<script type="text/javascript">
if(top === self) {
var url = '../../../../index.html';
var hash = 'org.apache.livy.scalaapi.LivyScalaClient';
var anchor = window.location.hash;
var anchor_opt = '';
if (anchor.length >= 1)
anchor_opt = '@' + anchor.substring(1);
window.location.href = url + '#' + hash + anchor_opt;
}
</script>
</head>
<body class="type">
<div id="definition">
<img alt="Class" src="../../../../lib/class_big.png" />
<p id="owner"><a href="../../../package.html" class="extype" name="org">org</a>.<a href="../../package.html" class="extype" name="org.apache">apache</a>.<a href="../package.html" class="extype" name="org.apache.livy">livy</a>.<a href="package.html" class="extype" name="org.apache.livy.scalaapi">scalaapi</a></p>
<h1>LivyScalaClient</h1><h3><span class="morelinks"><div>Related Doc:
<a href="package.html" class="extype" name="org.apache.livy.scalaapi">package scalaapi</a>
</div></span></h3><span class="permalink">
<a href="../../../../index.html#org.apache.livy.scalaapi.LivyScalaClient" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
</div>
<h4 id="signature" class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">class</span>
</span>
<span class="symbol">
<span class="name">LivyScalaClient</span><span class="result"> extends <span class="extype" name="scala.AnyRef">AnyRef</span></span>
</span>
</h4>
<div id="comment" class="fullcommenttop"><div class="comment cmt"><p>A client for submitting Spark-based jobs to a Livy backend.</p></div><div class="toggleContainer block">
<span class="toggle">Linear Supertypes</span>
<div class="superTypes hiddenContent"><span class="extype" name="scala.AnyRef">AnyRef</span>, <span class="extype" name="scala.Any">Any</span></div>
</div></div>
<div id="mbrsel">
<div id="textfilter"><span class="pre"></span><span class="input"><input id="mbrsel-input" type="text" accesskey="/" /></span><span class="post"></span></div>
<div id="order">
<span class="filtertype">Ordering</span>
<ol>
<li class="alpha in"><span>Alphabetic</span></li>
<li class="inherit out"><span>By Inheritance</span></li>
</ol>
</div>
<div id="ancestors">
<span class="filtertype">Inherited<br />
</span>
<ol id="linearization">
<li class="in" name="org.apache.livy.scalaapi.LivyScalaClient"><span>LivyScalaClient</span></li><li class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in" name="scala.Any"><span>Any</span></li>
</ol>
</div><div id="ancestors">
<span class="filtertype"></span>
<ol>
<li class="hideall out"><span>Hide All</span></li>
<li class="showall in"><span>Show All</span></li>
</ol>
</div>
<div id="visbl">
<span class="filtertype">Visibility</span>
<ol><li class="public in"><span>Public</span></li><li class="all out"><span>All</span></li></ol>
</div>
</div>
<div id="template">
<div id="allMembers">
<div id="constructors" class="members">
<h3>Instance Constructors</h3>
<ol><li name="org.apache.livy.scalaapi.LivyScalaClient#&lt;init&gt;" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="&lt;init&gt;(livyJavaClient:org.apache.livy.LivyClient):org.apache.livy.scalaapi.LivyScalaClient"></a>
<a id="&lt;init&gt;:LivyScalaClient"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">new</span>
</span>
<span class="symbol">
<span class="name">LivyScalaClient</span><span class="params">(<span name="livyJavaClient">livyJavaClient: <span class="extype" name="org.apache.livy.LivyClient">LivyClient</span></span>)</span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.livy.scalaapi.LivyScalaClient@&lt;init&gt;(livyJavaClient:org.apache.livy.LivyClient):org.apache.livy.scalaapi.LivyScalaClient" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Creates a Scala client.</p><div class="fullcomment"><div class="comment cmt"><p>Creates a Scala client.</p></div><dl class="paramcmts block"><dt class="param">livyJavaClient</dt><dd class="cmt"><p>the Java client of Livy.</p></dd></dl></div>
</li></ol>
</div>
<div id="values" class="values members">
<h3>Value Members</h3>
<ol><li name="scala.AnyRef#!=" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="!=(x$1:Any):Boolean"></a>
<a id="!=(Any):Boolean"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span title="gt4s: $bang$eq" class="name">!=</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.livy.scalaapi.LivyScalaClient@!=(x$1:Any):Boolean" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="scala.AnyRef###" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="##():Int"></a>
<a id="##():Int"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span title="gt4s: $hash$hash" class="name">##</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.livy.scalaapi.LivyScalaClient@##():Int" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="scala.AnyRef#==" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="==(x$1:Any):Boolean"></a>
<a id="==(Any):Boolean"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span title="gt4s: $eq$eq" class="name">==</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.livy.scalaapi.LivyScalaClient@==(x$1:Any):Boolean" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="org.apache.livy.scalaapi.LivyScalaClient#addFile" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="addFile(uri:java.net.URI):scala.concurrent.Future[_]"></a>
<a id="addFile(URI):Future[_]"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">addFile</span><span class="params">(<span name="uri">uri: <span class="extype" name="java.net.URI">URI</span></span>)</span><span class="result">: <span class="extype" name="scala.concurrent.Future">Future</span>[_]</span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.livy.scalaapi.LivyScalaClient@addFile(uri:java.net.URI):scala.concurrent.Future[_]" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Adds a file to the running remote context.</p><div class="fullcomment"><div class="comment cmt"><p>Adds a file to the running remote context.</p><p>Note that the URL should be reachable by the Spark driver process. If running the driver
in cluster mode, it may reside on a different host, meaning &quot;file:&quot; URLs have to exist
on that node (and not on the client machine).</p><p>If the provided URI has no scheme, it's considered to be relative to the default file system
configured in the Livy server.
</p></div><dl class="paramcmts block"><dt class="param">uri</dt><dd class="cmt"><p>The location of the file.</p></dd><dt>returns</dt><dd class="cmt"><p>A future that can be used to monitor the operation.</p></dd></dl></div>
</li><li name="org.apache.livy.scalaapi.LivyScalaClient#addJar" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="addJar(uri:java.net.URI):scala.concurrent.Future[_]"></a>
<a id="addJar(URI):Future[_]"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">addJar</span><span class="params">(<span name="uri">uri: <span class="extype" name="java.net.URI">URI</span></span>)</span><span class="result">: <span class="extype" name="scala.concurrent.Future">Future</span>[_]</span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.livy.scalaapi.LivyScalaClient@addJar(uri:java.net.URI):scala.concurrent.Future[_]" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Adds a jar file to the running remote context.</p><div class="fullcomment"><div class="comment cmt"><p>Adds a jar file to the running remote context.</p><p>Note that the URL should be reachable by the Spark driver process. If running the driver
in cluster mode, it may reside on a different host, meaning &quot;file:&quot; URLs have to exist
on that node (and not on the client machine).</p><p>If the provided URI has no scheme, it's considered to be relative to the default file system
configured in the Livy server.
</p></div><dl class="paramcmts block"><dt class="param">uri</dt><dd class="cmt"><p>The location of the jar file.</p></dd><dt>returns</dt><dd class="cmt"><p>A future that can be used to monitor the operation.</p></dd></dl></div>
</li><li name="scala.Any#asInstanceOf" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="asInstanceOf[T0]:T0"></a>
<a id="asInstanceOf[T0]:T0"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">asInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span class="extype" name="scala.Any.asInstanceOf.T0">T0</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.livy.scalaapi.LivyScalaClient@asInstanceOf[T0]:T0" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div>
</li><li name="scala.AnyRef#clone" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="clone():Object"></a>
<a id="clone():AnyRef"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">clone</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.AnyRef">AnyRef</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.livy.scalaapi.LivyScalaClient@clone():Object" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected[<a href="../../../../java$lang.html" class="extype" name="java.lang">java.lang</a>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
<span class="name">@throws</span><span class="args">(<span>
<span class="defval" name="classOf[java.lang.CloneNotSupportedException]">...</span>
</span>)</span>
</dd></dl></div>
</li><li name="scala.AnyRef#eq" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="eq(x$1:AnyRef):Boolean"></a>
<a id="eq(AnyRef):Boolean"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">eq</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.AnyRef">AnyRef</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.livy.scalaapi.LivyScalaClient@eq(x$1:AnyRef):Boolean" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
</li><li name="scala.AnyRef#equals" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="equals(x$1:Any):Boolean"></a>
<a id="equals(Any):Boolean"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Any">Any</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.livy.scalaapi.LivyScalaClient@equals(x$1:Any):Boolean" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="scala.AnyRef#finalize" visbl="prt" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="finalize():Unit"></a>
<a id="finalize():Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">finalize</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.livy.scalaapi.LivyScalaClient@finalize():Unit" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Attributes</dt><dd>protected[<a href="../../../../java$lang.html" class="extype" name="java.lang">java.lang</a>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
<span class="name">@throws</span><span class="args">(<span>
<span class="symbol">classOf[java.lang.Throwable]</span>
</span>)</span>
</dd></dl></div>
</li><li name="scala.AnyRef#getClass" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="getClass():Class[_]"></a>
<a id="getClass():Class[_]"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">getClass</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.Class">Class</span>[_]</span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.livy.scalaapi.LivyScalaClient@getClass():Class[_]" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="scala.AnyRef#hashCode" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="hashCode():Int"></a>
<a id="hashCode():Int"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">hashCode</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Int">Int</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.livy.scalaapi.LivyScalaClient@hashCode():Int" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="scala.Any#isInstanceOf" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="isInstanceOf[T0]:Boolean"></a>
<a id="isInstanceOf[T0]:Boolean"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">isInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.livy.scalaapi.LivyScalaClient@isInstanceOf[T0]:Boolean" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>Any</dd></dl></div>
</li><li name="scala.AnyRef#ne" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="ne(x$1:AnyRef):Boolean"></a>
<a id="ne(AnyRef):Boolean"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">ne</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.AnyRef">AnyRef</span></span>)</span><span class="result">: <span class="extype" name="scala.Boolean">Boolean</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.livy.scalaapi.LivyScalaClient@ne(x$1:AnyRef):Boolean" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
</li><li name="scala.AnyRef#notify" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="notify():Unit"></a>
<a id="notify():Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">notify</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.livy.scalaapi.LivyScalaClient@notify():Unit" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
</li><li name="scala.AnyRef#notifyAll" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="notifyAll():Unit"></a>
<a id="notifyAll():Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">notifyAll</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.livy.scalaapi.LivyScalaClient@notifyAll():Unit" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
</li><li name="org.apache.livy.scalaapi.LivyScalaClient#run" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="run[T](fn:org.apache.livy.scalaapi.ScalaJobContext=&gt;T):scala.concurrent.Future[T]"></a>
<a id="run[T]((ScalaJobContext)⇒T):Future[T]"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">run</span><span class="tparams">[<span name="T">T</span>]</span><span class="params">(<span name="fn">fn: (<a href="ScalaJobContext.html" class="extype" name="org.apache.livy.scalaapi.ScalaJobContext">ScalaJobContext</a>) ⇒ <span class="extype" name="org.apache.livy.scalaapi.LivyScalaClient.run.T">T</span></span>)</span><span class="result">: <span class="extype" name="scala.concurrent.Future">Future</span>[<span class="extype" name="org.apache.livy.scalaapi.LivyScalaClient.run.T">T</span>]</span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.livy.scalaapi.LivyScalaClient@run[T](fn:org.apache.livy.scalaapi.ScalaJobContext=&gt;T):scala.concurrent.Future[T]" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Asks the remote context to run a job immediately.</p><div class="fullcomment"><div class="comment cmt"><p>Asks the remote context to run a job immediately.</p><p>Normally, the remote context will queue jobs and execute them based on how many worker
threads have been configured. This method will run the submitted job in the same thread
processing the RPC message, so that queueing does not apply.</p><p>It's recommended that this method only be used to run code that finishes quickly. This
avoids interfering with the normal operation of the context.
</p></div><dl class="paramcmts block"><dt class="param">fn</dt><dd class="cmt"><p>The job to be executed. It is a function that takes in a ScalaJobContext and
returns the result of the execution of the job with that context.</p></dd><dt>returns</dt><dd class="cmt"><p>A handle that can be used to monitor the job.</p></dd></dl></div>
</li><li name="org.apache.livy.scalaapi.LivyScalaClient#stop" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="stop(shutdownContext:Boolean):Unit"></a>
<a id="stop(Boolean):Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">stop</span><span class="params">(<span name="shutdownContext">shutdownContext: <span class="extype" name="scala.Boolean">Boolean</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.livy.scalaapi.LivyScalaClient@stop(shutdownContext:Boolean):Unit" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Stops the remote context.</p><div class="fullcomment"><div class="comment cmt"><p>Stops the remote context.</p><p>Any pending jobs will be cancelled, and the remote context will be torn down.
</p></div><dl class="paramcmts block"><dt class="param">shutdownContext</dt><dd class="cmt"><p>Whether to shutdown the underlying Spark context. If false, the
context will keep running and it's still possible to send commands
to it, if the backend being used supports it.</p></dd></dl></div>
</li><li name="org.apache.livy.scalaapi.LivyScalaClient#submit" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="submit[T](fn:org.apache.livy.scalaapi.ScalaJobContext=&gt;T):org.apache.livy.scalaapi.ScalaJobHandle[T]"></a>
<a id="submit[T]((ScalaJobContext)⇒T):ScalaJobHandle[T]"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">submit</span><span class="tparams">[<span name="T">T</span>]</span><span class="params">(<span name="fn">fn: (<a href="ScalaJobContext.html" class="extype" name="org.apache.livy.scalaapi.ScalaJobContext">ScalaJobContext</a>) ⇒ <span class="extype" name="org.apache.livy.scalaapi.LivyScalaClient.submit.T">T</span></span>)</span><span class="result">: <a href="ScalaJobHandle.html" class="extype" name="org.apache.livy.scalaapi.ScalaJobHandle">ScalaJobHandle</a>[<span class="extype" name="org.apache.livy.scalaapi.LivyScalaClient.submit.T">T</span>]</span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.livy.scalaapi.LivyScalaClient@submit[T](fn:org.apache.livy.scalaapi.ScalaJobContext=&gt;T):org.apache.livy.scalaapi.ScalaJobHandle[T]" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Submits a job for asynchronous execution.</p><div class="fullcomment"><div class="comment cmt"><p>Submits a job for asynchronous execution.
</p></div><dl class="paramcmts block"><dt class="param">fn</dt><dd class="cmt"><p>The job to be executed. It is a function that takes in a ScalaJobContext and
returns the result of the execution of the job with that context.</p></dd><dt>returns</dt><dd class="cmt"><p>A handle that can be used to monitor the job.</p></dd></dl></div>
</li><li name="scala.AnyRef#synchronized" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="synchronized[T0](x$1:=&gt;T0):T0"></a>
<a id="synchronized[T0](⇒T0):T0"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">synchronized</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="params">(<span name="arg0">arg0: ⇒ <span class="extype" name="java.lang.AnyRef.synchronized.T0">T0</span></span>)</span><span class="result">: <span class="extype" name="java.lang.AnyRef.synchronized.T0">T0</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.livy.scalaapi.LivyScalaClient@synchronized[T0](x$1:=&gt;T0):T0" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd></dl></div>
</li><li name="scala.AnyRef#toString" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="toString():String"></a>
<a id="toString():String"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">toString</span><span class="params">()</span><span class="result">: <span class="extype" name="java.lang.String">String</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.livy.scalaapi.LivyScalaClient@toString():String" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div>
</li><li name="org.apache.livy.scalaapi.LivyScalaClient#uploadFile" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="uploadFile(file:java.io.File):scala.concurrent.Future[_]"></a>
<a id="uploadFile(File):Future[_]"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">uploadFile</span><span class="params">(<span name="file">file: <span class="extype" name="java.io.File">File</span></span>)</span><span class="result">: <span class="extype" name="scala.concurrent.Future">Future</span>[_]</span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.livy.scalaapi.LivyScalaClient@uploadFile(file:java.io.File):scala.concurrent.Future[_]" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Upload a file to be passed to the Spark application.</p><div class="fullcomment"><div class="comment cmt"><p>Upload a file to be passed to the Spark application.
</p></div><dl class="paramcmts block"><dt class="param">file</dt><dd class="cmt"><p>The local file to be uploaded.</p></dd><dt>returns</dt><dd class="cmt"><p>A future that can be used to monitor this operation.</p></dd></dl></div>
</li><li name="org.apache.livy.scalaapi.LivyScalaClient#uploadJar" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="uploadJar(jar:java.io.File):scala.concurrent.Future[_]"></a>
<a id="uploadJar(File):Future[_]"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier"></span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">uploadJar</span><span class="params">(<span name="jar">jar: <span class="extype" name="java.io.File">File</span></span>)</span><span class="result">: <span class="extype" name="scala.concurrent.Future">Future</span>[_]</span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.livy.scalaapi.LivyScalaClient@uploadJar(jar:java.io.File):scala.concurrent.Future[_]" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<p class="shortcomment cmt">Upload a jar to be added to the Spark application classpath.</p><div class="fullcomment"><div class="comment cmt"><p>Upload a jar to be added to the Spark application classpath.
</p></div><dl class="paramcmts block"><dt class="param">jar</dt><dd class="cmt"><p>The local file to be uploaded.</p></dd><dt>returns</dt><dd class="cmt"><p>A future that can be used to monitor this operation.</p></dd></dl></div>
</li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="wait():Unit"></a>
<a id="wait():Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">wait</span><span class="params">()</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.livy.scalaapi.LivyScalaClient@wait():Unit" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
<span class="name">@throws</span><span class="args">(<span>
<span class="defval" name="classOf[java.lang.InterruptedException]">...</span>
</span>)</span>
</dd></dl></div>
</li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="wait(x$1:Long,x$2:Int):Unit"></a>
<a id="wait(Long,Int):Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">wait</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Long">Long</span></span>, <span name="arg1">arg1: <span class="extype" name="scala.Int">Int</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.livy.scalaapi.LivyScalaClient@wait(x$1:Long,x$2:Int):Unit" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
<span class="name">@throws</span><span class="args">(<span>
<span class="defval" name="classOf[java.lang.InterruptedException]">...</span>
</span>)</span>
</dd></dl></div>
</li><li name="scala.AnyRef#wait" visbl="pub" data-isabs="false" fullComment="yes" group="Ungrouped">
<a id="wait(x$1:Long):Unit"></a>
<a id="wait(Long):Unit"></a>
<h4 class="signature">
<span class="modifier_kind">
<span class="modifier">final </span>
<span class="kind">def</span>
</span>
<span class="symbol">
<span class="name">wait</span><span class="params">(<span name="arg0">arg0: <span class="extype" name="scala.Long">Long</span></span>)</span><span class="result">: <span class="extype" name="scala.Unit">Unit</span></span>
</span>
</h4><span class="permalink">
<a href="../../../../index.html#org.apache.livy.scalaapi.LivyScalaClient@wait(x$1:Long):Unit" title="Permalink" target="_top">
<img src="../../../../lib/permalink.png" alt="Permalink" />
</a>
</span>
<div class="fullcomment"><dl class="attributes block"> <dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd>
<span class="name">@throws</span><span class="args">(<span>
<span class="defval" name="classOf[java.lang.InterruptedException]">...</span>
</span>)</span>
</dd></dl></div>
</li></ol>
</div>
</div>
<div id="inheritedMembers">
<div class="parent" name="scala.AnyRef">
<h3>Inherited from <span class="extype" name="scala.AnyRef">AnyRef</span></h3>
</div><div class="parent" name="scala.Any">
<h3>Inherited from <span class="extype" name="scala.Any">Any</span></h3>
</div>
</div>
<div id="groupedMembers">
<div class="group" name="Ungrouped">
<h3>Ungrouped</h3>
</div>
</div>
</div>
<div id="tooltip"></div>
<div id="footer"> </div>
</body>
</html>