Package io.jenkins.plugins.ephemeral_credentials

Class EphemeralSSHUserPrivateKey

java.lang.Object

io.jenkins.plugins.ephemeral_credentials.EphemeralCredentialSpec

io.jenkins.plugins.ephemeral_credentials.EphemeralSSHUserPrivateKey

All Implemented Interfaces:

Serializable

public class EphemeralSSHUserPrivateKey
extends EphemeralCredentialSpec

SSH Username with private key. Unlike the other credential types, this one pulls in a plugin (SSH Credentials) beyond what this plugin otherwise needs - so it's declared as an optional Maven/HPI dependency: installations that never use ephemeralSSHUserPrivateKey don't need it installed at all.

The constructor deliberately touches BasicSSHUserPrivateKey (a class literal is enough to force resolution) so that a missing plugin fails immediately, with a clear message, at the point the pipeline author declares this spec - not deep inside materialize(java.util.Map<java.lang.String, java.lang.Object>) after a human has already answered an input prompt for nothing.

See Also:

• EphemeralCredentialSpec
• BasicSSHUserPrivateKey
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
EphemeralSSHUserPrivateKey(String id, String description)

Method Summary

Modifier and Type	Method	Description
List<ParameterDefinition>	inputParameters()	Parameters to pass to the input step when this credential is missing.
com.cloudbees.plugins.credentials.Credentials	materialize(Map<String,Object> answers)	Builds the credential from the input step's answers, keyed by the parameter names returned from EphemeralCredentialSpec.inputParameters().

Methods inherited from class io.jenkins.plugins.ephemeral_credentials.EphemeralCredentialSpec

getDescription, getId

Methods inherited from class java.lang.Object

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

Constructor Details

EphemeralSSHUserPrivateKey

public EphemeralSSHUserPrivateKey(String id,
 String description)

Method Details

inputParameters

public List<ParameterDefinition> inputParameters()

Description copied from class: EphemeralCredentialSpec

Parameters to pass to the input step when this credential is missing. input's own message is the spec's EphemeralCredentialSpec.getDescription() (falling back to a generic default), set by the caller - these are just the value-collecting fields.

Specified by:

inputParameters in class EphemeralCredentialSpec

materialize

public com.cloudbees.plugins.credentials.Credentials materialize(Map<String,Object> answers)

Description copied from class: EphemeralCredentialSpec

Builds the credential from the input step's answers, keyed by the parameter names returned from EphemeralCredentialSpec.inputParameters().

Specified by:

materialize in class EphemeralCredentialSpec