Index (FlowPDF Groovy Library 1.1.2.0 API)

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _

A

AbstractParameter - Interface in com.cloudbees.flowpdf: Abstraction for Credential and Parameter that can be stored in a StepParameters map
acquireCredentialForScheme(String, Credential) - Method in RESTConfig
Action - Class in com.cloudbees.flowpdf.stepresult: Action represents piece of an operations sequence required to apply the result
Action.actionTypes - Enum in com.cloudbees.flowpdf.stepresult: Predefined action types
Action(Action.actionTypes, String, String) - Constructor in Action: Default constructor.
addArguments(List<String>) - Method in Command: Adds new arguments to the command.
addDependentData(Data) - Method in Data: Pushes new Data to the dependent data of this instance
addDependentPayload(Payload) - Method in Payload: Saves given Payload as a dependent for current instance
addMaskedValue(String) - Method in Log
addOrUpdateValue(String, String) - Method in Data: Adds a value into current report values.
addParameter(AbstractParameter, boolean) - Method in StepParameters: Adds new parameter to the current list
addParameters(ArrayList<AbstractParameter>, boolean) - Method in StepParameters: Adds or replaces the parameters in current list
addValue(String, String) - Method in Data: Adds a value into current report values.
appendValue(String) - Method in Action
apply() - Method in Action: This method should contain the implementation for applying a value to entity.
apply() - Method in SetOutputParameterAction: This method should contain the implementation for applying a value to entity.
apply() - Method in SetPropertyAction: This method contains implementation for applying a value to entity.
apply() - Method in StepResult
applyAndFlush() - Method in StepResult
applyIfNotApplied() - Method in StepResult
applyStepResult() - Method in Context: Applies current StepResult
args - Field in Command: Arguments for the program.

B

bailOut(String, String, Throwable) - Method in Context: Immediately aborts current execution and exits with exit code 1.
BasicAuthRequestHook - Class in com.cloudbees.flowpdf.client: Authentication hook that adds 'Authorization: Basic ...' header
BearerAuthRequestHook - Class in com.cloudbees.flowpdf.client: Authentication hook that adds a predefined token as a 'Authorization: Bearer ' header.
BearerAuthRequestHook(Map<String, String>) - Constructor in BearerAuthRequestHook: Constructor
buildDataset(FlowPlugin, List<Map>) - Method in Reporting: This method is used to convert records to the compatible representation that can be transformed to the payload
buildMetadataLocation() - Method in Reporting: This method builds a path to the metadata property (context dependable)
buildMetadataName(String, String, ArrayList<String>) - Method in MetadataFactory: Builds a context and configuration specific name of the metadata property.
buildPayloadSet(FlowPlugin, Dataset) - Method in Reporting: Placeholder for the buildPayloadSet method
buildPluginProjectName() - Method in Context: Builds name of the project for current plugin version @return

C

call(HTTPRequest) - Method in BasicAuthRequestHook: This method augments request with 'Authorization: Basic ...' header
call(HTTPRequest) - Method in BearerAuthRequestHook: This method augments request with an authentication header.
call(HTTPRequest) - Method in RequestHook: This method modifies request to contain necessary authentication information
call(HTTPRequest) - Method in RSAOAuthRequestHook: Main method that uses net.oauth libraries to sign the request
CLI - Class in com.cloudbees.flowpdf.components.cli: CLI is an Component that is responsible for command-line execution.
code - Field in ExecutionResult: Exit code returned by the program after the execution
collectReportingData() - Method in Reporting: Entry method for the component process.
Command - Class in com.cloudbees.flowpdf.components.cli: This class represents a system command that is being used by CLI.
Command(Map<String, Serializable>) - Constructor in Command: Constructor.
compareMetadata(Metadata, Metadata) - Method in Reporting: This method is responsible for comparing current stored values and the one that was built from the result of getLastRecord()
Component - Class in com.cloudbees.flowpdf.components: Component is an abstraction for extensions of the FlowPDF-groovy functionality.
ComponentManager - Class in com.cloudbees.flowpdf.components: ComponentManager is responsible for proper instantiation of the Component.
ComponentManager(FlowPlugin) - Constructor in ComponentManager: Constructor
Config - Class in com.cloudbees.flowpdf: This class represents values of current configuration (global values) that is available in current run context by the name that is provided in procedure config form.
contentBytes - Field in HTTPRequest: (body) Binary content of the request
contentString - Field in HTTPRequest: (body) String content of the request
Context - Class in com.cloudbees.flowpdf: Context represents a model of the job runtime.
Context(def, String, String) - Constructor in Context: Constructor.
ContextFactory - Class in com.cloudbees.flowpdf: A context factory that generates the Context object.
ContextFactory(Map<String, Object>, String, String) - Constructor in ContextFactory: Constructor.
convertDependentDataToPayloadRecursive(Payload, Data) - Method in Payload: Recursively goes through the Data in a Payload and converts the dependent values
createNewDependentData(Map) - Method in Data: Creates new Data that will be included as a dependent Data for this instance
createNewDependentPayload(String, Map<String, Object>) - Method in Payload: Creates new Payload and saves it as a dependent for current instance
Credential - Class in com.cloudbees.flowpdf: This class represents a credential of CloudBees CD.
Credential(String, String, String, String) - Constructor in Credential: Constructor

D

Data - Class in com.cloudbees.flowpdf.components.reporting: Represents a reporting system data that can be converted to a payload.
Data(Map<String, Object>) - Constructor in Data
Dataset - Class in com.cloudbees.flowpdf.components.reporting: This class represents a collection of Data.
debug(def) - Method in Log
doRequest(HTTPRequest) - Method in REST: Executes the request with an .

E

Engine - Class in com.cloudbees.flowpdf.components.reporting: This class contains reporting-specific interactions with the CloudBees CD server reporting APIs
EntityAlreadyExists - Class in com.cloudbees.flowpdf.exceptions: An exception that represents a situation when something already exists, but it should not.
EntityAlreadyExists(String, String, String) - Constructor in EntityAlreadyExists: Positional arguments constructor allows you to clarify the details.
EntityDoesNotExist - Class in com.cloudbees.flowpdf.exceptions: An exception that represents a situation when something does not exist, but it should.
EntityDoesNotExist(String, String, String) - Constructor in EntityDoesNotExist: Positional arguments constructor allows you to clarify the details.
error(def) - Method in Log: Add a message with severity 'error' to the log
errorDiag(def) - Method in Log
evalDslFile(URL, def) - Method in FlowAPI: Runs given DSL file on the server
exceptionCode() - Method in FlowPDFException: Returns error code for this exception type.
ExecutionResult - Class in com.cloudbees.flowpdf.components.cli: This class represents a command-line execution result with exit code, stdout and stderr.
ExecutionResult(Map) - Constructor in ExecutionResult: Constructor

F

FlowAPI - Class in com.cloudbees.flowpdf: This class is a wrapper for the CloudBees CD REST client It's considered to contain the best practices and to help omit some pitfalls of the original API
FlowPDFException - Class in com.cloudbees.flowpdf.exceptions: Base class for the FlowPDF-Groovy exceptions
FlowPDFException(String) - Constructor in FlowPDFException: Skip calling render and use this message as an error description.
FlowPlugin - Class in com.cloudbees.flowpdf: FlowPDF is an CloudBees CD Plugin Development Framework.
FlowPlugin() - Constructor in FlowPlugin: Constructor
flush() - Method in StepResult
FWLog - Class in com.cloudbees.flowpdf: This is a static holder of the framework logger.

G

getAsArrayList() - Method in StepParameters
getAsMap() - Method in StepParameters
getCode() - Method in ExecutionResult: Accessor for the ExecutionResult.code
getComponent(Class<Component>) - Method in ComponentManager: Get a loaded component from a static cache
getComponentLocal(Class<Component>) - Method in ComponentManager: Get a loaded component from an instance cache
getConfigName() - Method in Context: Gets name of the config specified as a value for one of the step parameters.
getConfigValues() - Method in Context: This method returns a Config object that represents plugin configuration.
getContext() - Method in FlowPlugin: This method returns already created L object.
getCredential(String) - Method in StepParameters: Get a credential from a map
getCredentialName() - Method in Credential: Returns name of the current credential
getCredentialType() - Method in Credential: Returns type of the current credential
getCurrentProcedureName() - Method in Context: Retrieves name for a procedure we are running in.
getCurrentProjectName() - Method in Context: Returns current runtime context project name.
getCurrentScheduleName() - Method in Context: This method retrieves name of the current schedule we are running inside or an empty string
getEc() - Method in FlowAPI: Use this method to get an initialized object for the specific purposes that are not covered by this wrapper.
getFlowPDFVersion() - Method in FlowPlugin: Determines current version of the flowpdf-groovy-lib
getFlowProperty(String) - Method in FlowAPI: Returns value of the property at given path
getHttpBuilder() - Method in REST: This method returns an initialized groovyx.net.http.HTTPBuilder instance for the extended use cases.
getInstance() - Method in FWLog: Singleton constructor
getLastPayload() - Method in Payloadset: Returns payload that was added last
getLastRecord(FlowPlugin) - Method in Reporting: This method is used to check freshness of current metadata.
getLevelName(Integer) - Method in FWLog: Overriding log level names, so user can easily distinguish framework and plugin log messages
getLevelName(Integer) - Method in Log
getLogLevel() - Method in Log: Returns current log level.
getMessage() - Method in FlowPDFException
getMethod() - Method in HTTPRequest: Accessor for the method field
getName() - Method in AbstractParameter: Returns a value that represents an actual or configuration parameter name
getName() - Method in Credential: The generic method allowing the credential can be processed as a parameter.
getName() - Method in Parameter: Returns a name for the current parameter.
getParameter(String) - Method in StepParameters: Get a parameter from a map
getParametersList() - Method in StepParameters: Returns a list of the parameter keys @return
getPath() - Method in HTTPRequest: Accessor for the path field
getPayloadDefinition(String) - Method in Engine: Cached accessor for the report object types definitions defined on the CloudBees CD server
getPayloadsForType(String) - Method in Payloadset: Returns only the payloads whose type matches given one
getPluginName() - Method in FlowPlugin: Accessor for the pluginName variable
getPluginProjectName() - Method in FlowPlugin: Builds name of the plugin project
getPluginProjectPath() - Method in FlowPlugin: Builds path to the plugin project
getRecordsAfter(FlowPlugin, Metadata) - Method in Reporting: If current metadata is older than the record received by the getLastRecord(), this method will be called to get new records.
getReportObjectTypeRequiredKeys(String) - Method in Engine: Filters keys that are required to be in the payload (according to the report object definition)
getReportObjectTypes() - Method in Engine: Cached accessor for the report object types defined on the CloudBees CD server
getRequiredCredential(String) - Method in StepParameters: Get a credential from a map with a strict check for existence
getRequiredParameter(String) - Method in StepParameters: Get a parameter from a map with a strict check for existence
getRunContext() - Method in Context: Cached accessor for Context.determineRunContext
getRuntimeParameters() - Method in Context: Handy shortcut for receiving the configuration and procedure parameters.
getSecretValue() - Method in Credential: Returns a secret value that is stored in the current credential.
getServerUrl() - Method in FlowAPI: Builds server url for current environment variables
getServerVersion() - Method in FlowAPI: Asks server for version and returns version of the CloudBees CD Server
getStdErr() - Method in ExecutionResult: Accessor for the ExecutionResult.stdErr
getStdOut() - Method in ExecutionResult: Accessor for the ExecutionResult.stdOut
getStepParameters() - Method in Context: This method returns representation of current procedure parameters
getTimeout() - Method in Command: Returns current value for the command timeout
getUserName() - Method in Credential: Returns a user name that is stored in the current credential.
getValue() - Method in AbstractParameter: Returns a value that represents an actual or configuration parameter value
getValue() - Method in Credential: The generic method allowing the credential can be processed as a parameter.
getValue() - Method in Parameter: Returns a value for the current parameter.

H

hasReportingObjectType(String) - Method in Payloadset: Checks if this Payloadset contains Payload with given report object type
headers - Field in HTTPRequest: Map of headers to be sent with this request
HTTPRequest - Class in com.cloudbees.flowpdf.client: This class represents a composition of the HTTP request parts
HTTPRequest(Map) - Constructor in HTTPRequest: Constructor.

I

info(def) - Method in Log
infoDiag(def) - Method in Log
init(Map<String, Object>, FlowPlugin) - Method in CLI: Method is used to configure the component.
init(Map<String, Object>, FlowPlugin) - Method in Component
init(Map<String, Object>, FlowPlugin) - Method in Reporting: Initialization of the component.
initialGetRecords(FlowPlugin, int) - Method in Reporting: This method will be called if there is no metadata stored for current Reporting configuration and context.
initTransformer(String) - Method in Reporting
isCheckConnectionInCreateConfiguration() - Method in Context: Checking if we are running in a specific step.
isEFComponent() - Method in CLI: Flag method that shows this component requires FlowPlugin instance on initialization.
isEFComponent() - Method in Component
isEFComponent() - Method in Reporting: If a parameter named 'transformScript' was found and contains a closure an instance of the Transformer will be initialized to process report objects.
isParameterExists(String) - Method in StepParameters: Returns true if parameter exists in the current configuration.
isParameterHasValue(String) - Method in StepParameters: Checks if parameter both exists and has non-empty value
isParameterRequired(String) - Method in Context: Checks if the parameter with a specified name is required.
isPreview() - Method in Reporting: Getter for the isPreviewMode
isSuccess() - Method in ExecutionResult: This method is used to ensure that there is no error for execution of the command.
isValidReportingObjectType(String) - Method in Engine: This method checks if given type is supported by the CloudBees CD Server
isWindows() - Method in CLI: Checks if current OS is Windows.

J

K

L

loadComponent(Class<Component>, Map<String, Object>, FlowPlugin) - Method in ComponentManager: Instantiates the specified component with given values ans saves it to the ComponentManager static cache
loadComponentLocal(Class<Component>, Map<String, Object>, FlowPlugin) - Method in ComponentManager: Instantiates the specified component with given values ans saves it to this ComponentManager instance's cache
Log - Class in com.cloudbees.flowpdf: This class provides logging functionality for FlowPDF.
Log(Map<String, String>) - Constructor in Log: Constructor
logDebug(def) - Method in Log
logError(def) - Method in Log
logErrorDiag(def) - Method in Log
logInfo(def) - Method in Log
logInfoDiag(def) - Method in Log
logTrace(def) - Method in Log
logWarnDiag(def) - Method in Log
logWarning(def) - Method in Log

M

merge(StepParameters, boolean) - Method in StepParameters: Allows to concat to different instances of the StepParameters.
Metadata - Class in com.cloudbees.flowpdf.components.reporting: Metadata is a state representation.
Metadata(Map) - Constructor in Metadata: Constructor.
MetadataFactory - Class in com.cloudbees.flowpdf.components.reporting: This class is responsible for creating the {link @Metadata} objects either from the Payload or from the value stored in a property.
MetadataFactory(Map) - Constructor in MetadataFactory: Constructor
method - Field in HTTPRequest: Request method
MissingFunctionArgument - Class in com.cloudbees.flowpdf.exceptions: An exception that represents a situation when function didn't receive a mandatory parameter.
MissingFunctionArgument(String, String) - Constructor in MissingFunctionArgument: Positional arguments constructor allows you to clarify the details..
MissingFunctionDefinition - Class in com.cloudbees.flowpdf.exceptions: An exception that represents a situation when some class does not have some function defined, but should.
MissingFunctionDefinition(String, String) - Constructor in MissingFunctionDefinition: Positional arguments constructor allows you to clarify the details.

N

newCommand(String, ArrayList<String>) - Method in CLI

Creates new Command instance

newContext() - Method in ContextFactory

Creates new Context object.

newContext() - Method in FlowPlugin

Creates Context object.

newData(Map) - Method in Dataset

Creates new Data and saves it in this Dataset instance.

newDataset(ArrayList<String>, List<Data>) - Method in Reporting

Shortcut to create a dataset from given data

newFromLocation(String) - Method in Metadata

Reads and decodes value stored on the CloudBees CD server

newFromLocation() - Method in MetadataFactory

Reads and validates value from the CloudBees CD property that will be converted to a Metadata instance.

newMetadataFactory() - Method in Reporting

newMetadataFromPayload(Payload) - Method in MetadataFactory

This method creates new Metadata from given Payload object.

newPayload(Map<String, Object>) - Method in Payloadset

This method creates new Payload from given values and saves it to the collection

newPayloadset(ArrayList<String>, ArrayList<Payload>) - Method in Reporting

Shortcut to create a payloadset from given payloads

newRequest(Map) - Method in REST

Creates new request

 HTTPRequest request = restClient.newRequest([
   method      : 'GET',
   contentType : 'JSON',
   path        : '/my/path/',
   query       : [ parameter1 : 'value1' ],
   content     : 'request body goes here',
   headers     : [ 'Cookie' : 'shared-cookie;' ]
 ])

newRESTClient(RESTConfig) - Method in Context

Reads configuration values and instantiates new REST client for the configuration.

newStepResult() - Method in Context

Renews a StepResult linked to the current context.

O

OAuthRequestHook - Class in com.cloudbees.flowpdf.client.oauth: Base class for the OAuth authorization hooks.
OAuthRequestHook(RESTConfig) - Constructor in OAuthRequestHook

P

Parameter - Class in com.cloudbees.flowpdf: This class represents the CloudBees CD parameter (key-value pair).
Parameter(String, String) - Constructor in Parameter
parseBooleanPropertyValue(def, String) - Method in Context: Internal method for parsing different boolean representations.
path - Field in HTTPRequest: Path part of this request URL
Payload - Class in com.cloudbees.flowpdf.components.reporting: Represents a reporting system data in a format compatible with a DevOpsInsight Server.
Payload(Map<String, Object>) - Constructor in Payload: Constructor
Payloadset - Class in com.cloudbees.flowpdf.components.reporting: Payloadset represents a wrapper for the collection of the reporting payloads.
pluginInfo() - Method in FlowPlugin: This method should return information about a plugin
prepareAndValidatePayloads(Payloadset) - Method in Reporting: This method is responsible for validating the payloads prepared to be sent to the CloudBees CD server
prepareAndValidateSinglePayload(Payload, Engine) - Method in Reporting: This method compares the payload with format defined on CloudBees CD server
prepareRequest(HTTPRequest) - Method in REST: Checking that the request has required values and is ready to be executed Additional actions (like OAuth processing) will be applied to the request
program - Field in Command: Name of the program to run.

Q

query - Field in HTTPRequest: Map of values that represents query parameters for this request

R

rawRecordsToDataset(List<Map<String, Object>>) - Method in Reporting: Converts objects returned from the reporting system to a Data
readActualCredential(String, String) - Method in Context: Read the values of the credential in current context.
readActualParameter(String) - Method in Context: Read the value of an actual parameter in current context.
readActualParameterValue(String) - Method in FlowAPI: This method contains a logic to get a value for an actual parameter.
render() - Method in EntityAlreadyExists: Builds an exception message from the initial parameters.
render() - Method in EntityDoesNotExist: Builds an exception message from the initial parameters.
render() - Method in FlowPDFException: Builds an exception message from the initial parameters.
render() - Method in MissingFunctionArgument: Builds an exception message from the initial parameters.
render() - Method in MissingFunctionDefinition: Builds an exception message from the initial parameters.
render() - Method in UnexpectedEmptyValue: Builds an exception message from the initial parameters.
render() - Method in UnexpectedMissingValue: Builds an exception message from the initial parameters.
render() - Method in WrongFunctionArgumentType: Builds an exception message from the initial parameters.
render() - Method in WrongFunctionArgumentValue: Builds an exception message from the initial parameters.
renderCommand() - Method in Command: Builds a ProcessBuilder for given program and arguments.
replaceMasked(String) - Method in Log
report(Payloadset) - Method in Engine: This method sends all the Payloads for a given Payloadset
Reporting - Class in com.cloudbees.flowpdf.components.reporting: This module provides a component for Release Command Center (RCC) integration.
reportRecursive(List<Payload>, Map<String, Integer>) - Method in Engine: This method is responsible for sending the report of the payload and then send all it's dependent payloads
request(String, String, Map<String, String>, String) - Method in REST: A handy shortcut for subsequent newRequest() and doRequest()) calls defaultContentType should be set first ( with setResponseContentType() )
requestContentType - Field in HTTPRequest: Content type for this request
RequestHook - Interface in com.cloudbees.flowpdf.client: Authentication is implemented in form of HTTPRequest hooks.
REST - Class in com.cloudbees.flowpdf.client: REST is a configuration-driven wrapper for the groovyx.net.http.HTTPBuilder.
REST(RESTConfig) - Constructor in REST: Constructor
RESTConfig - Class in com.cloudbees.flowpdf.client
retrieveConfigByNameAndLocation(String, String) - Method in Context: Reads the specified property sheet and converts the properties to the Parameter or Credential objects.
retrieveCurrentProjectName(String) - Method in Context: Retrieves name of the project where current running job was started @return
RSAOAuthRequestHook - Class in com.cloudbees.flowpdf.client.oauth: Implementation of the OAuth with RSA-SHA1 (tested with Atlassian JIRA) authorization hook.
RSAOAuthRequestHook(RESTConfig) - Constructor in RSAOAuthRequestHook: Constructor
run() - Method in Command: Renders a Command to a ProcessBuilder and executes it.
runCommand(Command) - Method in CLI: Shortcut for a Command.run.
runReaderStream(InputStream, Appendable) - Method in StreamReaderThread
runStep(String, String, String) - Method in FlowPlugin: This method is responsible for collecting the context information and running the procedure's step

S

sanitizeLogLevel(def) - Method in Log
set(String, String) - Method in Parameter: Sets a name for the current parameter.
setBinaryContent(byte[]) - Method in HTTPRequest: Sets the binary content of the request.
setContentBytes(byte[]) - Method in HTTPRequest
setContentString(String) - Method in HTTPRequest
setCredentialName(String) - Method in Credential: Sets new name for a current credential.
setCredentialType(String) - Method in Credential: Sets new type of the credential
setDefaultLogLevel(def) - Method in Log: Sets a log level for all new instancews and the predefined static instance
setDefaultLogToProperty(String) - Method in Log: Sets a property where the copy of log will be stored for a static instance
setEc(ElectricFlow) - Method in FlowAPI: This method allows to replace the ElectricFlow instance
setFlowProperty(String, String) - Method in FlowAPI: Sets CloudBees CD property at the given path
setHeader(String, String) - Method in HTTPRequest: Sets a header value
setHeaders(Map<String, String>) - Method in HTTPRequest
setJobStepOutcome(String) - Method in StepResult
setJobStepSummary(String) - Method in StepResult
setJobSummary(String) - Method in StepResult
setLogLevel(def) - Method in Log: Sets new log level for this instance
setLogToProperty(String) - Method in Log: Sets a property where the copy of log will be stored for an instance
setMethod(Method) - Method in HTTPRequest
setName(String) - Method in Parameter: Sets a name for the current parameter.
setOutcomeProperty(String, String) - Method in StepResult
setOutputParameter(String, String) - Method in StepResult
SetOutputParameterAction - Class in com.cloudbees.flowpdf.stepresult: Action which results in setting value for an output parameter.
SetOutputParameterAction(actionTypes, String, String) - Constructor in SetOutputParameterAction: Default constructor.
setPath(String) - Method in HTTPRequest
setPipelineSummary(String, String) - Method in StepResult
SetPropertyAction - Class in com.cloudbees.flowpdf.stepresult: Action which results in setting value for a property.
SetPropertyAction(actionTypes, String, String) - Constructor in SetPropertyAction: Default constructor.
setProxyParameters(Map<String, String>) - Method in RESTConfig: Convenience method to set all proxy parameters with a map
setQuery(Map<String, String>) - Method in HTTPRequest
setQueryParameter(String, String) - Method in HTTPRequest: Sets or removes the query parameter with given name
setReportUrl(String, String, String) - Method in StepResult
setRequestContentType(ContentType) - Method in HTTPRequest
setResponseContentType(String) - Method in REST: Set new default content type to be set for the requests without a contentType set.
setResponseContentType(String) - Method in RESTConfig: Convenience method.
setSecretValue(String) - Method in Credential: Sets new secret value
setTimeout(long) - Method in Command: Sets new value value for the command timeout
setUserName(String) - Method in Credential: Sets new value for a username.
setValue(String) - Method in Parameter: Sets a value for the current parameter.
showEnvironmentInfo() - Method in FlowPlugin: Logs environment information
stdErr - Field in ExecutionResult: Content of the standart output after the command execution
stdOut - Field in ExecutionResult: Content of the standart output after the command execution
StepParameters - Class in com.cloudbees.flowpdf: This class represents current step parameters, that are defined for current procedure step or current pipeline task.
StepParameters(Map<String, AbstractParameter>) - Constructor in StepParameters: Constructor
StepResult - Class in com.cloudbees.flowpdf
StreamReaderThread - Class in com.cloudbees.flowpdf.components.cli.utils

T

timeout - Field in Command: Default timeout is set to 300 seconds (5 minutes)
toString() - Method in Credential: Credentials should not be shown in a string context for security reasons.
toString() - Method in Data: toString override was made for the debugging purposes
toString() - Method in ExecutionResult
toString() - Method in Metadata
toString() - Method in Parameter: Overriding default behaviour, so the parameter can be automatically showed in a string context.
toString() - Method in Payload
toString() - Method in StepParameters
trace(def) - Method in Log
transform(Data) - Method in Transformer: Transforms single Data values with a closure
Transformer - Class in com.cloudbees.flowpdf.components.reporting: This class is a wrapper for the user-specified groovy.lang.Closure that can be used to process reporting system records.
Transformer(Map<String, Object>) - Constructor in Transformer: Constructor.

U

UnexpectedEmptyValue - Class in com.cloudbees.flowpdf.exceptions: An exception that represents a situation when unexpected empty value has appeared.
UnexpectedEmptyValue(String, String) - Constructor in UnexpectedEmptyValue: Positional arguments constructor allows you to clarify the details.
UnexpectedMissingValue - Class in com.cloudbees.flowpdf.exceptions: An exception that represents a situation when a required or mandatory value is missing.
UnexpectedMissingValue(String, String) - Constructor in UnexpectedMissingValue: Positional arguments constructor allows you to clarify the details.
updateOrAddParameter(AbstractParameter) - Method in StepParameters: Adds or replaces the parameter in current list
updateValue(String, String) - Method in Data: Updates a value in current report values.
userAgent - Field in REST

V

validateAndConvertRow(String, def, Map<String, Object>) - Method in Reporting: This method validates that the value for given key corresponds with the type that is defined on the CloudBees server.

W

warnDiag(def) - Method in Log
warning(def) - Method in Log
workingDirectory - Field in Command: Working directory for the program.
write() - Method in Metadata: Encodes current value to a JSON string and saves it under the specified property path.
WrongFunctionArgumentType - Class in com.cloudbees.flowpdf.exceptions: An exception that represents a situation when function received an argument of a type that is not suitable.
WrongFunctionArgumentType(String, String, String, String) - Constructor in WrongFunctionArgumentType: Positional arguments constructor allows you to clarify the details.
WrongFunctionArgumentValue - Class in com.cloudbees.flowpdf.exceptions: An exception that represents a situation when function received an argument that has a wrong value.
WrongFunctionArgumentValue(String, String, String, String) - Constructor in WrongFunctionArgumentValue: Positional arguments constructor allows you to clarify the details.