@PublicApi
public interface VariableConfigurationService
Modifier and Type | Method and Description |
---|---|
@NotNull VariableDefinition |
createGlobalVariable(@NotNull String variableKey,
@NotNull String variableValue)
Creates new Global variable.
|
@NotNull VariableDefinition |
createPlanVariable(@NotNull Plan plan,
@NotNull String variableKey,
@NotNull String variableValue)
Creates new Plan variable.
|
VariableDefinition |
createProjectVariable(long projectId,
@NotNull String variableKey,
@NotNull String variableValue)
Create a project variable.
|
@NotNull VariableDefinition |
createUniqueGlobalVariable(@NotNull String variableKey,
@NotNull String variableValue)
Creates new global variable.
|
@NotNull VariableDefinition |
createUniquePlanVariable(@NotNull Plan plan,
@NotNull String variableKey,
@NotNull String variableValue)
Creates new Plan variable.
|
@NotNull VariableDefinition |
createVariableForEnvironment(long environmentId,
@NotNull String variableKey,
@NotNull String variableValue)
Creates new variable for Deployment Environment
|
void |
deleteVariableDefinition(@NotNull VariableDefinition variableDefinition)
Removes
VariableDefinition |
void |
setDeploymentEnvironmentVariables(long environmentId,
@NotNull List<com.atlassian.bamboo.specs.api.model.VariableProperties> variables)
Creates complete deployment environment variables list.
|
void |
setPlanVariables(@NotNull Chain plan,
@NotNull List<com.atlassian.bamboo.specs.api.model.VariableProperties> variables)
Creates complete plan variables list.
|
void |
setProjectVariables(long projectId,
@NotNull List<com.atlassian.bamboo.specs.api.model.VariableProperties> variables)
Creates complete project variables list.
|
@NotNull VariableDefinition |
updateVariableDefinition(@NotNull VariableDefinition variableDefinition,
String previousValue)
Updates
VariableDefinition |
@NotNull @NotNull VariableDefinition createUniquePlanVariable(@NotNull @NotNull Plan plan, @NotNull @NotNull String variableKey, @NotNull @NotNull String variableValue)
plan
- plan the variable belongs tovariableKey
- variable key.variableValue
- variable valueVariableDefinition
@NotNull @NotNull VariableDefinition createUniqueGlobalVariable(@NotNull @NotNull String variableKey, @NotNull @NotNull String variableValue)
variableKey
- variable key.variableValue
- variable valueVariableDefinition
@NotNull @NotNull VariableDefinition createPlanVariable(@NotNull @NotNull Plan plan, @NotNull @NotNull String variableKey, @NotNull @NotNull String variableValue)
plan
- plan the variable belongs tovariableKey
- variable key.variableValue
- variable valueVariableDefinition
IllegalArgumentException
- iff variable key is not unique@NotNull @NotNull VariableDefinition createVariableForEnvironment(long environmentId, @NotNull @NotNull String variableKey, @NotNull @NotNull String variableValue)
environmentId
- variableKey
- variable key.variableValue
- variable valueVariableDefinition
IllegalArgumentException
- iff variable key is not unique or com.atlassian.bamboo.deployments.environments.Environment does not exist@NotNull @NotNull VariableDefinition createGlobalVariable(@NotNull @NotNull String variableKey, @NotNull @NotNull String variableValue)
variableValue
- variable valueVariableDefinition
IllegalArgumentException
- iff variable key is not unique@NotNull @NotNull VariableDefinition updateVariableDefinition(@NotNull @NotNull VariableDefinition variableDefinition, String previousValue)
VariableDefinition
IllegalArgumentException
- iff variable key is not uniquevoid deleteVariableDefinition(@NotNull @NotNull VariableDefinition variableDefinition)
VariableDefinition
void setPlanVariables(@NotNull @NotNull Chain plan, @NotNull @NotNull List<com.atlassian.bamboo.specs.api.model.VariableProperties> variables)
void setProjectVariables(long projectId, @NotNull @NotNull List<com.atlassian.bamboo.specs.api.model.VariableProperties> variables)
void setDeploymentEnvironmentVariables(long environmentId, @NotNull @NotNull List<com.atlassian.bamboo.specs.api.model.VariableProperties> variables)
VariableDefinition createProjectVariable(long projectId, @NotNull @NotNull String variableKey, @NotNull @NotNull String variableValue)
Copyright © 2022 Atlassian Software Systems Pty Ltd. All rights reserved.