com.atlassian.bamboo.configuration.external

Interface PlanConfigExportService

All Known Implementing Classes:

PlanConfigExportServiceImpl

@ExperimentalApi
public interface PlanConfigExportService

Service to export plan configurations in human readable format.

Since:

5.14

Method Summary

Modifier and Type	Method and Description
Iterable<Path>	exportAllPlans() Export all plans to default location in Bamboo home dir.
Iterable<Path>	exportPlan(ImmutableTopLevelPlan plan) Export top level plan to default location in Bamboo home dir.
com.atlassian.bamboo.specs.api.builders.plan.Plan	exportPlanToSpecs(ImmutableTopLevelPlan plan) Export top level plan to Bamboo Specs entity.

Method Detail

exportAllPlans

@NotNull
Iterable<Path> exportAllPlans()

Export all plans to default location in Bamboo home dir.

Returns:

paths to files updated by export process

exportPlan

@NotNull
Iterable<Path> exportPlan(@NotNull
                                   ImmutableTopLevelPlan plan)

Export top level plan to default location in Bamboo home dir.

Returns:

paths to files updated by export process

exportPlanToSpecs

com.atlassian.bamboo.specs.api.builders.plan.Plan exportPlanToSpecs(@NotNull
                                                                    ImmutableTopLevelPlan plan)

Export top level plan to Bamboo Specs entity.

Returns:

an entity representing plan.

Since:

6.1