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.

  • Constructor Details

    • ScpTask

      public ScpTask()

  • Method Details

    • fromLocalPath

      public ScpTask fromLocalPath(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(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(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(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(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(Object o)
      Overrides:
      equals in class BaseSshTask<ScpTask,ScpTaskProperties>

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class BaseSshTask<ScpTask,ScpTaskProperties>