Package com.hiddenlayer.api.lib

Class CommunityScanner

  • All Implemented Interfaces:
    
public final class CommunityScanner

    Community scanner that provides the communityScan method with polling functionality.

    This class extends the generated SDK to provide the same functionality as the old SDK's communityScan method, which initiates a scan and optionally waits for results.

    • Method Detail

      • communityScan

         final ScanReport communityScan(CommunityScanOptions options)

        Scan a model available at a remote location using the HiddenLayer Model Scanner.

        Parameters:
        options - The scan options containing model information
        Returns:

        Scan Results

      • communityScan

        @JvmOverloads() final ScanReport communityScan(String modelName, String modelPath, String modelSource, String modelVersion, Boolean waitForResults, String requestSource, String origin)

        Convenience method with individual parameters (for backward compatibility).

        Parameters:
        modelName - Name of the model to be shown on the HiddenLayer UI
        modelPath - Path to the model file in the remote location, e.g.
        modelSource - Type of remote location where the model is stored
        modelVersion - Version of the model to be shown on the HiddenLayer UI (default: "main")
        waitForResults - Whether to wait for the scan to finish (default: true)
        requestSource - Source that requested the scan (default: "API Upload")
        origin - Origin platform where the model came from (default: "")
        Returns:

        Scan Results

      • communityScan

        @JvmOverloads() final ScanReport communityScan(String modelName, String modelPath, String modelSource, String modelVersion, Boolean waitForResults, String requestSource)

        Convenience method with individual parameters (for backward compatibility).

        Parameters:
        modelName - Name of the model to be shown on the HiddenLayer UI
        modelPath - Path to the model file in the remote location, e.g.
        modelSource - Type of remote location where the model is stored
        modelVersion - Version of the model to be shown on the HiddenLayer UI (default: "main")
        waitForResults - Whether to wait for the scan to finish (default: true)
        requestSource - Source that requested the scan (default: "API Upload")
        Returns:

        Scan Results

      • communityScan

        @JvmOverloads() final ScanReport communityScan(String modelName, String modelPath, String modelSource, String modelVersion, Boolean waitForResults)

        Convenience method with individual parameters (for backward compatibility).

        Parameters:
        modelName - Name of the model to be shown on the HiddenLayer UI
        modelPath - Path to the model file in the remote location, e.g.
        modelSource - Type of remote location where the model is stored
        modelVersion - Version of the model to be shown on the HiddenLayer UI (default: "main")
        waitForResults - Whether to wait for the scan to finish (default: true)
        Returns:

        Scan Results

      • communityScan

        @JvmOverloads() final ScanReport communityScan(String modelName, String modelPath, String modelSource, String modelVersion)

        Convenience method with individual parameters (for backward compatibility).

        Parameters:
        modelName - Name of the model to be shown on the HiddenLayer UI
        modelPath - Path to the model file in the remote location, e.g.
        modelSource - Type of remote location where the model is stored
        modelVersion - Version of the model to be shown on the HiddenLayer UI (default: "main")
        Returns:

        Scan Results

      • communityScan

        @JvmOverloads() final ScanReport communityScan(String modelName, String modelPath, String modelSource)

        Convenience method with individual parameters (for backward compatibility).

        Parameters:
        modelName - Name of the model to be shown on the HiddenLayer UI
        modelPath - Path to the model file in the remote location, e.g.
        modelSource - Type of remote location where the model is stored
        Returns:

        Scan Results