| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_261) on Sat Sep 11 21:19:59 MSK 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ComputeJobContext (Ignite 2.11.0)</title> |
| <meta name="date" content="2021-09-11"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <link rel='shortcut icon' href='https://ignite.apache.org/favicon.ico'/> |
| </head> |
| |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ComputeJobContext (Ignite 2.11.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ComputeJobContext.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/ignite/compute/ComputeJobBeforeFailover.html" title="annotation in org.apache.ignite.compute"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html" title="interface in org.apache.ignite.compute"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/ignite/compute/ComputeJobContext.html" target="_top">Frames</a></li> |
| <li><a href="ComputeJobContext.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.ignite.compute</div> |
| <h2 title="Interface ComputeJobContext" class="title">Interface ComputeJobContext</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html" title="interface in org.apache.ignite.compute">ComputeJobContinuation</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">ComputeJobContext</span> |
| extends <a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html" title="interface in org.apache.ignite.compute">ComputeJobContinuation</a></pre> |
| <div class="block">Context attached to every job executed on the grid. Note that unlike |
| <a href="../../../../org/apache/ignite/compute/ComputeTaskSession.html" title="interface in org.apache.ignite.compute"><code>ComputeTaskSession</code></a>, which distributes all attributes to all jobs |
| in the task including the task itself, job context attributes belong |
| to a job and do not get sent over network unless a job moves from one |
| node to another. |
| <p> |
| In most cases a job, once assigned to a node, will never move to another |
| node. However, it is possible that collision SPI rejects a job before |
| it ever got a chance to execute (job rejection) which will cause fail-over |
| to another node. Or user is not satisfied with the outcome of a job and |
| fails it over to another node by returning <a href="../../../../org/apache/ignite/compute/ComputeJobResultPolicy.html#FAILOVER"><code>ComputeJobResultPolicy.FAILOVER</code></a> |
| policy from <a href="../../../../org/apache/ignite/compute/ComputeTask.html#result-org.apache.ignite.compute.ComputeJobResult-java.util.List-"><code>ComputeTask.result(ComputeJobResult, List)</code></a> method. In this case |
| all context attributes set on one node will be available on any other node |
| this job travels to. |
| <p> |
| You can also use <code>ComputeJobContext</code> to communicate between SPI's and jobs. |
| For example, if you need to cancel an actively running job from <a href="../../../../org/apache/ignite/spi/collision/CollisionSpi.html" title="interface in org.apache.ignite.spi.collision"><code>CollisionSpi</code></a> |
| you may choose to set some context attribute on the job to mark the fact |
| that a job was cancelled by grid and not by a user. Context attributes can |
| also be assigned in <a href="../../../../org/apache/ignite/spi/failover/FailoverSpi.html" title="interface in org.apache.ignite.spi.failover"><code>FailoverSpi</code></a> prior to failing over a job. |
| <p> |
| From within <a href="../../../../org/apache/ignite/compute/ComputeTask.html#result-org.apache.ignite.compute.ComputeJobResult-java.util.List-"><code>ComputeTask.result(ComputeJobResult, List)</code></a> or <a href="../../../../org/apache/ignite/compute/ComputeTask.html#reduce-java.util.List-"><code>ComputeTask.reduce(List)</code></a> methods, |
| job context is available via <a href="../../../../org/apache/ignite/compute/ComputeJobResult.html#getJobContext--"><code>ComputeJobResult.getJobContext()</code></a> method which gives user the |
| ability to check context attributes from within grid task implementation for every job |
| returned from remote nodes. |
| <p> |
| Job context can be injected into <a href="../../../../org/apache/ignite/compute/ComputeJob.html" title="interface in org.apache.ignite.compute"><code>ComputeJob</code></a> via <a href="../../../../org/apache/ignite/resources/JobContextResource.html" title="annotation in org.apache.ignite.resources"><code>JobContextResource</code></a> |
| annotation. Refer to the <a href="../../../../org/apache/ignite/resources/JobContextResource.html" title="annotation in org.apache.ignite.resources"><code>JobContextResource</code></a> |
| documentation for coding examples on how to inject job context. |
| <p> |
| Attribute names that start with <code>"apache.ignite:"</code> are reserved for internal system use.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><span class='angle_bracket'><</span>K,V<span class='angle_bracket'>></span> V</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/compute/ComputeJobContext.html#getAttribute-K-">getAttribute</a></span>(K key)</code> |
| <div class="block">Gets attribute from this job context.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><span class='angle_bracket'><</span>?,?<span class='angle_bracket'>></span></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/compute/ComputeJobContext.html#getAttributes--">getAttributes</a></span>()</code> |
| <div class="block">Gets all attributes present in this job context.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/ignite/lang/IgniteUuid.html" title="class in org.apache.ignite.lang">IgniteUuid</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/compute/ComputeJobContext.html#getJobId--">getJobId</a></span>()</code> |
| <div class="block">Gets ID of the job this context belongs to.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/compute/ComputeJobContext.html#setAttribute-java.lang.Object-java.lang.Object-">setAttribute</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> key, |
| @Nullable <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> val)</code> |
| <div class="block">Sets an attribute into this job context.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/compute/ComputeJobContext.html#setAttributes-java.util.Map-">setAttributes</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><span class='angle_bracket'><</span>?,?<span class='angle_bracket'>></span> attrs)</code> |
| <div class="block">Sets map of attributes into this job context.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.ignite.compute.ComputeJobContinuation"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.ignite.compute.<a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html" title="interface in org.apache.ignite.compute">ComputeJobContinuation</a></h3> |
| <code><a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html#callcc--">callcc</a>, <a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html#heldcc--">heldcc</a>, <a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html#holdcc--">holdcc</a>, <a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html#holdcc-long-">holdcc</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getJobId--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getJobId</h4> |
| <pre><a href="../../../../org/apache/ignite/lang/IgniteUuid.html" title="class in org.apache.ignite.lang">IgniteUuid</a> getJobId()</pre> |
| <div class="block">Gets ID of the job this context belongs to.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>ID of the job this context belongs to.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setAttribute-java.lang.Object-java.lang.Object-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAttribute</h4> |
| <pre>void setAttribute(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> key, |
| @Nullable |
| @Nullable <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> val)</pre> |
| <div class="block">Sets an attribute into this job context.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - Attribute key.</dd> |
| <dd><code>val</code> - Attribute value.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setAttributes-java.util.Map-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setAttributes</h4> |
| <pre>void setAttributes(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><span class='angle_bracket'><</span>?,?<span class='angle_bracket'>></span> attrs)</pre> |
| <div class="block">Sets map of attributes into this job context.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>attrs</code> - Local attributes.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAttribute-java.lang.Object-"> |
| <!-- --> |
| </a><a name="getAttribute-K-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAttribute</h4> |
| <pre><span class='angle_bracket'><</span>K,V<span class='angle_bracket'>></span> V getAttribute(K key)</pre> |
| <div class="block">Gets attribute from this job context.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>K</code> - Type of the attribute key.</dd> |
| <dd><code>V</code> - Type of the attribute value.</dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>key</code> - Attribute key.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Attribute value (possibly <code>null</code>).</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAttributes--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getAttributes</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><span class='angle_bracket'><</span>?,?<span class='angle_bracket'>></span> getAttributes()</pre> |
| <div class="block">Gets all attributes present in this job context.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>All attributes.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ComputeJobContext.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/ignite/compute/ComputeJobBeforeFailover.html" title="annotation in org.apache.ignite.compute"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/ignite/compute/ComputeJobContinuation.html" title="interface in org.apache.ignite.compute"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/ignite/compute/ComputeJobContext.html" target="_top">Frames</a></li> |
| <li><a href="ComputeJobContext.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small><table width="100%" border="0" cellspacing=0 cellpadding=0 style="padding: 5px"> <tr> <td> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <a target=_blank href="https://ignite.apache.org"><nobr>2021 Copyright © Apache Software Foundation</nobr></a> </td> </tr> </tbody> </table> </td> <td width="100%" align="right" valign="center"> <a href="https://twitter.com/ApacheIgnite" class="twitter-follow-button" data-show-count="false" data-size="large">Follow @ApacheIgnite</a> </td> </tr> <tr> <td colspan="2" valign="top" align="left"> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <b>Ignite Database and Caching Platform</b> </td> <td>: ver. <strong>2.11.0</strong> </td> </tr> <tr style="padding: 0; margin: 0"> <td> <b>Release Date</b> </td> <td>: September 11 2021 </td> </tr> </tbody> </table> </td> </tr> </table></small></p> |
| </body> |
| </html> |
