Pkldoc > com.github.action > com.github.action.actions.Cache

CacheInputs0.0.7

Properties
Methods

class CacheInputs

Known subtypes:
Known usages:
All versions:

Properties

link
path: String

A list of files, directories, and wildcard patterns to cache and restore
Each entry should be separated by newlines.

Example:
```
path =
  """
  path/to/dependencies
  some/other/dependencies
  """
```
link

key: String

An explicit key for restoring and saving the cache
link

`restore-keys`: String?

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

`upload-chunk-size`: Int?

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

enableCrossOsArchive: Boolean?

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

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

Fail the workflow if cache entry is not found
link

`lookup-only`: Boolean?

Check if a cache entry exists for the given input(s) (key, restoreKeys) without downloading the cache.
link

`save-always`: Boolean?

Run the post step to save the cache even if another step before fails

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.