A E F G H J L N O P R S T U V X

A

abortExecution(Long) - Method in class org.rundeck.api.RundeckClient

Abort an execution (identified by the given ID).

AbortParser - Class in org.rundeck.api.parser

Parser for a single RundeckAbort

AbortParser() - Constructor for class org.rundeck.api.parser.AbortParser

AbortParser(String) - Constructor for class org.rundeck.api.parser.AbortParser

addOption(Object, Object) - Method in class org.rundeck.api.OptionsBuilder

Add an option

API_ENDPOINT - Static variable in class org.rundeck.api.RundeckClient

API_VERSION - Static variable in class org.rundeck.api.RundeckClient

AssertUtil - Class in org.rundeck.api.util

Utility class for assertions

AssertUtil() - Constructor for class org.rundeck.api.util.AssertUtil

E

equals(Object) - Method in class org.rundeck.api.domain.RundeckAbort

equals(Object) - Method in class org.rundeck.api.domain.RundeckExecution

equals(Object) - Method in class org.rundeck.api.domain.RundeckJob

equals(Object) - Method in class org.rundeck.api.domain.RundeckNode

equals(Object) - Method in class org.rundeck.api.domain.RundeckProject

equals(Object) - Method in class org.rundeck.api.RundeckClient

excludeHostname(String) - Method in class org.rundeck.api.NodeFiltersBuilder

Exclude nodes matching the given hostname

excludeName(String) - Method in class org.rundeck.api.NodeFiltersBuilder

Exclude nodes matching the given name

excludeOsArch(String) - Method in class org.rundeck.api.NodeFiltersBuilder

Exclude nodes matching the given OS-arch

excludeOsFamily(String) - Method in class org.rundeck.api.NodeFiltersBuilder

Exclude nodes matching the given OS-family

excludeOsName(String) - Method in class org.rundeck.api.NodeFiltersBuilder

Exclude nodes matching the given OS-name

excludeOsVersion(String) - Method in class org.rundeck.api.NodeFiltersBuilder

Exclude nodes matching the given OS-version

excludePrecedence(boolean) - Method in class org.rundeck.api.NodeFiltersBuilder

Whether exclusion filters take precedence (default to yes).

excludeTags(String) - Method in class org.rundeck.api.NodeFiltersBuilder

Exclude nodes matching the given tags

excludeType(String) - Method in class org.rundeck.api.NodeFiltersBuilder

Exclude nodes matching the given type

ExecutionParser - Class in org.rundeck.api.parser

Parser for a single RundeckExecution

ExecutionParser() - Constructor for class org.rundeck.api.parser.ExecutionParser

ExecutionParser(String) - Constructor for class org.rundeck.api.parser.ExecutionParser

ExecutionsParser - Class in org.rundeck.api.parser

Parser for a List of RundeckExecution

ExecutionsParser(String) - Constructor for class org.rundeck.api.parser.ExecutionsParser

F

findJob(String, String, String) - Method in class org.rundeck.api.RundeckClient

Find a job, identified by its project, group and name.

G

generateArgString(Properties) - Static method in class org.rundeck.api.util.ParametersUtil

Generates a RunDeck "argString" representing the given options.

generateNodeFiltersString(Properties) - Static method in class org.rundeck.api.util.ParametersUtil

Generates an url-encoded string representing the given nodeFilters.

getAbortedBy() - Method in class org.rundeck.api.domain.RundeckExecution

getDescription() - Method in class org.rundeck.api.domain.RundeckExecution

getDescription() - Method in class org.rundeck.api.domain.RundeckJob

getDescription() - Method in class org.rundeck.api.domain.RundeckNode

getDescription() - Method in class org.rundeck.api.domain.RundeckProject

getDurationInMillis() - Method in class org.rundeck.api.domain.RundeckExecution

getDurationInSeconds() - Method in class org.rundeck.api.domain.RundeckExecution

getEditUrl() - Method in class org.rundeck.api.domain.RundeckNode

getEndedAt() - Method in class org.rundeck.api.domain.RundeckExecution

getExecution() - Method in class org.rundeck.api.domain.RundeckAbort

getExecution(Long) - Method in class org.rundeck.api.RundeckClient

Get a single execution, identified by the given ID

getFullName() - Method in class org.rundeck.api.domain.RundeckJob

getGroup() - Method in class org.rundeck.api.domain.RundeckJob

getHostname() - Method in class org.rundeck.api.domain.RundeckNode

getId() - Method in class org.rundeck.api.domain.RundeckExecution

getId() - Method in class org.rundeck.api.domain.RundeckJob

getJob() - Method in class org.rundeck.api.domain.RundeckExecution

getJob(String) - Method in class org.rundeck.api.RundeckClient

Get the definition of a single job, identified by the given ID

getJobExecutions(String) - Method in class org.rundeck.api.RundeckClient

Get the executions of the given job

getJobExecutions(String, RundeckExecution.ExecutionStatus) - Method in class org.rundeck.api.RundeckClient

Get the executions of the given job

getJobExecutions(String, RundeckExecution.ExecutionStatus, Long, Long) - Method in class org.rundeck.api.RundeckClient

Get the executions of the given job

getJobs() - Method in class org.rundeck.api.RundeckClient

List all jobs (for all projects)

getJobs(String) - Method in class org.rundeck.api.RundeckClient

List all jobs that belongs to the given project

getJobs(String, String, String, String...) - Method in class org.rundeck.api.RundeckClient

List the jobs that belongs to the given project, and matches the given criteria (jobFilter, groupPath and jobIds)

getLogin() - Method in class org.rundeck.api.RundeckClient

getName() - Method in class org.rundeck.api.domain.RundeckJob

getName() - Method in class org.rundeck.api.domain.RundeckNode

getName() - Method in class org.rundeck.api.domain.RundeckProject

getNode(String, String) - Method in class org.rundeck.api.RundeckClient

Get the definition of a single node

getNodes() - Method in class org.rundeck.api.RundeckClient

List all nodes (for all projects)

getNodes(String) - Method in class org.rundeck.api.RundeckClient

List all nodes that belongs to the given project

getNodes(String, Properties) - Method in class org.rundeck.api.RundeckClient

List nodes that belongs to the given project

getOsArch() - Method in class org.rundeck.api.domain.RundeckNode

getOsFamily() - Method in class org.rundeck.api.domain.RundeckNode

getOsName() - Method in class org.rundeck.api.domain.RundeckNode

getOsVersion() - Method in class org.rundeck.api.domain.RundeckNode

getPassword() - Method in class org.rundeck.api.RundeckClient

getProject() - Method in class org.rundeck.api.domain.RundeckJob

getProject(String) - Method in class org.rundeck.api.RundeckClient

Get the definition of a single project, identified by the given name

getProjects() - Method in class org.rundeck.api.RundeckClient

List all projects

getRemoteUrl() - Method in class org.rundeck.api.domain.RundeckNode

getRunningExecutions() - Method in class org.rundeck.api.RundeckClient

Get all running executions (for all projects)

getRunningExecutions(String) - Method in class org.rundeck.api.RundeckClient

Get the running executions for the given project

getStartedAt() - Method in class org.rundeck.api.domain.RundeckExecution

getStartedBy() - Method in class org.rundeck.api.domain.RundeckExecution

getStatus() - Method in class org.rundeck.api.domain.RundeckAbort

getStatus() - Method in class org.rundeck.api.domain.RundeckExecution

getTags() - Method in class org.rundeck.api.domain.RundeckNode

getType() - Method in class org.rundeck.api.domain.RundeckNode

getUrl() - Method in class org.rundeck.api.domain.RundeckExecution

getUrl() - Method in class org.rundeck.api.RundeckClient

getUsername() - Method in class org.rundeck.api.domain.RundeckNode

H

hashCode() - Method in class org.rundeck.api.domain.RundeckAbort

hashCode() - Method in class org.rundeck.api.domain.RundeckExecution

hashCode() - Method in class org.rundeck.api.domain.RundeckJob

hashCode() - Method in class org.rundeck.api.domain.RundeckNode

hashCode() - Method in class org.rundeck.api.domain.RundeckProject

hashCode() - Method in class org.rundeck.api.RundeckClient

hostname(String) - Method in class org.rundeck.api.NodeFiltersBuilder

Include nodes matching the given hostname

J

JobParser - Class in org.rundeck.api.parser

Parser for a single RundeckJob

JobParser() - Constructor for class org.rundeck.api.parser.JobParser

JobParser(String) - Constructor for class org.rundeck.api.parser.JobParser

JobsParser - Class in org.rundeck.api.parser

Parser for a List of RundeckJob

JobsParser(String) - Constructor for class org.rundeck.api.parser.JobsParser

L

loadDocument(HttpResponse) - Static method in class org.rundeck.api.parser.ParserHelper

Load an XML Document from the given RunDeck HttpResponse.

loadDocument(InputStream) - Static method in class org.rundeck.api.parser.ParserHelper

Load an XML Document from the given InputStream

N

name(String) - Method in class org.rundeck.api.NodeFiltersBuilder

Include nodes matching the given name

NodeFiltersBuilder - Class in org.rundeck.api

Builder for node filters

NodeFiltersBuilder() - Constructor for class org.rundeck.api.NodeFiltersBuilder

Build a new instance.

NodeParser - Class in org.rundeck.api.parser

Parser for a single RundeckNode

NodeParser() - Constructor for class org.rundeck.api.parser.NodeParser

NodeParser(String) - Constructor for class org.rundeck.api.parser.NodeParser

NodesParser - Class in org.rundeck.api.parser

Parser for a List of RundeckNode

NodesParser(String) - Constructor for class org.rundeck.api.parser.NodesParser

notBlank(String, String) - Static method in class org.rundeck.api.util.AssertUtil

Test if the given String is blank (null, empty or only whitespace)

notNull(Object, String) - Static method in class org.rundeck.api.util.AssertUtil

Test if the given Object is null

O

OptionsBuilder - Class in org.rundeck.api

Builder for job options

OptionsBuilder() - Constructor for class org.rundeck.api.OptionsBuilder

Build a new instance.

org.rundeck.api - package org.rundeck.api

Java client for the RunDeck API.

org.rundeck.api.domain - package org.rundeck.api.domain

Domain classes that are returned to the client of the API.

org.rundeck.api.parser - package org.rundeck.api.parser

Internal parsers for parsing the RunDeck responses.

org.rundeck.api.util - package org.rundeck.api.util

Some utility classes.

osArch(String) - Method in class org.rundeck.api.NodeFiltersBuilder

Include nodes matching the given OS-arch

osFamily(String) - Method in class org.rundeck.api.NodeFiltersBuilder

Include nodes matching the given OS-family

osName(String) - Method in class org.rundeck.api.NodeFiltersBuilder

Include nodes matching the given OS-name

osVersion(String) - Method in class org.rundeck.api.NodeFiltersBuilder

Include nodes matching the given OS-version

P

ParametersUtil - Class in org.rundeck.api.util

Utility class for API parameters that should be passed in URLs.

ParametersUtil() - Constructor for class org.rundeck.api.util.ParametersUtil

ParserHelper - Class in org.rundeck.api.parser

Helper for parsing RunDeck responses

ParserHelper() - Constructor for class org.rundeck.api.parser.ParserHelper

parseXmlNode(Node) - Method in class org.rundeck.api.parser.AbortParser

parseXmlNode(Node) - Method in class org.rundeck.api.parser.ExecutionParser

parseXmlNode(Node) - Method in class org.rundeck.api.parser.ExecutionsParser

parseXmlNode(Node) - Method in class org.rundeck.api.parser.JobParser

parseXmlNode(Node) - Method in class org.rundeck.api.parser.JobsParser

parseXmlNode(Node) - Method in class org.rundeck.api.parser.NodeParser

parseXmlNode(Node) - Method in class org.rundeck.api.parser.NodesParser

parseXmlNode(Node) - Method in class org.rundeck.api.parser.ProjectParser

parseXmlNode(Node) - Method in class org.rundeck.api.parser.ProjectsParser

parseXmlNode(Node) - Method in interface org.rundeck.api.parser.XmlNodeParser

Parse the given XML Node

ping() - Method in class org.rundeck.api.RundeckClient

Try to "ping" the RunDeck instance to see if it is alive

ProjectParser - Class in org.rundeck.api.parser

Parser for a single RundeckProject

ProjectParser() - Constructor for class org.rundeck.api.parser.ProjectParser

ProjectParser(String) - Constructor for class org.rundeck.api.parser.ProjectParser

ProjectsParser - Class in org.rundeck.api.parser

Parser for a List of RundeckProject

ProjectsParser(String) - Constructor for class org.rundeck.api.parser.ProjectsParser

R

runAdhocCommand(String, String) - Method in class org.rundeck.api.RundeckClient

Run an ad-hoc command, and wait until its execution is finished (or aborted) to return.

runAdhocCommand(String, String, long, TimeUnit) - Method in class org.rundeck.api.RundeckClient

Run an ad-hoc command, and wait until its execution is finished (or aborted) to return.

runAdhocCommand(String, String, Properties) - Method in class org.rundeck.api.RundeckClient

Run an ad-hoc command, and wait until its execution is finished (or aborted) to return.

runAdhocCommand(String, String, Properties, long, TimeUnit) - Method in class org.rundeck.api.RundeckClient

Run an ad-hoc command, and wait until its execution is finished (or aborted) to return.

RundeckAbort - Class in org.rundeck.api.domain

Represents an abort of a RundeckExecution

RundeckAbort() - Constructor for class org.rundeck.api.domain.RundeckAbort

RundeckAbort.AbortStatus - Enum in org.rundeck.api.domain

The status of an abort

RundeckApiException - Exception in org.rundeck.api

A generic (unchecked) exception when using the RunDeck API

RundeckApiException(String) - Constructor for exception org.rundeck.api.RundeckApiException

RundeckApiException(String, Throwable) - Constructor for exception org.rundeck.api.RundeckApiException

RundeckApiException.RundeckApiLoginException - Exception in org.rundeck.api

Specific login-related error

RundeckApiException.RundeckApiLoginException(String) - Constructor for exception org.rundeck.api.RundeckApiException.RundeckApiLoginException

RundeckApiException.RundeckApiLoginException(String, Throwable) - Constructor for exception org.rundeck.api.RundeckApiException.RundeckApiLoginException

RundeckClient - Class in org.rundeck.api

Main entry point to talk to a RunDeck instance.

RundeckClient(String, String, String) - Constructor for class org.rundeck.api.RundeckClient

Instantiate a new RundeckClient for the RunDeck instance at the given url

RundeckExecution - Class in org.rundeck.api.domain

Represents a RunDeck execution, usually triggered by an API call.

RundeckExecution() - Constructor for class org.rundeck.api.domain.RundeckExecution

RundeckExecution.ExecutionStatus - Enum in org.rundeck.api.domain

The status of an execution

RundeckJob - Class in org.rundeck.api.domain

Represents a RunDeck job

RundeckJob() - Constructor for class org.rundeck.api.domain.RundeckJob

RundeckNode - Class in org.rundeck.api.domain

Represents a RunDeck node (server on which RunDeck can execute jobs and commands)

RundeckNode() - Constructor for class org.rundeck.api.domain.RundeckNode

RundeckProject - Class in org.rundeck.api.domain

Represents a RunDeck project

RundeckProject() - Constructor for class org.rundeck.api.domain.RundeckProject

runJob(String) - Method in class org.rundeck.api.RundeckClient

Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return.

runJob(String, Properties) - Method in class org.rundeck.api.RundeckClient

Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return.

runJob(String, Properties, Properties) - Method in class org.rundeck.api.RundeckClient

Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return.

runJob(String, Properties, long, TimeUnit) - Method in class org.rundeck.api.RundeckClient

Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return.

runJob(String, Properties, Properties, long, TimeUnit) - Method in class org.rundeck.api.RundeckClient

Run a RunDeck job (identified by the given ID), and wait until its execution is finished (or aborted) to return.

S

setAbortedBy(String) - Method in class org.rundeck.api.domain.RundeckExecution

setDescription(String) - Method in class org.rundeck.api.domain.RundeckExecution

setDescription(String) - Method in class org.rundeck.api.domain.RundeckJob

setDescription(String) - Method in class org.rundeck.api.domain.RundeckNode

setDescription(String) - Method in class org.rundeck.api.domain.RundeckProject

setEditUrl(String) - Method in class org.rundeck.api.domain.RundeckNode

setEndedAt(Date) - Method in class org.rundeck.api.domain.RundeckExecution

setExecution(RundeckExecution) - Method in class org.rundeck.api.domain.RundeckAbort

setGroup(String) - Method in class org.rundeck.api.domain.RundeckJob

setHostname(String) - Method in class org.rundeck.api.domain.RundeckNode

setId(Long) - Method in class org.rundeck.api.domain.RundeckExecution

setId(String) - Method in class org.rundeck.api.domain.RundeckJob

setJob(RundeckJob) - Method in class org.rundeck.api.domain.RundeckExecution

setName(String) - Method in class org.rundeck.api.domain.RundeckJob

setName(String) - Method in class org.rundeck.api.domain.RundeckNode

setName(String) - Method in class org.rundeck.api.domain.RundeckProject

setOsArch(String) - Method in class org.rundeck.api.domain.RundeckNode

setOsFamily(String) - Method in class org.rundeck.api.domain.RundeckNode

setOsName(String) - Method in class org.rundeck.api.domain.RundeckNode

setOsVersion(String) - Method in class org.rundeck.api.domain.RundeckNode

setProject(String) - Method in class org.rundeck.api.domain.RundeckJob

setRemoteUrl(String) - Method in class org.rundeck.api.domain.RundeckNode

setStartedAt(Date) - Method in class org.rundeck.api.domain.RundeckExecution

setStartedBy(String) - Method in class org.rundeck.api.domain.RundeckExecution

setStatus(RundeckAbort.AbortStatus) - Method in class org.rundeck.api.domain.RundeckAbort

setStatus(RundeckExecution.ExecutionStatus) - Method in class org.rundeck.api.domain.RundeckExecution

setTags(List<String>) - Method in class org.rundeck.api.domain.RundeckNode

setType(String) - Method in class org.rundeck.api.domain.RundeckNode

setUrl(String) - Method in class org.rundeck.api.domain.RundeckExecution

setUsername(String) - Method in class org.rundeck.api.domain.RundeckNode

T

tags(String) - Method in class org.rundeck.api.NodeFiltersBuilder

Include nodes matching the given tags

testCredentials() - Method in class org.rundeck.api.RundeckClient

Test your credentials (login/password) on the RunDeck instance

toProperties() - Method in class org.rundeck.api.NodeFiltersBuilder

toProperties() - Method in class org.rundeck.api.OptionsBuilder

toString() - Method in class org.rundeck.api.domain.RundeckAbort

toString() - Method in class org.rundeck.api.domain.RundeckExecution

toString() - Method in class org.rundeck.api.domain.RundeckJob

toString() - Method in class org.rundeck.api.domain.RundeckNode

toString() - Method in class org.rundeck.api.domain.RundeckProject

toString() - Method in class org.rundeck.api.RundeckClient

triggerAdhocCommand(String, String) - Method in class org.rundeck.api.RundeckClient

Trigger the execution of an ad-hoc command, and return immediately (without waiting the end of the execution).

triggerAdhocCommand(String, String, Properties) - Method in class org.rundeck.api.RundeckClient

Trigger the execution of an ad-hoc command, and return immediately (without waiting the end of the execution).

triggerJob(String) - Method in class org.rundeck.api.RundeckClient

Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the end of the job execution)

triggerJob(String, Properties) - Method in class org.rundeck.api.RundeckClient

Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the end of the job execution)

triggerJob(String, Properties, Properties) - Method in class org.rundeck.api.RundeckClient

Trigger the execution of a RunDeck job (identified by the given ID), and return immediately (without waiting the end of the job execution)

type(String) - Method in class org.rundeck.api.NodeFiltersBuilder

Include nodes matching the given type

U

urlEncode(String) - Static method in class org.rundeck.api.util.ParametersUtil

URL-encode the given string

V

valueOf(String) - Static method in enum org.rundeck.api.domain.RundeckAbort.AbortStatus

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.rundeck.api.domain.RundeckExecution.ExecutionStatus

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.rundeck.api.domain.RundeckAbort.AbortStatus

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.rundeck.api.domain.RundeckExecution.ExecutionStatus

Returns an array containing the constants of this enum type, in the order they are declared.

X

XmlNodeParser<T> - Interface in org.rundeck.api.parser

Interface to be implemented for parsers that handle XML Nodes

A E F G H J L N O P R S T U V X