Package org.kohsuke.github

Class GHWorkflowJobQueryBuilder

java.lang.Object

org.kohsuke.github.GHQueryBuilder<GHWorkflowJob>

org.kohsuke.github.GHWorkflowJobQueryBuilder

public class GHWorkflowJobQueryBuilder
extends GHQueryBuilder<GHWorkflowJob>

Lists up jobs of a workflow run with some filtering.

Author:

Guillaume Smet

Field Summary

Fields inherited from class org.kohsuke.github.GHQueryBuilder

req

Method Summary

Modifier and Type	Method	Description
GHWorkflowJobQueryBuilder	all()	Apply a filter to return jobs from all executions of this workflow run.
GitHub	getRoot()	Deprecated. For access to the GitHub instance, use a local copy instead of pulling it out of objects.
GHWorkflowJobQueryBuilder	latest()	Apply a filter to only return the jobs of the most recent execution of the workflow run.
PagedIterable<GHWorkflowJob>	list()	List.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

latest

public GHWorkflowJobQueryBuilder latest()

Apply a filter to only return the jobs of the most recent execution of the workflow run.

Returns:

the workflow run job query builder

all

public GHWorkflowJobQueryBuilder all()

Apply a filter to return jobs from all executions of this workflow run.

Returns:

the workflow run job run query builder

list

public PagedIterable<GHWorkflowJob> list()

List.

Specified by:

list in class GHQueryBuilder<GHWorkflowJob>

Returns:

the paged iterable

getRoot

@Deprecated
public GitHub getRoot()

Deprecated.

For access to the GitHub instance, use a local copy instead of pulling it out of objects.

Get the root GitHub instance for this object.

Returns:

the root GitHub instance