com.cloudbees.jenkins.plugins.sshcredentials
Interface SSHUser

All Superinterfaces:

com.cloudbees.plugins.credentials.Credentials, hudson.model.Describable<com.cloudbees.plugins.credentials.Credentials>, java.io.Serializable

All Known Subinterfaces:

SSHUserPassword, SSHUserPrivateKey

All Known Implementing Classes:

BaseSSHUser, BasicSSHUserPassword, BasicSSHUserPrivateKey

public interface SSHUser
extends com.cloudbees.plugins.credentials.Credentials

Details of a SSH user.

Method Summary

java.lang.String	getDescription() The display description of this credential (e.g.
java.lang.String	getId() Returns a unique Id that can be used to find this user record again.
java.lang.String	getUsername() The SSH username

Methods inherited from interface com.cloudbees.plugins.credentials.Credentials

getDescriptor, getScope

Method Detail

getUsername

@NonNull
java.lang.String getUsername()

The SSH username

Returns:

The SSH username

getDescription

java.lang.String getDescription()

The display description of this credential (e.g. the host name / domain that the user details apply to)

Returns:

The display description of this credential.

getId

java.lang.String getId()

Returns a unique Id that can be used to find this user record again. In the default implementations provided by this plugin, IDs are auto-generated.

Returns:

a unique Id that can be used to find this user record again.