Package org.kohsuke.github

Class GHWorkflowRunQueryBuilder

java.lang.Object
org.kohsuke.github.GHQueryBuilder<GHWorkflowRun>
org.kohsuke.github.GHWorkflowRunQueryBuilder
public class GHWorkflowRunQueryBuilder extends GHQueryBuilder<GHWorkflowRun>
Lists up workflow runs with some filtering and sorting.
Author:
Guillaume Smet
See Also:

  • Method Details

    • actor

      public GHWorkflowRunQueryBuilder actor(String actor)
      Actor workflow run query builder.
      Parameters:
      actor - the actor
      Returns:
      the gh workflow run query builder

    • actor

      public GHWorkflowRunQueryBuilder actor(GHUser actor)
      Actor workflow run query builder.
      Parameters:
      actor - the actor
      Returns:
      the gh workflow run query builder

    • branch

      public GHWorkflowRunQueryBuilder branch(String branch)
      Branch workflow run query builder.
      Parameters:
      branch - the branch
      Returns:
      the gh workflow run query builder

    • event

      public GHWorkflowRunQueryBuilder event(GHEvent event)
      Event workflow run query builder.
      Parameters:
      event - the event
      Returns:
      the gh workflow run query builder

    • event

      public GHWorkflowRunQueryBuilder event(String event)
      Event workflow run query builder.
      Parameters:
      event - the event
      Returns:
      the gh workflow run query builder

    • status

      public GHWorkflowRunQueryBuilder status(GHWorkflowRun.Status status)
      Status workflow run query builder.
      Parameters:
      status - the status
      Returns:
      the gh workflow run query builder

    • conclusion

      public GHWorkflowRunQueryBuilder conclusion(GHWorkflowRun.Conclusion conclusion)
      Conclusion workflow run query builder.

      The GitHub API is also using the status field to search by conclusion.

      Parameters:
      conclusion - the conclusion
      Returns:
      the gh workflow run query builder

    • created

      public GHWorkflowRunQueryBuilder created(String created)
      Created workflow run query builder.
      Parameters:
      created - a range following the Query for dates syntax
      Returns:
      the gh workflow run query builder
      See Also:

    • headSha

      public GHWorkflowRunQueryBuilder headSha(String headSha)
      Head sha workflow run query builder.
      Parameters:
      headSha - the head sha
      Returns:
      the gh workflow run query builder

    • list

      public PagedIterable<GHWorkflowRun> list()
      List.
      Specified by:
      list in class GHQueryBuilder<GHWorkflowRun>
      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