@ExperimentalApi
@Internal
public interface TaskCondition
Modifier and Type | Method and Description |
---|---|
default com.atlassian.bamboo.specs.api.builders.condition.TaskCondition |
fromYaml(Node node,
TaskValidationContext validationContext)
Parse YAML representation of condition.
|
default String |
getDescription(CommonContext commonContext,
TaskConditionConfig condition)
Provide condition description to display at UI and build logs.
|
boolean |
isMet(RuntimeTaskDefinition taskDefinition,
Map<String,String> conditionConfiguration,
CommonContext commonContext) |
Map<String,String> |
prepareConfiguration(ActionParametersMap parametersMap) |
Map<String,Object> |
prepareParametersMap(Map<String,String> configuration,
ActionParametersMap parametersMap) |
default Node |
toYaml(com.atlassian.bamboo.specs.api.model.plan.condition.ConditionProperties condition) |
ErrorCollection |
validate(ActionParametersMap parametersMap)
Validate user input before saving condition configuration.
|
boolean isMet(@NotNull RuntimeTaskDefinition taskDefinition, @NotNull Map<String,String> conditionConfiguration, @NotNull CommonContext commonContext)
@NotNull Map<String,String> prepareConfiguration(@NotNull ActionParametersMap parametersMap)
@NotNull Map<String,Object> prepareParametersMap(@NotNull Map<String,String> configuration, @NotNull ActionParametersMap parametersMap)
configuration
- - condition configuration from TaskDefinitionparametersMap
- - user submitted parameters. Use it to restore configuration in case of validation errors.@Nullable ErrorCollection validate(@NotNull ActionParametersMap parametersMap)
@NotNull default String getDescription(@NotNull CommonContext commonContext, @NotNull TaskConditionConfig condition)
commonContext
- execution contextcondition
- settings@Nullable default com.atlassian.bamboo.specs.api.builders.condition.TaskCondition fromYaml(@NotNull Node node, @NotNull TaskValidationContext validationContext)
@Nullable default Node toYaml(@NotNull com.atlassian.bamboo.specs.api.model.plan.condition.ConditionProperties condition)
Copyright © 2021 Atlassian Software Systems Pty Ltd. All rights reserved.