com.atlassian.bamboo.storage.location

Interface StorageTagService

All Known Implementing Classes:

AbstractStorageTagService, RemoteAgentStorageTagService, StorageTagServiceImpl

@Internal
public interface StorageTagService

Method Summary

Modifier and Type	Method and Description
@Nullable ChainStorageTag	getChainStorageTag(@NotNull PlanKey chainKey)
@NotNull String	getStorageLabel(@NotNull Key key) Returns the storage label for the specified key.

Method Detail

getChainStorageTag

@Nullable
@Nullable ChainStorageTag getChainStorageTag(@NotNull
                                                       @NotNull PlanKey chainKey)

Returns:

storage tag for the specified chain. The storage tag is used to determine the storage location for artifacts, logs and other files related to the chain. A chain's storage tag is assigned when the chain is created and it never changes.

Throws:

IllegalArgumentException - if supplied with a job key instead of a chain key.

getStorageLabel

@NotNull
@NotNull String getStorageLabel(@NotNull
                                         @NotNull Key key)

Returns the storage label for the specified key. For chains, the storage label is equal to the storage tag (eg. "PROJ-PLAN" or "12345"). For jobs, the storage label is "{chain-storage-tag}-{partial-job-key}" (eg. "12345-JOB6"). For all other entities the storage label is the build key.