Package com.atlassian.bamboo.plan

Interface Plan

All Superinterfaces:
BambooIdProvider, BambooObject, BambooObjectWithOid, Deletable, Describable, DescriptionProvider, EntityWithOid, ImmutableDeletable, ImmutableEntityWithOid, ImmutablePlan, NameProvider, PlanIdentifier, PlanKeyProvider, Versionable
All Known Subinterfaces:
Buildable, Chain, ChainBranch, Job, TopLevelPlan
All Known Implementing Classes:
AbstractChain, AbstractPlan, ChainBranchImpl, DefaultChain, DefaultJob
@PublicApi public interface Plan extends BambooObjectWithOid, Describable, Deletable, ImmutablePlan
Mutable version of the plan. The naming is different within the code and user interface. As of Bamboo 10.2 Plan object can represent:
    Chain (known as Plan in the user interface)
    Chain Branch (known as Plan Branch in the user interface)
    Job
    Job present on a branch

  • Method Details

    • setKey

      void setKey(String fullKey)
      Parameters:
      fullKey -

    • setPlanKey

      void setPlanKey(@NotNull @NotNull PlanKey planKey)

    • setBuildKey

      void setBuildKey(String buildKey)
      Define the build's unique key (uppercase alphanumeric)
      Parameters:
      buildKey - The value of the key

    • setBuildName

      void setBuildName(String buildName)

    • setSuspendedFromBuilding

      void setSuspendedFromBuilding(boolean suspendFromBuilding)
      Sets the build to suspend temporarily
      Parameters:
      suspendFromBuilding -

    • getBuildDefinitionXml

      @Nullable @Nullable BuildDefinitionForBuild getBuildDefinitionXml()

    • setBuildDefinitionXml

      void setBuildDefinitionXml(@Nullable @Nullable BuildDefinitionForBuild buildDefinitionXml)

    • setMaster

      void setMaster(Plan master)
      Set which plan is the master of this plan. The master is the plan which this one is derived from. Configuration will be pulled from the master if one exists and if it is not a divergent branch
      Parameters:
      master -

    • setProject

      void setProject(Project project)

    • getLatestResultsSummary

      @Nullable @Nullable ResultsSummary getLatestResultsSummary()
      Description copied from interface: ImmutablePlan
      Get the latest finished result
      Specified by:
      getLatestResultsSummary in interface ImmutablePlan
      Returns:
      The summary info for the last completed build. Returns null if there are no build results for this plan

    • setLabellings

      void setLabellings(List<Labelling> labellings)

    • getRelatedLabellings

      @NotNull @NotNull List<Labelling> getRelatedLabellings()
      Returns labellings that are applicable for the plan level
      Returns:
      Empty list if no labels

    • getLabellings

      @NotNull @Deprecated @NotNull List<Labelling> getLabellings()
      Deprecated.
      3.4
      Used only for Hibernate mapping purposes. Deprecated for removal from the interface
      Returns: