com.atlassian.bamboo.specs.builders.task

Class SshTask

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<SshTask,SshTaskProperties>

com.atlassian.bamboo.specs.builders.task.SshTask

public class SshTask
extends BaseSshTask<SshTask,SshTaskProperties>

Represents a task to run a remote command over SSH.

Field Summary

Fields

Modifier and Type	Field and Description
protected Duration	keepAliveInterval

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

authenticationType, host, hostFingerprint, 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 and Description
SshTask()

Method Summary

Modifier and Type	Method and Description
protected SshTaskProperties	build()
SshTask	command(Path path)
SshTask	command(String command) Shell command to execute on the remote host.
SshTask	keepAliveInterval(Duration keepAliveInterval) Sets the SSH keep alive interval.
SshTask	keepAliveIntervalInSeconds(int keepAliveIntervalSeconds) Sets the SSH keep alive interval in seconds.

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

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

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

conditions, description, enabled, requirements

Methods inherited from class java.lang.Object

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

Field Detail

keepAliveInterval

@Nullable
protected Duration keepAliveInterval

Constructor Detail

SshTask

public SshTask()

Method Detail

command

public SshTask command(@NotNull
                       String command)

Shell command to execute on the remote host.

command

public SshTask command(@NotNull
                       Path path)

keepAliveInterval

public SshTask keepAliveInterval(Duration keepAliveInterval)

Sets the SSH keep alive interval.

keepAliveIntervalInSeconds

public SshTask keepAliveIntervalInSeconds(int keepAliveIntervalSeconds)

Sets the SSH keep alive interval in seconds.

build

@NotNull
protected SshTaskProperties build()

Overrides:

build in class Task<SshTask,SshTaskProperties>