Index (GoCD Plugin API)

A B C D E F G H I J L N O P R S T U V W

A

about() - Method in interface com.thoughtworks.go.plugin.api.info.PluginDescriptor: Plugin author information.
AbstractGoPlugin - Class in com.thoughtworks.go.plugin.api: An abstract implementation GoPlugin which will take care of GoApplicationAccessor initialization.
AbstractGoPlugin() - Constructor for class com.thoughtworks.go.plugin.api.AbstractGoPlugin
add(Property) - Method in class com.thoughtworks.go.plugin.api.config.Configuration: Deprecated.

Adds given property as configuration
add(Option<T>) - Method in class com.thoughtworks.go.plugin.api.config.Options: Deprecated.

Adds given option to container
addData(String, String) - Method in class com.thoughtworks.go.plugin.api.material.packagerepository.PackageRevision: Deprecated.

Adds additional data related to the package revision
addError(ValidationError) - Method in class com.thoughtworks.go.plugin.api.response.validation.ValidationResult: Deprecated.

Adds provided ValidationError to error container
addErrors(Collection<ValidationError>) - Method in class com.thoughtworks.go.plugin.api.response.validation.ValidationResult: Deprecated.

Adds collection of ValidationError to the error container
addOrSet(Option<T>, T) - Method in class com.thoughtworks.go.plugin.api.config.Options: Deprecated.
addProperty(String) - Method in class com.thoughtworks.go.plugin.api.task.TaskConfig: Deprecated.

Adds a property to the configuration of this task.
addRequestHeader(String, String) - Method in class com.thoughtworks.go.plugin.api.request.DefaultGoApiRequest: Adds new request header.
addRequestHeader(String, String) - Method in class com.thoughtworks.go.plugin.api.request.DefaultGoPluginApiRequest: Adds new request header.
addRequestParameter(String, String) - Method in class com.thoughtworks.go.plugin.api.request.DefaultGoApiRequest: Adds new request parameter.
addRequestParameter(String, String) - Method in class com.thoughtworks.go.plugin.api.request.DefaultGoPluginApiRequest: Adds new request parameter.
addResponseHeader(String, String) - Method in class com.thoughtworks.go.plugin.api.response.DefaultGoApiResponse: Adds new response header.
addResponseHeader(String, String) - Method in class com.thoughtworks.go.plugin.api.response.DefaultGoPluginApiResponse: Adds new response header.
api() - Method in class com.thoughtworks.go.plugin.api.request.DefaultGoApiRequest: Api name for the request
api() - Method in class com.thoughtworks.go.plugin.api.request.GoApiRequest: Api name for the request
apiVersion() - Method in class com.thoughtworks.go.plugin.api.request.DefaultGoApiRequest: Api version of the request
apiVersion() - Method in class com.thoughtworks.go.plugin.api.request.GoApiRequest: Api version of the request
asMap() - Method in interface com.thoughtworks.go.plugin.api.task.EnvironmentVariables: Deprecated.

B

BAD_REQUEST - Static variable in class com.thoughtworks.go.plugin.api.response.DefaultGoPluginApiResponse
badRequest(String) - Static method in class com.thoughtworks.go.plugin.api.response.DefaultGoApiResponse: Creates an instance DefaultGoApiResponse which represents bad request with response code 400
badRequest(String) - Static method in class com.thoughtworks.go.plugin.api.response.DefaultGoPluginApiResponse: Creates an instance DefaultGoPluginApiResponse which represents bad request with response code 400

C

com.thoughtworks.go.plugin.api - package com.thoughtworks.go.plugin.api
com.thoughtworks.go.plugin.api.annotation - package com.thoughtworks.go.plugin.api.annotation
com.thoughtworks.go.plugin.api.config - package com.thoughtworks.go.plugin.api.config
com.thoughtworks.go.plugin.api.exceptions - package com.thoughtworks.go.plugin.api.exceptions
com.thoughtworks.go.plugin.api.info - package com.thoughtworks.go.plugin.api.info
com.thoughtworks.go.plugin.api.logging - package com.thoughtworks.go.plugin.api.logging
com.thoughtworks.go.plugin.api.material.packagerepository - package com.thoughtworks.go.plugin.api.material.packagerepository
com.thoughtworks.go.plugin.api.material.packagerepository.exceptions - package com.thoughtworks.go.plugin.api.material.packagerepository.exceptions
com.thoughtworks.go.plugin.api.request - package com.thoughtworks.go.plugin.api.request
com.thoughtworks.go.plugin.api.response - package com.thoughtworks.go.plugin.api.response
com.thoughtworks.go.plugin.api.response.execution - package com.thoughtworks.go.plugin.api.response.execution
com.thoughtworks.go.plugin.api.response.validation - package com.thoughtworks.go.plugin.api.response.validation
com.thoughtworks.go.plugin.api.task - package com.thoughtworks.go.plugin.api.task
compareTo(Object) - Method in class com.thoughtworks.go.plugin.api.material.packagerepository.PackageMaterialProperty: Deprecated.
compareTo(Object) - Method in class com.thoughtworks.go.plugin.api.task.TaskConfigProperty: Deprecated.
config() - Method in interface com.thoughtworks.go.plugin.api.task.Task: Deprecated.

Specifies the configuration accepted and expected for the task.
Configuration - Class in com.thoughtworks.go.plugin.api.config: Deprecated.
Configuration() - Constructor for class com.thoughtworks.go.plugin.api.config.Configuration: Deprecated.
Console - Interface in com.thoughtworks.go.plugin.api.task: Deprecated.
console() - Method in interface com.thoughtworks.go.plugin.api.task.TaskExecutionContext: Deprecated.

This Console instance will be setup such that any messages written to it will show up in the build log.
Console.SecureEnvVarSpecifier - Interface in com.thoughtworks.go.plugin.api.task: Deprecated.

Used to specify which environment variables are secure and shouldn't be printed literally.
context - Static variable in class com.thoughtworks.go.plugin.api.task.JobConsoleLogger
copy() - Method in class com.thoughtworks.go.plugin.api.config.Option: Deprecated.

Creates copy of this option

D

debug(String) - Method in class com.thoughtworks.go.plugin.api.logging.Logger: Messages to be logged in debug mode.
debug(String, Throwable) - Method in class com.thoughtworks.go.plugin.api.logging.Logger: Messages to be logged in debug mode.
debug(String, Object) - Method in class com.thoughtworks.go.plugin.api.logging.Logger: Messages to be logged in debug mode according to the specified format and argument.
debug(String, Object, Object) - Method in class com.thoughtworks.go.plugin.api.logging.Logger: Messages to be logged in debug mode according to the specified format and arguments.
debug(String, Object...) - Method in class com.thoughtworks.go.plugin.api.logging.Logger: Messages to be logged in debug mode according to the specified format and arguments.
DefaultGoApiRequest - Class in com.thoughtworks.go.plugin.api.request: Default implementation of GoApiRequest
DefaultGoApiRequest(String, String, GoPluginIdentifier) - Constructor for class com.thoughtworks.go.plugin.api.request.DefaultGoApiRequest: Constructs DefaultGoApiRequest with api name, api version and plugin identifier
DefaultGoApiResponse - Class in com.thoughtworks.go.plugin.api.response: Default implementation of GoApiResponse
DefaultGoApiResponse(int) - Constructor for class com.thoughtworks.go.plugin.api.response.DefaultGoApiResponse: Constructs DefaultGoApiResponse with response code
DefaultGoPluginApiRequest - Class in com.thoughtworks.go.plugin.api.request: Default implementation of GoPluginApiRequest
DefaultGoPluginApiRequest(String, String, String) - Constructor for class com.thoughtworks.go.plugin.api.request.DefaultGoPluginApiRequest: Constructs DefaultGoPluginApiRequest with extension name, extension version and request name
DefaultGoPluginApiResponse - Class in com.thoughtworks.go.plugin.api.response: Default implementation of GoPluginApiResponse
DefaultGoPluginApiResponse(int) - Constructor for class com.thoughtworks.go.plugin.api.response.DefaultGoPluginApiResponse: Constructs DefaultGoPluginApiResponse with response code
DefaultGoPluginApiResponse(int, String) - Constructor for class com.thoughtworks.go.plugin.api.response.DefaultGoPluginApiResponse: Constructs DefaultGoPluginApiResponse
DefaultGoPluginApiResponse(int, String, Map<String, String>) - Constructor for class com.thoughtworks.go.plugin.api.response.DefaultGoPluginApiResponse: Constructs DefaultGoPluginApiResponse
description() - Method in interface com.thoughtworks.go.plugin.api.info.PluginDescriptor.About: Plugin Description.
DISPLAY_NAME - Static variable in class com.thoughtworks.go.plugin.api.config.Property: Deprecated.

Option to specify the display name for the property
DISPLAY_ORDER - Static variable in class com.thoughtworks.go.plugin.api.config.Property: Deprecated.

Option to specify order of display of property on screen
displayValue() - Method in interface com.thoughtworks.go.plugin.api.task.TaskView: Deprecated.

Specifies the display value of this task plugin.

E

environment() - Method in interface com.thoughtworks.go.plugin.api.task.TaskExecutionContext: Deprecated.

The environment variables that this task should run with.
EnvironmentVariables - Interface in com.thoughtworks.go.plugin.api.task: Deprecated.
equals(Object) - Method in class com.thoughtworks.go.plugin.api.material.packagerepository.PackageRevision: Deprecated.
equals(Object) - Method in class com.thoughtworks.go.plugin.api.response.validation.ValidationError: Deprecated.
error(String) - Method in class com.thoughtworks.go.plugin.api.logging.Logger: Messages to be logged in error mode.
error(String, Throwable) - Method in class com.thoughtworks.go.plugin.api.logging.Logger: Messages to be logged in error mode.
error(String, Object) - Method in class com.thoughtworks.go.plugin.api.logging.Logger: Messages to be logged in error mode according to the specified format and argument.
error(String, Object, Object) - Method in class com.thoughtworks.go.plugin.api.logging.Logger: Messages to be logged in error mode according to the specified format and arguments.
error(String, Object...) - Method in class com.thoughtworks.go.plugin.api.logging.Logger: Messages to be logged in error mode according to the specified format and arguments.
error(String) - Static method in class com.thoughtworks.go.plugin.api.response.DefaultGoApiResponse: Creates an instance DefaultGoApiResponse which represents error request with response code 500
error(String) - Static method in class com.thoughtworks.go.plugin.api.response.DefaultGoPluginApiResponse: Creates an instance DefaultGoPluginApiResponse which represents error request with response code 500
execute(TaskConfig, TaskExecutionContext) - Method in interface com.thoughtworks.go.plugin.api.task.TaskExecutor: Deprecated.

The plugin infrastructure will call the execute() method, on the agent side, when the task needs to be run.
ExecutionResult - Class in com.thoughtworks.go.plugin.api.response.execution: Deprecated.
ExecutionResult() - Constructor for class com.thoughtworks.go.plugin.api.response.execution.ExecutionResult: Deprecated.
executor() - Method in interface com.thoughtworks.go.plugin.api.task.Task: Deprecated.

The executor is the part of the plugin which actually does the work.
Extension - Annotation Type in com.thoughtworks.go.plugin.api.annotation: Annotation that marks a type an extension implementation.
extension() - Method in class com.thoughtworks.go.plugin.api.request.DefaultGoPluginApiRequest: Extension name of the request
extension() - Method in class com.thoughtworks.go.plugin.api.request.GoPluginApiRequest: Extension name of the request
extensionVersion() - Method in class com.thoughtworks.go.plugin.api.request.DefaultGoPluginApiRequest: Extension version of the request
extensionVersion() - Method in class com.thoughtworks.go.plugin.api.request.GoPluginApiRequest: Extension version of the request

F

failure(String, Exception) - Static method in class com.thoughtworks.go.plugin.api.response.execution.ExecutionResult: Deprecated.

Mark the result as 'Failure'.
failure(String) - Static method in class com.thoughtworks.go.plugin.api.response.execution.ExecutionResult: Deprecated.

Mark the result as 'Failure'.
findOption(Option<T>) - Method in class com.thoughtworks.go.plugin.api.config.Options: Deprecated.

Finds matching option by option name

G

get(String) - Method in class com.thoughtworks.go.plugin.api.config.Configuration: Deprecated.

Gets property for a given property key
getConsoleLogger() - Static method in class com.thoughtworks.go.plugin.api.task.JobConsoleLogger
getData() - Method in class com.thoughtworks.go.plugin.api.material.packagerepository.PackageRevision: Deprecated.

Gets additional data related to package revision
getDataFor(String) - Method in class com.thoughtworks.go.plugin.api.material.packagerepository.PackageRevision: Deprecated.

Gets additional data related to package revision for given key
getErrors() - Method in class com.thoughtworks.go.plugin.api.response.validation.ValidationResult: Deprecated.

Gets list of errors for container
getExtension() - Method in class com.thoughtworks.go.plugin.api.GoPluginIdentifier: Gets extension name
getKey() - Method in class com.thoughtworks.go.plugin.api.config.Property: Deprecated.

Gets property key
getKey() - Method in class com.thoughtworks.go.plugin.api.response.validation.ValidationError: Deprecated.

Gets error key
getLoggerFor(Class) - Static method in class com.thoughtworks.go.plugin.api.logging.Logger
getMessage() - Method in class com.thoughtworks.go.plugin.api.response.validation.ValidationError: Deprecated.

Gets error message
getMessages() - Method in class com.thoughtworks.go.plugin.api.response.Result: Deprecated.

Gets error messages associated with result
getMessages() - Method in class com.thoughtworks.go.plugin.api.response.validation.ValidationResult: Deprecated.

Collects error message string as list from all the errors in the container
getMessagesForDisplay() - Method in class com.thoughtworks.go.plugin.api.response.Result: Deprecated.

Formats the messages in the result to a suitable form so that it can be used in user interface.
getOption(Option<T>) - Method in class com.thoughtworks.go.plugin.api.config.Property: Deprecated.

Gets value for given option
getOptions() - Method in class com.thoughtworks.go.plugin.api.config.Property: Deprecated.

Gets all options of property
getRevision() - Method in class com.thoughtworks.go.plugin.api.material.packagerepository.PackageRevision: Deprecated.

Gets revision string
getRevisionComment() - Method in class com.thoughtworks.go.plugin.api.material.packagerepository.PackageRevision: Deprecated.

Gets comment associated with revision
getSupportedExtensionVersions() - Method in class com.thoughtworks.go.plugin.api.GoPluginIdentifier: Gets list of supported extension versions
getTimestamp() - Method in class com.thoughtworks.go.plugin.api.material.packagerepository.PackageRevision: Deprecated.

Gets revision timestamp
getTrackbackUrl() - Method in class com.thoughtworks.go.plugin.api.material.packagerepository.PackageRevision: Deprecated.

Gets url which can provide information about producer of package revision
getUser() - Method in class com.thoughtworks.go.plugin.api.material.packagerepository.PackageRevision: Deprecated.

Gets user associated with revision
getValue() - Method in class com.thoughtworks.go.plugin.api.config.Option: Deprecated.

Gets value for this option
getValue() - Method in class com.thoughtworks.go.plugin.api.config.Property: Deprecated.

Gets property value.
getValue(String) - Method in class com.thoughtworks.go.plugin.api.task.TaskConfig: Deprecated.

Retrieves the value of a property.
GoApiRequest - Class in com.thoughtworks.go.plugin.api.request: Provides an abstraction for api request sent from plugin to Go
GoApiRequest() - Constructor for class com.thoughtworks.go.plugin.api.request.GoApiRequest
GoApiResponse - Class in com.thoughtworks.go.plugin.api.response: Provides an abstraction for api response sent from Go to plugin
GoApiResponse() - Constructor for class com.thoughtworks.go.plugin.api.response.GoApiResponse
goApplicationAccessor - Variable in class com.thoughtworks.go.plugin.api.AbstractGoPlugin
GoApplicationAccessor - Class in com.thoughtworks.go.plugin.api: GoApplicationAccessor will provide an abstraction over communication from plugin to Go.
GoApplicationAccessor() - Constructor for class com.thoughtworks.go.plugin.api.GoApplicationAccessor
GoPlugin - Interface in com.thoughtworks.go.plugin.api: GoPlugin interface represents Go plugin.
GoPluginApiMarker - Annotation Type in com.thoughtworks.go.plugin.api: Annotation that marks a type as an extension point provided by Go.
GoPluginApiRequest - Class in com.thoughtworks.go.plugin.api.request: Provides an abstraction for api request sent from Go to plugin
GoPluginApiRequest() - Constructor for class com.thoughtworks.go.plugin.api.request.GoPluginApiRequest
GoPluginApiResponse - Class in com.thoughtworks.go.plugin.api.response: Provides an abstraction for api response sent from plugin to Go
GoPluginApiResponse() - Constructor for class com.thoughtworks.go.plugin.api.response.GoPluginApiResponse
GoPluginIdentifier - Class in com.thoughtworks.go.plugin.api: Provides details about supported extension point and its version by a plugin
GoPluginIdentifier(String, List<String>) - Constructor for class com.thoughtworks.go.plugin.api.GoPluginIdentifier: Constructs GoPluginIdentifier with extension and list of supported extension versions

H

handle(GoPluginApiRequest) - Method in interface com.thoughtworks.go.plugin.api.GoPlugin: Handles GoPluginApiRequest request submitted from Go to plugin implementation and returns result as GoPluginApiResponse
hashCode() - Method in class com.thoughtworks.go.plugin.api.material.packagerepository.PackageRevision: Deprecated.
hashCode() - Method in class com.thoughtworks.go.plugin.api.response.validation.ValidationError: Deprecated.
hasOption(Option<T>) - Method in class com.thoughtworks.go.plugin.api.config.Options: Deprecated.
hasSameNameAs(Option<T>) - Method in class com.thoughtworks.go.plugin.api.config.Option: Deprecated.

Checks if this option has same name as the provided option

I

id() - Method in interface com.thoughtworks.go.plugin.api.info.PluginDescriptor: Plugin Id.
incompleteRequest(String) - Static method in class com.thoughtworks.go.plugin.api.response.DefaultGoApiResponse: Creates an instance DefaultGoApiResponse which represents incomplete request with response code 412
incompleteRequest(String) - Static method in class com.thoughtworks.go.plugin.api.response.DefaultGoPluginApiResponse: Creates an instance DefaultGoPluginApiResponse which represents incomplete request with response code 412
info(String) - Method in class com.thoughtworks.go.plugin.api.logging.Logger: Messages to be logged in info mode.
info(String, Throwable) - Method in class com.thoughtworks.go.plugin.api.logging.Logger: Messages to be logged in info mode.
info(String, Object) - Method in class com.thoughtworks.go.plugin.api.logging.Logger: Messages to be logged in info mode according to the specified format and argument.
info(String, Object, Object) - Method in class com.thoughtworks.go.plugin.api.logging.Logger: Messages to be logged in info mode according to the specified format and arguments.
info(String, Object...) - Method in class com.thoughtworks.go.plugin.api.logging.Logger: Messages to be logged in info mode according to the specified format and arguments.
initialize(LoggingService) - Static method in class com.thoughtworks.go.plugin.api.logging.Logger
initializeGoApplicationAccessor(GoApplicationAccessor) - Method in class com.thoughtworks.go.plugin.api.AbstractGoPlugin: Initializes GoApplicationAccessor with an instance of GoApplicationAccessor
initializeGoApplicationAccessor(GoApplicationAccessor) - Method in interface com.thoughtworks.go.plugin.api.GoPlugin: Initializes an instance of GoApplicationAccessor.
INTERNAL_ERROR - Static variable in class com.thoughtworks.go.plugin.api.response.DefaultGoApiResponse
INTERNAL_ERROR - Static variable in class com.thoughtworks.go.plugin.api.response.DefaultGoPluginApiResponse
InvalidPackageRevisionDataException - Exception in com.thoughtworks.go.plugin.api.material.packagerepository.exceptions: Deprecated.
InvalidPackageRevisionDataException(String) - Constructor for exception com.thoughtworks.go.plugin.api.material.packagerepository.exceptions.InvalidPackageRevisionDataException: Deprecated.
isSecure(String) - Method in interface com.thoughtworks.go.plugin.api.task.Console.SecureEnvVarSpecifier: Deprecated.
isSuccessful() - Method in class com.thoughtworks.go.plugin.api.response.Result: Deprecated.

Checks if result is successful
isSuccessful() - Method in class com.thoughtworks.go.plugin.api.response.validation.ValidationResult: Deprecated.

Checks if result of the validation is successful based on the size of error container

J

JobConsoleLogger - Class in com.thoughtworks.go.plugin.api.task
JobConsoleLogger() - Constructor for class com.thoughtworks.go.plugin.api.task.JobConsoleLogger

L

list() - Method in class com.thoughtworks.go.plugin.api.config.Configuration: Deprecated.

Returns copy of properties list
list() - Method in class com.thoughtworks.go.plugin.api.material.packagerepository.PackageConfiguration: Deprecated.
list() - Method in class com.thoughtworks.go.plugin.api.material.packagerepository.RepositoryConfiguration: Deprecated.
list() - Method in class com.thoughtworks.go.plugin.api.task.TaskConfig: Deprecated.
Load - Annotation Type in com.thoughtworks.go.plugin.api.annotation: Annotation that marks a method to be called when a plugin is loaded.
Logger - Class in com.thoughtworks.go.plugin.api.logging: Logger for use by plugin developers.

N

name() - Method in interface com.thoughtworks.go.plugin.api.info.PluginDescriptor.About: Author name.
name() - Method in interface com.thoughtworks.go.plugin.api.info.PluginDescriptor.Vendor: Vendor name.

O

Option<T> - Class in com.thoughtworks.go.plugin.api.config: Deprecated.
Option(String, T) - Constructor for class com.thoughtworks.go.plugin.api.config.Option: Deprecated.
Options - Class in com.thoughtworks.go.plugin.api.config: Deprecated.
Options() - Constructor for class com.thoughtworks.go.plugin.api.config.Options: Deprecated.

P

PackageConfiguration - Class in com.thoughtworks.go.plugin.api.material.packagerepository: Deprecated.
PackageConfiguration() - Constructor for class com.thoughtworks.go.plugin.api.material.packagerepository.PackageConfiguration: Deprecated.
PackageMaterialProperty - Class in com.thoughtworks.go.plugin.api.material.packagerepository: Deprecated.
PackageMaterialProperty(String) - Constructor for class com.thoughtworks.go.plugin.api.material.packagerepository.PackageMaterialProperty: Deprecated.
PackageMaterialProperty(String, String) - Constructor for class com.thoughtworks.go.plugin.api.material.packagerepository.PackageMaterialProperty: Deprecated.
PackageRevision - Class in com.thoughtworks.go.plugin.api.material.packagerepository: Deprecated.
PackageRevision(String, Date, String) - Constructor for class com.thoughtworks.go.plugin.api.material.packagerepository.PackageRevision: Deprecated.
PackageRevision(String, Date, String, Map<String, String>) - Constructor for class com.thoughtworks.go.plugin.api.material.packagerepository.PackageRevision: Deprecated.
PackageRevision(String, Date, String, String, String) - Constructor for class com.thoughtworks.go.plugin.api.material.packagerepository.PackageRevision: Deprecated.
PackageRevision(String, Date, String, String, String, Map<String, String>) - Constructor for class com.thoughtworks.go.plugin.api.material.packagerepository.PackageRevision: Deprecated.
PART_OF_IDENTITY - Static variable in class com.thoughtworks.go.plugin.api.config.Property: Deprecated.

Option to specify if a property is part of group of properties used to uniquely identify material
PluginContext - Interface in com.thoughtworks.go.plugin.api.info: Context passed to the methods marked with Load and/or UnLoad annotation.
PluginDescriptor - Interface in com.thoughtworks.go.plugin.api.info: Descriptor represent the plugin descriptor XML file.
PluginDescriptor.About - Interface in com.thoughtworks.go.plugin.api.info: Plugin author information.
PluginDescriptor.Vendor - Interface in com.thoughtworks.go.plugin.api.info: Plugin vendor information.
PluginDescriptorAware - Interface in com.thoughtworks.go.plugin.api.info: Deprecated.
pluginIdentifier() - Method in interface com.thoughtworks.go.plugin.api.GoPlugin: Provides an instance of GoPluginIdentifier, providing details about supported extension point and its versions
pluginIdentifier() - Method in class com.thoughtworks.go.plugin.api.request.DefaultGoApiRequest: Provides an instance of GoPluginIdentifier for the request
pluginIdentifier() - Method in class com.thoughtworks.go.plugin.api.request.GoApiRequest: Provides an instance of GoPluginIdentifier for the request
PluginPreference - Interface in com.thoughtworks.go.plugin.api.config
printEnvironment(Map<String, String>, Console.SecureEnvVarSpecifier) - Method in interface com.thoughtworks.go.plugin.api.task.Console: Deprecated.

Print details about the environment specified in the argument into the build log.
printEnvironment(Map<String, String>) - Method in class com.thoughtworks.go.plugin.api.task.JobConsoleLogger
printLine(String) - Method in interface com.thoughtworks.go.plugin.api.task.Console: Deprecated.

Print a line out to the build log.
printLine(String) - Method in class com.thoughtworks.go.plugin.api.task.JobConsoleLogger
Property - Class in com.thoughtworks.go.plugin.api.config: Deprecated.
Property(String) - Constructor for class com.thoughtworks.go.plugin.api.config.Property: Deprecated.
Property(String, String) - Constructor for class com.thoughtworks.go.plugin.api.config.Property: Deprecated.
Property(String, String, String) - Constructor for class com.thoughtworks.go.plugin.api.config.Property: Deprecated.

R

readErrorOf(InputStream) - Method in interface com.thoughtworks.go.plugin.api.task.Console: Deprecated.

Setup the console to read the input stream as standard error.
readErrorOf(InputStream) - Method in class com.thoughtworks.go.plugin.api.task.JobConsoleLogger
readOutputOf(InputStream) - Method in interface com.thoughtworks.go.plugin.api.task.Console: Deprecated.

Setup the console to read the input stream as standard output.
readOutputOf(InputStream) - Method in class com.thoughtworks.go.plugin.api.task.JobConsoleLogger
REDIRECT_RESPONSE_CODE - Static variable in class com.thoughtworks.go.plugin.api.response.DefaultGoApiResponse
removeError(ValidationError) - Method in class com.thoughtworks.go.plugin.api.response.validation.ValidationResult: Deprecated.

Removes specified validation error from the error container
removeErrors(Collection<ValidationError>) - Method in class com.thoughtworks.go.plugin.api.response.validation.ValidationResult: Deprecated.

Removes specified collection of validation errors from the container
RepositoryConfiguration - Class in com.thoughtworks.go.plugin.api.material.packagerepository: Deprecated.
RepositoryConfiguration() - Constructor for class com.thoughtworks.go.plugin.api.material.packagerepository.RepositoryConfiguration: Deprecated.
requestBody() - Method in class com.thoughtworks.go.plugin.api.request.DefaultGoApiRequest: Provides json formatted request body
requestBody() - Method in class com.thoughtworks.go.plugin.api.request.DefaultGoPluginApiRequest: Provides json formatted request body of request
requestBody() - Method in class com.thoughtworks.go.plugin.api.request.GoApiRequest: Provides json formatted request body
requestBody() - Method in class com.thoughtworks.go.plugin.api.request.GoPluginApiRequest: Provides json formatted request body
requestHeaders() - Method in class com.thoughtworks.go.plugin.api.request.DefaultGoApiRequest: Provides request headers as key value pair for the request.
requestHeaders() - Method in class com.thoughtworks.go.plugin.api.request.DefaultGoPluginApiRequest: Provides request headers as key value pair for the request.
requestHeaders() - Method in class com.thoughtworks.go.plugin.api.request.GoApiRequest: Provides request headers as key value pair for the request.
requestHeaders() - Method in class com.thoughtworks.go.plugin.api.request.GoPluginApiRequest: Provides request headers as key value pair for the request.
requestName() - Method in class com.thoughtworks.go.plugin.api.request.DefaultGoPluginApiRequest: Name or operation supported for an extension
requestName() - Method in class com.thoughtworks.go.plugin.api.request.GoPluginApiRequest: Name or operation supported for an extension
requestParameters() - Method in class com.thoughtworks.go.plugin.api.request.DefaultGoApiRequest: Provides request parameters as key value pair for the request
requestParameters() - Method in class com.thoughtworks.go.plugin.api.request.DefaultGoPluginApiRequest: Provides request parameters as key value pair for the request
requestParameters() - Method in class com.thoughtworks.go.plugin.api.request.GoApiRequest: Provides request parameters as key value pair for the request
requestParameters() - Method in class com.thoughtworks.go.plugin.api.request.GoPluginApiRequest: Provides request parameters as key value pair for the request
REQUIRED - Static variable in class com.thoughtworks.go.plugin.api.config.Property: Deprecated.

Option to specify if a property is a mandatory when configuration is captured
responseBody() - Method in class com.thoughtworks.go.plugin.api.response.DefaultGoApiResponse: Provides json formatted response body
responseBody() - Method in class com.thoughtworks.go.plugin.api.response.DefaultGoPluginApiResponse: Provides json formatted response body
responseBody() - Method in class com.thoughtworks.go.plugin.api.response.GoApiResponse: Provides json formatted response body
responseBody() - Method in class com.thoughtworks.go.plugin.api.response.GoPluginApiResponse: Provides json formatted response body
responseCode() - Method in class com.thoughtworks.go.plugin.api.response.DefaultGoApiResponse: Provides response code for the request sent
responseCode() - Method in class com.thoughtworks.go.plugin.api.response.DefaultGoPluginApiResponse: Provides response code for the request sent
responseCode() - Method in class com.thoughtworks.go.plugin.api.response.GoApiResponse: Provides response code for the request sent
responseCode() - Method in class com.thoughtworks.go.plugin.api.response.GoPluginApiResponse: Provides response code for the request sent
responseHeaders() - Method in class com.thoughtworks.go.plugin.api.response.DefaultGoApiResponse: Provides response headers as key value pair for the response.
responseHeaders() - Method in class com.thoughtworks.go.plugin.api.response.DefaultGoPluginApiResponse: Provides response headers as key value pair for the response.
responseHeaders() - Method in class com.thoughtworks.go.plugin.api.response.GoApiResponse: Provides response headers as key value pair for the response.
responseHeaders() - Method in class com.thoughtworks.go.plugin.api.response.GoPluginApiResponse: Provides response headers as key value pair for the response.
Result - Class in com.thoughtworks.go.plugin.api.response: Deprecated.
Result() - Constructor for class com.thoughtworks.go.plugin.api.response.Result: Deprecated.

S

SECURE - Static variable in class com.thoughtworks.go.plugin.api.config.Property: Deprecated.

Option to specify if a property is a secure property.
secureEnvSpecifier() - Method in interface com.thoughtworks.go.plugin.api.task.EnvironmentVariables: Deprecated.
set(Option<T>, T) - Method in class com.thoughtworks.go.plugin.api.config.Options: Deprecated.

Finds matching option by option name and sets specified value
setPluginDescriptor(PluginDescriptor) - Method in interface com.thoughtworks.go.plugin.api.info.PluginDescriptorAware: Deprecated.

Callback method invoked with plugins own descriptor.
setRequestBody(String) - Method in class com.thoughtworks.go.plugin.api.request.DefaultGoApiRequest: Sets request body
setRequestBody(String) - Method in class com.thoughtworks.go.plugin.api.request.DefaultGoPluginApiRequest: Sets request body
setRequestHeaders(Map<String, String>) - Method in class com.thoughtworks.go.plugin.api.request.DefaultGoPluginApiRequest
setRequestParams(Map<String, String>) - Method in class com.thoughtworks.go.plugin.api.request.DefaultGoPluginApiRequest
setResponseBody(String) - Method in class com.thoughtworks.go.plugin.api.response.DefaultGoApiResponse: Sets response body
setResponseBody(String) - Method in class com.thoughtworks.go.plugin.api.response.DefaultGoPluginApiResponse: Sets response body
setValue(T) - Method in class com.thoughtworks.go.plugin.api.config.Option: Deprecated.

Sets the value for this option
size() - Method in class com.thoughtworks.go.plugin.api.config.Configuration: Deprecated.

Returns number of properties in this configuration
size() - Method in class com.thoughtworks.go.plugin.api.config.Options: Deprecated.
submit(GoApiRequest) - Method in class com.thoughtworks.go.plugin.api.GoApplicationAccessor: Submits an instance of GoApiRequest to Go and returns an instance of GoApiResponse
success(String) - Static method in class com.thoughtworks.go.plugin.api.response.DefaultGoApiResponse: Creates an instance DefaultGoApiResponse which represents success request with response code 200
success(String) - Static method in class com.thoughtworks.go.plugin.api.response.DefaultGoPluginApiResponse: Creates an instance DefaultGoPluginApiResponse which represents success request with response code 200
success(String) - Static method in class com.thoughtworks.go.plugin.api.response.execution.ExecutionResult: Deprecated.

Mark the result as 'Success'.
SUCCESS_RESPONSE_CODE - Static variable in class com.thoughtworks.go.plugin.api.response.DefaultGoApiResponse
SUCCESS_RESPONSE_CODE - Static variable in class com.thoughtworks.go.plugin.api.response.DefaultGoPluginApiResponse

T

targetGoVersion() - Method in interface com.thoughtworks.go.plugin.api.info.PluginDescriptor.About: Target Go version.
targetOperatingSystems() - Method in interface com.thoughtworks.go.plugin.api.info.PluginDescriptor.About: Operating systems on which this plugin can run.
Task - Interface in com.thoughtworks.go.plugin.api.task: Deprecated.
TaskConfig - Class in com.thoughtworks.go.plugin.api.task: Deprecated.
TaskConfig() - Constructor for class com.thoughtworks.go.plugin.api.task.TaskConfig: Deprecated.
TaskConfigProperty - Class in com.thoughtworks.go.plugin.api.task: Deprecated.
TaskConfigProperty(String) - Constructor for class com.thoughtworks.go.plugin.api.task.TaskConfigProperty: Deprecated.
TaskConfigProperty(String, String) - Constructor for class com.thoughtworks.go.plugin.api.task.TaskConfigProperty: Deprecated.
TaskExecutionContext - Interface in com.thoughtworks.go.plugin.api.task: Deprecated.
TaskExecutor - Interface in com.thoughtworks.go.plugin.api.task: Deprecated.
TaskView - Interface in com.thoughtworks.go.plugin.api.task: Deprecated.
template() - Method in interface com.thoughtworks.go.plugin.api.task.TaskView: Deprecated.

The template for the task configuration, written using Angular.js templating language.
toString() - Method in class com.thoughtworks.go.plugin.api.material.packagerepository.PackageRevision: Deprecated.

U

UnhandledRequestTypeException - Exception in com.thoughtworks.go.plugin.api.exceptions
UnhandledRequestTypeException(String) - Constructor for exception com.thoughtworks.go.plugin.api.exceptions.UnhandledRequestTypeException
UnLoad - Annotation Type in com.thoughtworks.go.plugin.api.annotation: Annotation that marks a method to be called when a plugin is unloaded.
url() - Method in interface com.thoughtworks.go.plugin.api.info.PluginDescriptor.Vendor: Vendor website URL
UsedOnGoAgent - Annotation Type in com.thoughtworks.go.plugin.api.annotation: A method mark by this annotation indicates that the method is invoked on the Go Agent.
UsedOnGoServer - Annotation Type in com.thoughtworks.go.plugin.api.annotation: A method mark by this annotation indicates that the method is invoked on the Go server.

V

validate(TaskConfig) - Method in interface com.thoughtworks.go.plugin.api.task.Task: Deprecated.

Checks if a given task configuration is valid.
validateDataKey(String) - Method in class com.thoughtworks.go.plugin.api.material.packagerepository.PackageRevision: Deprecated.
VALIDATION_ERROR - Static variable in class com.thoughtworks.go.plugin.api.response.DefaultGoApiResponse
VALIDATION_FAILED - Static variable in class com.thoughtworks.go.plugin.api.response.DefaultGoPluginApiResponse
ValidationError - Class in com.thoughtworks.go.plugin.api.response.validation: Deprecated.
ValidationError(String, String) - Constructor for class com.thoughtworks.go.plugin.api.response.validation.ValidationError: Deprecated.

creates instance of ValidationError
ValidationError(String) - Constructor for class com.thoughtworks.go.plugin.api.response.validation.ValidationError: Deprecated.

creates instance of ValidationError
ValidationResult - Class in com.thoughtworks.go.plugin.api.response.validation: Deprecated.
ValidationResult() - Constructor for class com.thoughtworks.go.plugin.api.response.validation.ValidationResult: Deprecated.
vendor() - Method in interface com.thoughtworks.go.plugin.api.info.PluginDescriptor.About: Plugin vendor details.
version() - Method in interface com.thoughtworks.go.plugin.api.info.PluginDescriptor.About: Provides version of the plugin which will be used by plugin authors to provide meaningful version for the plugin.
version() - Method in interface com.thoughtworks.go.plugin.api.info.PluginDescriptor: Provides version of the plugin which will be used by Go to identify the version of the plugin.
view() - Method in interface com.thoughtworks.go.plugin.api.task.Task: Deprecated.

The implementation of TaskView returned by this method defines the view of the plugin, both in the task type dropdown of the job configuration UI as well as the modal box for the task.

W

warn(String) - Method in class com.thoughtworks.go.plugin.api.logging.Logger: Messages to be logged in warn mode.
warn(String, Throwable) - Method in class com.thoughtworks.go.plugin.api.logging.Logger: Messages to be logged in warn mode.
warn(String, Object) - Method in class com.thoughtworks.go.plugin.api.logging.Logger: Messages to be logged in warn mode according to the specified format and argument.
warn(String, Object, Object) - Method in class com.thoughtworks.go.plugin.api.logging.Logger: Messages to be logged in warn mode according to the specified format and arguments.
warn(String, Object...) - Method in class com.thoughtworks.go.plugin.api.logging.Logger: Messages to be logged in warn mode according to the specified format and arguments.
with(Option<T>, T) - Method in class com.thoughtworks.go.plugin.api.config.Property: Deprecated.

Adds an option
withDefault(String) - Method in class com.thoughtworks.go.plugin.api.config.Property: Deprecated.
withErrorMessages(String...) - Method in class com.thoughtworks.go.plugin.api.response.Result: Deprecated.

Creates instance of result with specified errors
withErrorMessages(List<String>) - Method in class com.thoughtworks.go.plugin.api.response.Result: Deprecated.

Creates instance of result with specified errors
withSuccessMessages(String...) - Method in class com.thoughtworks.go.plugin.api.response.Result: Deprecated.

Creates instance of result with specified success messages
withSuccessMessages(List<String>) - Method in class com.thoughtworks.go.plugin.api.response.Result: Deprecated.

Creates instance of result with specified success messages
workingDir() - Method in interface com.thoughtworks.go.plugin.api.task.TaskExecutionContext: Deprecated.

Working directory to be used by the task.
writeTo(Console) - Method in interface com.thoughtworks.go.plugin.api.task.EnvironmentVariables: Deprecated.

Write the environment variables to a Console.

A B C D E F G H I J L N O P R S T U V W