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

Interface BuildScanCaptureSettings

public interface BuildScanCaptureSettings
Allows configuring what data will be captured as part of the build scan.
Since:
1.21
See Also:

  • Method Details

    • setFileFingerprints

      void setFileFingerprints(boolean capture)
      Specifies whether to capture information about each file used as an input to a goal execution.

      Defaults to true.

      Capturing file fingerprints may increase the size of the build scan data. This requires more time to transmit to the server, and more storage space at the server. Most builds will not incur a noticeable difference when this feature is enabled. Large builds may increase the build scan data by a handful of megabytes. For most builds, the increase will be negligible.

      If using Develocity with a good connection to the server this capture should stay enabled, as it allows comparing goal inputs at a file level when comparing builds.

      This property may also be set in develocity.xml or via the gradle.scan.captureGoalInputFiles system property. If this is set to any value other than false, the capture will be enabled, otherwise the capture will be disabled. If the capture is enabled or disabled via system property, calling this method has no effect. That is, the system property takes precedence over the value set via this method.

      This method cannot be called after the MavenSession has been started (i.e. after the ExecutionEvent.Type.SessionStarted event has been received). Doing so will produce a build time error.

      Parameters:
      capture - whether to capture information about each file use as an input to a goal execution

    • isFileFingerprints

      boolean isFileFingerprints()
      See setFileFingerprints(boolean).
      Returns:
      whether information about each file used as an input to a goal will be captured

    • setBuildLogging

      void setBuildLogging(boolean capture)
      Specifies whether to capture build logging output.

      Defaults to true.

      This property may also be set in develocity.xml or via the develocity.scan.captureBuildLogging system property. If this is set to any value other than false, the capture will be enabled, otherwise the capture will be disabled. If the capture is enabled or disabled via system property, calling this method has no effect. That is, the system property takes precedence over the value set via this method.

      This method cannot be called after the MavenSession has been started (i.e. after the ExecutionEvent.Type.SessionStarted event has been received). Doing so will produce a build time error.

      Parameters:
      capture - whether to capture build logging output

    • isBuildLogging

      boolean isBuildLogging()
      See setBuildLogging(boolean).
      Returns:
      whether build logging output will be captured

    • setTestLogging

      void setTestLogging(boolean capture)
      Specifies whether to capture test logging output.

      Defaults to true.

      This property may also be set in develocity.xml or via the develocity.scan.captureTestLogging system property. If this is set to any value other than false, the capture will be enabled, otherwise the capture will be disabled. If the capture is enabled or disabled via system property, calling this method has no effect. That is, the system property takes precedence over the value set via this method.

      This method cannot be called after the MavenSession has been started (i.e. after the ExecutionEvent.Type.SessionStarted event has been received). Doing so will produce a build time error.

      Parameters:
      capture - whether to capture test logging output

    • isTestLogging

      boolean isTestLogging()
      See setTestLogging(boolean).
      Returns:
      whether test logging output will be captured

    • setResourceUsage

      void setResourceUsage(boolean capture)
      Specifies whether to capture information about the resources used by the build.

      Defaults to true.

      This property may also be set in develocity.xml or via the develocity.scan.captureResourceUsage system property. If this is set to any value other than false, the capture will be enabled, otherwise the capture will be disabled. If the capture is enabled or disabled via system property, calling this method has no effect. That is, the system property takes precedence over the value set via this method.

      This method cannot be called after the MavenSession has been started (i.e. after the ExecutionEvent.Type.SessionStarted event has been received). Doing so will produce a build time error.

      Parameters:
      capture - whether to capture resource usage
      Since:
      1.22

    • isResourceUsage

      boolean isResourceUsage()
      See setResourceUsage(boolean).
      Returns:
      whether resource usage information will be captured
      Since:
      1.22