com.atlassian.bamboo.plan.artifact

Interface ImmutableArtifactSubscription

All Superinterfaces:

BambooIdProvider, NameProvider

All Known Subinterfaces:

ArtifactSubscription, ArtifactSubscriptionSubstitutionAware

All Known Implementing Classes:

ArtifactSubscriptionImpl, ArtifactSubscriptionSubstitutionAwareImpl, ImmutableArtifactSubscriptionImpl

public interface ImmutableArtifactSubscription
extends BambooIdProvider, NameProvider

Method Summary

Modifier and Type	Method and Description
@NotNull ImmutableArtifactDefinition	getArtifactDefinition() Get definition of artifact we're subscribed to.
@NotNull ImmutableJob	getConsumerJob() Get job which consumes the artifact
@Nullable String	getDestinationDirectory() Get destination path.
@NotNull String	getName()

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

getId

Method Detail

getName

@NotNull
@NotNull String getName()

Specified by:

getName in interface NameProvider

getArtifactDefinition

@NotNull
@NotNull ImmutableArtifactDefinition getArtifactDefinition()

Get definition of artifact we're subscribed to.

Returns:

ArtifactDefinition object

getConsumerJob

@NotNull
@NotNull ImmutableJob getConsumerJob()

Get job which consumes the artifact

Returns:

Job object

getDestinationDirectory

@Nullable
@Nullable String getDestinationDirectory()

Get destination path. This represents a location where consumer job expects to find an artifact.

Returns:

Path to the expected location of artifact