com.atlassian.bamboo.specs.builders.task

Class InjectVariablesTask

java.lang.Object

com.atlassian.bamboo.specs.api.builders.EntityPropertiesBuilder<P>

com.atlassian.bamboo.specs.api.builders.task.Task<InjectVariablesTask,InjectVariablesTaskProperties>

com.atlassian.bamboo.specs.builders.task.InjectVariablesTask

public class InjectVariablesTask
extends Task<InjectVariablesTask,InjectVariablesTaskProperties>

Represents a task that injects Bamboo variables from a file in a simple "key=value" format. File is read on agent when the task is run.

By default scope of extracted variables is set to InjectVariablesScope.LOCAL and the namespace is set to "inject".

Field Summary

Fields inherited from class com.atlassian.bamboo.specs.api.builders.task.Task

conditions, description, requirements, taskEnabled

Constructor Summary

Constructors

Constructor and Description
InjectVariablesTask()

Method Summary

Modifier and Type	Method and Description
protected InjectVariablesTaskProperties	build()
InjectVariablesTask	namespace(String namespace) Specifies namespace to avoid name conflicts with existing variables.
InjectVariablesTask	path(String path) Specifies path to properties file.
InjectVariablesTask	scope(InjectVariablesScope scope) Specifies scope of the created variables to result.
InjectVariablesTask	scopeLocal() Specifies scope of the created variables to local.
InjectVariablesTask	scopeResult() Specifies scope of the created variables to result.

Methods inherited from class com.atlassian.bamboo.specs.api.builders.task.Task

conditions, description, enabled, requirements

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InjectVariablesTask

public InjectVariablesTask()

Method Detail

path

public InjectVariablesTask path(@NotNull
                                String path)

Specifies path to properties file. File will be read when task is run and variables will be created.

namespace

public InjectVariablesTask namespace(@NotNull
                                     String namespace)

Specifies namespace to avoid name conflicts with existing variables.

scopeLocal

public InjectVariablesTask scopeLocal()

Specifies scope of the created variables to local. They will be available only in current job.

scopeResult

public InjectVariablesTask scopeResult()

Specifies scope of the created variables to result. They will be available in subsequent stages of this plan and in releases created from the result.

scope

public InjectVariablesTask scope(@NotNull
                                 InjectVariablesScope scope)

Specifies scope of the created variables to result.

build

@NotNull
protected InjectVariablesTaskProperties build()

Overrides:

build in class Task<InjectVariablesTask,InjectVariablesTaskProperties>