jlengrand/github-api
1
0
Fork 0
mirror of https://github.com/jlengrand/github-api.git synced 2026-05-08 08:21:26 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e099a8c87f8a3c40696df70b628b2b087df25163
github-api/apidocs/org/kohsuke/github/GHCheckRun.html
Liam Newman e099a8c87f Release 1.119
2021-01-05 18:12:07 -08:00

707 lines
31 KiB
HTML
Raw Blame History

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.5) on Tue Jan 05 17:49:37 PST 2021 -->
<title>GHCheckRun (GitHub API for Java 1.119 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="dc.created" content="2021-01-05">
<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.4.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="GHCheckRun (GitHub API for Java 1.119 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":42};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/GHCheckRun.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 GHCheckRun" class="title">Class GHCheckRun</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.GHCheckRun</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">GHCheckRun</span>
extends <a href="GHObject.html" title="class in org.kohsuke.github">GHObject</a></pre>
<div class="block">Represents a check run.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://developer.github.com/v3/checks/runs/">documentation</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="GHCheckRun.AnnotationLevel.html" title="enum in org.kohsuke.github">GHCheckRun.AnnotationLevel</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="GHCheckRun.Conclusion.html" title="enum in org.kohsuke.github">GHCheckRun.Conclusion</a></span></code></th>
<td class="colLast">
<div class="block">Final conclusion of the check.</div>
</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="GHCheckRun.Output.html" title="class in org.kohsuke.github">GHCheckRun.Output</a></span></code></th>
<td class="colLast">
<div class="block">Represents an output in a check run to include summary and other results.</div>
</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="GHCheckRun.Status.html" title="enum in org.kohsuke.github">GHCheckRun.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()">GHCheckRun</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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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><a href="GHApp.html" title="class in org.kohsuke.github">GHApp</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getApp()">getApp</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the GitHub app this check run belongs to, included in response.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="GHCheckSuite.html" title="class in org.kohsuke.github">GHCheckSuite</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCheckSuite()">getCheckSuite</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the check suite this check run belongs to</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util" class="externalLink">Date</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCompletedAt()">getCompletedAt</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the completed time of the check run in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.</div>
</td>
</tr>
<tr id="i3" 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="#getConclusion()">getConclusion</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets conclusion of a completed check run.</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="#getDetailsUrl()">getDetailsUrl</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the details URL from which to find full details of the check run on the integrator's site.</div>
</td>
</tr>
<tr id="i5" 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="#getExternalId()">getExternalId</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets a reference for the check run on the integrator's system.</div>
</td>
</tr>
<tr id="i6" 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="i7" 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 the HTML URL: https://github.com/[owner]/[repo-name]/runs/[check-run-id], usually an GitHub Action page of
the check run.</div>
</td>
</tr>
<tr id="i8" 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">Gets the custom name of this check run.</div>
</td>
</tr>
<tr id="i9" 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="#getNodeId()">getNodeId</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the global node id to access most objects in GitHub.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="GHCheckRun.Output.html" title="class in org.kohsuke.github">GHCheckRun.Output</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getOutput()">getOutput</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets an output for a check run.</div>
</td>
</tr>
<tr id="i11" 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 check run.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util" class="externalLink">Date</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getStartedAt()">getStartedAt</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets the start time of the check run in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.</div>
</td>
</tr>
<tr id="i13" 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="#getStatus()">getStatus</a></span>()</code></th>
<td class="colLast">
<div class="block">Gets status of the check run.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="GHCheckRunBuilder.html" title="class in org.kohsuke.github">GHCheckRunBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#update()">update</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span></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#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>GHCheckRun</h4>
<pre>public&nbsp;GHCheckRun()</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="getStatus()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStatus</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;getStatus()</pre>
<div class="block">Gets status of the check run.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Status of the check run</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="GHCheckRun.Status.html" title="enum in org.kohsuke.github"><code>GHCheckRun.Status</code></a></dd>
</dl>
</li>
</ul>
<a id="getConclusion()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConclusion</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;getConclusion()</pre>
<div class="block">Gets conclusion of a completed check run.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Status of the check run</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="GHCheckRun.Conclusion.html" title="enum in org.kohsuke.github"><code>GHCheckRun.Conclusion</code></a></dd>
</dl>
</li>
</ul>
<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">Gets the custom name of this check run.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Name of the check run</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="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 check run.
Note this field is only populated for events. When getting a <a href="GHCheckRun.html" title="class in org.kohsuke.github"><code>GHCheckRun</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 check 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="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()</pre>
<div class="block">Gets the HTML URL: https://github.com/[owner]/[repo-name]/runs/[check-run-id], usually an GitHub Action page of
the check run.</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>HTML URL</dd>
</dl>
</li>
</ul>
<a id="getNodeId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNodeId</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;getNodeId()</pre>
<div class="block">Gets the global node id to access most objects in GitHub.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="GHObject.html#getNodeId()">getNodeId</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>Global node id</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://developer.github.com/v4/guides/using-global-node-ids/">documentation</a></dd>
</dl>
</li>
</ul>
<a id="getExternalId()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExternalId</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;getExternalId()</pre>
<div class="block">Gets a reference for the check run on the integrator's system.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Reference id</dd>
</dl>
</li>
</ul>
<a id="getDetailsUrl()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDetailsUrl</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;getDetailsUrl()</pre>
<div class="block">Gets the details URL from which to find full details of the check run on the integrator's site.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Details URL</dd>
</dl>
</li>
</ul>
<a id="getStartedAt()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStartedAt</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util" class="externalLink">Date</a>&nbsp;getStartedAt()</pre>
<div class="block">Gets the start time of the check run in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Timestamp of the start time</dd>
</dl>
</li>
</ul>
<a id="getCompletedAt()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCompletedAt</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util" class="externalLink">Date</a>&nbsp;getCompletedAt()</pre>
<div class="block">Gets the completed time of the check run in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Timestamp of the completed time</dd>
</dl>
</li>
</ul>
<a id="getApp()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getApp</h4>
<pre class="methodSignature">public&nbsp;<a href="GHApp.html" title="class in org.kohsuke.github">GHApp</a>&nbsp;getApp()</pre>
<div class="block">Gets the GitHub app this check run belongs to, included in response.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>GitHub App</dd>
</dl>
</li>
</ul>
<a id="getCheckSuite()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCheckSuite</h4>
<pre class="methodSignature">public&nbsp;<a href="GHCheckSuite.html" title="class in org.kohsuke.github">GHCheckSuite</a>&nbsp;getCheckSuite()</pre>
<div class="block">Gets the check suite this check run belongs to</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Check suite</dd>
</dl>
</li>
</ul>
<a id="getOutput()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutput</h4>
<pre class="methodSignature">public&nbsp;<a href="GHCheckRun.Output.html" title="class in org.kohsuke.github">GHCheckRun.Output</a>&nbsp;getOutput()</pre>
<div class="block">Gets an output for a check run.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Output of a check run</dd>
</dl>
</li>
</ul>
<a id="update()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>update</h4>
<pre class="methodSignature"><a href="Preview.html" title="annotation in org.kohsuke.github">@Preview</a>(<a href="internal/Previews.html#ANTIOPE">ANTIOPE</a>)
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang" class="externalLink">@Deprecated</a>
@NonNull
public&nbsp;<a href="GHCheckRunBuilder.html" title="class in org.kohsuke.github">GHCheckRunBuilder</a>&nbsp;update()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span></div>
<div class="block">Updates this check run.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a builder which you should customize, then call <a href="GHCheckRunBuilder.html#create()"><code>GHCheckRunBuilder.create()</code></a></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/GHCheckRun.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