Package jenkins.tasks.filters

Interface EnvVarsFilterGlobalRule

All Superinterfaces:

Describable<EnvVarsFilterGlobalRule>, EnvVarsFilterRule, ExtensionPoint, Serializable

@Restricted(org.kohsuke.accmod.restrictions.Beta.class)
public interface EnvVarsFilterGlobalRule
extends Describable<EnvVarsFilterGlobalRule>, EnvVarsFilterRule, ExtensionPoint, Serializable

Environment variables filter rule that is configured globally for all jobs.

The job types can be filtered using isApplicable(Run, Object, Launcher) The local rules are applied before the global ones.

Since:

2.246

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Method Summary

Modifier and Type	Method	Description
default Descriptor<EnvVarsFilterGlobalRule>	getDescriptor()	Gets the descriptor for this instance.
boolean	isApplicable(Run<?,?> run, Object builder, Launcher launcher)

Methods inherited from interface jenkins.tasks.filters.EnvVarsFilterRule

filter, getDisplayName

Method Details

getDescriptor

default Descriptor<EnvVarsFilterGlobalRule> getDescriptor()

Description copied from interface: Describable

Gets the descriptor for this instance.

Descriptor is a singleton for every concrete Describable implementation, so if a.getClass() == b.getClass() then by default a.getDescriptor() == b.getDescriptor() as well. (In rare cases a single implementation class may be used for instances with distinct descriptors.)

By default looks for a nested class (conventionally named DescriptorImpl) implementing Descriptor and marked with Extension.

Specified by:

getDescriptor in interface Describable<EnvVarsFilterGlobalRule>

isApplicable

boolean isApplicable(@CheckForNull
 Run<?,?> run,
 @NonNull
 Object builder,
 @NonNull
 Launcher launcher)

Parameters:

run - The executing run that has one of its step requiring environment filters

builder - Normally inherits from EnvVarsFilterableBuilder but not forced to let reflection usage in plugins

launcher - The launcher that will be used to run the command

Returns:

true iff the rule can be applied to that builder