Package com.atlassian.bamboo.buildqueue

Interface PipelineDefinition

All Superinterfaces:
BambooIdProvider, BambooObject, Cloneable, Comparable<PipelineDefinition>, CreationDateProvider
All Known Subinterfaces:
AgentWithCapabilitiesDefinition, ElasticAgentDefinition, EphemeralAgentDefinition, LocalAgentDefinition, RemoteAgentDefinition
All Known Implementing Classes:
AgentWithCapabilitiesDefinitionImpl, ElasticAgentDefinitionImpl, EphemeralAgentDefinitionImpl, LocalAgentDefinitionImpl, PipelineDefinitionImpl, RemoteAgentDefinitionImpl
public interface PipelineDefinition extends BambooObject, BambooIdProvider, CreationDateProvider, Comparable<PipelineDefinition>, Cloneable
Definition of an entity (agent) capable of executing plans

  • Method Details

    • getName

      String getName()

    • setName

      void setName(String name)

    • getDescription

      @Nullable @Nullable String getDescription()

    • getCreationDate

      Date getCreationDate()
      Specified by:
      getCreationDate in interface CreationDateProvider
      Returns:
      Date the version object was created.

    • setCreationDate

      void setCreationDate(Date date)

    • getLastModificationDate

      Date getLastModificationDate()

    • setLastModificationDate

      void setLastModificationDate(Date date)

    • accept

      void accept(PipelineDefinitionVisitor visitor)
      Call back method to perform different actions depending on what type of agent it is
      Parameters:
      visitor - Visitor object

    • setDescription

      void setDescription(@Nullable @Nullable String description)

    • isEnabled

      boolean isEnabled()

    • setEnabled

      void setEnabled(boolean enabled)

    • getType

      @NotNull @NotNull AgentType getType()
      Gets type of the agent
      Returns:
      Type of the agent

    • getEphemeralAgentDedicationUntyped

      @Internal @Nullable @Nullable String getEphemeralAgentDedicationUntyped()
      For persistence only. Use getEphemeralAgentDedication() instead.
      Since:
      9.1

    • setEphemeralAgentDedicationUntyped

      @Internal void setEphemeralAgentDedicationUntyped(@Nullable @Nullable String key)
      For persistence only. Use setEphemeralAgentDedication(ResultKey) instead.
      Since:
      9.1

    • getEphemeralAgentDedication

      @Nullable @Nullable ResultKey getEphemeralAgentDedication()
      Key of the job this agent is dedicated to or null if not a dedicated ephemeral agent.
      Since:
      9.1

    • setEphemeralAgentDedication

      void setEphemeralAgentDedication(@Nullable @Nullable ResultKey key)
      Mark this agent as dedicated to a specific job.
      Since:
      9.1

    • isDedicated

      boolean isDedicated()
      Is the agent dedicated to a specific job.
      Returns:
      whether is dedicated
      Since:
      9.1