diff --git a/apidocs/assets/navtree_data.js b/apidocs/assets/navtree_data.js
index adf562b..fc51aee 100644
--- a/apidocs/assets/navtree_data.js
+++ b/apidocs/assets/navtree_data.js
@@ -3,13 +3,16 @@ var NAVTREE_DATA =
, "" ], [ "Enums", null, [ [ "FileType", "org/rundeck/api/FileType.html", null, "" ] ]
, "" ], [ "Exceptions", null, [ [ "RundeckApiException", "org/rundeck/api/RundeckApiException.html", null, "" ], [ "RundeckApiException.RundeckApiAuthException", "org/rundeck/api/RundeckApiException.RundeckApiAuthException.html", null, "" ], [ "RundeckApiException.RundeckApiLoginException", "org/rundeck/api/RundeckApiException.RundeckApiLoginException.html", null, "" ], [ "RundeckApiException.RundeckApiTokenException", "org/rundeck/api/RundeckApiException.RundeckApiTokenException.html", null, "" ] ]
, "" ] ]
-, "" ], [ "org.rundeck.api.domain", "org/rundeck/api/domain/package-summary.html", [ [ "Description", "org/rundeck/api/domain/package-descr.html", null, "" ], [ "Classes", null, [ [ "RundeckAbort", "org/rundeck/api/domain/RundeckAbort.html", null, "" ], [ "RundeckEvent", "org/rundeck/api/domain/RundeckEvent.html", null, "" ], [ "RundeckEvent.NodeSummary", "org/rundeck/api/domain/RundeckEvent.NodeSummary.html", null, "" ], [ "RundeckExecution", "org/rundeck/api/domain/RundeckExecution.html", null, "" ], [ "RundeckHistory", "org/rundeck/api/domain/RundeckHistory.html", null, "" ], [ "RundeckJob", "org/rundeck/api/domain/RundeckJob.html", null, "" ], [ "RundeckJobsImportResult", "org/rundeck/api/domain/RundeckJobsImportResult.html", null, "" ], [ "RundeckNode", "org/rundeck/api/domain/RundeckNode.html", null, "" ], [ "RundeckProject", "org/rundeck/api/domain/RundeckProject.html", null, "" ], [ "RundeckSystemInfo", "org/rundeck/api/domain/RundeckSystemInfo.html", null, "" ] ]
-, "" ], [ "Enums", null, [ [ "RundeckAbort.AbortStatus", "org/rundeck/api/domain/RundeckAbort.AbortStatus.html", null, "" ], [ "RundeckEvent.EventStatus", "org/rundeck/api/domain/RundeckEvent.EventStatus.html", null, "" ], [ "RundeckExecution.ExecutionStatus", "org/rundeck/api/domain/RundeckExecution.ExecutionStatus.html", null, "" ], [ "RundeckJobsImportMethod", "org/rundeck/api/domain/RundeckJobsImportMethod.html", null, "" ] ]
+, "" ], [ "org.rundeck.api.domain", "org/rundeck/api/domain/package-summary.html", [ [ "Description", "org/rundeck/api/domain/package-descr.html", null, "" ], [ "Classes", null, [ [ "RundeckAbort", "org/rundeck/api/domain/RundeckAbort.html", null, "" ], [ "RundeckEvent", "org/rundeck/api/domain/RundeckEvent.html", null, "" ], [ "RundeckEvent.NodeSummary", "org/rundeck/api/domain/RundeckEvent.NodeSummary.html", null, "" ], [ "RundeckExecution", "org/rundeck/api/domain/RundeckExecution.html", null, "" ], [ "RundeckHistory", "org/rundeck/api/domain/RundeckHistory.html", null, "" ], [ "RundeckJob", "org/rundeck/api/domain/RundeckJob.html", null, "" ], [ "RundeckJobDelete", "org/rundeck/api/domain/RundeckJobDelete.html", null, "" ], [ "RundeckJobDeleteBulk", "org/rundeck/api/domain/RundeckJobDeleteBulk.html", null, "" ], [ "RundeckJobsImportResult", "org/rundeck/api/domain/RundeckJobsImportResult.html", null, "" ], [ "RundeckNode", "org/rundeck/api/domain/RundeckNode.html", null, "" ], [ "RundeckOutput", "org/rundeck/api/domain/RundeckOutput.html", null, "" ], [ "RundeckOutputEntry", "org/rundeck/api/domain/RundeckOutputEntry.html", null, "" ], [ "RundeckProject", "org/rundeck/api/domain/RundeckProject.html", null, "" ], [ "RundeckSystemInfo", "org/rundeck/api/domain/RundeckSystemInfo.html", null, "" ] ]
+, "" ], [ "Enums", null, [ [ "RundeckAbort.AbortStatus", "org/rundeck/api/domain/RundeckAbort.AbortStatus.html", null, "" ], [ "RundeckEvent.EventStatus", "org/rundeck/api/domain/RundeckEvent.EventStatus.html", null, "" ], [ "RundeckExecution.ExecutionStatus", "org/rundeck/api/domain/RundeckExecution.ExecutionStatus.html", null, "" ], [ "RundeckJobsImportMethod", "org/rundeck/api/domain/RundeckJobsImportMethod.html", null, "" ], [ "RundeckOutputEntry.RundeckLogLevel", "org/rundeck/api/domain/RundeckOutputEntry.RundeckLogLevel.html", null, "" ] ]
, "" ] ]
, "" ], [ "org.rundeck.api.parser", "org/rundeck/api/parser/package-summary.html", [ [ "Description", "org/rundeck/api/parser/package-descr.html", null, "" ], [ "Interfaces", null, [ [ "XmlNodeParser", "org/rundeck/api/parser/XmlNodeParser.html", null, "" ] ]
-, "" ], [ "Classes", null, [ [ "AbortParser", "org/rundeck/api/parser/AbortParser.html", null, "" ], [ "EventParser", "org/rundeck/api/parser/EventParser.html", null, "" ], [ "ExecutionParser", "org/rundeck/api/parser/ExecutionParser.html", null, "" ], [ "HistoryParser", "org/rundeck/api/parser/HistoryParser.html", null, "" ], [ "JobParser", "org/rundeck/api/parser/JobParser.html", null, "" ], [ "JobsImportResultParser", "org/rundeck/api/parser/JobsImportResultParser.html", null, "" ], [ "ListParser", "org/rundeck/api/parser/ListParser.html", null, "" ], [ "NodeParser", "org/rundeck/api/parser/NodeParser.html", null, "" ], [ "ParserHelper", "org/rundeck/api/parser/ParserHelper.html", null, "" ], [ "ProjectParser", "org/rundeck/api/parser/ProjectParser.html", null, "" ], [ "StringParser", "org/rundeck/api/parser/StringParser.html", null, "" ], [ "SystemInfoParser", "org/rundeck/api/parser/SystemInfoParser.html", null, "" ] ]
+, "" ], [ "Classes", null, [ [ "AbortParser", "org/rundeck/api/parser/AbortParser.html", null, "" ], [ "BulkDeleteParser", "org/rundeck/api/parser/BulkDeleteParser.html", null, "" ], [ "DeleteParser", "org/rundeck/api/parser/DeleteParser.html", null, "" ], [ "EventParser", "org/rundeck/api/parser/EventParser.html", null, "" ], [ "ExecutionParser", "org/rundeck/api/parser/ExecutionParser.html", null, "" ], [ "HistoryParser", "org/rundeck/api/parser/HistoryParser.html", null, "" ], [ "JobParser", "org/rundeck/api/parser/JobParser.html", null, "" ], [ "JobsImportResultParser", "org/rundeck/api/parser/JobsImportResultParser.html", null, "" ], [ "ListParser", "org/rundeck/api/parser/ListParser.html", null, "" ], [ "NodeParser", "org/rundeck/api/parser/NodeParser.html", null, "" ], [ "OutputEntryParser", "org/rundeck/api/parser/OutputEntryParser.html", null, "" ], [ "OutputParser", "org/rundeck/api/parser/OutputParser.html", null, "" ], [ "PagedResultParser", "org/rundeck/api/parser/PagedResultParser.html", null, "" ], [ "ParserHelper", "org/rundeck/api/parser/ParserHelper.html", null, "" ], [ "ProjectParser", "org/rundeck/api/parser/ProjectParser.html", null, "" ], [ "StringParser", "org/rundeck/api/parser/StringParser.html", null, "" ], [ "SystemInfoParser", "org/rundeck/api/parser/SystemInfoParser.html", null, "" ] ]
, "" ] ]
-, "" ], [ "org.rundeck.api.util", "org/rundeck/api/util/package-summary.html", [ [ "Description", "org/rundeck/api/util/package-descr.html", null, "" ], [ "Classes", null, [ [ "AssertUtil", "org/rundeck/api/util/AssertUtil.html", null, "" ], [ "ParametersUtil", "org/rundeck/api/util/ParametersUtil.html", null, "" ] ]
+, "" ], [ "org.rundeck.api.query", "org/rundeck/api/query/package-summary.html", [ [ "Description", "org/rundeck/api/query/package-descr.html", null, "" ], [ "Classes", null, [ [ "ExecutionQuery", "org/rundeck/api/query/ExecutionQuery.html", null, "" ], [ "ExecutionQuery.Builder", "org/rundeck/api/query/ExecutionQuery.Builder.html", null, "" ] ]
+, "" ] ]
+, "" ], [ "org.rundeck.api.util", "org/rundeck/api/util/package-summary.html", [ [ "Description", "org/rundeck/api/util/package-descr.html", null, "" ], [ "Interfaces", null, [ [ "PagedResults", "org/rundeck/api/util/PagedResults.html", null, "" ] ]
+, "" ], [ "Classes", null, [ [ "AssertUtil", "org/rundeck/api/util/AssertUtil.html", null, "" ], [ "ParametersUtil", "org/rundeck/api/util/ParametersUtil.html", null, "" ] ]
, "" ] ]
, "" ] ]
diff --git a/apidocs/proof-read.txt b/apidocs/proof-read.txt
index 9dde75a..67d01d3 100644
--- a/apidocs/proof-read.txt
+++ b/apidocs/proof-read.txt
@@ -13,6 +13,9 @@ javadoc proofread file: ./proof-read.txt
Internal parsers for parsing the RunDeck responses.
+=== reference/org/rundeck/api/query/package-descr.html ===
+
+
=== reference/org/rundeck/api/util/package-descr.html ===
Some utility classes.
@@ -21,325 +24,6 @@ javadoc proofread file: ./proof-read.txt
See the documentation of the RundeckClient class (main entry point of the API).
-=== org/rundeck/api/domain/RundeckJobsImportResult.html ===
- Result of importing some jobs into RunDeck
-CONSTRUCTOR: RundeckJobsImportResult
-METHOD: addFailedJob
-METHOD: addSkippedJob
-METHOD: addSucceededJob
-METHOD: equals
-METHOD: getFailedJobs
-METHOD: getSkippedJobs
-METHOD: getSucceededJobs
-METHOD: hashCode
-METHOD: toString
-
-
-=== org/rundeck/api/domain/RundeckAbort.html ===
- Represents an abort of a
- {@link ... RundeckExecution}
-CONSTRUCTOR: RundeckAbort
-METHOD: equals
-METHOD: getExecution
-METHOD: getStatus
-METHOD: hashCode
-METHOD: setExecution
-METHOD: setStatus
-METHOD: toString
-
-
-=== org/rundeck/api/domain/RundeckAbort.AbortStatus.html ===
- The status of an abort
-ENUM: ABORTED
-ENUM: FAILED
-ENUM: PENDING
-METHOD: valueOf
-METHOD: values
-
-
-=== org/rundeck/api/domain/RundeckProject.html ===
- Represents a RunDeck project
-CONSTRUCTOR: RundeckProject
-METHOD: equals
-METHOD: getDescription
-METHOD: getName
-METHOD: getResourceModelProviderUrl
-METHOD: hashCode
-METHOD: setDescription
-METHOD: setName
-METHOD: setResourceModelProviderUrl
-METHOD: toString
-
-
-=== org/rundeck/api/domain/RundeckNode.html ===
- Represents a RunDeck node (server on which RunDeck can execute jobs and commands)
-CONSTRUCTOR: RundeckNode
-METHOD: equals
-METHOD: getDescription
-METHOD: getEditUrl
-METHOD: getHostname
-METHOD: getName
-METHOD: getOsArch
-METHOD: getOsFamily
-METHOD: getOsName
-METHOD: getOsVersion
-METHOD: getRemoteUrl
-METHOD: getTags
-METHOD: getType
-METHOD: getUsername
-METHOD: hashCode
-METHOD: setDescription
-METHOD: setEditUrl
-METHOD: setHostname
-METHOD: setName
-METHOD: setOsArch
-METHOD: setOsFamily
-METHOD: setOsName
-METHOD: setOsVersion
-METHOD: setRemoteUrl
-METHOD: setTags
-METHOD: setType
-METHOD: setUsername
-METHOD: toString
-
-
-=== org/rundeck/api/domain/RundeckHistory.html ===
- Represents a portion of the RunDeck (events) history
-CONSTRUCTOR: RundeckHistory
-METHOD: addEvent
-METHOD: equals
-METHOD: getCount
-METHOD: getEvents
-METHOD: getMax
-METHOD: getOffset
-METHOD: getTotal
-METHOD: hashCode
-METHOD: setCount
-METHOD: setEvents
-METHOD: setMax
-METHOD: setOffset
-METHOD: setTotal
-METHOD: toString
-
-
-=== org/rundeck/api/domain/RundeckEvent.html ===
- Represents a RunDeck event
-CONSTRUCTOR: RundeckEvent
-METHOD: equals
-METHOD: getAbortedBy
-METHOD: getDuration
-METHOD: getDurationInMillis
-METHOD: getDurationInSeconds
-METHOD: getEndedAt
-METHOD: getExecutionId
-METHOD: getJobId
-METHOD: getNodeSummary
-METHOD: getProject
-METHOD: getShortDuration
-METHOD: getStartedAt
-METHOD: getStatus
-METHOD: getSummary
-METHOD: getTitle
-METHOD: getUser
-METHOD: hashCode
-METHOD: isAdhoc
-METHOD: setAbortedBy
-METHOD: setEndedAt
-METHOD: setExecutionId
-METHOD: setJobId
-METHOD: setNodeSummary
-METHOD: setProject
-METHOD: setStartedAt
-METHOD: setStatus
-METHOD: setSummary
-METHOD: setTitle
-METHOD: setUser
-METHOD: toString
-
-
-=== org/rundeck/api/domain/RundeckEvent.NodeSummary.html ===
- Summary for nodes
-CONSTRUCTOR: RundeckEvent.NodeSummary
-METHOD: equals
-METHOD: getFailed
-METHOD: getSucceeded
-METHOD: getTotal
-METHOD: hashCode
-METHOD: setFailed
-METHOD: setSucceeded
-METHOD: setTotal
-METHOD: toString
-
-
-=== org/rundeck/api/domain/RundeckEvent.EventStatus.html ===
- The status of an event
-ENUM: ABORTED
-ENUM: FAILED
-ENUM: SUCCEEDED
-METHOD: valueOf
-METHOD: values
-
-
-=== org/rundeck/api/domain/RundeckSystemInfo.html ===
- Represents the RunDeck system info
-CONSTRUCTOR: RundeckSystemInfo
-METHOD: equals
-METHOD: getActiveThreads
-METHOD: getBaseDir
-METHOD: getBuild
-METHOD: getCpuLoadAverage
-METHOD: getDate
-METHOD: getFreeMemoryInBytes
-METHOD: getJvmName
-METHOD: getJvmVendor
-METHOD: getJvmVersion
-METHOD: getMaxMemoryInBytes
-METHOD: getNode
-METHOD: getOsArch
-METHOD: getOsName
-METHOD: getOsVersion
-METHOD: getRunningJobs
-METHOD: getStartDate
-METHOD: getTotalMemoryInBytes
-METHOD: getUptime
-METHOD: getUptimeInMillis
-METHOD: getVersion
-METHOD: hashCode
-METHOD: setActiveThreads
-METHOD: setBaseDir
-METHOD: setBuild
-METHOD: setCpuLoadAverage
-METHOD: setDate
-METHOD: setFreeMemoryInBytes
-METHOD: setJvmName
-METHOD: setJvmVendor
-METHOD: setJvmVersion
-METHOD: setMaxMemoryInBytes
-METHOD: setNode
-METHOD: setOsArch
-METHOD: setOsName
-METHOD: setOsVersion
-METHOD: setRunningJobs
-METHOD: setStartDate
-METHOD: setTotalMemoryInBytes
-METHOD: setUptimeInMillis
-METHOD: setVersion
-METHOD: toString
-
-
-=== org/rundeck/api/domain/RundeckJob.html ===
- Represents a RunDeck job
-CONSTRUCTOR: RundeckJob
-METHOD: equals
-METHOD: getDescription
-METHOD: getFullName
-METHOD: getGroup
-METHOD: getId
-METHOD: getName
-METHOD: getProject
-METHOD: hashCode
-METHOD: setDescription
-METHOD: setGroup
-METHOD: setId
-METHOD: setName
-METHOD: setProject
-METHOD: toString
-
-
-=== org/rundeck/api/domain/RundeckJobsImportMethod.html ===
- The behavior when importing jobs (which may already exist).
-ENUM: CREATE
-ENUM: SKIP
-ENUM: UPDATE
-METHOD: valueOf
-METHOD: values
-
-
-=== org/rundeck/api/domain/RundeckExecution.html ===
- Represents a RunDeck execution, usually triggered by an API call. An execution could be a
- {@link ... RundeckJob}
- execution or an "ad-hoc" execution.
-CONSTRUCTOR: RundeckExecution
-METHOD: equals
-METHOD: getAbortedBy
-METHOD: getDescription
-METHOD: getDuration
-METHOD: getDurationInMillis
-METHOD: getDurationInSeconds
-METHOD: getEndedAt
-METHOD: getId
-METHOD: getJob
-METHOD: getShortDuration
-METHOD: getStartedAt
-METHOD: getStartedBy
-METHOD: getStatus
-METHOD: getUrl
-METHOD: hashCode
-METHOD: setAbortedBy
-METHOD: setDescription
-METHOD: setEndedAt
-METHOD: setId
-METHOD: setJob
-METHOD: setStartedAt
-METHOD: setStartedBy
-METHOD: setStatus
-METHOD: setUrl
-METHOD: toString
-
-
-=== org/rundeck/api/domain/RundeckExecution.ExecutionStatus.html ===
- The status of an execution
-ENUM: ABORTED
-ENUM: FAILED
-ENUM: RUNNING
-ENUM: SUCCEEDED
-METHOD: valueOf
-METHOD: values
-
-
-=== org/rundeck/api/NodeFiltersBuilder.html ===
- Builder for node filters
-CONSTRUCTOR: NodeFiltersBuilder
- Build a new instance. At the end, use
- {@link ... toProperties()}
- .
-METHOD: excludeHostname
- Exclude nodes matching the given hostname
-METHOD: excludeName
- Exclude nodes matching the given name
-METHOD: excludeOsArch
- Exclude nodes matching the given OS-arch
-METHOD: excludeOsFamily
- Exclude nodes matching the given OS-family
-METHOD: excludeOsName
- Exclude nodes matching the given OS-name
-METHOD: excludeOsVersion
- Exclude nodes matching the given OS-version
-METHOD: excludePrecedence
- Whether exclusion filters take precedence (default to yes).
-METHOD: excludeTags
- Exclude nodes matching the given tags
-METHOD: excludeType
- Exclude nodes matching the given type
-METHOD: hostname
- Include nodes matching the given hostname
-METHOD: name
- Include nodes matching the given name
-METHOD: osArch
- Include nodes matching the given OS-arch
-METHOD: osFamily
- Include nodes matching the given OS-family
-METHOD: osName
- Include nodes matching the given OS-name
-METHOD: osVersion
- Include nodes matching the given OS-version
-METHOD: tags
- Include nodes matching the given tags
-METHOD: toProperties
-METHOD: type
- Include nodes matching the given type
-
-
=== org/rundeck/api/RundeckClient.html ===
Main entry point to talk to a RunDeck instance.
You have 2 methods for authentication : login-based or token-based. If you want to use the first, you need to provide
@@ -348,7 +32,7 @@ METHOD: type
Usage :
-
+
// using login-based authentication :
RundeckClient rundeck = new RundeckClient("http://localhost:4440", "admin", "admin");
// or for a token-based authentication :
@@ -371,19 +55,22 @@ FIELD: API_ENDPOINT
FIELD: API_VERSION
Version of the API supported
CONSTRUCTOR: RundeckClient
- Instantiate a new
- {@link ... RundeckClient}
- for the RunDeck instance at the given url, using token-based
- authentication.
CONSTRUCTOR: RundeckClient
Instantiate a new
{@link ... RundeckClient}
for the RunDeck instance at the given url, using login-based
authentication.
+CONSTRUCTOR: RundeckClient
+ Instantiate a new
+ {@link ... RundeckClient}
+ for the RunDeck instance at the given url,
+ using token-based or session-based authentication. Either token or sessionID must be valid
METHOD: abortExecution
Abort an execution (identified by the given ID). The execution should be running...
METHOD: deleteJob
Delete a single job, identified by the given ID
+METHOD: deleteJobs
+ Delete multiple jobs, identified by the given IDs
METHOD: equals
METHOD: exportJob
Export the definition of a single job, identified by the given ID
@@ -416,8 +103,14 @@ METHOD: exportJobsToFile
METHOD: findJob
Find a job, identified by its project, group and name. Note that the groupPath is optional, as a job does not
need to belong to a group (either pass null, or an empty string).
+METHOD: generateToken
+ Generate a new token and get the result page (which is the html page of the user's profile)
METHOD: getExecution
Get a single execution, identified by the given ID
+METHOD: getExecutions
+ Get executions based on query parameters
+METHOD: getHistory
+ Get the (events) history for the given project
METHOD: getHistory
Get the (events) history for the given project
METHOD: getHistory
@@ -438,6 +131,10 @@ METHOD: getHistory
Get the (events) history for the given project
METHOD: getJob
Get the definition of a single job, identified by the given ID
+METHOD: getJobExecutionOutput
+ Get the execution output of the given job
+METHOD: getJobExecutionOutput
+ Get the execution output of the given job
METHOD: getJobExecutions
Get the executions of the given job
METHOD: getJobExecutions
@@ -463,7 +160,11 @@ METHOD: getNodes
List all nodes that belongs to the given project
METHOD: getNodes
List nodes that belongs to the given project
+METHOD: getOutput
+ Get the output of a job execution
METHOD: getPassword
+METHOD: getProfilePage
+ Get the html page of the user's profile
METHOD: getProject
Get the definition of a single project, identified by the given name
METHOD: getProjects
@@ -472,6 +173,7 @@ METHOD: getRunningExecutions
Get all running executions (for all projects)
METHOD: getRunningExecutions
Get the running executions for the given project
+METHOD: getSessionID
METHOD: getSystemInfo
Get system informations about the RunDeck server
METHOD: getToken
@@ -662,19 +364,6 @@ METHOD: triggerJob
end of the job execution)
-=== org/rundeck/api/OptionsBuilder.html ===
- Builder for job options
-CONSTRUCTOR: OptionsBuilder
- Build a new instance. Use
- {@link ... addOption(Object, Object)}
- to add some options, and then
- {@link ... toProperties()}
- when you're done !
-METHOD: addOption
- Add an option
-METHOD: toProperties
-
-
=== org/rundeck/api/RundeckApiException.html ===
A generic (unchecked) exception when using the RunDeck API
CONSTRUCTOR: RundeckApiException
@@ -699,6 +388,62 @@ CONSTRUCTOR: RundeckApiException.RundeckApiTokenException
CONSTRUCTOR: RundeckApiException.RundeckApiTokenException
+=== org/rundeck/api/OptionsBuilder.html ===
+ Builder for job options
+CONSTRUCTOR: OptionsBuilder
+ Build a new instance. Use
+ {@link ... addOption(Object, Object)}
+ to add some options, and then
+ {@link ... toProperties()}
+ when you're done !
+METHOD: addOption
+ Add an option
+METHOD: toProperties
+
+
+=== org/rundeck/api/NodeFiltersBuilder.html ===
+ Builder for node filters
+CONSTRUCTOR: NodeFiltersBuilder
+ Build a new instance. At the end, use
+ {@link ... toProperties()}
+ .
+METHOD: excludeHostname
+ Exclude nodes matching the given hostname
+METHOD: excludeName
+ Exclude nodes matching the given name
+METHOD: excludeOsArch
+ Exclude nodes matching the given OS-arch
+METHOD: excludeOsFamily
+ Exclude nodes matching the given OS-family
+METHOD: excludeOsName
+ Exclude nodes matching the given OS-name
+METHOD: excludeOsVersion
+ Exclude nodes matching the given OS-version
+METHOD: excludePrecedence
+ Whether exclusion filters take precedence (default to yes).
+METHOD: excludeTags
+ Exclude nodes matching the given tags
+METHOD: excludeType
+ Exclude nodes matching the given type
+METHOD: hostname
+ Include nodes matching the given hostname
+METHOD: name
+ Include nodes matching the given name
+METHOD: osArch
+ Include nodes matching the given OS-arch
+METHOD: osFamily
+ Include nodes matching the given OS-family
+METHOD: osName
+ Include nodes matching the given OS-name
+METHOD: osVersion
+ Include nodes matching the given OS-version
+METHOD: tags
+ Include nodes matching the given tags
+METHOD: toProperties
+METHOD: type
+ Include nodes matching the given type
+
+
=== org/rundeck/api/FileType.html ===
All supported types of files.
ENUM: XML
@@ -707,12 +452,388 @@ METHOD: valueOf
METHOD: values
-=== org/rundeck/api/parser/AbortParser.html ===
- Parser for a single
- {@link ... RundeckAbort}
-CONSTRUCTOR: AbortParser
-CONSTRUCTOR: AbortParser
-METHOD: parseXmlNode
+=== org/rundeck/api/domain/RundeckSystemInfo.html ===
+ Represents the RunDeck system info
+CONSTRUCTOR: RundeckSystemInfo
+METHOD: equals
+METHOD: getActiveThreads
+METHOD: getBaseDir
+METHOD: getBuild
+METHOD: getCpuLoadAverage
+METHOD: getDate
+METHOD: getFreeMemoryInBytes
+METHOD: getJvmName
+METHOD: getJvmVendor
+METHOD: getJvmVersion
+METHOD: getMaxMemoryInBytes
+METHOD: getNode
+METHOD: getOsArch
+METHOD: getOsName
+METHOD: getOsVersion
+METHOD: getRunningJobs
+METHOD: getStartDate
+METHOD: getTotalMemoryInBytes
+METHOD: getUptime
+METHOD: getUptimeInMillis
+METHOD: getVersion
+METHOD: hashCode
+METHOD: setActiveThreads
+METHOD: setBaseDir
+METHOD: setBuild
+METHOD: setCpuLoadAverage
+METHOD: setDate
+METHOD: setFreeMemoryInBytes
+METHOD: setJvmName
+METHOD: setJvmVendor
+METHOD: setJvmVersion
+METHOD: setMaxMemoryInBytes
+METHOD: setNode
+METHOD: setOsArch
+METHOD: setOsName
+METHOD: setOsVersion
+METHOD: setRunningJobs
+METHOD: setStartDate
+METHOD: setTotalMemoryInBytes
+METHOD: setUptimeInMillis
+METHOD: setVersion
+METHOD: toString
+
+
+=== org/rundeck/api/domain/RundeckProject.html ===
+ Represents a RunDeck project
+CONSTRUCTOR: RundeckProject
+METHOD: equals
+METHOD: getDescription
+METHOD: getName
+METHOD: getResourceModelProviderUrl
+METHOD: hashCode
+METHOD: setDescription
+METHOD: setName
+METHOD: setResourceModelProviderUrl
+METHOD: toString
+
+
+=== org/rundeck/api/domain/RundeckOutputEntry.html ===
+ Represents a RunDeck output entry
+CONSTRUCTOR: RundeckOutputEntry
+METHOD: equals
+METHOD: getCommand
+METHOD: getLevel
+METHOD: getMessage
+METHOD: getNode
+METHOD: getTime
+METHOD: getUser
+METHOD: hashCode
+METHOD: setCommand
+METHOD: setLevel
+METHOD: setMessage
+METHOD: setNode
+METHOD: setTime
+METHOD: setUser
+METHOD: toString
+
+
+=== org/rundeck/api/domain/RundeckOutputEntry.RundeckLogLevel.html ===
+ENUM: CONFIG
+ENUM: FINEST
+ENUM: INFO
+ENUM: SEVERE
+ENUM: WARNING
+METHOD: valueOf
+METHOD: values
+
+
+=== org/rundeck/api/domain/RundeckOutput.html ===
+ Represents a RunDeck output
+CONSTRUCTOR: RundeckOutput
+METHOD: addLogEntry
+METHOD: equals
+METHOD: getExecDuration
+METHOD: getExecutionId
+METHOD: getLastModified
+METHOD: getLogEntries
+METHOD: getOffset
+METHOD: getPercentLoaded
+METHOD: getStatus
+METHOD: getTotalSize
+METHOD: hashCode
+METHOD: isCompleted
+METHOD: isEmpty
+METHOD: isExecCompleted
+METHOD: isHasFailedNodes
+METHOD: isUnmodified
+METHOD: setCompleted
+METHOD: setEmpty
+METHOD: setExecCompleted
+METHOD: setExecDuration
+METHOD: setExecutionId
+METHOD: setHasFailedNodes
+METHOD: setLastModified
+METHOD: setLogEntries
+METHOD: setOffset
+METHOD: setPercentLoaded
+METHOD: setStatus
+METHOD: setTotalSize
+METHOD: setUnmodified
+METHOD: toString
+
+
+=== org/rundeck/api/domain/RundeckNode.html ===
+ Represents a RunDeck node (server on which RunDeck can execute jobs and commands)
+CONSTRUCTOR: RundeckNode
+METHOD: equals
+METHOD: getDescription
+METHOD: getEditUrl
+METHOD: getHostname
+METHOD: getName
+METHOD: getOsArch
+METHOD: getOsFamily
+METHOD: getOsName
+METHOD: getOsVersion
+METHOD: getRemoteUrl
+METHOD: getTags
+METHOD: getType
+METHOD: getUsername
+METHOD: hashCode
+METHOD: setDescription
+METHOD: setEditUrl
+METHOD: setHostname
+METHOD: setName
+METHOD: setOsArch
+METHOD: setOsFamily
+METHOD: setOsName
+METHOD: setOsVersion
+METHOD: setRemoteUrl
+METHOD: setTags
+METHOD: setType
+METHOD: setUsername
+METHOD: toString
+
+
+=== org/rundeck/api/domain/RundeckJobsImportResult.html ===
+ Result of importing some jobs into RunDeck
+CONSTRUCTOR: RundeckJobsImportResult
+METHOD: addFailedJob
+METHOD: addSkippedJob
+METHOD: addSucceededJob
+METHOD: equals
+METHOD: getFailedJobs
+METHOD: getSkippedJobs
+METHOD: getSucceededJobs
+METHOD: hashCode
+METHOD: toString
+
+
+=== org/rundeck/api/domain/RundeckJobsImportMethod.html ===
+ The behavior when importing jobs (which may already exist).
+ENUM: CREATE
+ENUM: SKIP
+ENUM: UPDATE
+METHOD: valueOf
+METHOD: values
+
+
+=== org/rundeck/api/domain/RundeckJobDeleteBulk.html ===
+ RundeckJobDeleteBulk represents the result of a bulk job delete request and contains
+ a list of
+ {@link ... RundeckJobDelete}
+ objects.
+CONSTRUCTOR: RundeckJobDeleteBulk
+METHOD: getRequestCount
+ The number of job delete requests processed.
+METHOD: getResults
+METHOD: isAllsuccessful
+ True if all job delete requests were successful
+METHOD: iterator
+METHOD: toString
+
+
+=== org/rundeck/api/domain/RundeckJobDelete.html ===
+ RundeckJobDelete represents a result of a job delete request.
+CONSTRUCTOR: RundeckJobDelete
+METHOD: equals
+METHOD: getError
+ Error message if the job could not be deleted
+METHOD: getErrorCode
+ Error code string if there was a failure
+METHOD: getId
+ Job ID
+METHOD: getMessage
+ Success message if it was successful
+METHOD: hashCode
+METHOD: isSuccessful
+ True if the job was successfully deleted
+METHOD: setError
+METHOD: setErrorCode
+METHOD: setId
+METHOD: setMessage
+METHOD: setSuccessful
+METHOD: toString
+
+
+=== org/rundeck/api/domain/RundeckJob.html ===
+ Represents a RunDeck job
+CONSTRUCTOR: RundeckJob
+METHOD: equals
+METHOD: getAverageDuration
+METHOD: getDescription
+METHOD: getFullName
+METHOD: getGroup
+METHOD: getId
+METHOD: getName
+METHOD: getProject
+METHOD: hashCode
+METHOD: setAverageDuration
+METHOD: setDescription
+METHOD: setGroup
+METHOD: setId
+METHOD: setName
+METHOD: setProject
+METHOD: toString
+
+
+=== org/rundeck/api/domain/RundeckHistory.html ===
+ Represents a portion of the RunDeck (events) history
+CONSTRUCTOR: RundeckHistory
+METHOD: addEvent
+METHOD: equals
+METHOD: getCount
+METHOD: getEvents
+METHOD: getMax
+METHOD: getOffset
+METHOD: getTotal
+METHOD: hashCode
+METHOD: setCount
+METHOD: setEvents
+METHOD: setMax
+METHOD: setOffset
+METHOD: setTotal
+METHOD: toString
+
+
+=== org/rundeck/api/domain/RundeckExecution.html ===
+ Represents a RunDeck execution, usually triggered by an API call. An execution could be a
+ {@link ... RundeckJob}
+ execution or an "ad-hoc" execution.
+CONSTRUCTOR: RundeckExecution
+METHOD: equals
+METHOD: getAbortedBy
+METHOD: getArgstring
+ the argument string for the execution
+METHOD: getDescription
+METHOD: getDuration
+METHOD: getDurationInMillis
+METHOD: getDurationInSeconds
+METHOD: getEndedAt
+METHOD: getId
+METHOD: getJob
+METHOD: getShortDuration
+METHOD: getStartedAt
+METHOD: getStartedBy
+METHOD: getStatus
+METHOD: getUrl
+METHOD: hashCode
+METHOD: setAbortedBy
+METHOD: setArgstring
+METHOD: setDescription
+METHOD: setEndedAt
+METHOD: setId
+METHOD: setJob
+METHOD: setStartedAt
+METHOD: setStartedBy
+METHOD: setStatus
+METHOD: setUrl
+METHOD: toString
+
+
+=== org/rundeck/api/domain/RundeckExecution.ExecutionStatus.html ===
+ The status of an execution
+ENUM: ABORTED
+ENUM: FAILED
+ENUM: RUNNING
+ENUM: SUCCEEDED
+METHOD: valueOf
+METHOD: values
+
+
+=== org/rundeck/api/domain/RundeckEvent.html ===
+ Represents a RunDeck event
+CONSTRUCTOR: RundeckEvent
+METHOD: equals
+METHOD: getAbortedBy
+METHOD: getDuration
+METHOD: getDurationInMillis
+METHOD: getDurationInSeconds
+METHOD: getEndedAt
+METHOD: getExecutionId
+METHOD: getJobId
+METHOD: getNodeSummary
+METHOD: getProject
+METHOD: getShortDuration
+METHOD: getStartedAt
+METHOD: getStatus
+METHOD: getSummary
+METHOD: getTitle
+METHOD: getUser
+METHOD: hashCode
+METHOD: isAdhoc
+METHOD: setAbortedBy
+METHOD: setEndedAt
+METHOD: setExecutionId
+METHOD: setJobId
+METHOD: setNodeSummary
+METHOD: setProject
+METHOD: setStartedAt
+METHOD: setStatus
+METHOD: setSummary
+METHOD: setTitle
+METHOD: setUser
+METHOD: toString
+
+
+=== org/rundeck/api/domain/RundeckEvent.NodeSummary.html ===
+ Summary for nodes
+CONSTRUCTOR: RundeckEvent.NodeSummary
+METHOD: equals
+METHOD: getFailed
+METHOD: getSucceeded
+METHOD: getTotal
+METHOD: hashCode
+METHOD: setFailed
+METHOD: setSucceeded
+METHOD: setTotal
+METHOD: toString
+
+
+=== org/rundeck/api/domain/RundeckEvent.EventStatus.html ===
+ The status of an event
+ENUM: ABORTED
+ENUM: FAILED
+ENUM: SUCCEEDED
+METHOD: valueOf
+METHOD: values
+
+
+=== org/rundeck/api/domain/RundeckAbort.html ===
+ Represents an abort of a
+ {@link ... RundeckExecution}
+CONSTRUCTOR: RundeckAbort
+METHOD: equals
+METHOD: getExecution
+METHOD: getStatus
+METHOD: hashCode
+METHOD: setExecution
+METHOD: setStatus
+METHOD: toString
+
+
+=== org/rundeck/api/domain/RundeckAbort.AbortStatus.html ===
+ The status of an abort
+ENUM: ABORTED
+ENUM: FAILED
+ENUM: PENDING
+METHOD: valueOf
+METHOD: values
=== org/rundeck/api/parser/XmlNodeParser.html ===
@@ -724,19 +845,27 @@ METHOD: parseXmlNode
{@link/Node}
-=== org/rundeck/api/parser/JobParser.html ===
+=== org/rundeck/api/parser/SystemInfoParser.html ===
Parser for a single
- {@link ... RundeckJob}
-CONSTRUCTOR: JobParser
-CONSTRUCTOR: JobParser
+ {@link ... RundeckSystemInfo}
+CONSTRUCTOR: SystemInfoParser
+CONSTRUCTOR: SystemInfoParser
METHOD: parseXmlNode
-=== org/rundeck/api/parser/HistoryParser.html ===
+=== org/rundeck/api/parser/StringParser.html ===
Parser for a single
- {@link ... RundeckHistory}
-CONSTRUCTOR: HistoryParser
-CONSTRUCTOR: HistoryParser
+ {@link/String}
+CONSTRUCTOR: StringParser
+CONSTRUCTOR: StringParser
+METHOD: parseXmlNode
+
+
+=== org/rundeck/api/parser/ProjectParser.html ===
+ Parser for a single
+ {@link ... RundeckProject}
+CONSTRUCTOR: ProjectParser
+CONSTRUCTOR: ProjectParser
METHOD: parseXmlNode
@@ -750,35 +879,22 @@ METHOD: loadDocument
{@link/InputStream}
-=== org/rundeck/api/parser/StringParser.html ===
- Parser for a single
- {@link/String}
-CONSTRUCTOR: StringParser
-CONSTRUCTOR: StringParser
+=== org/rundeck/api/parser/PagedResultParser.html ===
+ PagedResultParser extracts paging data from an xpath node, and includes the List result from a ListParser
+CONSTRUCTOR: PagedResultParser
+ Create a PagedResultParser
METHOD: parseXmlNode
-=== org/rundeck/api/parser/EventParser.html ===
- Parser for a single
- {@link ... RundeckEvent}
-CONSTRUCTOR: EventParser
-CONSTRUCTOR: EventParser
+=== org/rundeck/api/parser/OutputParser.html ===
+CONSTRUCTOR: OutputParser
+CONSTRUCTOR: OutputParser
METHOD: parseXmlNode
-=== org/rundeck/api/parser/JobsImportResultParser.html ===
- Parser for a single
- {@link ... RundeckJobsImportResult}
-CONSTRUCTOR: JobsImportResultParser
-CONSTRUCTOR: JobsImportResultParser
-METHOD: parseXmlNode
-
-
-=== org/rundeck/api/parser/SystemInfoParser.html ===
- Parser for a single
- {@link ... RundeckSystemInfo}
-CONSTRUCTOR: SystemInfoParser
-CONSTRUCTOR: SystemInfoParser
+=== org/rundeck/api/parser/OutputEntryParser.html ===
+CONSTRUCTOR: OutputEntryParser
+CONSTRUCTOR: OutputEntryParser
METHOD: parseXmlNode
@@ -798,6 +914,30 @@ CONSTRUCTOR: ListParser
METHOD: parseXmlNode
+=== org/rundeck/api/parser/JobsImportResultParser.html ===
+ Parser for a single
+ {@link ... RundeckJobsImportResult}
+CONSTRUCTOR: JobsImportResultParser
+CONSTRUCTOR: JobsImportResultParser
+METHOD: parseXmlNode
+
+
+=== org/rundeck/api/parser/JobParser.html ===
+ Parser for a single
+ {@link ... RundeckJob}
+CONSTRUCTOR: JobParser
+CONSTRUCTOR: JobParser
+METHOD: parseXmlNode
+
+
+=== org/rundeck/api/parser/HistoryParser.html ===
+ Parser for a single
+ {@link ... RundeckHistory}
+CONSTRUCTOR: HistoryParser
+CONSTRUCTOR: HistoryParser
+METHOD: parseXmlNode
+
+
=== org/rundeck/api/parser/ExecutionParser.html ===
Parser for a single
{@link ... RundeckExecution}
@@ -806,14 +946,120 @@ CONSTRUCTOR: ExecutionParser
METHOD: parseXmlNode
-=== org/rundeck/api/parser/ProjectParser.html ===
+=== org/rundeck/api/parser/EventParser.html ===
Parser for a single
- {@link ... RundeckProject}
-CONSTRUCTOR: ProjectParser
-CONSTRUCTOR: ProjectParser
+ {@link ... RundeckEvent}
+CONSTRUCTOR: EventParser
+CONSTRUCTOR: EventParser
METHOD: parseXmlNode
+=== org/rundeck/api/parser/DeleteParser.html ===
+ DeleteParser is ...
+CONSTRUCTOR: DeleteParser
+CONSTRUCTOR: DeleteParser
+METHOD: parseXmlNode
+
+
+=== org/rundeck/api/parser/BulkDeleteParser.html ===
+ BulkDeleteParser is ...
+CONSTRUCTOR: BulkDeleteParser
+CONSTRUCTOR: BulkDeleteParser
+METHOD: parseXmlNode
+
+
+=== org/rundeck/api/parser/AbortParser.html ===
+ Parser for a single
+ {@link ... RundeckAbort}
+CONSTRUCTOR: AbortParser
+CONSTRUCTOR: AbortParser
+METHOD: parseXmlNode
+
+
+=== org/rundeck/api/query/ExecutionQuery.html ===
+ ExecutionQuery contains the query parameters for the /executions api, create one with the
+ {@link ... ExecutionQuery.Builder}
+ class, e.g.
+ using the
+ {@link ... builder()}
+ method.
+METHOD: builder
+ Create a Builder for an ExecutionQuery
+METHOD: getAbortedby
+METHOD: getAdhoc
+METHOD: getBegin
+METHOD: getDescription
+METHOD: getEnd
+METHOD: getExcludeGroupPath
+METHOD: getExcludeGroupPathExact
+METHOD: getExcludeJob
+METHOD: getExcludeJobExact
+METHOD: getExcludeJobIdList
+METHOD: getExcludeJobList
+METHOD: getGroupPath
+METHOD: getGroupPathExact
+METHOD: getJob
+METHOD: getJobExact
+METHOD: getJobIdList
+METHOD: getJobList
+METHOD: getProject
+METHOD: getRecent
+METHOD: getStatus
+METHOD: getUser
+METHOD: notBlank
+ Return true if some parameter is set
+
+
+=== org/rundeck/api/query/ExecutionQuery.Builder.html ===
+ Builder for ExecutionQueries
+CONSTRUCTOR: ExecutionQuery.Builder
+METHOD: abortedby
+ Username
+METHOD: adhoc
+ True to query only adhoc executions, false to query only Job executions, null for both
+METHOD: begin
+ Start date/time for execution completion time
+METHOD: build
+ Build the query
+METHOD: description
+ Job description match
+METHOD: end
+ End date/time for execution completion time
+METHOD: excludeGroupPath
+ Group path or super path, which will exclude any jobs within the subtree.
+METHOD: excludeGroupPathExact
+ Exact group path to exclude
+METHOD: excludeJob
+ Job name filter to exclude, which can match any part of the name
+METHOD: excludeJobExact
+ Job exact name filter to exclude, much match exactly
+METHOD: excludeJobIdList
+ List of job IDs to exclude from query
+METHOD: excludeJobList
+ List of job "group/name" to exclude from query
+METHOD: groupPath
+ Group path or super path, which will include any jobs within the subtree.
+METHOD: groupPathExact
+ Exact group path to include
+METHOD: job
+ Job name filter, which can match any part of the name
+METHOD: jobExact
+ Job exact name filter, much match exactly
+METHOD: jobIdList
+ List of job IDs to query
+METHOD: jobList
+ List of job "group/name" to query
+METHOD: project
+ Project name
+METHOD: recent
+ Recent time filter, in the for "XY", where X is a number, and Y
+ is one of: "h" (hour), "d" (day), "w" (week), "m" (month), "y" (year)
+METHOD: status
+ Execution status to query
+METHOD: user
+ Name of username that started the execution
+
+
=== org/rundeck/api/util/ParametersUtil.html ===
Utility class for API parameters that should be passed in URLs.
CONSTRUCTOR: ParametersUtil
@@ -827,6 +1073,20 @@ METHOD: urlEncode
URL-encode the given string
+=== org/rundeck/api/util/PagedResults.html ===
+ PagedResults contains a List of a certain type, and paging information.
+METHOD: getCount
+ Number of items available in page
+METHOD: getMax
+ Max number of items returned in page
+METHOD: getOffset
+ Offset into all items
+METHOD: getResults
+ Results list
+METHOD: getTotal
+ Total items to be paged
+
+
=== org/rundeck/api/util/AssertUtil.html ===
Utility class for assertions
CONSTRUCTOR: AssertUtil
diff --git a/apidocs/reference/classes.html b/apidocs/reference/classes.html
index 842ba14..14b5d94 100644
--- a/apidocs/reference/classes.html
+++ b/apidocs/reference/classes.html
@@ -148,6 +148,8 @@
org.rundeck.api.parser
+ org.rundeck.api.query
+
org.rundeck.api.util
@@ -197,6 +199,8 @@
A
+
B
+
D
E
F
H
@@ -231,6 +235,32 @@
+
B
+
+
+
+
D
+
+
+
E
@@ -337,6 +380,18 @@
+
+ OutputEntryParser |
+ |
+
+
+
+
+ OutputParser |
+ |
+
+
+
@@ -344,6 +399,18 @@
+
+ PagedResultParser<T> |
+ PagedResultParser extracts paging data from an xpath node, and includes the List result from a ListParser |
+
+
+
+
+ PagedResults<T> |
+ PagedResults contains a List of a certain type, and paging information. |
+
+
+
ParametersUtil |
Utility class for API parameters that should be passed in URLs. |
@@ -459,6 +526,19 @@
+
+ RundeckJobDelete |
+ RundeckJobDelete represents a result of a job delete request. |
+
+
+
+
+ RundeckJobDeleteBulk |
+ RundeckJobDeleteBulk represents the result of a bulk job delete request and contains
+ a list of RundeckJobDelete objects. |
+
+
+
RundeckJobsImportMethod |
The behavior when importing jobs (which may already exist). |
@@ -478,12 +558,34 @@
+ RundeckOutput |
+ Represents a RunDeck output
+
+ |
+
+
+
+
+ RundeckOutputEntry |
+ Represents a RunDeck output entry
+
+ |
+
+
+
+
+ RundeckOutputEntry.RundeckLogLevel |
+ |
+
+
+
+
RundeckProject |
Represents a RunDeck project |
-
+
RundeckSystemInfo |
Represents the RunDeck system info |
diff --git a/apidocs/reference/current.xml b/apidocs/reference/current.xml
index b1a84b3..a8689bc 100644
--- a/apidocs/reference/current.xml
+++ b/apidocs/reference/current.xml
@@ -488,6 +488,24 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -1166,6 +1288,62 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
org.rundeck.api.parser
+ org.rundeck.api.query
+
org.rundeck.api.util
@@ -399,6 +401,42 @@
+
+ |
+
+
+ RundeckJobDelete
+
+ |
+
+
+
+ |
+
+
+
+
+
+
+ |
+
+
+ RundeckJobDeleteBulk
+
+ |
+
+
+
+ Iterable
+
+
+
+ |
+
+
+
+
+
|
@@ -439,6 +477,46 @@
+ |
+ |
+
+
+ RundeckOutput
+
+ |
+
+
+
+ Serializable
+
+
+
+ |
+
+
+
+
+
+
+ |
+
+
+ RundeckOutputEntry
+
+ |
+
+
+
+ Serializable
+
+
+
+ |
+
+
+
+
+
|
@@ -499,6 +577,46 @@
+ |
+ |
+
+
+ BulkDeleteParser
+
+ |
+
+
+
+ XmlNodeParser
+
+
+
+ |
+
+
+
+
+
+
+ |
+
+
+ DeleteParser
+
+ |
+
+
+
+ XmlNodeParser
+
+
+
+ |
+
+
+
+
+
|
@@ -639,6 +757,66 @@
+ |
+ |
+
+
+ OutputEntryParser
+
+ |
+
+
+
+ XmlNodeParser
+
+
+
+ |
+
+
+
+
+
+
+ |
+
+
+ OutputParser
+
+ |
+
+
+
+ XmlNodeParser
+
+
+
+ |
+
+
+
+
+
+
+ |
+
+
+ PagedResultParser
+
+ |
+
+
+
+ XmlNodeParser
+
+
+
+ |
+
+
+
+
+
|
@@ -715,6 +893,38 @@
+ |
+ |
+
+
+ ExecutionQuery
+
+ |
+
+
+
+ |
+
+
+
+
+
+
+ |
+
+
+ ExecutionQuery.Builder
+
+ |
+
+
+
+ |
+
+
+
+
+
|
diff --git a/apidocs/reference/lists.js b/apidocs/reference/lists.js
index 8f25957..e798ae4 100644
--- a/apidocs/reference/lists.js
+++ b/apidocs/reference/lists.js
@@ -18,27 +18,41 @@ var DATA = [
{ id:16, label:"org.rundeck.api.domain.RundeckExecution.ExecutionStatus", link:"org/rundeck/api/domain/RundeckExecution.ExecutionStatus.html", type:"class" },
{ id:17, label:"org.rundeck.api.domain.RundeckHistory", link:"org/rundeck/api/domain/RundeckHistory.html", type:"class" },
{ id:18, label:"org.rundeck.api.domain.RundeckJob", link:"org/rundeck/api/domain/RundeckJob.html", type:"class" },
- { id:19, label:"org.rundeck.api.domain.RundeckJobsImportMethod", link:"org/rundeck/api/domain/RundeckJobsImportMethod.html", type:"class" },
- { id:20, label:"org.rundeck.api.domain.RundeckJobsImportResult", link:"org/rundeck/api/domain/RundeckJobsImportResult.html", type:"class" },
- { id:21, label:"org.rundeck.api.domain.RundeckNode", link:"org/rundeck/api/domain/RundeckNode.html", type:"class" },
- { id:22, label:"org.rundeck.api.domain.RundeckProject", link:"org/rundeck/api/domain/RundeckProject.html", type:"class" },
- { id:23, label:"org.rundeck.api.domain.RundeckSystemInfo", link:"org/rundeck/api/domain/RundeckSystemInfo.html", type:"class" },
- { id:24, label:"org.rundeck.api.parser", link:"org/rundeck/api/parser/package-summary.html", type:"package" },
- { id:25, label:"org.rundeck.api.parser.AbortParser", link:"org/rundeck/api/parser/AbortParser.html", type:"class" },
- { id:26, label:"org.rundeck.api.parser.EventParser", link:"org/rundeck/api/parser/EventParser.html", type:"class" },
- { id:27, label:"org.rundeck.api.parser.ExecutionParser", link:"org/rundeck/api/parser/ExecutionParser.html", type:"class" },
- { id:28, label:"org.rundeck.api.parser.HistoryParser", link:"org/rundeck/api/parser/HistoryParser.html", type:"class" },
- { id:29, label:"org.rundeck.api.parser.JobParser", link:"org/rundeck/api/parser/JobParser.html", type:"class" },
- { id:30, label:"org.rundeck.api.parser.JobsImportResultParser", link:"org/rundeck/api/parser/JobsImportResultParser.html", type:"class" },
- { id:31, label:"org.rundeck.api.parser.ListParser", link:"org/rundeck/api/parser/ListParser.html", type:"class" },
- { id:32, label:"org.rundeck.api.parser.NodeParser", link:"org/rundeck/api/parser/NodeParser.html", type:"class" },
- { id:33, label:"org.rundeck.api.parser.ParserHelper", link:"org/rundeck/api/parser/ParserHelper.html", type:"class" },
- { id:34, label:"org.rundeck.api.parser.ProjectParser", link:"org/rundeck/api/parser/ProjectParser.html", type:"class" },
- { id:35, label:"org.rundeck.api.parser.StringParser", link:"org/rundeck/api/parser/StringParser.html", type:"class" },
- { id:36, label:"org.rundeck.api.parser.SystemInfoParser", link:"org/rundeck/api/parser/SystemInfoParser.html", type:"class" },
- { id:37, label:"org.rundeck.api.parser.XmlNodeParser", link:"org/rundeck/api/parser/XmlNodeParser.html", type:"class" },
- { id:38, label:"org.rundeck.api.util", link:"org/rundeck/api/util/package-summary.html", type:"package" },
- { id:39, label:"org.rundeck.api.util.AssertUtil", link:"org/rundeck/api/util/AssertUtil.html", type:"class" },
- { id:40, label:"org.rundeck.api.util.ParametersUtil", link:"org/rundeck/api/util/ParametersUtil.html", type:"class" }
+ { id:19, label:"org.rundeck.api.domain.RundeckJobDelete", link:"org/rundeck/api/domain/RundeckJobDelete.html", type:"class" },
+ { id:20, label:"org.rundeck.api.domain.RundeckJobDeleteBulk", link:"org/rundeck/api/domain/RundeckJobDeleteBulk.html", type:"class" },
+ { id:21, label:"org.rundeck.api.domain.RundeckJobsImportMethod", link:"org/rundeck/api/domain/RundeckJobsImportMethod.html", type:"class" },
+ { id:22, label:"org.rundeck.api.domain.RundeckJobsImportResult", link:"org/rundeck/api/domain/RundeckJobsImportResult.html", type:"class" },
+ { id:23, label:"org.rundeck.api.domain.RundeckNode", link:"org/rundeck/api/domain/RundeckNode.html", type:"class" },
+ { id:24, label:"org.rundeck.api.domain.RundeckOutput", link:"org/rundeck/api/domain/RundeckOutput.html", type:"class" },
+ { id:25, label:"org.rundeck.api.domain.RundeckOutputEntry", link:"org/rundeck/api/domain/RundeckOutputEntry.html", type:"class" },
+ { id:26, label:"org.rundeck.api.domain.RundeckOutputEntry.RundeckLogLevel", link:"org/rundeck/api/domain/RundeckOutputEntry.RundeckLogLevel.html", type:"class" },
+ { id:27, label:"org.rundeck.api.domain.RundeckProject", link:"org/rundeck/api/domain/RundeckProject.html", type:"class" },
+ { id:28, label:"org.rundeck.api.domain.RundeckSystemInfo", link:"org/rundeck/api/domain/RundeckSystemInfo.html", type:"class" },
+ { id:29, label:"org.rundeck.api.parser", link:"org/rundeck/api/parser/package-summary.html", type:"package" },
+ { id:30, label:"org.rundeck.api.parser.AbortParser", link:"org/rundeck/api/parser/AbortParser.html", type:"class" },
+ { id:31, label:"org.rundeck.api.parser.BulkDeleteParser", link:"org/rundeck/api/parser/BulkDeleteParser.html", type:"class" },
+ { id:32, label:"org.rundeck.api.parser.DeleteParser", link:"org/rundeck/api/parser/DeleteParser.html", type:"class" },
+ { id:33, label:"org.rundeck.api.parser.EventParser", link:"org/rundeck/api/parser/EventParser.html", type:"class" },
+ { id:34, label:"org.rundeck.api.parser.ExecutionParser", link:"org/rundeck/api/parser/ExecutionParser.html", type:"class" },
+ { id:35, label:"org.rundeck.api.parser.HistoryParser", link:"org/rundeck/api/parser/HistoryParser.html", type:"class" },
+ { id:36, label:"org.rundeck.api.parser.JobParser", link:"org/rundeck/api/parser/JobParser.html", type:"class" },
+ { id:37, label:"org.rundeck.api.parser.JobsImportResultParser", link:"org/rundeck/api/parser/JobsImportResultParser.html", type:"class" },
+ { id:38, label:"org.rundeck.api.parser.ListParser", link:"org/rundeck/api/parser/ListParser.html", type:"class" },
+ { id:39, label:"org.rundeck.api.parser.NodeParser", link:"org/rundeck/api/parser/NodeParser.html", type:"class" },
+ { id:40, label:"org.rundeck.api.parser.OutputEntryParser", link:"org/rundeck/api/parser/OutputEntryParser.html", type:"class" },
+ { id:41, label:"org.rundeck.api.parser.OutputParser", link:"org/rundeck/api/parser/OutputParser.html", type:"class" },
+ { id:42, label:"org.rundeck.api.parser.PagedResultParser", link:"org/rundeck/api/parser/PagedResultParser.html", type:"class" },
+ { id:43, label:"org.rundeck.api.parser.ParserHelper", link:"org/rundeck/api/parser/ParserHelper.html", type:"class" },
+ { id:44, label:"org.rundeck.api.parser.ProjectParser", link:"org/rundeck/api/parser/ProjectParser.html", type:"class" },
+ { id:45, label:"org.rundeck.api.parser.StringParser", link:"org/rundeck/api/parser/StringParser.html", type:"class" },
+ { id:46, label:"org.rundeck.api.parser.SystemInfoParser", link:"org/rundeck/api/parser/SystemInfoParser.html", type:"class" },
+ { id:47, label:"org.rundeck.api.parser.XmlNodeParser", link:"org/rundeck/api/parser/XmlNodeParser.html", type:"class" },
+ { id:48, label:"org.rundeck.api.query", link:"org/rundeck/api/query/package-summary.html", type:"package" },
+ { id:49, label:"org.rundeck.api.query.ExecutionQuery", link:"org/rundeck/api/query/ExecutionQuery.html", type:"class" },
+ { id:50, label:"org.rundeck.api.query.ExecutionQuery.Builder", link:"org/rundeck/api/query/ExecutionQuery.Builder.html", type:"class" },
+ { id:51, label:"org.rundeck.api.util", link:"org/rundeck/api/util/package-summary.html", type:"package" },
+ { id:52, label:"org.rundeck.api.util.AssertUtil", link:"org/rundeck/api/util/AssertUtil.html", type:"class" },
+ { id:53, label:"org.rundeck.api.util.PagedResults", link:"org/rundeck/api/util/PagedResults.html", type:"class" },
+ { id:54, label:"org.rundeck.api.util.ParametersUtil", link:"org/rundeck/api/util/ParametersUtil.html", type:"class" }
];
diff --git a/apidocs/reference/org/rundeck/api/FileType.html b/apidocs/reference/org/rundeck/api/FileType.html
index d1ca21a..4286198 100644
--- a/apidocs/reference/org/rundeck/api/FileType.html
+++ b/apidocs/reference/org/rundeck/api/FileType.html
@@ -149,6 +149,8 @@
org.rundeck.api.parser
+ org.rundeck.api.query
+
org.rundeck.api.util
diff --git a/apidocs/reference/org/rundeck/api/NodeFiltersBuilder.html b/apidocs/reference/org/rundeck/api/NodeFiltersBuilder.html
index b1c5681..0c8c54e 100644
--- a/apidocs/reference/org/rundeck/api/NodeFiltersBuilder.html
+++ b/apidocs/reference/org/rundeck/api/NodeFiltersBuilder.html
@@ -149,6 +149,8 @@
org.rundeck.api.parser
+ org.rundeck.api.query
+
org.rundeck.api.util
diff --git a/apidocs/reference/org/rundeck/api/OptionsBuilder.html b/apidocs/reference/org/rundeck/api/OptionsBuilder.html
index d3ac568..ca344cc 100644
--- a/apidocs/reference/org/rundeck/api/OptionsBuilder.html
+++ b/apidocs/reference/org/rundeck/api/OptionsBuilder.html
@@ -149,6 +149,8 @@
org.rundeck.api.parser
+ org.rundeck.api.query
+
org.rundeck.api.util
diff --git a/apidocs/reference/org/rundeck/api/RundeckApiException.RundeckApiAuthException.html b/apidocs/reference/org/rundeck/api/RundeckApiException.RundeckApiAuthException.html
index 5150212..e1a21b7 100644
--- a/apidocs/reference/org/rundeck/api/RundeckApiException.RundeckApiAuthException.html
+++ b/apidocs/reference/org/rundeck/api/RundeckApiException.RundeckApiAuthException.html
@@ -149,6 +149,8 @@
org.rundeck.api.parser
+ org.rundeck.api.query
+
org.rundeck.api.util
diff --git a/apidocs/reference/org/rundeck/api/RundeckApiException.RundeckApiLoginException.html b/apidocs/reference/org/rundeck/api/RundeckApiException.RundeckApiLoginException.html
index 204c06d..0db94ef 100644
--- a/apidocs/reference/org/rundeck/api/RundeckApiException.RundeckApiLoginException.html
+++ b/apidocs/reference/org/rundeck/api/RundeckApiException.RundeckApiLoginException.html
@@ -149,6 +149,8 @@
org.rundeck.api.parser
+ org.rundeck.api.query
+
org.rundeck.api.util
diff --git a/apidocs/reference/org/rundeck/api/RundeckApiException.RundeckApiTokenException.html b/apidocs/reference/org/rundeck/api/RundeckApiException.RundeckApiTokenException.html
index a363a93..9b52e34 100644
--- a/apidocs/reference/org/rundeck/api/RundeckApiException.RundeckApiTokenException.html
+++ b/apidocs/reference/org/rundeck/api/RundeckApiException.RundeckApiTokenException.html
@@ -149,6 +149,8 @@
org.rundeck.api.parser
+ org.rundeck.api.query
+
org.rundeck.api.util
diff --git a/apidocs/reference/org/rundeck/api/RundeckApiException.html b/apidocs/reference/org/rundeck/api/RundeckApiException.html
index e5bc9b2..1e3026f 100644
--- a/apidocs/reference/org/rundeck/api/RundeckApiException.html
+++ b/apidocs/reference/org/rundeck/api/RundeckApiException.html
@@ -149,6 +149,8 @@
org.rundeck.api.parser
+ org.rundeck.api.query
+
org.rundeck.api.util
diff --git a/apidocs/reference/org/rundeck/api/RundeckClient.html b/apidocs/reference/org/rundeck/api/RundeckClient.html
index 443e90f..e05ace2 100644
--- a/apidocs/reference/org/rundeck/api/RundeckClient.html
+++ b/apidocs/reference/org/rundeck/api/RundeckClient.html
@@ -149,6 +149,8 @@
org.rundeck.api.parser
+ org.rundeck.api.query
+
org.rundeck.api.util
@@ -341,7 +343,7 @@ Summary:
Usage :
-
+
// using login-based authentication :
RundeckClient rundeck = new RundeckClient("http://localhost:4440", "admin", "admin");
// or for a token-based authentication :
@@ -449,9 +451,6 @@ Summary:
RundeckClient(String url, String token)
- Instantiate a new RundeckClient for the RunDeck instance at the given url, using token-based
- authentication.
-
| |
@@ -474,6 +473,25 @@ Summary:
+
+
+
+
+
+
+
+
+
+ |
+
+ RundeckClient(String url, String token, String sessionID, boolean useToken)
+
+ Instantiate a new RundeckClient for the RunDeck instance at the given url,
+ using token-based or session-based authentication.
+
+ |
+
+
@@ -531,6 +549,24 @@ Summary:
+
RundeckJobDeleteBulk
+
+
+ deleteJobs(List<String> jobIds)
+
+ Delete multiple jobs, identified by the given IDs
+
+ |
+
+
+
+
+
+
+
+
+
+
boolean
|
@@ -540,7 +576,7 @@ Summary:
-
+
@@ -558,7 +594,7 @@ Summary:
-
+
@@ -576,7 +612,7 @@ Summary:
-
+
@@ -594,7 +630,7 @@ Summary:
-
+
@@ -612,7 +648,7 @@ Summary:
-
+
@@ -630,7 +666,7 @@ Summary:
-
+
@@ -649,7 +685,7 @@ Summary:
-
+
@@ -667,7 +703,7 @@ Summary:
-
+
@@ -686,7 +722,7 @@ Summary:
-
+
@@ -704,7 +740,7 @@ Summary:
-
+
@@ -723,7 +759,7 @@ Summary:
-
+
@@ -741,7 +777,7 @@ Summary:
-
+
@@ -760,7 +796,7 @@ Summary:
-
+
@@ -778,6 +814,24 @@ Summary:
+
+
+
+
+
+
+
+ InputStream
+ |
+
+ generateToken(String username)
+
+ Generate a new token and get the result page (which is the html page of the user's profile)
+
+ |
+
+
+
@@ -803,6 +857,24 @@ Summary:
+ PagedResults<RundeckExecution>
+ |
+
+ getExecutions(ExecutionQuery query, Long max, Long offset)
+
+ Get executions based on query parameters
+
+ |
+
+
+
+
+
+
+
+
+
+
RundeckHistory
|
@@ -814,7 +886,7 @@ Summary:
-
+
@@ -832,7 +904,7 @@ Summary:
-
+
@@ -850,7 +922,7 @@ Summary:
-
+
@@ -868,7 +940,7 @@ Summary:
-
+
@@ -886,7 +958,7 @@ Summary:
-
+
@@ -904,7 +976,7 @@ Summary:
-
+
@@ -922,6 +994,24 @@ Summary:
+
+
+
+
+
+
+
+ RundeckHistory
+ |
+
+ getHistory(String project, String user, String recent, List<String> includeJobNames, List<String> excludeJobNames, Date begin, Date end, Long max, Long offset)
+
+ Get the (events) history for the given project
+
+ |
+
+
+
@@ -983,6 +1073,42 @@ Summary:
+ RundeckOutput
+ |
+
+ getJobExecutionOutput(Long executionId, int offset, int lastlines, long lastmod, int maxlines)
+
+ Get the execution output of the given job
+
+ |
+
+
+
+
+
+
+
+
+
+
+ RundeckOutput
+ |
+
+ getJobExecutionOutput(Long executionId, int offset, long lastmod, int maxlines)
+
+ Get the execution output of the given job
+
+ |
+
+
+
+
+
+
+
+
+
+
List<RundeckExecution>
|
@@ -1215,6 +1341,24 @@ Summary:
+ InputStream
+ |
+
+ getOutput(String executionId)
+
+ Get the output of a job execution
+
+ |
+
+
+
+
+
+
+
+
+
+
String
|
@@ -1224,6 +1368,24 @@ Summary:
+
+
+
+
+
+
+
+ InputStream
+ |
+
+ getProfilePage(String username)
+
+ Get the html page of the user's profile
+
+ |
+
+
+
@@ -1303,6 +1465,22 @@ Summary:
+ String
+ |
+
+ getSessionID()
+
+ |
+
+
+
+
+
+
+
+
+
+
RundeckSystemInfo
|
@@ -1314,7 +1492,7 @@ Summary:
-
+
@@ -1330,7 +1508,7 @@ Summary:
-
+
@@ -1346,7 +1524,7 @@ Summary:
-
+
@@ -1362,7 +1540,7 @@ Summary:
-
+
@@ -1380,7 +1558,7 @@ Summary:
-
+
@@ -1398,7 +1576,7 @@ Summary:
-
+
@@ -1416,7 +1594,7 @@ Summary:
-
+
@@ -1434,7 +1612,7 @@ Summary:
-
+
@@ -1452,7 +1630,7 @@ Summary:
-
+
@@ -1470,7 +1648,7 @@ Summary:
-
+
@@ -1488,7 +1666,7 @@ Summary:
-
+
@@ -1506,7 +1684,7 @@ Summary:
-
+
@@ -1524,7 +1702,7 @@ Summary:
-
+
@@ -1542,7 +1720,7 @@ Summary:
-
+
@@ -1560,7 +1738,7 @@ Summary:
-
+
@@ -1578,7 +1756,7 @@ Summary:
-
+
@@ -1596,7 +1774,7 @@ Summary:
-
+
@@ -1614,7 +1792,7 @@ Summary:
-
+
@@ -1632,7 +1810,7 @@ Summary:
-
+
@@ -1650,7 +1828,7 @@ Summary:
-
+
@@ -1668,7 +1846,7 @@ Summary:
-
+
@@ -1686,7 +1864,7 @@ Summary:
-
+
@@ -1704,7 +1882,7 @@ Summary:
-
+
@@ -1722,7 +1900,7 @@ Summary:
-
+
@@ -1740,7 +1918,7 @@ Summary:
-
+
@@ -1758,7 +1936,7 @@ Summary:
-
+
@@ -1776,7 +1954,7 @@ Summary:
-
+
@@ -1794,7 +1972,7 @@ Summary:
-
+
@@ -1812,7 +1990,7 @@ Summary:
-
+
@@ -1830,7 +2008,7 @@ Summary:
-
+
@@ -1848,7 +2026,7 @@ Summary:
-
+
@@ -1866,7 +2044,7 @@ Summary:
-
+
@@ -1884,7 +2062,7 @@ Summary:
-
+
@@ -1902,7 +2080,7 @@ Summary:
-
+
@@ -1920,7 +2098,7 @@ Summary:
-
+
@@ -1938,7 +2116,7 @@ Summary:
-
+
@@ -1956,7 +2134,7 @@ Summary:
-
+
@@ -1974,7 +2152,7 @@ Summary:
-
+
@@ -1992,7 +2170,7 @@ Summary:
-
+
@@ -2010,14 +2188,14 @@ Summary:
-
+
- void
+ String
|
testAuth()
@@ -2028,7 +2206,7 @@ Summary:
- |
+
@@ -2049,7 +2227,7 @@ Summary:
-
+
@@ -2065,7 +2243,7 @@ Summary:
-
+
@@ -2083,7 +2261,7 @@ Summary:
-
+
@@ -2101,7 +2279,7 @@ Summary:
-
+
@@ -2119,7 +2297,7 @@ Summary:
-
+
@@ -2137,7 +2315,7 @@ Summary:
-
+
@@ -2155,7 +2333,7 @@ Summary:
-
+
@@ -2173,7 +2351,7 @@ Summary:
-
+
@@ -2191,7 +2369,7 @@ Summary:
-
+
@@ -2209,7 +2387,7 @@ Summary:
-
+
@@ -2227,7 +2405,7 @@ Summary:
-
+
@@ -2245,7 +2423,7 @@ Summary:
-
+
@@ -2263,7 +2441,7 @@ Summary:
-
+
@@ -2282,7 +2460,7 @@ Summary:
-
+
@@ -2301,7 +2479,7 @@ Summary:
-
+
@@ -2595,7 +2773,7 @@ From class
Constant Value:
- "/api/2"
+ "/api/5"
@@ -2634,8 +2812,8 @@ From class
Constant Value:
- 2
- (0x00000002)
+ 5
+ (0x00000005)
@@ -2682,28 +2860,13 @@ From class
- Instantiate a new RundeckClient for the RunDeck instance at the given url, using token-based
- authentication.
-
- Parameters
-
-
- url
- | of the RunDeck instance ("http://localhost:4440", "http://rundeck.your-compagny.com/", etc) |
-
-
- token
- | to use for authentication on the RunDeck instance |
-
-
-
+
@@ -2771,6 +2934,69 @@ From class
+
+
+
+
+
+ public
+
+
+
+
+
+
+ RundeckClient
+ (String url, String token, String sessionID, boolean useToken)
+
+
+
+
+ Instantiate a new RundeckClient for the RunDeck instance at the given url,
+ using token-based or session-based authentication. Either token or sessionID must be valid
+
+ Parameters
+
+
+ url
+ | of the RunDeck instance ("http://localhost:4440", "http://rundeck.your-compagny.com/", etc) |
+
+
+ token
+ | to use for authentication on the RunDeck instance |
+
+
+ sessionID
+ | to use for session authentication on the RunDeck instance |
+
+
+ useToken
+ | should be true if using token, false if using sessionID |
+
+
+
+
+
+
+
+
+
@@ -2918,6 +3144,72 @@ From class
+
+
+
+
+
+
+
+ Delete multiple jobs, identified by the given IDs
+
+ Parameters
+
+
+ jobIds
+ | List of job IDS |
+
+
+
+
+
+
+
+
+
+
@@ -4000,6 +4292,72 @@ From class
+
+
+
+
+
+ public
+
+
+
+
+ InputStream
+
+ generateToken
+ (String username)
+
+
+
+
+ Generate a new token and get the result page (which is the html page of the user's profile)
+
+ Parameters
+
+
+ username
+ | - mandatory |
+
+
+
+
+ Returns
+ - an InputStream instance, not linked to any network resources - won't be null
+
+
+
+
+
+
+
@@ -4066,6 +4424,80 @@ From class
+
+
+
+
+
+
+
+ Get executions based on query parameters
+
+ Parameters
+
+
+ query
+ | query parameters for the request |
+
+
+ max
+ | number of results to return - optional (null for all) |
+
+
+ offset
+ | the 0-indexed offset for the first result to return - optional |
+
+
+
+
+
+
+
+
+
+
@@ -4646,6 +5078,106 @@ From class
+
+
+
+
+
+
+
+ Get the (events) history for the given project
+
+ Parameters
+
+
+ project
+ | name of the project - mandatory |
+
+
+ user
+ | include only events created by the given user - optional |
+
+
+ recent
+ | include only events matching the given period of time. Format : "XY", where X is an
+ integer, and Y is one of : "h" (hour), "d" (day), "w" (week), "m" (month), "y" (year).
+ Example : "2w" (= last 2 weeks), "5d" (= last 5 days), etc. Optional. |
+
+
+ includeJobNames
+ | list of job names ("group/name") to include results for |
+
+
+ excludeJobNames
+ | list of job names ("group/name") to exclude results for |
+
+
+ begin
+ | date for the earlier events to retrieve - optional |
+
+
+ end
+ | date for the latest events to retrieve - optional |
+
+
+ max
+ | number of results to return - optional (default to 20) |
+
+
+ offset
+ | the 0-indexed offset for the first result to return - optional (default to O) |
+
+
+
+
+
+
+
+
+
+
@@ -4880,6 +5412,162 @@ From class
+
+
+
+
+
+ public
+
+
+
+
+ RundeckOutput
+
+ getJobExecutionOutput
+ (Long executionId, int offset, int lastlines, long lastmod, int maxlines)
+
+
+
+
+ Get the execution output of the given job
+
+ Parameters
+
+
+ executionId
+ | identifier of the execution - mandatory |
+
+
+ offset
+ | byte offset to read from in the file. 0 indicates the beginning. |
+
+
+ lastlines
+ | nnumber of lines to retrieve from the end of the available output. If specified it will override the offset value and return only the specified number of lines at the end of the log. |
+
+
+ lastmod
+ | epoch datestamp in milliseconds, return results only if modification changed since the specified date OR if more data is available at the given offset |
+
+
+ maxlines
+ | maximum number of lines to retrieve forward from the specified offset. |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ public
+
+
+
+
+ RundeckOutput
+
+ getJobExecutionOutput
+ (Long executionId, int offset, long lastmod, int maxlines)
+
+
+
+
+ Get the execution output of the given job
+
+ Parameters
+
+
+ offset
+ | byte offset to read from in the file. 0 indicates the beginning. |
+
+
+ lastmod
+ | epoch datestamp in milliseconds, return results only if modification changed since the specified date OR if more data is available at the given offset |
+
+
+ maxlines
+ | maximum number of lines to retrieve forward from the specified offset. |
+
+
+
+
+
+
+
+
+
+
@@ -5493,7 +6181,7 @@ From class
Returns
- - the login used for authentication on the RunDeck instance (null if using token-based auth)
+
- the login used for authentication on the RunDeck instance (null if using token-based or session-based auth)
@@ -5764,6 +6452,63 @@ From class
+
+
+
+
+
+ public
+
+
+
+
+ InputStream
+
+ getOutput
+ (String executionId)
+
+
+
+
+ Get the output of a job execution
+
+ Returns
+ - an InputStream instance, not linked to any network resources - won't be null
+
+
+
+
+
+
+
@@ -5792,7 +6537,7 @@ From class
Returns
- - the password used for authentication on the RunDeck instance (null if using token-based auth)
+
- the password used for authentication on the RunDeck instance (null if using token-based or session-based auth)
@@ -5800,6 +6545,72 @@ From class
+
+
+
+
+
+ public
+
+
+
+
+ InputStream
+
+ getProfilePage
+ (String username)
+
+
+
+
+ Get the html page of the user's profile
+
+ Parameters
+
+
+ username
+ | - mandatory |
+
+
+
+
+ Returns
+ - an InputStream instance, not linked to any network resources - won't be null
+
+
+
+
+
+
+
@@ -6046,6 +6857,42 @@ From class
+
+
+
+
+
+ public
+
+
+
+
+ String
+
+ getSessionID
+ ()
+
+
+
+
+
+
+ Returns
+ - the sessionID used for authentication on the RunDeck instance (null if using login-based or token-based auth)
+
+
+
+
+
+
+
@@ -6127,7 +6974,7 @@ From class
Returns
- - the auth-token used for authentication on the RunDeck instance (null if using login-based auth)
+
- the auth-token used for authentication on the RunDeck instance (null if using login-based or session-based auth)
@@ -9262,7 +10109,7 @@ From class
- void
+ String
testAuth
()
@@ -9278,6 +10125,10 @@ From class
Test the authentication on the RunDeck instance.
+
+ Returns
+ - sessionID if doing username+password login and it succeeded
+
Throws
diff --git a/apidocs/reference/org/rundeck/api/domain/RundeckAbort.AbortStatus.html b/apidocs/reference/org/rundeck/api/domain/RundeckAbort.AbortStatus.html
index c7dca82..5b432d6 100644
--- a/apidocs/reference/org/rundeck/api/domain/RundeckAbort.AbortStatus.html
+++ b/apidocs/reference/org/rundeck/api/domain/RundeckAbort.AbortStatus.html
@@ -149,6 +149,8 @@
org.rundeck.api.parser
+ org.rundeck.api.query
+
org.rundeck.api.util
@@ -165,8 +167,12 @@
RundeckExecution
RundeckHistory
RundeckJob
+ RundeckJobDelete
+ RundeckJobDeleteBulk
RundeckJobsImportResult
RundeckNode
+ RundeckOutput
+ RundeckOutputEntry
RundeckProject
RundeckSystemInfo
@@ -179,6 +185,7 @@
RundeckEvent.EventStatus
RundeckExecution.ExecutionStatus
RundeckJobsImportMethod
+ RundeckOutputEntry.RundeckLogLevel
diff --git a/apidocs/reference/org/rundeck/api/domain/RundeckAbort.html b/apidocs/reference/org/rundeck/api/domain/RundeckAbort.html
index 5683a24..488bdbb 100644
--- a/apidocs/reference/org/rundeck/api/domain/RundeckAbort.html
+++ b/apidocs/reference/org/rundeck/api/domain/RundeckAbort.html
@@ -149,6 +149,8 @@
org.rundeck.api.parser
+ org.rundeck.api.query
+
org.rundeck.api.util
@@ -165,8 +167,12 @@
RundeckExecution
RundeckHistory
RundeckJob
+ RundeckJobDelete
+ RundeckJobDeleteBulk
RundeckJobsImportResult
RundeckNode
+ RundeckOutput
+ RundeckOutputEntry
RundeckProject
RundeckSystemInfo
@@ -179,6 +185,7 @@
RundeckEvent.EventStatus
RundeckExecution.ExecutionStatus
RundeckJobsImportMethod
+ RundeckOutputEntry.RundeckLogLevel
diff --git a/apidocs/reference/org/rundeck/api/domain/RundeckEvent.EventStatus.html b/apidocs/reference/org/rundeck/api/domain/RundeckEvent.EventStatus.html
index f38d0ee..2db9539 100644
--- a/apidocs/reference/org/rundeck/api/domain/RundeckEvent.EventStatus.html
+++ b/apidocs/reference/org/rundeck/api/domain/RundeckEvent.EventStatus.html
@@ -149,6 +149,8 @@
org.rundeck.api.parser
+ org.rundeck.api.query
+
org.rundeck.api.util
@@ -165,8 +167,12 @@
RundeckExecution
RundeckHistory
RundeckJob
+ RundeckJobDelete
+ RundeckJobDeleteBulk
RundeckJobsImportResult
RundeckNode
+ RundeckOutput
+ RundeckOutputEntry
RundeckProject
RundeckSystemInfo
@@ -179,6 +185,7 @@
RundeckEvent.EventStatus
RundeckExecution.ExecutionStatus
RundeckJobsImportMethod
+ RundeckOutputEntry.RundeckLogLevel
diff --git a/apidocs/reference/org/rundeck/api/domain/RundeckEvent.NodeSummary.html b/apidocs/reference/org/rundeck/api/domain/RundeckEvent.NodeSummary.html
index 9e89cdc..d07bb02 100644
--- a/apidocs/reference/org/rundeck/api/domain/RundeckEvent.NodeSummary.html
+++ b/apidocs/reference/org/rundeck/api/domain/RundeckEvent.NodeSummary.html
@@ -149,6 +149,8 @@
org.rundeck.api.parser
+ org.rundeck.api.query
+
org.rundeck.api.util
@@ -165,8 +167,12 @@
RundeckExecution
RundeckHistory
RundeckJob
+ RundeckJobDelete
+ RundeckJobDeleteBulk
RundeckJobsImportResult
RundeckNode
+ RundeckOutput
+ RundeckOutputEntry
RundeckProject
RundeckSystemInfo
@@ -179,6 +185,7 @@
RundeckEvent.EventStatus
RundeckExecution.ExecutionStatus
RundeckJobsImportMethod
+ RundeckOutputEntry.RundeckLogLevel
diff --git a/apidocs/reference/org/rundeck/api/domain/RundeckEvent.html b/apidocs/reference/org/rundeck/api/domain/RundeckEvent.html
index 067a253..63afab9 100644
--- a/apidocs/reference/org/rundeck/api/domain/RundeckEvent.html
+++ b/apidocs/reference/org/rundeck/api/domain/RundeckEvent.html
@@ -149,6 +149,8 @@
org.rundeck.api.parser
+ org.rundeck.api.query
+
org.rundeck.api.util
@@ -165,8 +167,12 @@
RundeckExecution
RundeckHistory
RundeckJob
+ RundeckJobDelete
+ RundeckJobDeleteBulk
RundeckJobsImportResult
RundeckNode
+ RundeckOutput
+ RundeckOutputEntry
RundeckProject
RundeckSystemInfo
@@ -179,6 +185,7 @@
RundeckEvent.EventStatus
RundeckExecution.ExecutionStatus
RundeckJobsImportMethod
+ RundeckOutputEntry.RundeckLogLevel
diff --git a/apidocs/reference/org/rundeck/api/domain/RundeckExecution.ExecutionStatus.html b/apidocs/reference/org/rundeck/api/domain/RundeckExecution.ExecutionStatus.html
index 563c51b..21d7877 100644
--- a/apidocs/reference/org/rundeck/api/domain/RundeckExecution.ExecutionStatus.html
+++ b/apidocs/reference/org/rundeck/api/domain/RundeckExecution.ExecutionStatus.html
@@ -149,6 +149,8 @@
org.rundeck.api.parser
+ org.rundeck.api.query
+
org.rundeck.api.util
@@ -165,8 +167,12 @@
RundeckExecution
RundeckHistory
RundeckJob
+ RundeckJobDelete
+ RundeckJobDeleteBulk
RundeckJobsImportResult
RundeckNode
+ RundeckOutput
+ RundeckOutputEntry
RundeckProject
RundeckSystemInfo
@@ -179,6 +185,7 @@
RundeckEvent.EventStatus
RundeckExecution.ExecutionStatus
RundeckJobsImportMethod
+ RundeckOutputEntry.RundeckLogLevel
diff --git a/apidocs/reference/org/rundeck/api/domain/RundeckExecution.html b/apidocs/reference/org/rundeck/api/domain/RundeckExecution.html
index 04db062..2bdbe2b 100644
--- a/apidocs/reference/org/rundeck/api/domain/RundeckExecution.html
+++ b/apidocs/reference/org/rundeck/api/domain/RundeckExecution.html
@@ -149,6 +149,8 @@
org.rundeck.api.parser
+ org.rundeck.api.query
+
org.rundeck.api.util
@@ -165,8 +167,12 @@
RundeckExecution
RundeckHistory
RundeckJob
+ RundeckJobDelete
+ RundeckJobDeleteBulk
RundeckJobsImportResult
RundeckNode
+ RundeckOutput
+ RundeckOutputEntry
RundeckProject
RundeckSystemInfo
@@ -179,6 +185,7 @@
RundeckEvent.EventStatus
RundeckExecution.ExecutionStatus
RundeckJobsImportMethod
+ RundeckOutputEntry.RundeckLogLevel
@@ -482,6 +489,25 @@ Summary:
+ String
+
+
+ getArgstring()
+
+ the argument string for the execution
+
+
+ |
+
+
+
+
+
+
+
+
+
+
String
|
@@ -491,7 +517,7 @@ Summary:
-
+
@@ -507,7 +533,7 @@ Summary:
-
+
@@ -523,7 +549,7 @@ Summary:
-
+
@@ -539,7 +565,7 @@ Summary:
-
+
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |