blob: dc9e76be2098372eda90ff27a4292a8d7da53760 [file] [log] [blame]
<!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_40) on Thu Jul 20 13:17:48 PDT 2017 -->
<title>JobInfoPrintUtils (gobblin-admin 0.11.0 API)</title>
<meta name="date" content="2017-07-20">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="JobInfoPrintUtils (gobblin-admin 0.11.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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="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="../../gobblin/cli/JobCommand.html" title="class in gobblin.cli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../index.html?gobblin/cli/JobInfoPrintUtils.html" target="_top">Frames</a></li>
<li><a href="JobInfoPrintUtils.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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">gobblin.cli</div>
<h2 title="Class JobInfoPrintUtils" class="title">Class JobInfoPrintUtils</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>gobblin.cli.JobInfoPrintUtils</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">JobInfoPrintUtils</span>
extends <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Utility methods to print out various pieces of info about jobs</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../gobblin/cli/JobInfoPrintUtils.html#JobInfoPrintUtils--">JobInfoPrintUtils</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>static <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../gobblin/cli/JobInfoPrintUtils.html#extractJobSchedule-gobblin.rest.JobExecutionInfo-">extractJobSchedule</a></span>(<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-rest-client/gobblin/rest/JobExecutionInfo.html?is-external=true" title="class or interface in gobblin.rest">JobExecutionInfo</a>&nbsp;jobInfo)</code>
<div class="block">Extracts the schedule from a job execution.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../gobblin/cli/JobInfoPrintUtils.html#printAllJobs-java.util.List-int-">printAllJobs</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-rest-client/gobblin/rest/JobExecutionInfo.html?is-external=true" title="class or interface in gobblin.rest">JobExecutionInfo</a>&gt;&nbsp;jobExecutionInfos,
int&nbsp;resultsLimit)</code>
<div class="block">Print summary information about a bunch of jobs in the system</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../gobblin/cli/JobInfoPrintUtils.html#printJob-com.google.common.base.Optional-">printJob</a></span>(<a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/base/Optional.html?is-external=true" title="class or interface in com.google.common.base">Optional</a>&lt;<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-rest-client/gobblin/rest/JobExecutionInfo.html?is-external=true" title="class or interface in gobblin.rest">JobExecutionInfo</a>&gt;&nbsp;jobExecutionInfoOptional)</code>
<div class="block">Print information about one specific job.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../gobblin/cli/JobInfoPrintUtils.html#printJobProperties-com.google.common.base.Optional-">printJobProperties</a></span>(<a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/base/Optional.html?is-external=true" title="class or interface in com.google.common.base">Optional</a>&lt;<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-rest-client/gobblin/rest/JobExecutionInfo.html?is-external=true" title="class or interface in gobblin.rest">JobExecutionInfo</a>&gt;&nbsp;jobExecutionInfoOptional)</code>
<div class="block">Print properties of a specific job</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../gobblin/cli/JobInfoPrintUtils.html#printJobRuns-java.util.List-">printJobRuns</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-rest-client/gobblin/rest/JobExecutionInfo.html?is-external=true" title="class or interface in gobblin.rest">JobExecutionInfo</a>&gt;&nbsp;jobExecutionInfos)</code>
<div class="block">Print a table describing a bunch of individual job executions.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="JobInfoPrintUtils--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>JobInfoPrintUtils</h4>
<pre>public&nbsp;JobInfoPrintUtils()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="extractJobSchedule-gobblin.rest.JobExecutionInfo-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>extractJobSchedule</h4>
<pre>public static&nbsp;<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;extractJobSchedule(<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-rest-client/gobblin/rest/JobExecutionInfo.html?is-external=true" title="class or interface in gobblin.rest">JobExecutionInfo</a>&nbsp;jobInfo)</pre>
<div class="block">Extracts the schedule from a job execution.
<p/>
If the job was in run once mode, it will return that, otherwise it will return the schedule.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jobInfo</code> - A job execution info to extract from</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>"RUN_ONCE", the Quartz schedule string, or "UNKNOWN" if there were no job properties</dd>
</dl>
</li>
</ul>
<a name="printJobRuns-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>printJobRuns</h4>
<pre>public static&nbsp;void&nbsp;printJobRuns(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-rest-client/gobblin/rest/JobExecutionInfo.html?is-external=true" title="class or interface in gobblin.rest">JobExecutionInfo</a>&gt;&nbsp;jobExecutionInfos)</pre>
<div class="block">Print a table describing a bunch of individual job executions.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jobExecutionInfos</code> - Job execution status to print</dd>
</dl>
</li>
</ul>
<a name="printAllJobs-java.util.List-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>printAllJobs</h4>
<pre>public static&nbsp;void&nbsp;printAllJobs(<a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-rest-client/gobblin/rest/JobExecutionInfo.html?is-external=true" title="class or interface in gobblin.rest">JobExecutionInfo</a>&gt;&nbsp;jobExecutionInfos,
int&nbsp;resultsLimit)</pre>
<div class="block">Print summary information about a bunch of jobs in the system</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jobExecutionInfos</code> - List of jobs</dd>
<dd><code>resultsLimit</code> - original result limit</dd>
</dl>
</li>
</ul>
<a name="printJob-com.google.common.base.Optional-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>printJob</h4>
<pre>public static&nbsp;void&nbsp;printJob(<a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/base/Optional.html?is-external=true" title="class or interface in com.google.common.base">Optional</a>&lt;<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-rest-client/gobblin/rest/JobExecutionInfo.html?is-external=true" title="class or interface in gobblin.rest">JobExecutionInfo</a>&gt;&nbsp;jobExecutionInfoOptional)</pre>
<div class="block">Print information about one specific job.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jobExecutionInfoOptional</code> - Job info to print</dd>
</dl>
</li>
</ul>
<a name="printJobProperties-com.google.common.base.Optional-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>printJobProperties</h4>
<pre>public static&nbsp;void&nbsp;printJobProperties(<a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/base/Optional.html?is-external=true" title="class or interface in com.google.common.base">Optional</a>&lt;<a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-rest-client/gobblin/rest/JobExecutionInfo.html?is-external=true" title="class or interface in gobblin.rest">JobExecutionInfo</a>&gt;&nbsp;jobExecutionInfoOptional)</pre>
<div class="block">Print properties of a specific job</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>jobExecutionInfoOptional</code> - </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="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="../../gobblin/cli/JobCommand.html" title="class in gobblin.cli"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../index.html?gobblin/cli/JobInfoPrintUtils.html" target="_top">Frames</a></li>
<li><a href="JobInfoPrintUtils.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>