Class AsyncModelScanner
-
- All Implemented Interfaces:
-
java.lang.AutoCloseable
public final class AsyncModelScanner implements AutoCloseable
Async version of ModelScanner for use with HiddenLayerClientAsync.
This class provides async versions of all model scanning functionality, including file and folder scanning with multipart upload functionality.
Important: This class implements
AutoCloseableand manages a thread pool internally. Always use it in a try-with-resources block or explicitly callclose()when done to ensure proper resource cleanup.Example usage:
AsyncModelScanner(client).use { scanner -> val result = scanner.scanFile(options).get() }
-
-
Constructor Summary
Constructors Constructor Description AsyncModelScanner(HiddenLayerClientAsync client)
-
Method Summary
Modifier and Type Method Description final CompletableFuture<ScanReport>scanFile(ScanFileOptions options)Async version of scanFile. final CompletableFuture<ScanReport>scanFile(String modelName, String modelPath, String modelVersion, Boolean waitForResults, String requestSource, String origin)Convenience method with individual parameters. final CompletableFuture<ScanReport>scanFile(String modelName, String modelPath, String modelVersion, Boolean waitForResults, String requestSource)Convenience method with individual parameters. final CompletableFuture<ScanReport>scanFile(String modelName, String modelPath, String modelVersion, Boolean waitForResults)Convenience method with individual parameters. final CompletableFuture<ScanReport>scanFile(String modelName, String modelPath, String modelVersion)Convenience method with individual parameters. final CompletableFuture<ScanReport>scanFile(String modelName, String modelPath)Convenience method with individual parameters. final CompletableFuture<ScanReport>scanFolder(ScanFolderOptions options)Async version of scanFolder. final CompletableFuture<ScanReport>scanFolder(String modelName, String path, String modelVersion, List<String> allowFilePatterns, List<String> ignoreFilePatterns, Boolean waitForResults, String requestSource, String origin)Convenience method with individual parameters. final CompletableFuture<ScanReport>scanFolder(String modelName, String path, String modelVersion, List<String> allowFilePatterns, List<String> ignoreFilePatterns, Boolean waitForResults, String requestSource)Convenience method with individual parameters. final CompletableFuture<ScanReport>scanFolder(String modelName, String path, String modelVersion, List<String> allowFilePatterns, List<String> ignoreFilePatterns, Boolean waitForResults)Convenience method with individual parameters. final CompletableFuture<ScanReport>scanFolder(String modelName, String path, String modelVersion, List<String> allowFilePatterns, List<String> ignoreFilePatterns)Convenience method with individual parameters. final CompletableFuture<ScanReport>scanFolder(String modelName, String path, String modelVersion, List<String> allowFilePatterns)Convenience method with individual parameters. final CompletableFuture<ScanReport>scanFolder(String modelName, String path, String modelVersion)Convenience method with individual parameters. final CompletableFuture<ScanReport>scanFolder(String modelName, String path)Convenience method with individual parameters. Unitclose()Closes the AsyncModelScanner and shuts down the internal thread pool. -
-
Constructor Detail
-
AsyncModelScanner
AsyncModelScanner(HiddenLayerClientAsync client)
-
-
Method Detail
-
scanFile
final CompletableFuture<ScanReport> scanFile(ScanFileOptions options)
Async version of scanFile.
- Parameters:
options- The scan options- Returns:
CompletableFuture containing the scan results
-
scanFile
@JvmOverloads() final CompletableFuture<ScanReport> scanFile(String modelName, String modelPath, String modelVersion, Boolean waitForResults, String requestSource, String origin)
Convenience method with individual parameters.
-
scanFile
@JvmOverloads() final CompletableFuture<ScanReport> scanFile(String modelName, String modelPath, String modelVersion, Boolean waitForResults, String requestSource)
Convenience method with individual parameters.
-
scanFile
@JvmOverloads() final CompletableFuture<ScanReport> scanFile(String modelName, String modelPath, String modelVersion, Boolean waitForResults)
Convenience method with individual parameters.
-
scanFile
@JvmOverloads() final CompletableFuture<ScanReport> scanFile(String modelName, String modelPath, String modelVersion)
Convenience method with individual parameters.
-
scanFile
@JvmOverloads() final CompletableFuture<ScanReport> scanFile(String modelName, String modelPath)
Convenience method with individual parameters.
-
scanFolder
final CompletableFuture<ScanReport> scanFolder(ScanFolderOptions options)
Async version of scanFolder.
- Parameters:
options- The scan options- Returns:
CompletableFuture containing the scan results
-
scanFolder
@JvmOverloads() final CompletableFuture<ScanReport> scanFolder(String modelName, String path, String modelVersion, List<String> allowFilePatterns, List<String> ignoreFilePatterns, Boolean waitForResults, String requestSource, String origin)
Convenience method with individual parameters.
-
scanFolder
@JvmOverloads() final CompletableFuture<ScanReport> scanFolder(String modelName, String path, String modelVersion, List<String> allowFilePatterns, List<String> ignoreFilePatterns, Boolean waitForResults, String requestSource)
Convenience method with individual parameters.
-
scanFolder
@JvmOverloads() final CompletableFuture<ScanReport> scanFolder(String modelName, String path, String modelVersion, List<String> allowFilePatterns, List<String> ignoreFilePatterns, Boolean waitForResults)
Convenience method with individual parameters.
-
scanFolder
@JvmOverloads() final CompletableFuture<ScanReport> scanFolder(String modelName, String path, String modelVersion, List<String> allowFilePatterns, List<String> ignoreFilePatterns)
Convenience method with individual parameters.
-
scanFolder
@JvmOverloads() final CompletableFuture<ScanReport> scanFolder(String modelName, String path, String modelVersion, List<String> allowFilePatterns)
Convenience method with individual parameters.
-
scanFolder
@JvmOverloads() final CompletableFuture<ScanReport> scanFolder(String modelName, String path, String modelVersion)
Convenience method with individual parameters.
-
scanFolder
@JvmOverloads() final CompletableFuture<ScanReport> scanFolder(String modelName, String path)
Convenience method with individual parameters.
-
close
Unit close()
Closes the AsyncModelScanner and shuts down the internal thread pool.
This method implements AutoCloseable.close() and ensures that all threads in the internal executor are properly shut down. After calling this method, the scanner instance should not be used for further operations.
This method is idempotent - calling it multiple times has no additional effect.
-
-
-
-