Variable (Atlassian Bamboo Plan Specs 9.5.1 API)

java.lang.Object
- com.atlassian.bamboo.specs.api.builders.EntityPropertiesBuilder<VariableProperties>
- - com.atlassian.bamboo.specs.api.builders.Variable

public class Variable
extends EntityPropertiesBuilder<VariableProperties>

Represents a Bamboo variable.

Constructor Summary

Constructors
Constructor Description

Variable(@NotNull java.lang.String name, @NotNull java.lang.String value)
Specifies a variable with given name and value.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected VariableProperties`	`build()`
`Variable`	`createOnly()`	Indicates that variable is automatically updated by build or deployment process.
`Variable`	`name(@NotNull java.lang.String name)`	Sets variable name.
`Variable`	`value(@NotNull java.lang.String value)`	Sets variable value.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Variable
```
public Variable(@NotNull
                @NotNull java.lang.String name,
                @NotNull
                @NotNull java.lang.String value)
```
    Specifies a variable with given name and value.
    
    Parameters:
    
    name - name of the variable
    
    value - value of the variable
- Method Detail
  - name
```
public Variable name(@NotNull
                     @NotNull java.lang.String name)
```
    Sets variable name.
    Variables with names containing words like 'password', 'secret', 'passphrase' are considered 'secret' and are encrypted when stored by Bamboo.
  - value
```
public Variable value(@NotNull
                      @NotNull java.lang.String value)
```
    Sets variable value.
    In case of 'secret' variables, both encrypted and unencrypted forms are valid.
    
    See Also:
    
    Encryption in Bamboo Specs
  - createOnly
```
public Variable createOnly()
```
    Indicates that variable is automatically updated by build or deployment process. In such a case, the variable is created and it's value set only if it doesn't already exist.
    
    Since:
    
    6.10
  - build
```
protected VariableProperties build()
```
    Specified by:
    
    build in class EntityPropertiesBuilder<VariableProperties>