SshTask (Atlassian Bamboo Plan Specs 9.5.1 API)

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 Description

protected @Nullable java.time.Duration keepAliveInterval
- 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

SshTask()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected @NotNull SshTaskProperties`	`build()`
`SshTask`	`command(@NotNull java.lang.String command)`	Shell command to execute on the remote host.
`SshTask`	`command(@NotNull java.nio.file.Path path)`
`boolean`	`equals(java.lang.Object o)`
`int`	`hashCode()`
`SshTask`	`keepAliveInterval(java.time.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, 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

Field Detail

keepAliveInterval

@Nullable
protected @Nullable java.time.Duration keepAliveInterval

Constructor Detail
- SshTask
```
public SshTask()
```

Method Detail

command

public SshTask command(@NotNull
                       @NotNull java.lang.String command)

Shell command to execute on the remote host.

command

public SshTask command(@NotNull
                       @NotNull java.nio.file.Path path)

keepAliveInterval

public SshTask keepAliveInterval(java.time.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 @NotNull SshTaskProperties build()
```
Specified by:

build in class Task<SshTask,SshTaskProperties>

equals
```
public boolean equals(java.lang.Object o)
```
Overrides:

equals in class BaseSshTask<SshTask,SshTaskProperties>

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class BaseSshTask<SshTask,SshTaskProperties>