mirror of
https://github.com/Fishwaldo/rundeck-api-java-client.git
synced 2025-07-23 13:29:08 +00:00
Wagon: Deploying site to repository
This commit is contained in:
Vincent Behar
parent
e7aab62206
commit
f98811b07a
180 changed files with 24637 additions and 2042 deletions
757
apidocs/org/rundeck/api/RundeckClient.html
Normal file
757
apidocs/org/rundeck/api/RundeckClient.html
Normal file
|
|
@ -0,0 +1,757 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||||
<!--NewPage-->
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<!-- Generated by javadoc (build 1.6.0_24) on Sat Jul 02 20:01:29 CEST 2011 -->
|
||||
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<TITLE>
|
||||
RundeckClient (RunDeck API - Java Client 1.0-SNAPSHOT API)
|
||||
</TITLE>
|
||||
|
||||
<META NAME="date" CONTENT="2011-07-02">
|
||||
|
||||
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
|
||||
|
||||
<SCRIPT type="text/javascript">
|
||||
function windowTitle()
|
||||
{
|
||||
if (location.href.indexOf('is-external=true') == -1) {
|
||||
parent.document.title="RundeckClient (RunDeck API - Java Client 1.0-SNAPSHOT API)";
|
||||
}
|
||||
}
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
</NOSCRIPT>
|
||||
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="white" onload="windowTitle();">
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||||
<A NAME="navbar_top"><!-- --></A>
|
||||
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_top_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/RundeckClient.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api"><B>PREV CLASS</B></A>
|
||||
NEXT CLASS</FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../index.html?org/rundeck/api/RundeckClient.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="RundeckClient.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_top"></A>
|
||||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||||
|
||||
<HR>
|
||||
<!-- ======== START OF CLASS DATA ======== -->
|
||||
<H2>
|
||||
<FONT SIZE="-1">
|
||||
org.rundeck.api</FONT>
|
||||
<BR>
|
||||
Class RundeckClient</H2>
|
||||
<PRE>
|
||||
<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
|
||||
<IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.rundeck.api.RundeckClient</B>
|
||||
</PRE>
|
||||
<DL>
|
||||
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></DD>
|
||||
</DL>
|
||||
<HR>
|
||||
<DL>
|
||||
<DT><PRE>public class <B>RundeckClient</B><DT>extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="http://java.sun.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A></DL>
|
||||
</PRE>
|
||||
|
||||
<P>
|
||||
Main entry point to talk to a RunDeck instance
|
||||
<P>
|
||||
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Author:</B></DT>
|
||||
<DD>Vincent Behar</DD>
|
||||
<DT><B>See Also:</B><DD><A HREF="../../../serialized-form.html#org.rundeck.api.RundeckClient">Serialized Form</A></DL>
|
||||
<HR>
|
||||
|
||||
<P>
|
||||
<!-- =========== FIELD SUMMARY =========== -->
|
||||
|
||||
<A NAME="field_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
||||
<B>Field Summary</B></FONT></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>static <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#API_ENDPOINT">API_ENDPOINT</A></B></CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE>static int</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#API_VERSION">API_VERSION</A></B></CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||||
|
||||
<A NAME="constructor_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
||||
<B>Constructor Summary</B></FONT></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#RundeckClient(java.lang.String, java.lang.String, java.lang.String)">RundeckClient</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> url,
|
||||
<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> login,
|
||||
<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> password)</CODE>
|
||||
|
||||
<BR>
|
||||
Instantiate a new <A HREF="../../../org/rundeck/api/RundeckClient.html" title="class in org.rundeck.api"><CODE>RundeckClient</CODE></A> for the RunDeck instance at the given url</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<!-- ========== METHOD SUMMARY =========== -->
|
||||
|
||||
<A NAME="method_summary"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
||||
<B>Method Summary</B></FONT></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> boolean</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#equals(java.lang.Object)">equals</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> obj)</CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#getExecution(java.lang.Long)">getExecution</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</A> executionId)</CODE>
|
||||
|
||||
<BR>
|
||||
Get a single execution, identified by the given ID</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="../../../org/rundeck/api/domain/RundeckJob.html" title="class in org.rundeck.api.domain">RundeckJob</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#getJob(java.lang.String)">getJob</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId)</CODE>
|
||||
|
||||
<BR>
|
||||
Get the definition of a single job, identified by the given ID</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A>></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#getJobExecutions(java.lang.String)">getJobExecutions</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId)</CODE>
|
||||
|
||||
<BR>
|
||||
Get the executions of the given job</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/rundeck/api/domain/RundeckJob.html" title="class in org.rundeck.api.domain">RundeckJob</A>></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#getJobs(java.lang.String)">getJobs</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> project)</CODE>
|
||||
|
||||
<BR>
|
||||
List all jobs that belongs to the given project</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/rundeck/api/domain/RundeckJob.html" title="class in org.rundeck.api.domain">RundeckJob</A>></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#getJobs(java.lang.String, java.lang.String, java.lang.String, java.lang.String...)">getJobs</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> project,
|
||||
<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobFilter,
|
||||
<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> groupPath,
|
||||
<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>... jobIds)</CODE>
|
||||
|
||||
<BR>
|
||||
List the jobs that belongs to the given project, and matches the given criteria (jobFilter, groupPath and jobIds)</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#getLogin()">getLogin</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#getPassword()">getPassword</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="../../../org/rundeck/api/domain/RundeckProject.html" title="class in org.rundeck.api.domain">RundeckProject</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#getProject(java.lang.String)">getProject</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> projectName)</CODE>
|
||||
|
||||
<BR>
|
||||
Get the definition of a single project, identified by the given name</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/rundeck/api/domain/RundeckProject.html" title="class in org.rundeck.api.domain">RundeckProject</A>></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#getProjects()">getProjects</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
List all projects</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#getUrl()">getUrl</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> int</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#hashCode()">hashCode</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#ping()">ping</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Try to "ping" the RunDeck instance to see if it is alive</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> void</CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#testCredentials()">testCredentials</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
Test your credentials (login/password) on the RunDeck instance</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#toString()">toString</A></B>()</CODE>
|
||||
|
||||
<BR>
|
||||
</TD>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||||
<CODE> <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A></CODE></FONT></TD>
|
||||
<TD><CODE><B><A HREF="../../../org/rundeck/api/RundeckClient.html#triggerJob(java.lang.String, java.util.Properties)">triggerJob</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId,
|
||||
<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> options)</CODE>
|
||||
|
||||
<BR>
|
||||
Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the
|
||||
end of the job execution)</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
||||
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
|
||||
</TR>
|
||||
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||||
<TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<P>
|
||||
|
||||
<!-- ============ FIELD DETAIL =========== -->
|
||||
|
||||
<A NAME="field_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
||||
<B>Field Detail</B></FONT></TH>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="API_VERSION"><!-- --></A><H3>
|
||||
API_VERSION</H3>
|
||||
<PRE>
|
||||
public static final transient int <B>API_VERSION</B></PRE>
|
||||
<DL>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.rundeck.api.RundeckClient.API_VERSION">Constant Field Values</A></DL>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="API_ENDPOINT"><!-- --></A><H3>
|
||||
API_ENDPOINT</H3>
|
||||
<PRE>
|
||||
public static final transient <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>API_ENDPOINT</B></PRE>
|
||||
<DL>
|
||||
<DL>
|
||||
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.rundeck.api.RundeckClient.API_ENDPOINT">Constant Field Values</A></DL>
|
||||
</DL>
|
||||
|
||||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||||
|
||||
<A NAME="constructor_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
||||
<B>Constructor Detail</B></FONT></TH>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="RundeckClient(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
|
||||
RundeckClient</H3>
|
||||
<PRE>
|
||||
public <B>RundeckClient</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> url,
|
||||
<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> login,
|
||||
<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> password)</PRE>
|
||||
<DL>
|
||||
<DD>Instantiate a new <A HREF="../../../org/rundeck/api/RundeckClient.html" title="class in org.rundeck.api"><CODE>RundeckClient</CODE></A> for the RunDeck instance at the given url
|
||||
<P>
|
||||
<DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>url</CODE> - of the RunDeck instance ("http://localhost:4440", "http://rundeck.your-compagny.com/", etc)<DD><CODE>login</CODE> - <DD><CODE>password</CODE> - </DL>
|
||||
</DL>
|
||||
|
||||
<!-- ============ METHOD DETAIL ========== -->
|
||||
|
||||
<A NAME="method_detail"><!-- --></A>
|
||||
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
||||
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||||
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
||||
<B>Method Detail</B></FONT></TH>
|
||||
</TR>
|
||||
</TABLE>
|
||||
|
||||
<A NAME="ping()"><!-- --></A><H3>
|
||||
ping</H3>
|
||||
<PRE>
|
||||
public void <B>ping</B>()
|
||||
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></PRE>
|
||||
<DL>
|
||||
<DD>Try to "ping" the RunDeck instance to see if it is alive
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - if the ping fails</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="testCredentials()"><!-- --></A><H3>
|
||||
testCredentials</H3>
|
||||
<PRE>
|
||||
public void <B>testCredentials</B>()
|
||||
throws <A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></PRE>
|
||||
<DL>
|
||||
<DD>Test your credentials (login/password) on the RunDeck instance
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login fails</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getJobs(java.lang.String)"><!-- --></A><H3>
|
||||
getJobs</H3>
|
||||
<PRE>
|
||||
public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/rundeck/api/domain/RundeckJob.html" title="class in org.rundeck.api.domain">RundeckJob</A>> <B>getJobs</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> project)
|
||||
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
||||
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
||||
<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
||||
<DL>
|
||||
<DD>List all jobs that belongs to the given project
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>project</CODE> - name of the project - mandatory
|
||||
<DT><B>Returns:</B><DD>a <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><CODE>List</CODE></A> of <A HREF="../../../org/rundeck/api/domain/RundeckJob.html" title="class in org.rundeck.api.domain"><CODE>RundeckJob</CODE></A> : might be empty, but won't be null
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API
|
||||
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
||||
<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the project is blank (null, empty or whitespace)<DT><B>See Also:</B><DD><A HREF="../../../org/rundeck/api/RundeckClient.html#getJobs(java.lang.String, java.lang.String, java.lang.String, java.lang.String...)"><CODE>getJobs(String, String, String, String...)</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getJobs(java.lang.String, java.lang.String, java.lang.String, java.lang.String...)"><!-- --></A><H3>
|
||||
getJobs</H3>
|
||||
<PRE>
|
||||
public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/rundeck/api/domain/RundeckJob.html" title="class in org.rundeck.api.domain">RundeckJob</A>> <B>getJobs</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> project,
|
||||
<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobFilter,
|
||||
<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> groupPath,
|
||||
<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>... jobIds)
|
||||
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
||||
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
||||
<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
||||
<DL>
|
||||
<DD>List the jobs that belongs to the given project, and matches the given criteria (jobFilter, groupPath and jobIds)
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>project</CODE> - name of the project - mandatory<DD><CODE>jobFilter</CODE> - a filter for the job Name - optional<DD><CODE>groupPath</CODE> - a group or partial group path to include all jobs within that group path - optional<DD><CODE>jobIds</CODE> - a list of Job IDs to include - optional
|
||||
<DT><B>Returns:</B><DD>a <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><CODE>List</CODE></A> of <A HREF="../../../org/rundeck/api/domain/RundeckJob.html" title="class in org.rundeck.api.domain"><CODE>RundeckJob</CODE></A> : might be empty, but won't be null
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API
|
||||
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
||||
<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the project is blank (null, empty or whitespace)<DT><B>See Also:</B><DD><A HREF="../../../org/rundeck/api/RundeckClient.html#getJobs(java.lang.String)"><CODE>getJobs(String)</CODE></A></DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getJob(java.lang.String)"><!-- --></A><H3>
|
||||
getJob</H3>
|
||||
<PRE>
|
||||
public <A HREF="../../../org/rundeck/api/domain/RundeckJob.html" title="class in org.rundeck.api.domain">RundeckJob</A> <B>getJob</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId)
|
||||
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
||||
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
||||
<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
||||
<DL>
|
||||
<DD>Get the definition of a single job, identified by the given ID
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>jobId</CODE> - identifier of the job - mandatory
|
||||
<DT><B>Returns:</B><DD>a <A HREF="../../../org/rundeck/api/domain/RundeckJob.html" title="class in org.rundeck.api.domain"><CODE>RundeckJob</CODE></A> instance
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API
|
||||
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
||||
<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the jobId is blank (null, empty or whitespace)</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getJobExecutions(java.lang.String)"><!-- --></A><H3>
|
||||
getJobExecutions</H3>
|
||||
<PRE>
|
||||
public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A>> <B>getJobExecutions</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId)
|
||||
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
||||
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
||||
<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
||||
<DL>
|
||||
<DD>Get the executions of the given job
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>jobId</CODE> - identifier of the job - mandatory
|
||||
<DT><B>Returns:</B><DD>a <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><CODE>List</CODE></A> of <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain"><CODE>RundeckExecution</CODE></A> : might be empty, but won't be null
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API
|
||||
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
||||
<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the jobId is blank (null, empty or whitespace)</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getExecution(java.lang.Long)"><!-- --></A><H3>
|
||||
getExecution</H3>
|
||||
<PRE>
|
||||
public <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A> <B>getExecution</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Long.html?is-external=true" title="class or interface in java.lang">Long</A> executionId)
|
||||
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
||||
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
||||
<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
||||
<DL>
|
||||
<DD>Get a single execution, identified by the given ID
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>executionId</CODE> - identifier of the execution - mandatory
|
||||
<DT><B>Returns:</B><DD>a <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain"><CODE>RundeckExecution</CODE></A> instance
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API
|
||||
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
||||
<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the executionId is null</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="triggerJob(java.lang.String, java.util.Properties)"><!-- --></A><H3>
|
||||
triggerJob</H3>
|
||||
<PRE>
|
||||
public <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain">RundeckExecution</A> <B>triggerJob</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId,
|
||||
<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</A> options)
|
||||
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
||||
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
||||
<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
||||
<DL>
|
||||
<DD>Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the
|
||||
end of the job execution)
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>jobId</CODE> - identifier of the job - mandatory<DD><CODE>options</CODE> - of the job - optional
|
||||
<DT><B>Returns:</B><DD>a <A HREF="../../../org/rundeck/api/domain/RundeckExecution.html" title="class in org.rundeck.api.domain"><CODE>RundeckExecution</CODE></A> instance representing the newly created (and running) execution
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API
|
||||
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
||||
<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the jobId is blank (null, empty or whitespace)</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getProjects()"><!-- --></A><H3>
|
||||
getProjects</H3>
|
||||
<PRE>
|
||||
public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../org/rundeck/api/domain/RundeckProject.html" title="class in org.rundeck.api.domain">RundeckProject</A>> <B>getProjects</B>()
|
||||
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
||||
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></PRE>
|
||||
<DL>
|
||||
<DD>List all projects
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
|
||||
<DT><B>Returns:</B><DD>a <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util"><CODE>List</CODE></A> of <A HREF="../../../org/rundeck/api/domain/RundeckProject.html" title="class in org.rundeck.api.domain"><CODE>RundeckProject</CODE></A> : might be empty, but won't be null
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API
|
||||
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getProject(java.lang.String)"><!-- --></A><H3>
|
||||
getProject</H3>
|
||||
<PRE>
|
||||
public <A HREF="../../../org/rundeck/api/domain/RundeckProject.html" title="class in org.rundeck.api.domain">RundeckProject</A> <B>getProject</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> projectName)
|
||||
throws <A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A>,
|
||||
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A>,
|
||||
<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE>
|
||||
<DL>
|
||||
<DD>Get the definition of a single project, identified by the given name
|
||||
<P>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
<DT><B>Parameters:</B><DD><CODE>projectName</CODE> - name of the project - mandatory
|
||||
<DT><B>Returns:</B><DD>a <A HREF="../../../org/rundeck/api/domain/RundeckProject.html" title="class in org.rundeck.api.domain"><CODE>RundeckProject</CODE></A> instance
|
||||
<DT><B>Throws:</B>
|
||||
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.html" title="class in org.rundeck.api">RundeckApiException</A></CODE> - in case of error when calling the API
|
||||
<DD><CODE><A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api">RundeckApiException.RundeckApiLoginException</A></CODE> - if the login failed
|
||||
<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the projectName is blank (null, empty or whitespace)</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getUrl()"><!-- --></A><H3>
|
||||
getUrl</H3>
|
||||
<PRE>
|
||||
public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getUrl</B>()</PRE>
|
||||
<DL>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getLogin()"><!-- --></A><H3>
|
||||
getLogin</H3>
|
||||
<PRE>
|
||||
public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getLogin</B>()</PRE>
|
||||
<DL>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="getPassword()"><!-- --></A><H3>
|
||||
getPassword</H3>
|
||||
<PRE>
|
||||
public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getPassword</B>()</PRE>
|
||||
<DL>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="toString()"><!-- --></A><H3>
|
||||
toString</H3>
|
||||
<PRE>
|
||||
public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE>
|
||||
<DL>
|
||||
<DD><DL>
|
||||
<DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="hashCode()"><!-- --></A><H3>
|
||||
hashCode</H3>
|
||||
<PRE>
|
||||
public int <B>hashCode</B>()</PRE>
|
||||
<DL>
|
||||
<DD><DL>
|
||||
<DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<HR>
|
||||
|
||||
<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
|
||||
equals</H3>
|
||||
<PRE>
|
||||
public boolean <B>equals</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> obj)</PRE>
|
||||
<DL>
|
||||
<DD><DL>
|
||||
<DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>
|
||||
</DD>
|
||||
<DD><DL>
|
||||
</DL>
|
||||
</DD>
|
||||
</DL>
|
||||
<!-- ========= END OF CLASS DATA ========= -->
|
||||
<HR>
|
||||
|
||||
|
||||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||||
<A NAME="navbar_bottom"><!-- --></A>
|
||||
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
||||
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
||||
<TR>
|
||||
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
||||
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
||||
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
||||
<TR ALIGN="center" VALIGN="top">
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/RundeckClient.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
||||
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
</TD>
|
||||
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
||||
</EM>
|
||||
</TD>
|
||||
</TR>
|
||||
|
||||
<TR>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../org/rundeck/api/RundeckApiException.RundeckApiLoginException.html" title="class in org.rundeck.api"><B>PREV CLASS</B></A>
|
||||
NEXT CLASS</FONT></TD>
|
||||
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
||||
<A HREF="../../../index.html?org/rundeck/api/RundeckClient.html" target="_top"><B>FRAMES</B></A>
|
||||
<A HREF="RundeckClient.html" target="_top"><B>NO FRAMES</B></A>
|
||||
<SCRIPT type="text/javascript">
|
||||
<!--
|
||||
if(window==top) {
|
||||
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
||||
}
|
||||
//-->
|
||||
</SCRIPT>
|
||||
<NOSCRIPT>
|
||||
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
|
||||
</NOSCRIPT>
|
||||
|
||||
|
||||
</FONT></TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
||||
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
||||
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<A NAME="skip-navbar_bottom"></A>
|
||||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||||
|
||||
<HR>
|
||||
Copyright © 2011. All Rights Reserved.
|
||||
</BODY>
|
||||
</HTML>
|
||||
Loading…
Add table
Add a link
Reference in a new issue