EnvVarsFilterRule (Jenkins core 2.379 API)

All Superinterfaces:

Serializable

All Known Subinterfaces:

EnvVarsFilterGlobalRule, EnvVarsFilterLocalRule

All Known Implementing Classes:

RetainVariablesLocalRule
```
@Restricted(org.kohsuke.accmod.restrictions.Beta.class)
public interface EnvVarsFilterRule
extends Serializable
```
The order of execution of the rules is determined by first their type (local before global) and then, by default, their Extension.ordinal(), higher ordinal first, but configuration can customize the order.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`void`	`filter(EnvVars envVars, EnvVarsFilterRuleContext context)`	In case the filter detects something that must stop the build, it must throw a `EnvVarsFilterException`.
`default String`	`getDisplayName()`

- Method Detail
  - filter
```
void filter(@NonNull
            EnvVars envVars,
            @NonNull
            EnvVarsFilterRuleContext context)
     throws EnvVarsFilterException
```
    In case the filter detects something that must stop the build, it must throw a EnvVarsFilterException. This method may be executed on agents through a remoting channel.
    
    Throws:
    
    EnvVarsFilterException
  - getDisplayName
```
default String getDisplayName()
```