public interface BambooYamlParser
BambooYamlDefinition
@NotNull BambooYamlPlanDefinition parsePlan(@NotNull Map<String,Object> yamlStructure, @NotNull BambooYamlVersion yamlVersion, @NotNull VcsRepositoryData repository, @NotNull RssExecutionOutputHandler stdout) throws YamlSpecsValidationException
BambooYamlPlanDefinition
based on the given YAML structure. This method will
run basic validation, e.g. that types in the YAML document match.yamlStructure
- a single YAML document converted into a Map
yamlVersion
- YAML format versionrepository
- the VCS where the YAML is fromstdout
- output handler for logging execution informationYamlSpecsValidationException
- if the passed YAML document is not a valid plan definition@NotNull BambooYamlDeploymentDefinition parseDeployment(@NotNull Map<String,Object> yamlStructure, @NotNull BambooYamlVersion yamlVersion, @NotNull VcsRepositoryData repository) throws YamlSpecsValidationException
BambooYamlDeploymentDefinition
based on the given YAML structure. This method will
run basic validation, e.g. that types in the YAML document match.yamlStructure
- a single YAML document converted into a Map
yamlVersion
- YAML format versionYamlSpecsValidationException
- if the passed YAML document is not a valid deployment project definition@NotNull BambooYamlDeploymentPermissionsDefinition parseDeploymentPermissions(Map<String,Object> yamlStructure, BambooYamlVersion yamlVersion) throws YamlSpecsValidationException
BambooYamlDeploymentPermissionsDefinition
based on the given YAML structure. This method will
run basic validation, e.g. that types in the YAML document match.yamlStructure
- a single YAML document converted into a Map
yamlVersion
- YAML format versionYamlSpecsValidationException
- if the passed YAML document is not a valid deployment project permissions definition@NotNull BambooYamlPlanPermissionsDefinition parsePlanPermissions(Map<String,Object> yamlStructure, BambooYamlVersion yamlVersion) throws YamlSpecsValidationException
BambooYamlPlanPermissionsDefinition
based on the given YAML structure. This method will
run basic validation, e.g. that types in the YAML document match.yamlStructure
- a single YAML document converted into a Map
yamlVersion
- YAML format versionYamlSpecsValidationException
- if the passed YAML document is not a valid plan permissions definitionCopyright © 2021 Atlassian Software Systems Pty Ltd. All rights reserved.