Package io.jenkins.plugins.ephemeral_credentials

Class EphemeralCredentialsForgetGlobalVariable

java.lang.Object

org.jenkinsci.plugins.workflow.cps.GlobalVariable

io.jenkins.plugins.ephemeral_credentials.EphemeralCredentialsForgetGlobalVariable

All Implemented Interfaces:

ExtensionPoint

@Extension
public class EphemeralCredentialsForgetGlobalVariable
extends org.jenkinsci.plugins.workflow.cps.GlobalVariable

Registers ephemeralCredentialsForget(id) as a global step (no @Library import needed) - drops the credential cached under id for the current run, if any, and returns whether one was actually present. Useful for proactively purging a sensitive one-time-use credential before the run ends, rather than waiting for EphemeralCredentialsRunListener's whole-run cleanup. The pipeline-facing equivalent of EphemeralCredentialsAccessor.forget(java.lang.String).

See Also:

• EphemeralCredentialsAccessor

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class org.jenkinsci.plugins.workflow.cps.GlobalVariable

ALL

Constructor Summary

Constructors

Constructor	Description
EphemeralCredentialsForgetGlobalVariable()

Method Summary

Modifier and Type	Method	Description
String	getName()
Object	getValue(org.jenkinsci.plugins.workflow.cps.CpsScript script)

Methods inherited from class org.jenkinsci.plugins.workflow.cps.GlobalVariable

byName, forJob, forRun

Methods inherited from class java.lang.Object

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

Constructor Details

EphemeralCredentialsForgetGlobalVariable

public EphemeralCredentialsForgetGlobalVariable()

Method Details

getName

@NonNull
public String getName()

Specified by:

getName in class org.jenkinsci.plugins.workflow.cps.GlobalVariable

getValue

@NonNull
public Object getValue(@NonNull
 org.jenkinsci.plugins.workflow.cps.CpsScript script)

Specified by:

getValue in class org.jenkinsci.plugins.workflow.cps.GlobalVariable