Package com.atlassian.bamboo.specs.builders.task

Class ScpTask

java.lang.Object

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

com.atlassian.bamboo.specs.api.builders.task.Task<T,E>

com.atlassian.bamboo.specs.builders.task.BaseSshTask<ScpTask,ScpTaskProperties>

com.atlassian.bamboo.specs.builders.task.ScpTask

public class ScpTask
extends BaseSshTask<ScpTask,ScpTaskProperties>

Represents task that runs scp command.

Field Summary

Fields inherited from class com.atlassian.bamboo.specs.builders.task.BaseSshTask

authenticationType, hostFingerprint, hosts, key, passphrase, password, port, sharedCredentials, username

Fields inherited from class com.atlassian.bamboo.specs.api.builders.task.Task

conditions, description, requirements, taskEnabled

Constructor Summary

Constructors

Constructor	Description
ScpTask()

Method Summary

Modifier and Type	Method	Description
protected @NotNull ScpTaskProperties	build()
boolean	equals(java.lang.Object o)
ScpTask	fromArtifact(Artifact artifact)	Deprecated. since Bamboo 6.1.0, use fromArtifact(ArtifactItem)
ScpTask	fromArtifact(ArtifactItem artifactItem)	Artifact to copy.
ScpTask	fromArtifact(java.lang.String artifactName)	Deprecated. since Bamboo 6.1.0, use fromArtifact(ArtifactItem)
ScpTask	fromLocalPath(java.lang.String localPath)	The local path (relative to the Bamboo working directory) to the files you want to copy.
ScpTask	fromLocalPath(java.lang.String localPath, boolean antStyle)	The local path (relative to the Bamboo working directory) to the files you want to copy.
int	hashCode()
static ArtifactItem	parseArtifactItemString(java.lang.String fullName)	Convert a full artifact name "PROJECT-PLAN: artifact" or a short artifact name "artifact" into an ArtifactItem.
ScpTask	toRemotePath(java.lang.String remotePath)	The path to the destination directory on the remote server.

Methods inherited from class com.atlassian.bamboo.specs.builders.task.BaseSshTask

authenticateWithKey, authenticateWithKey, authenticateWithKeyWithPassphrase, authenticateWithKeyWithPassphrase, authenticateWithPassword, authenticateWithSshSharedCredentials, authenticateWithUsernamePasswordSharedCredentials, host, host, hostFingerprint, port, portDefault, username

Methods inherited from class com.atlassian.bamboo.specs.api.builders.task.Task

conditions, description, enabled, requirements, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ScpTask

public ScpTask()

Method Detail

fromLocalPath

public ScpTask fromLocalPath(java.lang.String localPath)

The local path (relative to the Bamboo working directory) to the files you want to copy. Use commas to separate files and directories. You can also use Ant-style pattern matching to include multiple files, such as **\/target/*.jar. Use fromLocalPath(String, boolean) to turn on Ant-style pattern matching.

fromLocalPath

public ScpTask fromLocalPath(java.lang.String localPath,
                             boolean antStyle)

The local path (relative to the Bamboo working directory) to the files you want to copy. Use commas to separate files and directories. You can also use Ant-style pattern matching to include multiple files, such as **\/target/*.jar. Ant-style pattern matching is false by default.

fromArtifact

@Deprecated
public ScpTask fromArtifact(java.lang.String artifactName)

Deprecated.

since Bamboo 6.1.0, use fromArtifact(ArtifactItem)

Name of the artifact to copy.

fromArtifact

@Deprecated
public ScpTask fromArtifact(Artifact artifact)

Deprecated.

since Bamboo 6.1.0, use fromArtifact(ArtifactItem)

Artifact to copy.

fromArtifact

public ScpTask fromArtifact(ArtifactItem artifactItem)

Artifact to copy.

Parameters:

artifactItem - specifies which downloaded artifact shall be copied

Returns:

ScpTask

Since:

Bamboo 6.1.0

toRemotePath

public ScpTask toRemotePath(java.lang.String remotePath)

The path to the destination directory on the remote server.

build

@NotNull
protected @NotNull ScpTaskProperties build()

Specified by:

build in class Task<ScpTask,ScpTaskProperties>

parseArtifactItemString

public static ArtifactItem parseArtifactItemString(java.lang.String fullName)

Convert a full artifact name "PROJECT-PLAN: artifact" or a short artifact name "artifact" into an ArtifactItem.

Parameters:

fullName - artifact name with project-plan keys

Returns:

ArtifactItem

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class BaseSshTask<ScpTask,ScpTaskProperties>

hashCode

public int hashCode()

Overrides:

hashCode in class BaseSshTask<ScpTask,ScpTaskProperties>