com.atlassian.bamboo.deployments.projects

Interface InternalDeploymentProject

All Superinterfaces:

BambooIdProvider, DescriptionProvider, ImmutableEntityWithOid, NameProvider

All Known Subinterfaces:

DeploymentProject, MutableDeploymentProject

All Known Implementing Classes:

DeploymentProjectIdentifier, DeploymentProjectImpl, MutableDeploymentProjectImpl, RestDeploymentProject

@Internal
public interface InternalDeploymentProject
extends BambooIdProvider, NameProvider, DescriptionProvider, ImmutableEntityWithOid

Common interface between all types of Deployment Projects. Defines relationship between client side objects and db objects. Though probably not useful for anything else. Be wary when adding things to this interface - be sure it makes sense in all contexts.

Method Summary

Modifier and Type	Method and Description
@Nullable String	getDescription()
default BambooEntityType	getEntityType() Entity type of this object, used in BambooEntityOid.
long	getId()
@NotNull DeploymentKey	getKey()
@NotNull String	getName()
@Nullable PlanKey	getPlanKey()

Methods inherited from interface com.atlassian.bamboo.core.ImmutableEntityWithOid

getOid

Method Detail

getEntityType

default BambooEntityType getEntityType()

Description copied from interface: ImmutableEntityWithOid

Entity type of this object, used in BambooEntityOid.

Specified by:

getEntityType in interface ImmutableEntityWithOid

getId

long getId()

Specified by:

getId in interface BambooIdProvider

Returns:

unique identifier (in this case from database)

getKey

@NotNull
@NotNull DeploymentKey getKey()

getName

@NotNull
@NotNull String getName()

Specified by:

getName in interface DescriptionProvider

Specified by:

getName in interface NameProvider

Returns:

User friendly shortish name for this deployment project. Must be unique with in Bamboo

getDescription

@Nullable
@Nullable String getDescription()

Specified by:

getDescription in interface DescriptionProvider

Returns:

Optional, longer description of the project

getPlanKey

@Nullable
@Nullable PlanKey getPlanKey()

Returns:

the plan key of the linked plan to this deployment Project.