|
| 1 | +// This file was generated using action-binding-generator. Don't change it by hand, otherwise your |
| 2 | +// changes will be overwritten with the next binding code regeneration. |
| 3 | +// See https://github.com/typesafegithub/github-workflows-kt for more info. |
| 4 | +@file:Suppress( |
| 5 | + "DataClassPrivateConstructor", |
| 6 | + "UNUSED_PARAMETER", |
| 7 | +) |
| 8 | + |
| 9 | +package io.github.typesafegithub.workflows.actions.actions |
| 10 | + |
| 11 | +import io.github.typesafegithub.workflows.domain.actions.Action |
| 12 | +import io.github.typesafegithub.workflows.domain.actions.RegularAction |
| 13 | +import java.util.LinkedHashMap |
| 14 | +import kotlin.Boolean |
| 15 | +import kotlin.String |
| 16 | +import kotlin.Suppress |
| 17 | +import kotlin.Unit |
| 18 | +import kotlin.collections.List |
| 19 | +import kotlin.collections.Map |
| 20 | +import kotlin.collections.toList |
| 21 | +import kotlin.collections.toTypedArray |
| 22 | + |
| 23 | +/** |
| 24 | + * Action: Restore Cache |
| 25 | + * |
| 26 | + * Restore Cache artifacts like dependencies and build outputs to improve workflow execution time |
| 27 | + * |
| 28 | + * [Action on GitHub](https://github.com/actions/cache/tree/v4/restore) |
| 29 | + * |
| 30 | + * @param path A list of files, directories, and wildcard patterns to restore |
| 31 | + * @param key An explicit key for restoring the cache |
| 32 | + * @param restoreKeys An ordered list of keys to use for restoring stale cache if no cache hit |
| 33 | + * occurred for key. Note `cache-hit` returns false in this case. |
| 34 | + * @param enableCrossOsArchive An optional boolean when enabled, allows windows runners to restore |
| 35 | + * caches that were saved on other platforms |
| 36 | + * @param failOnCacheMiss Fail the workflow if cache entry is not found |
| 37 | + * @param lookupOnly Check if a cache entry exists for the given input(s) (key, restore-keys) |
| 38 | + * without downloading the cache |
| 39 | + * @param _customInputs Type-unsafe map where you can put any inputs that are not yet supported by |
| 40 | + * the binding |
| 41 | + * @param _customVersion Allows overriding action's version, for example to use a specific minor |
| 42 | + * version, or a newer version that the binding doesn't yet know about |
| 43 | + */ |
| 44 | +public data class CacheRestoreV4 private constructor( |
| 45 | + /** |
| 46 | + * A list of files, directories, and wildcard patterns to restore |
| 47 | + */ |
| 48 | + public val path: List<String>, |
| 49 | + /** |
| 50 | + * An explicit key for restoring the cache |
| 51 | + */ |
| 52 | + public val key: String, |
| 53 | + /** |
| 54 | + * An ordered list of keys to use for restoring stale cache if no cache hit occurred for key. |
| 55 | + * Note `cache-hit` returns false in this case. |
| 56 | + */ |
| 57 | + public val restoreKeys: List<String>? = null, |
| 58 | + /** |
| 59 | + * An optional boolean when enabled, allows windows runners to restore caches that were saved on |
| 60 | + * other platforms |
| 61 | + */ |
| 62 | + public val enableCrossOsArchive: Boolean? = null, |
| 63 | + /** |
| 64 | + * Fail the workflow if cache entry is not found |
| 65 | + */ |
| 66 | + public val failOnCacheMiss: Boolean? = null, |
| 67 | + /** |
| 68 | + * Check if a cache entry exists for the given input(s) (key, restore-keys) without downloading |
| 69 | + * the cache |
| 70 | + */ |
| 71 | + public val lookupOnly: Boolean? = null, |
| 72 | + /** |
| 73 | + * Type-unsafe map where you can put any inputs that are not yet supported by the binding |
| 74 | + */ |
| 75 | + public val _customInputs: Map<String, String> = mapOf(), |
| 76 | + /** |
| 77 | + * Allows overriding action's version, for example to use a specific minor version, or a newer |
| 78 | + * version that the binding doesn't yet know about |
| 79 | + */ |
| 80 | + public val _customVersion: String? = null, |
| 81 | +) : RegularAction<CacheRestoreV4.Outputs>("actions", "cache/restore", _customVersion ?: "v4") { |
| 82 | + public constructor( |
| 83 | + vararg pleaseUseNamedArguments: Unit, |
| 84 | + path: List<String>, |
| 85 | + key: String, |
| 86 | + restoreKeys: List<String>? = null, |
| 87 | + enableCrossOsArchive: Boolean? = null, |
| 88 | + failOnCacheMiss: Boolean? = null, |
| 89 | + lookupOnly: Boolean? = null, |
| 90 | + _customInputs: Map<String, String> = mapOf(), |
| 91 | + _customVersion: String? = null, |
| 92 | + ) : this(path=path, key=key, restoreKeys=restoreKeys, enableCrossOsArchive=enableCrossOsArchive, |
| 93 | + failOnCacheMiss=failOnCacheMiss, lookupOnly=lookupOnly, _customInputs=_customInputs, |
| 94 | + _customVersion=_customVersion) |
| 95 | + |
| 96 | + @Suppress("SpreadOperator") |
| 97 | + override fun toYamlArguments(): LinkedHashMap<String, String> = linkedMapOf( |
| 98 | + *listOfNotNull( |
| 99 | + "path" to path.joinToString("\n"), |
| 100 | + "key" to key, |
| 101 | + restoreKeys?.let { "restore-keys" to it.joinToString("\n") }, |
| 102 | + enableCrossOsArchive?.let { "enableCrossOsArchive" to it.toString() }, |
| 103 | + failOnCacheMiss?.let { "fail-on-cache-miss" to it.toString() }, |
| 104 | + lookupOnly?.let { "lookup-only" to it.toString() }, |
| 105 | + *_customInputs.toList().toTypedArray(), |
| 106 | + ).toTypedArray() |
| 107 | + ) |
| 108 | + |
| 109 | + override fun buildOutputObject(stepId: String): Outputs = Outputs(stepId) |
| 110 | + |
| 111 | + public class Outputs( |
| 112 | + stepId: String, |
| 113 | + ) : Action.Outputs(stepId) { |
| 114 | + /** |
| 115 | + * A boolean value to indicate an exact match was found for the primary key |
| 116 | + */ |
| 117 | + public val cacheHit: String = "steps.$stepId.outputs.cache-hit" |
| 118 | + |
| 119 | + /** |
| 120 | + * A resolved cache key for which cache match was attempted |
| 121 | + */ |
| 122 | + public val cachePrimaryKey: String = "steps.$stepId.outputs.cache-primary-key" |
| 123 | + |
| 124 | + /** |
| 125 | + * Key of the cache that was restored, it could either be the primary key on cache-hit or a |
| 126 | + * partial/complete match of one of the restore keys |
| 127 | + */ |
| 128 | + public val cacheMatchedKey: String = "steps.$stepId.outputs.cache-matched-key" |
| 129 | + } |
| 130 | +} |
0 commit comments