Package com.atlassian.bamboo.configuration.external.yaml

Interface BambooYamlToSpecsConverter

All Known Implementing Classes:

BambooYamlToSpecsConverterImpl

public interface BambooYamlToSpecsConverter

Converter which maps a simplified Bamboo YAML document to Bamboo Specs instances.

See Also:

BambooYamlDefinition

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	BambooYamlToSpecsConverter.CombinedDeploymentPermissions

Method Summary

Modifier and Type	Method	Description
@NotNull BambooYamlToSpecsConverter.CombinedDeploymentPermissions	createDeploymentPermissions(@NotNull BambooYamlDeploymentPermissionsDefinition deploymentPermissionsDefinition)	Create a new instance of a specs DeploymentPermissions for the given YAML deployment project permissions definition.
@NotNull com.atlassian.bamboo.specs.api.builders.deployment.Deployment	createDeploymentProject(@NotNull BambooYamlDeploymentDefinition deploymentDefinition, @NotNull VcsRepositoryData repository)	Create a new instance of a specs Deployment for the given YAML deployment definition.
@NotNull com.atlassian.bamboo.specs.api.builders.plan.Plan	createPlan(@NotNull BambooYamlPlanDefinition planDefinition, @NotNull VcsRepositoryData repository)	Create a new instance of a specs Plan for the given YAML plan definition.
@NotNull com.atlassian.bamboo.specs.api.builders.permission.PlanPermissions	createPlanPermissions(@NotNull BambooYamlPlanPermissionsDefinition planPermissionsDefinition)	Create a new instance of a specs PlanPermissions for the given YAML plan permissions definition.

Method Detail

createPlan

@NotNull
@NotNull com.atlassian.bamboo.specs.api.builders.plan.Plan createPlan(@NotNull
                                                                      @NotNull BambooYamlPlanDefinition planDefinition,
                                                                      @NotNull
                                                                      @NotNull VcsRepositoryData repository)

Create a new instance of a specs Plan for the given YAML plan definition.

Parameters:

planDefinition - YAML definition of a plan, created by parsing the YAML document

repository - VCS repository hosting the YAML document

Returns:

Bamboo Specs plan representing the YAML document

createDeploymentProject

@NotNull
@NotNull com.atlassian.bamboo.specs.api.builders.deployment.Deployment createDeploymentProject(@NotNull
                                                                                               @NotNull BambooYamlDeploymentDefinition deploymentDefinition,
                                                                                               @NotNull
                                                                                               @NotNull VcsRepositoryData repository)

Create a new instance of a specs Deployment for the given YAML deployment definition.

Parameters:

deploymentDefinition - YAML definition of a deployment project, created by parsing the YAML document

repository - VCS repository hosting the YAML document

Returns:

Bamboo Specs deployment representing the YAML document

createPlanPermissions

@NotNull
@NotNull com.atlassian.bamboo.specs.api.builders.permission.PlanPermissions createPlanPermissions(@NotNull
                                                                                                  @NotNull BambooYamlPlanPermissionsDefinition planPermissionsDefinition)

Create a new instance of a specs PlanPermissions for the given YAML plan permissions definition.

Parameters:

planPermissionsDefinition - YAML definition of plan permissions, created by parsing the YAML document

Returns:

Bamboo Specs plan permissions representing the YAML document

createDeploymentPermissions

@NotNull
@NotNull BambooYamlToSpecsConverter.CombinedDeploymentPermissions createDeploymentPermissions(@NotNull
                                                                                              @NotNull BambooYamlDeploymentPermissionsDefinition deploymentPermissionsDefinition)

Create a new instance of a specs DeploymentPermissions for the given YAML deployment project permissions definition.

Parameters:

deploymentPermissionsDefinition - YAML definition of deployment project permissions, created by parsing the YAML document

Returns:

Bamboo Specs deployment project permissions representing the YAML document