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

A

addOption(Object, Object) - Method in class org.rundeck.api.util.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.RundeckExecution

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

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.util.NodeFiltersBuilder

Exclude nodes matching the given hostname

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

Exclude nodes matching the given name

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

Exclude nodes matching the given OS-arch

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

Exclude nodes matching the given OS-family

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

Exclude nodes matching the given OS-name

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

Exclude nodes matching the given OS-version

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

Whether exclusion filters take precedence (default to yes).

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

Exclude nodes matching the given tags

excludeType(String) - Method in class org.rundeck.api.util.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.RundeckProject

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

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

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

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

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

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.RundeckProject

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

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.RundeckExecution

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

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

H

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.RundeckProject

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

hostname(String) - Method in class org.rundeck.api.util.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.util.NodeFiltersBuilder

Include nodes matching the given name

NodeFiltersBuilder - Class in org.rundeck.api.util

Builder for node filters

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

Build a new instance.

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

Interface to be implemented for parsers that handle XML Nodes

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.util

Builder for job options

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

Build a new instance.

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

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

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

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

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

Include nodes matching the given OS-arch

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

Include nodes matching the given OS-family

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

Include nodes matching the given OS-name

osVersion(String) - Method in class org.rundeck.api.util.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

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

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

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

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

parseNode(Node) - Method in interface org.rundeck.api.parser.NodeParser

Parse the given XML Node

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

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

ParserHelper - Class in org.rundeck.api.parser

Helper for parsing RunDeck responses

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

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.

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

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.RundeckProject

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

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

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.RundeckProject

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

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

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

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

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

T

tags(String) - Method in class org.rundeck.api.util.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.util.NodeFiltersBuilder

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

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.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.util.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.RundeckExecution.ExecutionStatus

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

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.

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