api_function_restoregithubactionscache

Restore-GitHubActionsCache

🔘 NodeJS Wrapper: This dependents and requires NodeJS to invoke.

• Type: Function
• In Version: >= v0.5.0
• Alias:
  • Import-GitHubActionsCache

Restore cache that shared from the past jobs and/or workflows.

• # >= v2.0.0; Parameter Set: AzureSdk (Default)
  Restore-GitHubActionsCache
    [-Path] <String[]>
    [-Key] <String[]>
    [-ConcurrencyBlobDownload]
    [-Lookup]
    [-SegmentTimeout <UInt32>]
    [-DownloadConcurrency <Byte>]
    [-Timeout <UInt16>]

• # >= v2.0.0; Parameter Set: NoAzureSdk
  Restore-GitHubActionsCache
    [-Path] <String[]>
    [-Key] <String[]>
    [-ConcurrencyBlobDownload]
    [-Lookup]
    [-SegmentTimeout <UInt32>]
    -NoAzureSdk

• # < v2.0.0; Parameter Set: Path (Default)
  Restore-GitHubActionsCache
    [-Key] <String[]>
    [-Path] <String[]>
    [-NotUseAzureSdk]
    [-DownloadConcurrency <Byte>]
    [-Timeout <UInt16>]
    [-SegmentTimeout <UInt16>]
    [-LookUp]

• # < v2.0.0; Parameter Set: LiteralPath
  Restore-GitHubActionsCache
    [-Key] <String[]>
    -LiteralPath <String[]>
    [-NotUseAzureSdk]
    [-DownloadConcurrency <Byte>]
    [-Timeout <UInt16>]
    [-SegmentTimeout <UInt16>]
    [-LookUp]

Parameter

ConcurrencyBlobDownload

(>= v2.0.0) [Optional] <Switch> Whether to use GitHub Actions NodeJS toolkit HttpClient with concurrency for Azure Blob Storage.

• Parameter Set:
  • AzureSdk
  • NoAzureSdk
• Position: Named
• Accept Pipeline Input By Property Name: True ✔️

DownloadConcurrency

[Optional] <Byte> Number of parallel downloads of the cache (only for Azure SDK).

• Parameter Set:
  • (>= v2.0.0) AzureSdk
  • (< v2.0.0) LiteralPath
  • (< v2.0.0) Path
• Position: Named
• Accept Pipeline Input: False ❌
• Accept Pipeline Input By Property Name: True ✔️
• Accept Wildcard Characters: False ❌
• Alias:
  • Concurrency

Key

<String[]> Keys of the cache.

• Parameter Set:
  • (>= v2.0.0) AzureSdk
  • (< v2.0.0) LiteralPath
  • (>= v2.0.0) NoAzureSdk
  • (< v2.0.0) Path
• Position:
  • (>= v2.0.0) 1
  • (< v2.0.0) 0
• Accept Pipeline Input: False ❌
• Accept Pipeline Input By Property Name: True ✔️
• Accept Wildcard Characters: False ❌
• Alias:
  • Keys
  • Name
  • Names

LookUp

[Optional] <Switch> Weather to not restore the cache, and only check if a matching cache entry exists and return the cache key if it does.

• Parameter Set:
  • (>= v2.0.0) AzureSdk
  • (< v2.0.0) LiteralPath
  • (>= v2.0.0) NoAzureSdk
  • (< v2.0.0) Path
• Position: Named
• Accept Pipeline Input By Property Name: True ✔️

NoAzureSdk

(>= v2.0.0) <Switch> Whether to not use Azure Blob SDK to download the cache that stored on the Azure Blob Storage, this maybe affect the reliability and performance.

• Parameter Set: NoAzureSdk
• Position: Named
• Accept Pipeline Input By Property Name: True ✔️

Path

• (>= v2.0.0) <String[]> Paths of the cache, support Glob.
• (< v2.0.0) <String[]> Paths of the cache.

•

• Parameter Set: Path
• Position:
  • (>= v2.0.0) 0
  • (< v2.0.0) 1
• Accept Pipeline Input: False ❌
• Accept Pipeline Input By Property Name: True ✔️
• Accept Wildcard Characters: True ✔️
• Alias:
  • File
  • Files
  • Paths

SegmentTimeout

• (>= v2.0.0) [Optional] <UInt32> Maximum time for each segment download request of the cache, by milliseconds; This allows the segment download to get aborted and hence allow the job to proceed with a cache miss.

• (< v2.0.0) [Optional] <UInt16> Maximum time for each segment download request of the cache, by seconds in range 5~7200; This allows the segment download to get aborted and hence allow the job to proceed with a cache miss.

• Parameter Set:

  • (>= v2.0.0) AzureSdk
  • (< v2.0.0) LiteralPath
  • (>= v2.0.0) NoAzureSdk
  • (< v2.0.0) Path

• Position: Named

• Accept Pipeline Input By Property Name: True ✔️

Timeout

• (>= v2.0.0) [Optional] <UInt32> Maximum time for each download request of the cache, by milliseconds (only for Azure SDK).

• (< v2.0.0) [Optional] <UInt16> Maximum time for each download request of the cache (only for Azure SDK), by seconds in range 5~7200.

• Parameter Set:

  • (>= v2.0.0) AzureSdk
  • (< v2.0.0) LiteralPath
  • (>= v2.0.0) NoAzureSdk
  • (< v2.0.0) Path

• Position: Named

• Accept Pipeline Input By Property Name: True ✔️

LiteralPath

👎 Deprecated: This is officially deprecated, maybe throw warning in the latest version, and maybe remove in the future version.

(< v2.0.0) <String[]> Literal paths of the cache.

• Parameter Set: LiteralPath
• Position: Named
• Accept Pipeline Input: False ❌
• Accept Pipeline Input By Property Name: True ✔️
• Accept Wildcard Characters: False ❌
• Alias:
  • LiteralFile
  • LiteralFiles
  • LiteralPaths
  • LP
  • PSPath
  • PSPaths

NotUseAzureSdk

👎 Deprecated: This is officially deprecated, maybe throw warning in the latest version, and maybe remove in the future version.

(< v2.0.0) [Optional] <Switch> Whether to not use Azure Blob SDK to download the cache that stored on the Azure Blob Storage, this maybe affect the reliability and performance.

• Parameter Set:
  • LiteralPath
  • Path
• Position: Named
• Accept Pipeline Input By Property Name: True ✔️
• Alias:
  • NoAzureSdk

Output

<String> The key of the cache hit.