jlengrand/github-api
1
0
Fork 0
mirror of https://github.com/jlengrand/github-api.git synced 2026-05-09 00:11:24 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
5fc65a60b11bd69bacfd3489f46db83aeec8477c
github-api/apidocs/org/kohsuke/github/GHWorkflowRun.html
Liam Newman 5fc65a60b1 Release v1.125 with Jacoco data
2021-03-25 18:58:40 -07:00

844 lines
36 KiB
HTML
Raw Blame History

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.10) on Thu Mar 25 18:55:49 PDT 2021 -->
<title>GHWorkflowRun (GitHub API for Java 1.125 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2021-03-25">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="GHWorkflowRun (GitHub API for Java 1.125 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/GHWorkflowRun.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.kohsuke.github</a></div>
<h2 title="Class GHWorkflowRun" class="title">Class GHWorkflowRun</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="GHObject.html" title="class in org.kohsuke.github">org.kohsuke.github.GHObject</a></li>
<li>
<ul class="inheritance">
<li>org.kohsuke.github.GHWorkflowRun</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">GHWorkflowRun</span>
extends <a href="GHObject.html" title="class in org.kohsuke.github">GHObject</a></pre>
<div class="block">A workflow run.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Guillaume Smet</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="GHRepository.html#getWorkflowRun(long)"><code>GHRepository.getWorkflowRun(long)</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="GHWorkflowRun.Conclusion.html" title="enum in org.kohsuke.github">GHWorkflowRun.Conclusion</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="GHWorkflowRun.HeadCommit.html" title="class in org.kohsuke.github">GHWorkflowRun.HeadCommit</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="GHWorkflowRun.Status.html" title="enum in org.kohsuke.github">GHWorkflowRun.Status</a></span></code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.org.kohsuke.github.GHObject">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.kohsuke.github.<a href="GHObject.html" title="class in org.kohsuke.github">GHObject</a></h3>
<code><a href="GHObject.html#responseHeaderFields">responseHeaderFields</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">GHWorkflowRun</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cancel()">cancel</a></span>()</code></th>
<td class="colLast">
<div class="block">Cancel the workflow run.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#delete()">delete</a></span>()</code></th>
<td class="colLast">
<div class="block">Delete the workflow run.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getArtifactsUrl()">getArtifactsUrl</a></span>()</code></th>
<td class="colLast">
<div class="block">The artifacts URL, like https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCancelUrl()">getCancelUrl</a></span>()</code></th>
<td class="colLast">
<div class="block">The cancel URL, like https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCheckSuiteUrl()">getCheckSuiteUrl</a></span>()</code></th>
<td class="colLast">
<div class="block">The check suite URL, like https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="GHWorkflowRun.Conclusion.html" title="enum in org.kohsuke.github">GHWorkflowRun.Conclusion</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConclusion()">getConclusion</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the conclusion of the workflow run.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="GHEvent.html" title="enum in org.kohsuke.github">GHEvent</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEvent()">getEvent</a></span>()</code></th>
<td class="colLast">
<div class="block">The type of event that triggered the build.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHeadBranch()">getHeadBranch</a></span>()</code></th>
<td class="colLast">
<div class="block">The head branch name the changes are on.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="GHWorkflowRun.HeadCommit.html" title="class in org.kohsuke.github">GHWorkflowRun.HeadCommit</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHeadCommit()">getHeadCommit</a></span>()</code></th>
<td class="colLast">
<div class="block">The commit of current head.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="GHRepository.html" title="class in org.kohsuke.github">GHRepository</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHeadRepository()">getHeadRepository</a></span>()</code></th>
<td class="colLast">
<div class="block">The repository of current head.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHeadSha()">getHeadSha</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the HEAD SHA.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHtmlUrl()">getHtmlUrl</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets html url.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getJobsUrl()">getJobsUrl</a></span>()</code></th>
<td class="colLast">
<div class="block">The jobs URL, like https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLogsUrl()">getLogsUrl</a></span>()</code></th>
<td class="colLast">
<div class="block">The logs URL, like https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getName()">getName</a></span>()</code></th>
<td class="colLast">
<div class="block">The name of the workflow run.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="GHPullRequest.html" title="class in org.kohsuke.github">GHPullRequest</a>&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPullRequests()">getPullRequests</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the pull requests participated in this workflow run.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRerunUrl()">getRerunUrl</a></span>()</code></th>
<td class="colLast">
<div class="block">The rerun URL, like https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRunNumber()">getRunNumber</a></span>()</code></th>
<td class="colLast">
<div class="block">The run number.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="GHWorkflowRun.Status.html" title="enum in org.kohsuke.github">GHWorkflowRun.Status</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStatus()">getStatus</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets status of the workflow run.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getWorkflowId()">getWorkflowId</a></span>()</code></th>
<td class="colLast">
<div class="block">The workflow id.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getWorkflowUrl()">getWorkflowUrl</a></span>()</code></th>
<td class="colLast">
<div class="block">The workflow URL, like https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#rerun()">rerun</a></span>()</code></th>
<td class="colLast">
<div class="block">Rerun the workflow run.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.kohsuke.github.GHObject">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.kohsuke.github.<a href="GHObject.html" title="class in org.kohsuke.github">GHObject</a></h3>
<code><a href="GHObject.html#getCreatedAt()">getCreatedAt</a>, <a href="GHObject.html#getId()">getId</a>, <a href="GHObject.html#getNodeId()">getNodeId</a>, <a href="GHObject.html#getResponseHeaderFields()">getResponseHeaderFields</a>, <a href="GHObject.html#getUpdatedAt()">getUpdatedAt</a>, <a href="GHObject.html#getUrl()">getUrl</a>, <a href="GHObject.html#setResponseHeaderFields(org.kohsuke.github.GitHubResponse.ResponseInfo)">setResponseHeaderFields</a>, <a href="GHObject.html#toString()">toString</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>GHWorkflowRun</h4>
<pre>public&nbsp;GHWorkflowRun()</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="getName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;getName()</pre>
<div class="block">The name of the workflow run.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the name</dd>
</dl>
</li>
</ul>
<a id="getRunNumber()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRunNumber</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getRunNumber()</pre>
<div class="block">The run number.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the run number</dd>
</dl>
</li>
</ul>
<a id="getWorkflowId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWorkflowId</h4>
<pre class="methodSignature">public&nbsp;long&nbsp;getWorkflowId()</pre>
<div class="block">The workflow id.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the workflow id</dd>
</dl>
</li>
</ul>
<a id="getHtmlUrl()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHtmlUrl</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a>&nbsp;getHtmlUrl()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="GHObject.html#getHtmlUrl()">GHObject</a></code></span></div>
<div class="block">Gets html url.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="GHObject.html#getHtmlUrl()">getHtmlUrl</a></code>&nbsp;in class&nbsp;<code><a href="GHObject.html" title="class in org.kohsuke.github">GHObject</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>URL of this object for humans, which renders some HTML.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - on error</dd>
</dl>
</li>
</ul>
<a id="getJobsUrl()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJobsUrl</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a>&nbsp;getJobsUrl()</pre>
<div class="block">The jobs URL, like https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the diff url</dd>
</dl>
</li>
</ul>
<a id="getLogsUrl()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLogsUrl</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a>&nbsp;getLogsUrl()</pre>
<div class="block">The logs URL, like https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the diff url</dd>
</dl>
</li>
</ul>
<a id="getCheckSuiteUrl()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCheckSuiteUrl</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a>&nbsp;getCheckSuiteUrl()</pre>
<div class="block">The check suite URL, like https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the diff url</dd>
</dl>
</li>
</ul>
<a id="getArtifactsUrl()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getArtifactsUrl</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a>&nbsp;getArtifactsUrl()</pre>
<div class="block">The artifacts URL, like https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the diff url</dd>
</dl>
</li>
</ul>
<a id="getCancelUrl()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCancelUrl</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a>&nbsp;getCancelUrl()</pre>
<div class="block">The cancel URL, like https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the diff url</dd>
</dl>
</li>
</ul>
<a id="getRerunUrl()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRerunUrl</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a>&nbsp;getRerunUrl()</pre>
<div class="block">The rerun URL, like https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the diff url</dd>
</dl>
</li>
</ul>
<a id="getWorkflowUrl()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWorkflowUrl</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net" class="externalLink">URL</a>&nbsp;getWorkflowUrl()</pre>
<div class="block">The workflow URL, like https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the diff url</dd>
</dl>
</li>
</ul>
<a id="getHeadBranch()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeadBranch</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;getHeadBranch()</pre>
<div class="block">The head branch name the changes are on.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>head branch name</dd>
</dl>
</li>
</ul>
<a id="getHeadSha()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeadSha</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>&nbsp;getHeadSha()</pre>
<div class="block">Gets the HEAD SHA.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>sha for the HEAD commit</dd>
</dl>
</li>
</ul>
<a id="getHeadCommit()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeadCommit</h4>
<pre class="methodSignature">public&nbsp;<a href="GHWorkflowRun.HeadCommit.html" title="class in org.kohsuke.github">GHWorkflowRun.HeadCommit</a>&nbsp;getHeadCommit()</pre>
<div class="block">The commit of current head.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>head commit</dd>
</dl>
</li>
</ul>
<a id="getHeadRepository()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getHeadRepository</h4>
<pre class="methodSignature">public&nbsp;<a href="GHRepository.html" title="class in org.kohsuke.github">GHRepository</a>&nbsp;getHeadRepository()</pre>
<div class="block">The repository of current head.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>head repository</dd>
</dl>
</li>
</ul>
<a id="getEvent()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEvent</h4>
<pre class="methodSignature">public&nbsp;<a href="GHEvent.html" title="enum in org.kohsuke.github">GHEvent</a>&nbsp;getEvent()</pre>
<div class="block">The type of event that triggered the build.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>type of event</dd>
</dl>
</li>
</ul>
<a id="getStatus()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStatus</h4>
<pre class="methodSignature">public&nbsp;<a href="GHWorkflowRun.Status.html" title="enum in org.kohsuke.github">GHWorkflowRun.Status</a>&nbsp;getStatus()</pre>
<div class="block">Gets status of the workflow run.
<p>
Can be <code>UNKNOWN</code> if the value returned by GitHub is unknown from the API.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>status of the workflow run</dd>
</dl>
</li>
</ul>
<a id="getConclusion()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConclusion</h4>
<pre class="methodSignature">public&nbsp;<a href="GHWorkflowRun.Conclusion.html" title="enum in org.kohsuke.github">GHWorkflowRun.Conclusion</a>&nbsp;getConclusion()</pre>
<div class="block">Gets the conclusion of the workflow run.
<p>
Can be <code>UNKNOWN</code> if the value returned by GitHub is unknown from the API.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>conclusion of the workflow run</dd>
</dl>
</li>
</ul>
<a id="getPullRequests()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPullRequests</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink">List</a>&lt;<a href="GHPullRequest.html" title="class in org.kohsuke.github">GHPullRequest</a>&gt;&nbsp;getPullRequests()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
<div class="block">Gets the pull requests participated in this workflow run.
Note this field is only populated for events. When getting a <a href="GHWorkflowRun.html" title="class in org.kohsuke.github"><code>GHWorkflowRun</code></a> outside of an event, this is
always empty.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the list of <a href="GHPullRequest.html" title="class in org.kohsuke.github"><code>GHPullRequest</code></a>s for this workflow run. Only populated for events.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - the io exception</dd>
</dl>
</li>
</ul>
<a id="cancel()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cancel</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;cancel()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
<div class="block">Cancel the workflow run.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - the io exception</dd>
</dl>
</li>
</ul>
<a id="delete()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>delete</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;delete()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
<div class="block">Delete the workflow run.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - the io exception</dd>
</dl>
</li>
</ul>
<a id="rerun()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>rerun</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;rerun()
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></pre>
<div class="block">Rerun the workflow run.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io" class="externalLink">IOException</a></code> - the io exception</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/GHWorkflowRun.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2021. All rights reserved.</small></p>
</footer>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink