| <!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:49 PDT 2017 --> |
| <title>Index (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="Index (gobblin-admin 0.11.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </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>Package</li> |
| <li>Class</li> |
| <li><a href="overview-tree.html">Tree</a></li> |
| <li><a href="deprecated-list.html">Deprecated</a></li> |
| <li class="navBarCell1Rev">Index</li> |
| <li><a href="help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev</li> |
| <li>Next</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="index.html?index-all.html" target="_top">Frames</a></li> |
| <li><a href="index-all.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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="contentContainer"><a href="#I:A">A</a> <a href="#I:B">B</a> <a href="#I:C">C</a> <a href="#I:D">D</a> <a href="#I:E">E</a> <a href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:I">I</a> <a href="#I:J">J</a> <a href="#I:L">L</a> <a href="#I:M">M</a> <a href="#I:P">P</a> <a href="#I:Q">Q</a> <a href="#I:S">S</a> <a name="I:A"> |
| <!-- --> |
| </a> |
| <h2 class="title">A</h2> |
| <dl> |
| <dt><a href="gobblin/cli/AdminClient.html" title="class in gobblin.cli"><span class="typeNameLink">AdminClient</span></a> - Class in <a href="gobblin/cli/package-summary.html">gobblin.cli</a></dt> |
| <dd> |
| <div class="block">Simple wrapper around the JobExecutionInfoClient</div> |
| </dd> |
| <dt><span class="memberNameLink"><a href="gobblin/cli/AdminClient.html#AdminClient-java.lang.String-int-">AdminClient(String, int)</a></span> - Constructor for class gobblin.cli.<a href="gobblin/cli/AdminClient.html" title="class in gobblin.cli">AdminClient</a></dt> |
| <dd> |
| <div class="block">Creates a new client with the host and port specified.</div> |
| </dd> |
| <dt><a href="gobblin/admin/AdminWebServer.html" title="class in gobblin.admin"><span class="typeNameLink">AdminWebServer</span></a> - Class in <a href="gobblin/admin/package-summary.html">gobblin.admin</a></dt> |
| <dd> |
| <div class="block">Serves the admin UI interface using embedded Jetty.</div> |
| </dd> |
| <dt><span class="memberNameLink"><a href="gobblin/admin/AdminWebServer.html#AdminWebServer-java.util.Properties-java.net.URI-">AdminWebServer(Properties, URI)</a></span> - Constructor for class gobblin.admin.<a href="gobblin/admin/AdminWebServer.html" title="class in gobblin.admin">AdminWebServer</a></dt> |
| <dd> </dd> |
| </dl> |
| <a name="I:B"> |
| <!-- --> |
| </a> |
| <h2 class="title">B</h2> |
| <dl> |
| <dt><span class="memberNameLink"><a href="gobblin/cli/CliTablePrinter.Builder.html#build--">build()</a></span> - Method in class gobblin.cli.<a href="gobblin/cli/CliTablePrinter.Builder.html" title="class in gobblin.cli">CliTablePrinter.Builder</a></dt> |
| <dd> </dd> |
| <dt><span class="memberNameLink"><a href="gobblin/cli/CliTablePrinter.Builder.html#Builder--">Builder()</a></span> - Constructor for class gobblin.cli.<a href="gobblin/cli/CliTablePrinter.Builder.html" title="class in gobblin.cli">CliTablePrinter.Builder</a></dt> |
| <dd> </dd> |
| </dl> |
| <a name="I:C"> |
| <!-- --> |
| </a> |
| <h2 class="title">C</h2> |
| <dl> |
| <dt><a href="gobblin/cli/Cli.html" title="class in gobblin.cli"><span class="typeNameLink">Cli</span></a> - Class in <a href="gobblin/cli/package-summary.html">gobblin.cli</a></dt> |
| <dd> |
| <div class="block">A command line interface for interacting with Gobblin.</div> |
| </dd> |
| <dt><span class="memberNameLink"><a href="gobblin/cli/Cli.html#Cli-java.lang.String:A-">Cli(String[])</a></span> - Constructor for class gobblin.cli.<a href="gobblin/cli/Cli.html" title="class in gobblin.cli">Cli</a></dt> |
| <dd> |
| <div class="block">Create a new Cli object.</div> |
| </dd> |
| <dt><a href="gobblin/cli/CliTablePrinter.html" title="class in gobblin.cli"><span class="typeNameLink">CliTablePrinter</span></a> - Class in <a href="gobblin/cli/package-summary.html">gobblin.cli</a></dt> |
| <dd> |
| <div class="block">A format helper for CLI output.</div> |
| </dd> |
| <dt><span class="memberNameLink"><a href="gobblin/cli/CliTablePrinter.html#CliTablePrinter-java.util.List-java.util.List-int-int-java.util.List-">CliTablePrinter(List<String>, List<String>, int, int, List<List<String>>)</a></span> - Constructor for class gobblin.cli.<a href="gobblin/cli/CliTablePrinter.html" title="class in gobblin.cli">CliTablePrinter</a></dt> |
| <dd> </dd> |
| <dt><a href="gobblin/cli/CliTablePrinter.Builder.html" title="class in gobblin.cli"><span class="typeNameLink">CliTablePrinter.Builder</span></a> - Class in <a href="gobblin/cli/package-summary.html">gobblin.cli</a></dt> |
| <dd> |
| <div class="block">Used to build a <a href="gobblin/cli/CliTablePrinter.html" title="class in gobblin.cli"><code>CliTablePrinter</code></a> object.</div> |
| </dd> |
| <dt><span class="memberNameLink"><a href="gobblin/cli/AdminClient.html#close--">close()</a></span> - Method in class gobblin.cli.<a href="gobblin/cli/AdminClient.html" title="class in gobblin.cli">AdminClient</a></dt> |
| <dd> |
| <div class="block">Close connections to the REST server</div> |
| </dd> |
| <dt><a href="gobblin/cli/Command.html" title="interface in gobblin.cli"><span class="typeNameLink">Command</span></a> - Interface in <a href="gobblin/cli/package-summary.html">gobblin.cli</a></dt> |
| <dd> |
| <div class="block">Represents a single command for the CLI</div> |
| </dd> |
| </dl> |
| <a name="I:D"> |
| <!-- --> |
| </a> |
| <h2 class="title">D</h2> |
| <dl> |
| <dt><span class="memberNameLink"><a href="gobblin/cli/CliTablePrinter.Builder.html#data-java.util.List-">data(List<List<String>>)</a></span> - Method in class gobblin.cli.<a href="gobblin/cli/CliTablePrinter.Builder.html" title="class in gobblin.cli">CliTablePrinter.Builder</a></dt> |
| <dd> </dd> |
| <dt><span class="memberNameLink"><a href="gobblin/cli/CliTablePrinter.Builder.html#delimiterWidth-int-">delimiterWidth(int)</a></span> - Method in class gobblin.cli.<a href="gobblin/cli/CliTablePrinter.Builder.html" title="class in gobblin.cli">CliTablePrinter.Builder</a></dt> |
| <dd> </dd> |
| </dl> |
| <a name="I:E"> |
| <!-- --> |
| </a> |
| <h2 class="title">E</h2> |
| <dl> |
| <dt><span class="memberNameLink"><a href="gobblin/cli/Command.html#execute-gobblin.cli.Cli.GlobalOptions-java.lang.String:A-">execute(Cli.GlobalOptions, String[])</a></span> - Method in interface gobblin.cli.<a href="gobblin/cli/Command.html" title="interface in gobblin.cli">Command</a></dt> |
| <dd> </dd> |
| <dt><span class="memberNameLink"><a href="gobblin/cli/JobCommand.html#execute-gobblin.cli.Cli.GlobalOptions-java.lang.String:A-">execute(Cli.GlobalOptions, String[])</a></span> - Method in class gobblin.cli.<a href="gobblin/cli/JobCommand.html" title="class in gobblin.cli">JobCommand</a></dt> |
| <dd> </dd> |
| <dt><span class="memberNameLink"><a href="gobblin/cli/JobInfoPrintUtils.html#extractJobSchedule-gobblin.rest.JobExecutionInfo-">extractJobSchedule(JobExecutionInfo)</a></span> - Static method in class gobblin.cli.<a href="gobblin/cli/JobInfoPrintUtils.html" title="class in gobblin.cli">JobInfoPrintUtils</a></dt> |
| <dd> |
| <div class="block">Extracts the schedule from a job execution.</div> |
| </dd> |
| </dl> |
| <a name="I:F"> |
| <!-- --> |
| </a> |
| <h2 class="title">F</h2> |
| <dl> |
| <dt><span class="memberNameLink"><a href="gobblin/cli/CliTablePrinter.Builder.html#flags-java.util.List-">flags(List<String>)</a></span> - Method in class gobblin.cli.<a href="gobblin/cli/CliTablePrinter.Builder.html" title="class in gobblin.cli">CliTablePrinter.Builder</a></dt> |
| <dd> </dd> |
| </dl> |
| <a name="I:G"> |
| <!-- --> |
| </a> |
| <h2 class="title">G</h2> |
| <dl> |
| <dt><span class="memberNameLink"><a href="gobblin/cli/Cli.html#getCommandNames--">getCommandNames()</a></span> - Static method in class gobblin.cli.<a href="gobblin/cli/Cli.html" title="class in gobblin.cli">Cli</a></dt> |
| <dd> |
| <div class="block">Get the list of valid command names</div> |
| </dd> |
| <dt><a href="gobblin/admin/package-summary.html">gobblin.admin</a> - package gobblin.admin</dt> |
| <dd> </dd> |
| <dt><a href="gobblin/cli/package-summary.html">gobblin.cli</a> - package gobblin.cli</dt> |
| <dd> </dd> |
| </dl> |
| <a name="I:I"> |
| <!-- --> |
| </a> |
| <h2 class="title">I</h2> |
| <dl> |
| <dt><span class="memberNameLink"><a href="gobblin/cli/CliTablePrinter.Builder.html#indentation-int-">indentation(int)</a></span> - Method in class gobblin.cli.<a href="gobblin/cli/CliTablePrinter.Builder.html" title="class in gobblin.cli">CliTablePrinter.Builder</a></dt> |
| <dd> </dd> |
| </dl> |
| <a name="I:J"> |
| <!-- --> |
| </a> |
| <h2 class="title">J</h2> |
| <dl> |
| <dt><a href="gobblin/cli/JobCommand.html" title="class in gobblin.cli"><span class="typeNameLink">JobCommand</span></a> - Class in <a href="gobblin/cli/package-summary.html">gobblin.cli</a></dt> |
| <dd> |
| <div class="block">Logic to print out job state</div> |
| </dd> |
| <dt><span class="memberNameLink"><a href="gobblin/cli/JobCommand.html#JobCommand--">JobCommand()</a></span> - Constructor for class gobblin.cli.<a href="gobblin/cli/JobCommand.html" title="class in gobblin.cli">JobCommand</a></dt> |
| <dd> </dd> |
| <dt><a href="gobblin/cli/JobInfoPrintUtils.html" title="class in gobblin.cli"><span class="typeNameLink">JobInfoPrintUtils</span></a> - Class in <a href="gobblin/cli/package-summary.html">gobblin.cli</a></dt> |
| <dd> |
| <div class="block">Utility methods to print out various pieces of info about jobs</div> |
| </dd> |
| <dt><span class="memberNameLink"><a href="gobblin/cli/JobInfoPrintUtils.html#JobInfoPrintUtils--">JobInfoPrintUtils()</a></span> - Constructor for class gobblin.cli.<a href="gobblin/cli/JobInfoPrintUtils.html" title="class in gobblin.cli">JobInfoPrintUtils</a></dt> |
| <dd> </dd> |
| </dl> |
| <a name="I:L"> |
| <!-- --> |
| </a> |
| <h2 class="title">L</h2> |
| <dl> |
| <dt><span class="memberNameLink"><a href="gobblin/cli/CliTablePrinter.Builder.html#labels-java.util.List-">labels(List<String>)</a></span> - Method in class gobblin.cli.<a href="gobblin/cli/CliTablePrinter.Builder.html" title="class in gobblin.cli">CliTablePrinter.Builder</a></dt> |
| <dd> </dd> |
| </dl> |
| <a name="I:M"> |
| <!-- --> |
| </a> |
| <h2 class="title">M</h2> |
| <dl> |
| <dt><span class="memberNameLink"><a href="gobblin/cli/Cli.html#main-java.lang.String:A-">main(String[])</a></span> - Static method in class gobblin.cli.<a href="gobblin/cli/Cli.html" title="class in gobblin.cli">Cli</a></dt> |
| <dd> </dd> |
| </dl> |
| <a name="I:P"> |
| <!-- --> |
| </a> |
| <h2 class="title">P</h2> |
| <dl> |
| <dt><span class="memberNameLink"><a href="gobblin/cli/Cli.html#parseAndExecuteCommand--">parseAndExecuteCommand()</a></span> - Method in class gobblin.cli.<a href="gobblin/cli/Cli.html" title="class in gobblin.cli">Cli</a></dt> |
| <dd> |
| <div class="block">Parse and execute the appropriate command based on the args.</div> |
| </dd> |
| <dt><span class="memberNameLink"><a href="gobblin/cli/JobInfoPrintUtils.html#printAllJobs-java.util.List-int-">printAllJobs(List<JobExecutionInfo>, int)</a></span> - Static method in class gobblin.cli.<a href="gobblin/cli/JobInfoPrintUtils.html" title="class in gobblin.cli">JobInfoPrintUtils</a></dt> |
| <dd> |
| <div class="block">Print summary information about a bunch of jobs in the system</div> |
| </dd> |
| <dt><span class="memberNameLink"><a href="gobblin/cli/JobInfoPrintUtils.html#printJob-com.google.common.base.Optional-">printJob(Optional<JobExecutionInfo>)</a></span> - Static method in class gobblin.cli.<a href="gobblin/cli/JobInfoPrintUtils.html" title="class in gobblin.cli">JobInfoPrintUtils</a></dt> |
| <dd> |
| <div class="block">Print information about one specific job.</div> |
| </dd> |
| <dt><span class="memberNameLink"><a href="gobblin/cli/JobInfoPrintUtils.html#printJobProperties-com.google.common.base.Optional-">printJobProperties(Optional<JobExecutionInfo>)</a></span> - Static method in class gobblin.cli.<a href="gobblin/cli/JobInfoPrintUtils.html" title="class in gobblin.cli">JobInfoPrintUtils</a></dt> |
| <dd> |
| <div class="block">Print properties of a specific job</div> |
| </dd> |
| <dt><span class="memberNameLink"><a href="gobblin/cli/JobInfoPrintUtils.html#printJobRuns-java.util.List-">printJobRuns(List<JobExecutionInfo>)</a></span> - Static method in class gobblin.cli.<a href="gobblin/cli/JobInfoPrintUtils.html" title="class in gobblin.cli">JobInfoPrintUtils</a></dt> |
| <dd> |
| <div class="block">Print a table describing a bunch of individual job executions.</div> |
| </dd> |
| <dt><span class="memberNameLink"><a href="gobblin/cli/CliTablePrinter.html#printTable--">printTable()</a></span> - Method in class gobblin.cli.<a href="gobblin/cli/CliTablePrinter.html" title="class in gobblin.cli">CliTablePrinter</a></dt> |
| <dd> |
| <div class="block">Prints the table of data</div> |
| </dd> |
| </dl> |
| <a name="I:Q"> |
| <!-- --> |
| </a> |
| <h2 class="title">Q</h2> |
| <dl> |
| <dt><span class="memberNameLink"><a href="gobblin/cli/AdminClient.html#queryAllJobs-gobblin.rest.QueryListType-int-">queryAllJobs(QueryListType, int)</a></span> - Method in class gobblin.cli.<a href="gobblin/cli/AdminClient.html" title="class in gobblin.cli">AdminClient</a></dt> |
| <dd> |
| <div class="block">Retrieve all jobs</div> |
| </dd> |
| <dt><span class="memberNameLink"><a href="gobblin/cli/AdminClient.html#queryByJobId-java.lang.String-">queryByJobId(String)</a></span> - Method in class gobblin.cli.<a href="gobblin/cli/AdminClient.html" title="class in gobblin.cli">AdminClient</a></dt> |
| <dd> |
| <div class="block">Retrieve a Gobblin job by its id.</div> |
| </dd> |
| <dt><span class="memberNameLink"><a href="gobblin/cli/AdminClient.html#queryByJobName-java.lang.String-int-">queryByJobName(String, int)</a></span> - Method in class gobblin.cli.<a href="gobblin/cli/AdminClient.html" title="class in gobblin.cli">AdminClient</a></dt> |
| <dd> |
| <div class="block">Query jobs by name</div> |
| </dd> |
| </dl> |
| <a name="I:S"> |
| <!-- --> |
| </a> |
| <h2 class="title">S</h2> |
| <dl> |
| <dt><span class="memberNameLink"><a href="gobblin/admin/AdminWebServer.html#server">server</a></span> - Variable in class gobblin.admin.<a href="gobblin/admin/AdminWebServer.html" title="class in gobblin.admin">AdminWebServer</a></dt> |
| <dd> </dd> |
| <dt><span class="memberNameLink"><a href="gobblin/admin/AdminWebServer.html#shutDown--">shutDown()</a></span> - Method in class gobblin.admin.<a href="gobblin/admin/AdminWebServer.html" title="class in gobblin.admin">AdminWebServer</a></dt> |
| <dd> </dd> |
| <dt><span class="memberNameLink"><a href="gobblin/admin/AdminWebServer.html#startUp--">startUp()</a></span> - Method in class gobblin.admin.<a href="gobblin/admin/AdminWebServer.html" title="class in gobblin.admin">AdminWebServer</a></dt> |
| <dd> </dd> |
| </dl> |
| <a href="#I:A">A</a> <a href="#I:B">B</a> <a href="#I:C">C</a> <a href="#I:D">D</a> <a href="#I:E">E</a> <a href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:I">I</a> <a href="#I:J">J</a> <a href="#I:L">L</a> <a href="#I:M">M</a> <a href="#I:P">P</a> <a href="#I:Q">Q</a> <a href="#I:S">S</a> </div> |
| <!-- ======= 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>Package</li> |
| <li>Class</li> |
| <li><a href="overview-tree.html">Tree</a></li> |
| <li><a href="deprecated-list.html">Deprecated</a></li> |
| <li class="navBarCell1Rev">Index</li> |
| <li><a href="help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev</li> |
| <li>Next</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="index.html?index-all.html" target="_top">Frames</a></li> |
| <li><a href="index-all.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> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
