Package com.gradle.develocity.agent.maven.api.scan

Interface BuildScanDataObfuscation

public interface BuildScanDataObfuscation

Allows registering functions for obfuscating certain identifying information within build scans.

See Also:

• BuildScanApi.getObfuscation()

Method Summary

Modifier and Type	Method	Description
void	externalProcessName(Function<? super String,? extends String> obfuscator)	Registers a function to transform the names of external processes captured when resource usage capturing is enabled.
void	hostname(Function<? super String,? extends String> obfuscator)	Registers a function to transform the local hostname and public hostname captured.
void	ipAddresses(Function<? super List<InetAddress>,? extends List<String>> obfuscator)	Registers a function used to transform the IP addresses captured.
void	username(Function<? super String,? extends String> obfuscator)	Registers a function to transform the username captured.

Method Details

username

void username(Function<? super String,? extends String> obfuscator)

Registers a function to transform the username captured.

The function receives the username that would be captured, and should return the username that will be captured.

The received username may be null, and the function may return a null value.

Parameters:

obfuscator - the function to obfuscate the username

hostname

void hostname(Function<? super String,? extends String> obfuscator)

Registers a function to transform the local hostname and public hostname captured.

The function receives the hostname that would be captured, and should return the hostname that will be captured.

The received hostname may be null, and the function may return a null value.

Parameters:

obfuscator - the function to obfuscate the hostname

ipAddresses

void ipAddresses(Function<? super List<InetAddress>,? extends List<String>> obfuscator)

Registers a function used to transform the IP addresses captured.

The function receives a list of InetAddress that would be captured, and should return the list of String that will be captured.

The received list may be null or empty, and the function may return a null or empty list, but may not return a list with a null element.

Parameters:

obfuscator - the function to obfuscate the IP addresses

externalProcessName

void externalProcessName(Function<? super String,? extends String> obfuscator)

Registers a function to transform the names of external processes captured when resource usage capturing is enabled.

An external process is a process running on the same machine as the build, that is not the build process itself, nor a descendant process of the build process. The function receives an external process name that would be captured, and should return the external process name that will be captured.

The received process name may not be null, and the function may not return a null value.

Parameters:

obfuscator - the function to obfuscate the external process names

Since:

1.22