Package-level declarations

Types

Link copied to clipboard
sealed external interface ArchiveToolType
Link copied to clipboard
sealed external interface CacheFilename
Link copied to clipboard
external class CacheNotFoundError
Link copied to clipboard
sealed external interface CompressionMethod
Link copied to clipboard
external interface DownloadOptions
Link copied to clipboard
external class DownloadProgress
Link copied to clipboard
external class FilesNotFoundError
Link copied to clipboard
external class GHESNotSupportedError
Link copied to clipboard
external class InvalidResponseError
Link copied to clipboard
external class NetworkError
Link copied to clipboard
external class ReserveCacheError
Link copied to clipboard
external interface TransferProgressEvent
Link copied to clipboard
external interface UploadOptions
Link copied to clipboard
external class UploadProgress
Link copied to clipboard
external class UsageError
Link copied to clipboard
external class ValidationError

Properties

Link copied to clipboard
Link copied to clipboard
const val DefaultRetryAttempts: Int = 2
Link copied to clipboard
const val DefaultRetryDelay: Int = 5000
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val SocketTimeout: Int = 5000
Link copied to clipboard
Link copied to clipboard
const val TarFilename: String

Functions

Link copied to clipboard
external fun <T> assertDefined(name: String, value: T = definedExternally): T
Link copied to clipboard
suspend external fun createTar(    archiveFolder: String,     sourceDirectories: <Error class: unknown class><String>,     compressionMethod: CompressionMethod)
Link copied to clipboard
external fun createTarAsync(    archiveFolder: String,     sourceDirectories: <Error class: unknown class><String>,     compressionMethod: CompressionMethod): <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
suspend external fun createTempDirectory(): String
Link copied to clipboard
external fun createTempDirectoryAsync(): <Error class: unknown class><String>
Link copied to clipboard
suspend external fun downloadCache(archiveLocation: String, archivePath: String, options: DownloadOptions = definedExternally)
Link copied to clipboard
external fun downloadCacheAsync(    archiveLocation: String,     archivePath: String,     options: DownloadOptions = definedExternally): <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
suspend external fun downloadCacheHttpClient(archiveLocation: String, archivePath: String)
Link copied to clipboard
external fun downloadCacheHttpClientAsync(    archiveLocation: String,     archivePath: String): <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
suspend external fun downloadCacheHttpClientConcurrent(    archiveLocation: String,     archivePath: <Error class: unknown class>,     options: DownloadOptions)
Link copied to clipboard
external fun downloadCacheHttpClientConcurrentAsync(    archiveLocation: String,     archivePath: <Error class: unknown class>,     options: DownloadOptions): <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
suspend external fun downloadCacheStorageSDK(archiveLocation: String, archivePath: String, options: DownloadOptions)
Link copied to clipboard
external fun downloadCacheStorageSDKAsync(    archiveLocation: String,     archivePath: String,     options: DownloadOptions): <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
suspend external fun extractTar(archivePath: String, compressionMethod: CompressionMethod)
Link copied to clipboard
external fun extractTarAsync(    archivePath: String,     compressionMethod: CompressionMethod): <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
external fun getArchiveFileSizeInBytes(filePath: String): Number
Link copied to clipboard
external fun getCacheFileName(compressionMethod: CompressionMethod): String
Link copied to clipboard
external fun getCacheServiceURL(): String
Link copied to clipboard
Link copied to clipboard
external fun getCacheVersion(    paths: <Error class: unknown class><String>,     compressionMethod: CompressionMethod = definedExternally,     enableCrossOsArchive: Boolean = definedExternally): String
Link copied to clipboard
suspend external fun getCompressionMethod(): CompressionMethod
Link copied to clipboard
external fun getCompressionMethodAsync(): <Error class: unknown class><CompressionMethod>
Link copied to clipboard
external fun getDownloadOptions(copy: DownloadOptions = definedExternally): DownloadOptions
Link copied to clipboard
suspend external fun getGnuTarPathOnWindows(): String
Link copied to clipboard
external fun getGnuTarPathOnWindowsAsync(): <Error class: unknown class><String>
Link copied to clipboard
external fun getRuntimeToken(): String
Link copied to clipboard
external fun getUploadOptions(copy: UploadOptions = definedExternally): UploadOptions
Link copied to clipboard
external fun getUserAgentString(): String
Link copied to clipboard
external fun isFeatureAvailable(): Boolean
Link copied to clipboard
external fun isGhes(): Boolean
Link copied to clipboard
external fun isRetryableStatusCode(statusCode: Number = definedExternally): Boolean
Link copied to clipboard
external fun isServerErrorStatusCode(statusCode: Number = definedExternally): Boolean
Link copied to clipboard
external fun isSuccessStatusCode(statusCode: Number = definedExternally): Boolean
Link copied to clipboard
suspend external fun listTar(archivePath: String, compressionMethod: CompressionMethod)
Link copied to clipboard
external fun listTarAsync(    archivePath: String,     compressionMethod: CompressionMethod): <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
external fun maskSecretUrls(body: <Error class: unknown class><String, Any?>?)
Link copied to clipboard
external fun maskSigUrl(url: String)
Link copied to clipboard
suspend external fun resolvePaths(patterns: <Error class: unknown class><String>): <Error class: unknown class><String>
Link copied to clipboard
external fun resolvePathsAsync(    patterns: <Error class: unknown class><String>): <Error class: unknown class><<Error class: unknown class><String>>
Link copied to clipboard
suspend external fun restoreCache(    paths: <Error class: unknown class><String>,     primaryKey: String,     restoreKeys: <Error class: unknown class><String> = definedExternally,     options: DownloadOptions = definedExternally,     enableCrossOsArchive: Boolean = definedExternally): String?
Link copied to clipboard
external fun restoreCacheAsync(    paths: <Error class: unknown class><String>,     primaryKey: String,     restoreKeys: <Error class: unknown class><String> = definedExternally,     options: DownloadOptions = definedExternally,     enableCrossOsArchive: Boolean = definedExternally): <Error class: unknown class><String?>
Link copied to clipboard
suspend external fun <T> retry(    name: String,     method: () -> <Error class: unknown class><T>,     getStatusCode: (arg0: T) -> Number?,     maxAttempts: Number = definedExternally,     delay: Number = definedExternally,     onError: (<Error class: unknown class>) -> T?? = definedExternally): T
Link copied to clipboard
external fun <T> retryAsync(    name: String,     method: () -> <Error class: unknown class><T>,     getStatusCode: (arg0: T) -> Number?,     maxAttempts: Number = definedExternally,     delay: Number = definedExternally,     onError: (<Error class: unknown class>) -> T?? = definedExternally): <Error class: unknown class><T>
Link copied to clipboard
suspend external fun retryHttpClientResponse(    name: String,     method: () -> <Error class: unknown class><<Error class: unknown class>>,     maxAttempts: Number = definedExternally,     delay: Number = definedExternally): <Error class: unknown class>
Link copied to clipboard
external fun retryHttpClientResponseAsync(    name: String,     method: () -> <Error class: unknown class><<Error class: unknown class>>,     maxAttempts: Number = definedExternally,     delay: Number = definedExternally): <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
suspend external fun saveCache(    paths: <Error class: unknown class><String>,     key: String,     options: UploadOptions = definedExternally,     enableCrossOsArchive: Boolean = definedExternally): Number
suspend external fun saveCache(    cacheId: Number,     archivePath: String,     signedUploadURL: String = definedExternally,     options: UploadOptions = definedExternally)
Link copied to clipboard
external fun saveCacheAsync(    paths: <Error class: unknown class><String>,     key: String,     options: UploadOptions = definedExternally,     enableCrossOsArchive: Boolean = definedExternally): <Error class: unknown class><Number>
external fun saveCacheAsync(    cacheId: Number,     archivePath: String,     signedUploadURL: String = definedExternally,     options: UploadOptions = definedExternally): <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
suspend external fun unlinkFile(filePath: <Error class: unknown class>)
Link copied to clipboard
external fun unlinkFileAsync(filePath: <Error class: unknown class>): <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
suspend external fun uploadCacheArchiveSDK(    signedUploadURL: String,     archivePath: String,     options: UploadOptions = definedExternally): <Error class: unknown class><String, Any>
Link copied to clipboard
external fun uploadCacheArchiveSDKAsync(    signedUploadURL: String,     archivePath: String,     options: UploadOptions = definedExternally): <Error class: unknown class><<Error class: unknown class><String, Any>>