Packages > pkg.pkl-lang.org/pkl-pantry/com.github.actions > com.github.actions.actions.cache.v4.Cache

With1.3.0

Properties
Methods

class With

Known subtypes in package:
Known usages in package:
All versions:

Properties

link

hidden

pathList: Listing<String>Source

A list of files, directories, and wildcard patterns to cache and restore
link

path: String Source

A list of files, directories, and wildcard patterns to cache and restore

To set as a Listing, use pathList.
link

key: String Source

An explicit key for restoring and saving the cache
link

hidden

`restore-keys-list`: Listing<String>?Source

An ordered multiline string listing the prefix-matched keys, that are used for restoring stale cache if no cache hit occurred for key. Note cache-hit returns false in this case.
link

`restore-keys`: String?Source

An ordered multiline string listing the prefix-matched keys, that are used for restoring stale cache if no cache hit occurred for key. Note cache-hit returns false in this case.

To set as a Listing, use restore-keys-list.
link

`upload-chunk-size`: Int?Source

The chunk size used to split up large files during upload, in bytes
link

enableCrossOsArchive: Boolean?Source

An optional boolean when enabled, allows windows runners to save or restore caches that can be restored or saved respectively on other platforms

Default if unspecified: "false"
link

`fail-on-cache-miss`: Boolean?Source

Fail the workflow if cache entry is not found

Default if unspecified: "false"
link

`lookup-only`: Boolean?Source

Check if a cache entry exists for the given input(s) (key, restore-keys) without downloading the cache

Default if unspecified: "false"
link

`save-always`: Boolean?Source

Deprecated:
save-always does not work as intended and will be removed in a future release. A separate actions/cache/restore step should be used instead. See https://github.com/actions/cache/tree/main/save#always-save-cache for more details.

Run the post step to save the cache even if another step before fails
Default if unspecified: "false"

Methods(show inherited)

link

function

Any.getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

Any.toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

Any.ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

Typed.hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

Typed.getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

Typed.getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

Typed.toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

Typed.toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.