jlengrand/github-api
1
0
Fork 0
mirror of https://github.com/jlengrand/github-api.git synced 2026-05-12 00:11:23 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
0d424cedfa900c8a5a0e44babc2eeb708a488799
github-api/apidocs/org/kohsuke/github/GitHubBuilder.html
Kohsuke Kawaguchi 0d424cedfa Wagon: Deploying site to repository
2017-10-28 16:01:47 -07:00

579 lines
35 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_144) on Sat Oct 28 16:00:54 PDT 2017 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GitHubBuilder (GitHub API for Java 1.90 API)</title>
<meta name="date" content="2017-10-28">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="GitHubBuilder (GitHub API for Java 1.90 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":9,"i2":9,"i3":41,"i4":41,"i5":9,"i6":9,"i7":9,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static 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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/GitHubBuilder.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">
<li><a href="../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/kohsuke/github/GitUser.html" title="class in org.kohsuke.github"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/kohsuke/github/GitHubBuilder.html" target="_top">Frames</a></li>
<li><a href="GitHubBuilder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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 name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.kohsuke.github</div>
<h2 title="Class GitHubBuilder" class="title">Class GitHubBuilder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.kohsuke.github.GitHubBuilder</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">GitHubBuilder</span>
extends <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Configures connection details and produces <a href="../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github"><code>GitHub</code></a>.</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.59</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHubBuilder.html#GitHubBuilder--">GitHubBuilder</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHubBuilder.html#build--">build</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static <a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github">GitHubBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHubBuilder.html#fromCredentials--">fromCredentials</a></span>()</code>
<div class="block">First check if the credentials are configured using the ~/.github properties file.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github">GitHubBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHubBuilder.html#fromEnvironment--">fromEnvironment</a></span>()</code>
<div class="block">Creates <a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github"><code>GitHubBuilder</code></a> by picking up coordinates from environment variables.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static <a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github">GitHubBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHubBuilder.html#fromEnvironment-java.lang.String-java.lang.String-java.lang.String-">fromEnvironment</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;loginVariableName,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;passwordVariableName,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;oauthVariableName)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use <a href="../../../org/kohsuke/github/GitHubBuilder.html#fromEnvironment--"><code>fromEnvironment()</code></a> to pick up standard set of environment variables, so that
different clients of this library will all recognize one consistent set of coordinates.</span></div>
</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github">GitHubBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHubBuilder.html#fromEnvironment-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">fromEnvironment</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;loginVariableName,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;passwordVariableName,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;oauthVariableName,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;endpointVariableName)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use <a href="../../../org/kohsuke/github/GitHubBuilder.html#fromEnvironment--"><code>fromEnvironment()</code></a> to pick up standard set of environment variables, so that
different clients of this library will all recognize one consistent set of coordinates.</span></div>
</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static <a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github">GitHubBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHubBuilder.html#fromProperties-java.util.Properties-">fromProperties</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;props)</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static <a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github">GitHubBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHubBuilder.html#fromPropertyFile--">fromPropertyFile</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>static <a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github">GitHubBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHubBuilder.html#fromPropertyFile-java.lang.String-">fromPropertyFile</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;propertyFileName)</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github">GitHubBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHubBuilder.html#withAbuseLimitHandler-org.kohsuke.github.AbuseLimitHandler-">withAbuseLimitHandler</a></span>(<a href="../../../org/kohsuke/github/AbuseLimitHandler.html" title="class in org.kohsuke.github">AbuseLimitHandler</a>&nbsp;handler)</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github">GitHubBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHubBuilder.html#withConnector-org.kohsuke.github.HttpConnector-">withConnector</a></span>(<a href="../../../org/kohsuke/github/HttpConnector.html" title="interface in org.kohsuke.github">HttpConnector</a>&nbsp;connector)</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github">GitHubBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHubBuilder.html#withEndpoint-java.lang.String-">withEndpoint</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;endpoint)</code>&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github">GitHubBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHubBuilder.html#withOAuthToken-java.lang.String-">withOAuthToken</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;oauthToken)</code>&nbsp;</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github">GitHubBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHubBuilder.html#withOAuthToken-java.lang.String-java.lang.String-">withOAuthToken</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;oauthToken,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;user)</code>&nbsp;</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github">GitHubBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHubBuilder.html#withPassword-java.lang.String-java.lang.String-">withPassword</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;user,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;password)</code>&nbsp;</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github">GitHubBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHubBuilder.html#withProxy-java.net.Proxy-">withProxy</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/net/Proxy.html?is-external=true" title="class or interface in java.net">Proxy</a>&nbsp;p)</code>
<div class="block">Configures <a href="../../../org/kohsuke/github/GitHubBuilder.html#withConnector-org.kohsuke.github.HttpConnector-">connector</a>
that uses HTTP library in JRE but use a specific proxy, instead of
the system default one.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github">GitHubBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/kohsuke/github/GitHubBuilder.html#withRateLimitHandler-org.kohsuke.github.RateLimitHandler-">withRateLimitHandler</a></span>(<a href="../../../org/kohsuke/github/RateLimitHandler.html" title="class in org.kohsuke.github">RateLimitHandler</a>&nbsp;handler)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="GitHubBuilder--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>GitHubBuilder</h4>
<pre>public&nbsp;GitHubBuilder()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="fromCredentials--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromCredentials</h4>
<pre>public static&nbsp;<a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github">GitHubBuilder</a>&nbsp;fromCredentials()
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">First check if the credentials are configured using the ~/.github properties file.
If no user is specified it means there is no configuration present so check the environment instead.
If there is still no user it means there are no credentials defined and throw an IOException.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the configured Builder from credentials defined on the system or in the environment.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If there are no credentials defined in the ~/.github properties file or the process environment.</dd>
</dl>
</li>
</ul>
<a name="fromEnvironment-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromEnvironment</h4>
<pre>public static&nbsp;<a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github">GitHubBuilder</a>&nbsp;fromEnvironment(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;loginVariableName,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;passwordVariableName,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;oauthVariableName)
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use <a href="../../../org/kohsuke/github/GitHubBuilder.html#fromEnvironment--"><code>fromEnvironment()</code></a> to pick up standard set of environment variables, so that
different clients of this library will all recognize one consistent set of coordinates.</span></div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="fromEnvironment-java.lang.String-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromEnvironment</h4>
<pre>public static&nbsp;<a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github">GitHubBuilder</a>&nbsp;fromEnvironment(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;loginVariableName,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;passwordVariableName,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;oauthVariableName,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;endpointVariableName)
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use <a href="../../../org/kohsuke/github/GitHubBuilder.html#fromEnvironment--"><code>fromEnvironment()</code></a> to pick up standard set of environment variables, so that
different clients of this library will all recognize one consistent set of coordinates.</span></div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="fromEnvironment--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromEnvironment</h4>
<pre>public static&nbsp;<a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github">GitHubBuilder</a>&nbsp;fromEnvironment()
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Creates <a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github"><code>GitHubBuilder</code></a> by picking up coordinates from environment variables.
<p>
The following environment variables are recognized:
<ul>
<li>GITHUB_LOGIN: username like 'kohsuke'
<li>GITHUB_PASSWORD: raw password
<li>GITHUB_OAUTH: OAuth token to login
<li>GITHUB_ENDPOINT: URL of the API endpoint
</ul>
<p>
See class javadoc for the relationship between these coordinates.
<p>
For backward compatibility, the following environment variables are recognized but discouraged:
login, password, oauth</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="fromPropertyFile--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromPropertyFile</h4>
<pre>public static&nbsp;<a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github">GitHubBuilder</a>&nbsp;fromPropertyFile()
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="fromPropertyFile-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromPropertyFile</h4>
<pre>public static&nbsp;<a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github">GitHubBuilder</a>&nbsp;fromPropertyFile(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;propertyFileName)
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
<a name="fromProperties-java.util.Properties-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromProperties</h4>
<pre>public static&nbsp;<a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github">GitHubBuilder</a>&nbsp;fromProperties(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Properties.html?is-external=true" title="class or interface in java.util">Properties</a>&nbsp;props)</pre>
</li>
</ul>
<a name="withEndpoint-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withEndpoint</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github">GitHubBuilder</a>&nbsp;withEndpoint(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;endpoint)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>endpoint</code> - The URL of GitHub (or GitHub enterprise) API endpoint, such as "https://api.github.com" or
"http://ghe.acme.com/api/v3". Note that GitHub Enterprise has <tt>/api/v3</tt> in the URL.
For historical reasons, this parameter still accepts the bare domain name, but that's considered deprecated.</dd>
</dl>
</li>
</ul>
<a name="withPassword-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withPassword</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github">GitHubBuilder</a>&nbsp;withPassword(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;user,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;password)</pre>
</li>
</ul>
<a name="withOAuthToken-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withOAuthToken</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github">GitHubBuilder</a>&nbsp;withOAuthToken(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;oauthToken)</pre>
</li>
</ul>
<a name="withOAuthToken-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withOAuthToken</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github">GitHubBuilder</a>&nbsp;withOAuthToken(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;oauthToken,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;user)</pre>
</li>
</ul>
<a name="withConnector-org.kohsuke.github.HttpConnector-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withConnector</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github">GitHubBuilder</a>&nbsp;withConnector(<a href="../../../org/kohsuke/github/HttpConnector.html" title="interface in org.kohsuke.github">HttpConnector</a>&nbsp;connector)</pre>
</li>
</ul>
<a name="withRateLimitHandler-org.kohsuke.github.RateLimitHandler-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withRateLimitHandler</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github">GitHubBuilder</a>&nbsp;withRateLimitHandler(<a href="../../../org/kohsuke/github/RateLimitHandler.html" title="class in org.kohsuke.github">RateLimitHandler</a>&nbsp;handler)</pre>
</li>
</ul>
<a name="withAbuseLimitHandler-org.kohsuke.github.AbuseLimitHandler-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withAbuseLimitHandler</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github">GitHubBuilder</a>&nbsp;withAbuseLimitHandler(<a href="../../../org/kohsuke/github/AbuseLimitHandler.html" title="class in org.kohsuke.github">AbuseLimitHandler</a>&nbsp;handler)</pre>
</li>
</ul>
<a name="withProxy-java.net.Proxy-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withProxy</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/GitHubBuilder.html" title="class in org.kohsuke.github">GitHubBuilder</a>&nbsp;withProxy(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/net/Proxy.html?is-external=true" title="class or interface in java.net">Proxy</a>&nbsp;p)</pre>
<div class="block">Configures <a href="../../../org/kohsuke/github/GitHubBuilder.html#withConnector-org.kohsuke.github.HttpConnector-">connector</a>
that uses HTTP library in JRE but use a specific proxy, instead of
the system default one.</div>
</li>
</ul>
<a name="build--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>build</h4>
<pre>public&nbsp;<a href="../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github">GitHub</a>&nbsp;build()
throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/GitHubBuilder.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">
<li><a href="../../../org/kohsuke/github/GitHub.html" title="class in org.kohsuke.github"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/kohsuke/github/GitUser.html" title="class in org.kohsuke.github"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/kohsuke/github/GitHubBuilder.html" target="_top">Frames</a></li>
<li><a href="GitHubBuilder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&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 name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2017. All rights reserved.</small></p>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink