Pkldoc > com.github.action > com.github.action.actions.Artifact

DownloadInputs0.0.7

Properties
Methods

class DownloadInputs

Known subtypes:
Known usages:
All versions:

Properties

link

name: String?

Name of the artifact to download.

If unspecified, all artifacts for the run are downloaded.
link

`artifact-ids`: String(name == null)?

IDs of the artifacts to download, comma-separated. Either inputs artifact-ids or name can be used, but not both. Optional.
link

path: String?

Destination path.

Supports basic tilde expansion. Optional. Default is $GITHUB_WORKSPACE
link

pattern: String?

A glob pattern to the artifacts that should be downloaded. Ignored if name is specified. Optional.
link

`merge-multiple`: Boolean?

When multiple artifacts are matched, this changes the behavior of the destination directories.

If true, the downloaded artifacts will be in the same directory specified by path. If false, the downloaded artifacts will be extracted into individual named directories within the specified path. Note: When downloading a single artifact (by name or ID), it will always be extracted directly to the specified path. Optional. Default is 'false'
link

`github-token`: String?

The GitHub token used to authenticate with the GitHub API.

This is required when downloading artifacts from a different repository or from a different workflow run.

Optional. If unspecified, the action will download artifacts from the current repo and the current workflow run.
link

repository: String?

The repository owner and the repository name joined together by "/".

If githubToken is specified, this is the repository that artifacts will be downloaded from. Optional. Default is ${{ github.repository }}
link

`run-id`: (String|Number|Boolean)?

The id of the workflow run where the desired download artifact was uploaded from.

If github-token is specified, this is the run that artifacts will be downloaded from. Optional. Default is ${{ github.run_id }}

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.