rundeck-api-java-client/apidocs/reference/classes.html
2013-02-21 18:26:17 -08:00

664 lines
No EOL
24 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="shortcut icon" type="image/x-icon" href="./favicon.ico" />
<title>
Class Index
| RunDeck API - Java Client
</title>
<link href="./../assets/android-developer-docs.css" rel="stylesheet" type="text/css" />
<link href="./../assets/customizations.css" rel="stylesheet" type="text/css" />
<script src="./../assets/search_autocomplete.js" type="text/javascript"></script>
<script src="./../assets/jquery-resizable.min.js" type="text/javascript"></script>
<script src="./../assets/android-developer-docs.js" type="text/javascript"></script>
<script src="./../assets/prettify.js" type="text/javascript"></script>
<script type="text/javascript">
setToRoot("./", "./../assets/");
</script>
<script src="./../assets/android-developer-reference.js" type="text/javascript"></script>
<script src="./../assets/navtree_data.js" type="text/javascript"></script>
<script src="./../assets/customizations.js" type="text/javascript"></script>
<noscript>
<style type="text/css">
html,body{overflow:auto;}
#body-content{position:relative; top:0;}
#doc-content{overflow:visible;border-left:3px solid #666;}
#side-nav{padding:0;}
#side-nav .toggle-list ul {display:block;}
#resize-packages-nav{border-bottom:3px solid #666;}
</style>
</noscript>
</head>
<div id="header">
<div id="headerLeft">
<span id="masthead-title">RunDeck API - Java Client</span>
</div>
<div id="headerRight">
<div id="search" >
<div id="searchForm">
<form accept-charset="utf-8" class="gsc-search-box"
onsubmit="return submit_search()">
<table class="gsc-search-box" cellpadding="0" cellspacing="0"><tbody>
<tr>
<td class="gsc-input">
<input id="search_autocomplete" class="gsc-input" type="text" size="33" autocomplete="off"
title="search developer docs" name="q"
value="search developer docs"
onFocus="search_focus_changed(this, true)"
onBlur="search_focus_changed(this, false)"
onkeydown="return search_changed(event, true, './')"
onkeyup="return search_changed(event, false, './')" />
<div id="search_filtered_div" class="no-display">
<table id="search_filtered" cellspacing=0>
</table>
</div>
</td>
<td class="gsc-search-button">
<input type="submit" value="Search" title="search" id="search-button" class="gsc-search-button" />
</td>
<td class="gsc-clear-button">
<div title="clear results" class="gsc-clear-button">&nbsp;</div>
</td>
</tr></tbody>
</table>
</form>
</div><!-- searchForm -->
</div><!-- search -->
</div>
</div><!-- header -->
<div class="g-section g-tpl-240" id="body-content">
<div class="g-unit g-first side-nav-resizable" id="side-nav">
<div id="swapper">
<div id="nav-panels">
<div id="resize-packages-nav">
<div id="packages-nav">
<div id="index-links"><nobr>
<a href="./packages.html" >Package Index</a> |
<a href="./classes.html" class="selected">Class Index</a></nobr>
</div>
<ul>
<li class="api apilevel-">
<a href="./org/rundeck/api/package-summary.html">org.rundeck.api</a></li>
<li class="api apilevel-">
<a href="./org/rundeck/api/domain/package-summary.html">org.rundeck.api.domain</a></li>
<li class="api apilevel-">
<a href="./org/rundeck/api/parser/package-summary.html">org.rundeck.api.parser</a></li>
<li class="api apilevel-">
<a href="./org/rundeck/api/query/package-summary.html">org.rundeck.api.query</a></li>
<li class="api apilevel-">
<a href="./org/rundeck/api/util/package-summary.html">org.rundeck.api.util</a></li>
</ul><br/>
</div> <!-- end packages -->
</div> <!-- end resize-packages -->
<div id="classes-nav">
<script>
/*addLoadEvent(maxPackageHeight);*/
</script>
<p style="padding:10px">Select a package to view its members</p><br/>
</div><!-- end classes -->
</div><!-- end nav-panels -->
<div id="nav-tree" style="display:none">
<div id="index-links"><nobr>
<a href="./packages.html" >Package Index</a> |
<a href="./classes.html" class="selected">Class Index</a></nobr>
</div>
</div><!-- end nav-tree -->
</div><!-- end swapper -->
</div> <!-- end side-nav -->
<script>
if (!isMobile) {
$("<a href='#' id='nav-swap' onclick='swapNav();return false;' style='font-size:10px;line-height:9px;margin-left:1em;text-decoration:none;'><span id='tree-link'>Use Tree Navigation</span><span id='panel-link' style='display:none'>Use Panel Navigation</span></a>").appendTo("#side-nav");
chooseDefaultNav();
if ($("#nav-tree").is(':visible')) {
init_default_navtree("./");
} else {
addLoadEvent(function() {
scrollIntoView("packages-nav");
scrollIntoView("classes-nav");
});
}
$("#swapper").css({borderBottom:"2px solid #aaa"});
} else {
swapNav(); // tree view should be used on mobile
}
</script>
<div class="g-unit" id="doc-content">
<div id="jd-header">
<h1>Class Index</h1>
</div>
<div id="jd-content">
<div class="jd-letterlist">
<a href="#letter_A">A</a>
<a href="#letter_B">B</a>
<a href="#letter_D">D</a>
<a href="#letter_E">E</a>
<a href="#letter_F">F</a>
<a href="#letter_H">H</a>
<a href="#letter_J">J</a>
<a href="#letter_L">L</a>
<a href="#letter_N">N</a>
<a href="#letter_O">O</a>
<a href="#letter_P">P</a>
<a href="#letter_R">R</a>
<a href="#letter_S">S</a>
<a href="#letter_X">X</a>
</div>
<h2 id="letter_A">A</h2>
<table class="jd-sumtable">
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/parser/AbortParser.html">AbortParser</a></td>
<td class="jd-descrcol" width="100%">Parser for a single <code><a href="./org/rundeck/api/domain/RundeckAbort.html">RundeckAbort</a></code>&nbsp;</td>
</tr>
<tr class=" api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/util/AssertUtil.html">AssertUtil</a></td>
<td class="jd-descrcol" width="100%">Utility class for assertions&nbsp;</td>
</tr>
</table>
<h2 id="letter_B">B</h2>
<table class="jd-sumtable">
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/parser/BulkDeleteParser.html">BulkDeleteParser</a></td>
<td class="jd-descrcol" width="100%">BulkDeleteParser is ...&nbsp;</td>
</tr>
</table>
<h2 id="letter_D">D</h2>
<table class="jd-sumtable">
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/parser/DeleteParser.html">DeleteParser</a></td>
<td class="jd-descrcol" width="100%">DeleteParser is ...&nbsp;</td>
</tr>
</table>
<h2 id="letter_E">E</h2>
<table class="jd-sumtable">
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/parser/EventParser.html">EventParser</a></td>
<td class="jd-descrcol" width="100%">Parser for a single <code><a href="./org/rundeck/api/domain/RundeckEvent.html">RundeckEvent</a></code>&nbsp;</td>
</tr>
<tr class=" api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/parser/ExecutionParser.html">ExecutionParser</a></td>
<td class="jd-descrcol" width="100%">Parser for a single <code><a href="./org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code>&nbsp;</td>
</tr>
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/query/ExecutionQuery.html">ExecutionQuery</a></td>
<td class="jd-descrcol" width="100%">ExecutionQuery contains the query parameters for the /executions api, create one with the <code><a href="./org/rundeck/api/query/ExecutionQuery.Builder.html">ExecutionQuery.Builder</a></code> class, e.g.&nbsp;</td>
</tr>
<tr class=" api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/query/ExecutionQuery.Builder.html">ExecutionQuery.Builder</a></td>
<td class="jd-descrcol" width="100%">Builder for ExecutionQueries
&nbsp;</td>
</tr>
</table>
<h2 id="letter_F">F</h2>
<table class="jd-sumtable">
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/FileType.html">FileType</a></td>
<td class="jd-descrcol" width="100%">All supported types of files.&nbsp;</td>
</tr>
</table>
<h2 id="letter_H">H</h2>
<table class="jd-sumtable">
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/parser/HistoryParser.html">HistoryParser</a></td>
<td class="jd-descrcol" width="100%">Parser for a single <code><a href="./org/rundeck/api/domain/RundeckHistory.html">RundeckHistory</a></code>&nbsp;</td>
</tr>
</table>
<h2 id="letter_J">J</h2>
<table class="jd-sumtable">
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/parser/JobParser.html">JobParser</a></td>
<td class="jd-descrcol" width="100%">Parser for a single <code><a href="./org/rundeck/api/domain/RundeckJob.html">RundeckJob</a></code>&nbsp;</td>
</tr>
<tr class=" api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/parser/JobsImportResultParser.html">JobsImportResultParser</a></td>
<td class="jd-descrcol" width="100%">Parser for a single <code><a href="./org/rundeck/api/domain/RundeckJobsImportResult.html">RundeckJobsImportResult</a></code>&nbsp;</td>
</tr>
</table>
<h2 id="letter_L">L</h2>
<table class="jd-sumtable">
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/parser/ListParser.html">ListParser</a>&lt;T&gt;</td>
<td class="jd-descrcol" width="100%">Parser for a List of elements&nbsp;</td>
</tr>
</table>
<h2 id="letter_N">N</h2>
<table class="jd-sumtable">
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/NodeFiltersBuilder.html">NodeFiltersBuilder</a></td>
<td class="jd-descrcol" width="100%">Builder for node filters&nbsp;</td>
</tr>
<tr class=" api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/parser/NodeParser.html">NodeParser</a></td>
<td class="jd-descrcol" width="100%">Parser for a single <code><a href="./org/rundeck/api/domain/RundeckNode.html">RundeckNode</a></code>&nbsp;</td>
</tr>
</table>
<h2 id="letter_O">O</h2>
<table class="jd-sumtable">
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/OptionsBuilder.html">OptionsBuilder</a></td>
<td class="jd-descrcol" width="100%">Builder for job options&nbsp;</td>
</tr>
<tr class=" api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/parser/OutputEntryParser.html">OutputEntryParser</a></td>
<td class="jd-descrcol" width="100%">Parses output message content for API v6
&nbsp;</td>
</tr>
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/parser/OutputEntryParserV5.html">OutputEntryParserV5</a></td>
<td class="jd-descrcol" width="100%">OutputEntryParserV5 parses message entry for API v5&nbsp;</td>
</tr>
<tr class=" api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/parser/OutputParser.html">OutputParser</a></td>
<td class="jd-descrcol" width="100%">&nbsp;</td>
</tr>
</table>
<h2 id="letter_P">P</h2>
<table class="jd-sumtable">
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/parser/PagedResultParser.html">PagedResultParser</a>&lt;T&gt;</td>
<td class="jd-descrcol" width="100%">PagedResultParser extracts paging data from an xpath node, and includes the List result from a ListParser&nbsp;</td>
</tr>
<tr class=" api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/util/PagedResults.html">PagedResults</a>&lt;T&gt;</td>
<td class="jd-descrcol" width="100%">PagedResults contains a List of a certain type, and paging information.&nbsp;</td>
</tr>
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/util/ParametersUtil.html">ParametersUtil</a></td>
<td class="jd-descrcol" width="100%">Utility class for API parameters that should be passed in URLs.&nbsp;</td>
</tr>
<tr class=" api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/parser/ParserHelper.html">ParserHelper</a></td>
<td class="jd-descrcol" width="100%">Helper for parsing RunDeck responses&nbsp;</td>
</tr>
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/parser/ProjectParser.html">ProjectParser</a></td>
<td class="jd-descrcol" width="100%">Parser for a single <code><a href="./org/rundeck/api/domain/RundeckProject.html">RundeckProject</a></code>&nbsp;</td>
</tr>
</table>
<h2 id="letter_R">R</h2>
<table class="jd-sumtable">
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/domain/RundeckAbort.html">RundeckAbort</a></td>
<td class="jd-descrcol" width="100%">Represents an abort of a <code><a href="./org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></code>&nbsp;</td>
</tr>
<tr class=" api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/domain/RundeckAbort.AbortStatus.html">RundeckAbort.AbortStatus</a></td>
<td class="jd-descrcol" width="100%">The status of an abort
&nbsp;</td>
</tr>
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/RundeckApiException.html">RundeckApiException</a></td>
<td class="jd-descrcol" width="100%">A generic (unchecked) exception when using the RunDeck API&nbsp;</td>
</tr>
<tr class=" api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/RundeckApiException.RundeckApiAuthException.html">RundeckApiException.RundeckApiAuthException</a></td>
<td class="jd-descrcol" width="100%">Specific authentication-related error (either login or token).&nbsp;</td>
</tr>
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/RundeckApiException.RundeckApiLoginException.html">RundeckApiException.RundeckApiLoginException</a></td>
<td class="jd-descrcol" width="100%">Specific authentication-related error (in case of login-based authentication)
&nbsp;</td>
</tr>
<tr class=" api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/RundeckApiException.RundeckApiTokenException.html">RundeckApiException.RundeckApiTokenException</a></td>
<td class="jd-descrcol" width="100%">Specific authentication-related error (in case of token-based authentication)
&nbsp;</td>
</tr>
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/RundeckClient.html">RundeckClient</a></td>
<td class="jd-descrcol" width="100%">Main entry point to talk to a RunDeck instance.&nbsp;</td>
</tr>
<tr class=" api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/RundeckClient.Version.html">RundeckClient.Version</a></td>
<td class="jd-descrcol" width="100%">Supported version numbers
&nbsp;</td>
</tr>
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/RundeckClientBuilder.html">RundeckClientBuilder</a></td>
<td class="jd-descrcol" width="100%">Builder to create a <code><a href="./org/rundeck/api/RundeckClient.html">RundeckClient</a></code>, you must specify a url, and at least one of (login, password), token, or
sessionId.&nbsp;</td>
</tr>
<tr class=" api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/domain/RundeckEvent.html">RundeckEvent</a></td>
<td class="jd-descrcol" width="100%">Represents a RunDeck event&nbsp;</td>
</tr>
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/domain/RundeckEvent.EventStatus.html">RundeckEvent.EventStatus</a></td>
<td class="jd-descrcol" width="100%">The status of an event
&nbsp;</td>
</tr>
<tr class=" api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/domain/RundeckEvent.NodeSummary.html">RundeckEvent.NodeSummary</a></td>
<td class="jd-descrcol" width="100%">Summary for nodes
&nbsp;</td>
</tr>
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/domain/RundeckExecution.html">RundeckExecution</a></td>
<td class="jd-descrcol" width="100%">Represents a RunDeck execution, usually triggered by an API call.&nbsp;</td>
</tr>
<tr class=" api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/domain/RundeckExecution.ExecutionStatus.html">RundeckExecution.ExecutionStatus</a></td>
<td class="jd-descrcol" width="100%">The status of an execution
&nbsp;</td>
</tr>
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/domain/RundeckHistory.html">RundeckHistory</a></td>
<td class="jd-descrcol" width="100%">Represents a portion of the RunDeck (events) history&nbsp;</td>
</tr>
<tr class=" api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/domain/RundeckJob.html">RundeckJob</a></td>
<td class="jd-descrcol" width="100%">Represents a RunDeck job&nbsp;</td>
</tr>
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/domain/RundeckJobDelete.html">RundeckJobDelete</a></td>
<td class="jd-descrcol" width="100%">RundeckJobDelete represents a result of a job delete request.&nbsp;</td>
</tr>
<tr class=" api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/domain/RundeckJobDeleteBulk.html">RundeckJobDeleteBulk</a></td>
<td class="jd-descrcol" width="100%">RundeckJobDeleteBulk represents the result of a bulk job delete request and contains
a list of <code><a href="./org/rundeck/api/domain/RundeckJobDelete.html">RundeckJobDelete</a></code> objects.&nbsp;</td>
</tr>
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/domain/RundeckJobsImportMethod.html">RundeckJobsImportMethod</a></td>
<td class="jd-descrcol" width="100%">The behavior when importing jobs (which may already exist).&nbsp;</td>
</tr>
<tr class=" api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/domain/RundeckJobsImportResult.html">RundeckJobsImportResult</a></td>
<td class="jd-descrcol" width="100%">Result of importing some jobs into RunDeck&nbsp;</td>
</tr>
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/domain/RundeckNode.html">RundeckNode</a></td>
<td class="jd-descrcol" width="100%">Represents a RunDeck node (server on which RunDeck can execute jobs and commands)&nbsp;</td>
</tr>
<tr class=" api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/domain/RundeckOutput.html">RundeckOutput</a></td>
<td class="jd-descrcol" width="100%">Represents a RunDeck output
&nbsp;</td>
</tr>
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/domain/RundeckOutputEntry.html">RundeckOutputEntry</a></td>
<td class="jd-descrcol" width="100%">Represents a RunDeck output entry
&nbsp;</td>
</tr>
<tr class=" api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/domain/RundeckOutputEntry.RundeckLogLevel.html">RundeckOutputEntry.RundeckLogLevel</a></td>
<td class="jd-descrcol" width="100%">&nbsp;</td>
</tr>
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/domain/RundeckProject.html">RundeckProject</a></td>
<td class="jd-descrcol" width="100%">Represents a RunDeck project&nbsp;</td>
</tr>
<tr class=" api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/domain/RundeckSystemInfo.html">RundeckSystemInfo</a></td>
<td class="jd-descrcol" width="100%">Represents the RunDeck system info&nbsp;</td>
</tr>
</table>
<h2 id="letter_S">S</h2>
<table class="jd-sumtable">
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/parser/StringParser.html">StringParser</a></td>
<td class="jd-descrcol" width="100%">Parser for a single String&nbsp;</td>
</tr>
<tr class=" api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/parser/SystemInfoParser.html">SystemInfoParser</a></td>
<td class="jd-descrcol" width="100%">Parser for a single <code><a href="./org/rundeck/api/domain/RundeckSystemInfo.html">RundeckSystemInfo</a></code>&nbsp;</td>
</tr>
</table>
<h2 id="letter_X">X</h2>
<table class="jd-sumtable">
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="./org/rundeck/api/parser/XmlNodeParser.html">XmlNodeParser</a>&lt;T&gt;</td>
<td class="jd-descrcol" width="100%">Interface to be implemented for parsers that handle XML Nodes&nbsp;</td>
</tr>
</table>
<div id="footer">
Generated by <a href="http://code.google.com/p/doclava/">Doclava</a>.
</div> <!-- end footer -->
</div><!-- end jd-content -->
</div><!-- end doc-content -->
</div> <!-- end body-content -->
<script type="text/javascript">
init(); /* initialize android-developer-docs.js */
</script>
</body>
</html>