codeberg4s
0.1.0-SNAPSHOT
API
Generated with
codeberg4s/com.worxbend.codeberg4s/com.worxbend.codeberg4s.repositories/com.worxbend.codeberg4s.repositories.actions/ActionRunQuery

ActionRunQuery

com.worxbend.codeberg4s.repositories.actions.ActionRunQuery
See theActionRunQuery companion object
final case class ActionRunQuery(events: Vector[String], statuses: Vector[ActionStatus], runNumber: Option[Long], headSha: Option[CommitSha], ref: Option[String], workflowId: Option[WorkflowFileName])

The filters of GET /repos/{owner}/{repo}/actions/runs.

'''Only what the caller set is sent.''' An absent filter is not the same request as an empty one: omitting status asks for every run, and sending status= is a request Forgejo has no reading of. Nothing here has a default to fall back on, which is why ActionRunQuery.Empty renders to no parameters at all.

ActionRunQuery.Empty
 .triggeredBy("push")
 .withStatus(ActionStatus.Failure)
 .onRef("refs/heads/main")

Value parameters

events

which webhook events to include — push, pull_request, workflow_dispatch. Sent as a repeated query parameter, one per event, because the spec declares it as an array

headSha

only runs against this commit

ref

only runs involving this Git reference, for example refs/heads/main

runNumber

the per-repository counter of one run — ActionRun.indexInRepo, '''not''' RunId

statuses

which lifecycle states to include, likewise repeated. ActionStatus rather than String so a typo is a compile error instead of an empty page

workflowId

only runs of this workflow file

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def atCommit(sha: CommitSha): ActionRunQuery

Restricts the listing to runs against one commit.

Restricts the listing to runs against one commit.

Attributes

def numbered(number: Long): ActionRunQuery

Restricts the listing to the run carrying this per-repository counter.

Restricts the listing to the run carrying this per-repository counter.

Attributes

def ofWorkflow(workflow: WorkflowFileName): ActionRunQuery

Restricts the listing to runs of one workflow file.

Restricts the listing to runs of one workflow file.

Attributes

def onRef(reference: String): ActionRunQuery

Restricts the listing to runs involving one Git reference.

Restricts the listing to runs involving one Git reference.

Attributes

def triggeredBy(event: String): ActionRunQuery

Adds one webhook event to the filter.

Adds one webhook event to the filter.

Attributes

def withStatus(status: ActionStatus): ActionRunQuery

Adds one lifecycle state to the filter.

Adds one lifecycle state to the filter.

Attributes

Inherited methods

def productElementNames: Iterator[String]

An iterator over the names of all the elements of this product.

An iterator over the names of all the elements of this product.

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

An iterator over all the elements of this product.

An iterator over all the elements of this product.

Attributes

Returns

in the default implementation, an Iterator[Any]

Inherited from:
Product
Generated with