com.atlassian.bamboo.specs.api.builders.plan.artifact

Class Artifact

java.lang.Object

com.atlassian.bamboo.specs.api.builders.EntityPropertiesBuilder<ArtifactProperties>

com.atlassian.bamboo.specs.api.builders.plan.artifact.Artifact

public class Artifact
extends EntityPropertiesBuilder<ArtifactProperties>

Represents Bamboo artifact definition.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	REQUIRED_BY_DEFAULT
static boolean	SHARED_BY_DEFAULT

Constructor Summary

Constructors

Constructor and Description
Artifact()
Artifact(String name) Specify an artifact with given name.

Method Summary

Modifier and Type	Method and Description
protected ArtifactProperties	build()
Artifact	copyPattern(String copyPattern) Specify the pattern according to which Bamboo should copy files when creating an actual artifact.
String	getName() Returns defined artifact name, which serves as identifier for this object.
Artifact	location(String location) Specifies a path in which Bamboo should look for the files when creating an actual artifact.
Artifact	name(String name) Sets an artifact name.
Artifact	required() Set artifact to be required.
Artifact	required(boolean mandatory) Specifies if artifact is required.
Artifact	shared(boolean shared) Specifies if artifact is shared.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SHARED_BY_DEFAULT

public static final boolean SHARED_BY_DEFAULT

REQUIRED_BY_DEFAULT

public static final boolean REQUIRED_BY_DEFAULT

Constructor Detail

Artifact

public Artifact()

Artifact

public Artifact(@NotNull
                String name)
         throws PropertiesValidationException

Specify an artifact with given name. Name must be unique within the job; if artifact is shared it must be unique within the plan.

In the absence of oid, the name is used to identify the artifact. If the artifact with given name does not exist, a new one is created, otherwise existing one is updated.

Throws:

PropertiesValidationException

Method Detail

name

public Artifact name(@NotNull
                     String name)
              throws PropertiesValidationException

Sets an artifact name. Name must be unique within the job; if artifact is shared it must be unique within the plan.

In the absence of oid, the name is used to identify the artifact. If the artifact with given name does not exist, a new one is created, otherwise existing one is updated.

Throws:

PropertiesValidationException

copyPattern

public Artifact copyPattern(@NotNull
                            String copyPattern)
                     throws PropertiesValidationException

Specify the pattern according to which Bamboo should copy files when creating an actual artifact.

Parameters:

copyPattern - a copy pattern in Ant copy pattern format

Throws:

PropertiesValidationException

shared

public Artifact shared(boolean shared)

Specifies if artifact is shared. Shared artifacts can be downloaded by jobs in subsequent stages as well as other plans and deployments. False by default.

required

public Artifact required()

Set artifact to be required. Build will fail if can't publish required artifact.

required

public Artifact required(boolean mandatory)

Specifies if artifact is required. Build will fail if can't publish required artifact. False by default.

location

public Artifact location(@NotNull
                         String location)
                  throws PropertiesValidationException

Specifies a path in which Bamboo should look for the files when creating an actual artifact.

Throws:

PropertiesValidationException

getName

@NotNull
public String getName()

Returns defined artifact name, which serves as identifier for this object.

Throws:

IllegalStateException - if name is undefined

build

protected ArtifactProperties build()
                            throws PropertiesValidationException

Specified by:

build in class EntityPropertiesBuilder<ArtifactProperties>

Throws:

PropertiesValidationException