Package com.osacky.scan.tag

Class ScanApi

  • public class ScanApi
extends java.lang.Object
    For build and plugin authors to easily tag build scans.

    • Constructor Summary

      Constructors 
      Constructor Description
      ScanApi​(org.gradle.api.Project project)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void link​(java.lang.String name, java.lang.String url)
      Calls BuildScanExtension.link(String, String) if available.
      void tag​(java.lang.String tag)
      Calls BuildScanExtension.tag(String) if available.
      void value​(java.lang.String name, java.lang.String value)
      Calls BuildScanExtension.value(String, String) if available.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ScanApi

        public ScanApi​(org.gradle.api.Project project)

    • Method Detail

      • tag

        public void tag​(java.lang.String tag)
        Calls BuildScanExtension.tag(String) if available.
        Parameters:
        tag - a value to add as a Build scan tag

      • value

        public void value​(java.lang.String name,
                  java.lang.String value)
        Calls BuildScanExtension.value(String, String) if available.
        Parameters:
        name - the key for the custom value
        value - the data to add

      • link

        public void link​(java.lang.String name,
                 java.lang.String url)
        Calls BuildScanExtension.link(String, String) if available.
        Parameters:
        name - the name of the URL link to be displayed in the UI
        url - the URL to follow when the link is clicked