GHRepository (GitHub API for Java 1.92 API)

java.lang.Object
- org.kohsuke.github.GHObject
- - org.kohsuke.github.GHRepository

```
public class GHRepository
extends GHObject
```
A repository on GitHub.

Author:

Kohsuke Kawaguchi

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class GHRepository.Contributor

static class GHRepository.ForkSort
Sort orders for listing forks

Nested Classes
Modifier and Type	Class and Description
`static class`	`GHRepository.Contributor`
`static class`	`GHRepository.ForkSort` Sort orders for listing forks

Field Summary
- Fields inherited from class org.kohsuke.github.GHObject
  created_at, id, responseHeaderFields, updated_at, url

Constructor Summary

Constructors
Constructor and Description

GHRepository()

Constructors
Constructor and Description
`GHRepository()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addCollaborators(Collection<GHUser> users)`
`void`	`addCollaborators(GHUser... users)`
`GHDeployKey`	`addDeployKey(String title, String key)`
`GHBlobBuilder`	`createBlob()`
`GHCommitBuilder`	`createCommit()`
`GHCommitStatus`	`createCommitStatus(String sha1, GHCommitState state, String targetUrl, String description)`
`GHCommitStatus`	`createCommitStatus(String sha1, GHCommitState state, String targetUrl, String description, String context)` Creates a commit status
`GHContentUpdateResponse`	`createContent(byte[] contentBytes, String commitMessage, String path)`
`GHContentUpdateResponse`	`createContent(byte[] contentBytes, String commitMessage, String path, String branch)`
`GHContentUpdateResponse`	`createContent(String content, String commitMessage, String path)`
`GHContentUpdateResponse`	`createContent(String content, String commitMessage, String path, String branch)`
`GHDeploymentBuilder`	`createDeployment(String ref)`
`GHDeploymentStatusBuilder`	`createDeployStatus(int deploymentId, GHDeploymentState ghDeploymentState)` Deprecated. Use `getDeployment(deploymentId).createStatus(ghDeploymentState)`
`GHHook`	`createHook(String name, Map<String,String> config, Collection<GHEvent> events, boolean active)` See https://api.github.com/hooks for possible names and their configuration scheme.
`GHIssueBuilder`	`createIssue(String title)`
`GHLabel`	`createLabel(String name, String color)`
`GHMilestone`	`createMilestone(String title, String description)`
`GHPullRequest`	`createPullRequest(String title, String head, String base, String body)` Creates a new pull request.
`GHRef`	`createRef(String name, String sha)` Creates a named ref, such as tag, branch, etc.
`GHReleaseBuilder`	`createRelease(String tag)`
`GHTreeBuilder`	`createTree()`
`GHHook`	`createWebHook(URL url)`
`GHHook`	`createWebHook(URL url, Collection<GHEvent> events)`
`void`	`delete()` Deletes this repository.
`void`	`enableDownloads(boolean v)`
`void`	`enableIssueTracker(boolean v)` Enables or disables the issue tracker for this repository.
`void`	`enableWiki(boolean v)` Enables or disables Wiki for this repository.
`boolean`	`equals(Object obj)`
`GHRepository`	`fork()` Forks this repository as your repository.
`GHRepository`	`forkTo(GHOrganization org)` Forks this repository into an organization.
`GHBlob`	`getBlob(String blobSha)` Obtains the metadata & the content of a blob.
`GHBranch`	`getBranch(String name)`
`Map<String,GHBranch>`	`getBranches()` Gets branches by their names.
`GHRepositoryCloneTraffic`	`getCloneTraffic()` https://developer.github.com/v3/repos/traffic/#clones
`Set<String>`	`getCollaboratorNames()` Gets the names of the collaborators on this repository.
`GHPersonSet<GHUser>`	`getCollaborators()` Gets the collaborators on this repository.
`GHCommit`	`getCommit(String sha1)` Gets a commit object in this repository.
`GHCompare`	`getCompare(GHBranch id1, GHBranch id2)`
`GHCompare`	`getCompare(GHCommit id1, GHCommit id2)`
`GHCompare`	`getCompare(String id1, String id2)` Gets a comparison between 2 points in the repository.
`String`	`getDefaultBranch()` Returns the primary branch you'll configure in the "Admin > Options" config page.
`List<GHDeployKey>`	`getDeployKeys()`
`GHDeployment`	`getDeployment(long id)` Obtains a single `GHDeployment` by its ID.
`PagedIterable<GHDeploymentStatus>`	`getDeploymentStatuses(int id)` Deprecated. Use `getDeployment(id).listStatuses()`
`String`	`getDescription()`
`List<GHContent>`	`getDirectoryContent(String path)`
`List<GHContent>`	`getDirectoryContent(String path, String ref)`
`GHContent`	`getFileContent(String path)`
`GHContent`	`getFileContent(String path, String ref)`
`int`	`getForks()` Returns the number of all forks of this repository.
`String`	`getFullName()` Full repository name including the owner or organization.
`String`	`getGitTransportUrl()` Gets the git:// URL to this repository, such as "git://github.com/kohsuke/jenkins.git" This URL is read-only.
`String`	`getHomepage()`
`GHHook`	`getHook(int id)`
`List<GHHook>`	`getHooks()` Retrieves the currently configured hooks.
`URL`	`getHtmlUrl()` URL of this object for humans, which renders some HTML.
`String`	`getHttpTransportUrl()` Gets the HTTPS URL to this repository, such as "https://github.com/kohsuke/jenkins.git" This URL is read-only.
`GHIssue`	`getIssue(int id)`
`List<GHIssue>`	`getIssues(GHIssueState state)`
`List<GHIssue>`	`getIssues(GHIssueState state, GHMilestone milestone)`
`GHLabel`	`getLabel(String name)`
`String`	`getLanguage()` Gets the primary programming language.
`GHCommitStatus`	`getLastCommitStatus(String sha1)` Gets the last status of this commit, which is what gets shown in the UI.
`GHRelease`	`getLatestRelease()`
`GHLicense`	`getLicense()` Deprecated.
`GHContent`	`getLicenseContent()` Deprecated.
`String`	`getMasterBranch()` Deprecated. Renamed to `getDefaultBranch()`
`GHMilestone`	`getMilestone(int number)`
`Map<Integer,GHMilestone>`	`getMilestones()` Deprecated. Use `listMilestones(GHIssueState)`
`String`	`getMirrorUrl()` Gets the Mirror URL to access this repository: https://github.com/apache/tomee mirrored from git://git.apache.org/tomee.git
`String`	`getName()` Short repository name without the owner.
`int`	`getNetworkCount()` Deprecated. This no longer exists in the official API documentation. Use `getForks()`
`int`	`getOpenIssueCount()`
`GHUser`	`getOwner()`
`String`	`getOwnerName()`
`GHRepository`	`getParent()` Forked repositories have a 'parent' attribute that specifies the repository this repository is directly forked from.
`GHPermissionType`	`getPermission(GHUser u)` Obtain permission for a given user in this repository.
`GHPermissionType`	`getPermission(String user)` Obtain permission for a given user in this repository.
`Set<URL>`	`getPostCommitHooks()` Deprecated. Use `getHooks()` and `createHook(String, Map, Collection, boolean)`
`GHPullRequest`	`getPullRequest(int i)` Retrieves a specified pull request.
`List<GHPullRequest>`	`getPullRequests(GHIssueState state)` Retrieves all the pull requests of a particular state.
`Date`	`getPushedAt()`
`GHContent`	`getReadme()` https://developer.github.com/v3/repos/contents/#get-the-readme
`GHRef`	`getRef(String refName)` Retrive a ref of the given type for the current GitHub repository.
`GHRef[]`	`getRefs()` Retrieves all refs for the github repository.
`GHRef[]`	`getRefs(String refType)` Retrieves all refs of the given type for the current GitHub repository.
`List<GHRelease>`	`getReleases()` Deprecated. use `listReleases()`
`int`	`getSize()`
`GHRepository`	`getSource()` Forked repositories have a 'source' attribute that specifies the ultimate source of the forking chain.
`String`	`getSshUrl()` Gets the SSH URL to access this repository, such as [email protected]:rails/rails.git
`int`	`getStargazersCount()`
`int`	`getSubscribersCount()`
`GHSubscription`	`getSubscription()` Returns the current subscription.
`String`	`getSvnUrl()` Gets the Subversion URL to access this repository: https://github.com/rails/rails
`GHTagObject`	`getTagObject(String sha)` Returns the annotated tag object.
`Set<GHTeam>`	`getTeams()` If this repository belongs to an organization, return a set of teams.
`GHTree`	`getTree(String sha)` Retrive a tree of the given type for the current GitHub repository.
`GHTree`	`getTreeRecursive(String sha, int recursive)` Retrieves the tree for the current GitHub repository, recursively as described in here: https://developer.github.com/v3/git/trees/#get-a-tree-recursively
`GHRepositoryViewTraffic`	`getViewTraffic()` https://developer.github.com/v3/repos/traffic/#views
`int`	`getWatchers()`
`String`	`gitHttpTransportUrl()` Deprecated. Typo of `getHttpTransportUrl()`
`boolean`	`hasAdminAccess()`
`boolean`	`hasAssignee(GHUser u)` Checks if the given user is an assignee for this repository.
`boolean`	`hasDownloads()`
`int`	`hashCode()`
`boolean`	`hasIssues()`
`boolean`	`hasPages()`
`boolean`	`hasPullAccess()`
`boolean`	`hasPushAccess()`
`boolean`	`hasWiki()`
`boolean`	`isFork()`
`boolean`	`isPrivate()`
`PagedIterable<GHUser>`	`listAssignees()` Lists all the available assignees to which issues may be assigned.
`PagedIterable<GHUser>`	`listCollaborators()` Lists up the collaborators on this repository.
`PagedIterable<GHCommitComment>`	`listCommitComments()` Lists up all the commit comments in this repository.
`PagedIterable<GHCommit>`	`listCommits()` Lists all the commits.
`PagedIterable<GHCommitStatus>`	`listCommitStatuses(String sha1)` /** Lists all the commit statues attached to the given commit, newer ones first.
`PagedIterable<GHRepository.Contributor>`	`listContributors()`
`PagedIterable<GHDeployment>`	`listDeployments(String sha, String ref, String task, String environment)`
`PagedIterable<GHEventInfo>`	`listEvents()` Lists repository events.
`PagedIterable<GHRepository>`	`listForks()` Lists all the direct forks of this repository, sorted by github api default, currently `ForkSort.NEWEST`.
`PagedIterable<GHRepository>`	`listForks(GHRepository.ForkSort sort)` Lists all the direct forks of this repository, sorted by the given sort order.
`PagedIterable<GHIssue>`	`listIssues(GHIssueState state)` Lists up all the issues in this repository.
`PagedIterable<GHLabel>`	`listLabels()` Lists labels in this repository.
`Map<String,Long>`	`listLanguages()` List languages for the specified repository.
`PagedIterable<GHMilestone>`	`listMilestones(GHIssueState state)` Lists up all the milestones in this repository.
`GHNotificationStream`	`listNotifications()` List all the notifications in a repository for the current user.
`PagedIterable<GHPullRequest>`	`listPullRequests(GHIssueState state)` Deprecated. Use `queryPullRequests()`
`PagedIterable<GHRef>`	`listRefs()` Retrieves all refs for the github repository.
`PagedIterable<GHRef>`	`listRefs(String refType)` Retrieves all refs of the given type for the current GitHub repository.
`PagedIterable<GHRelease>`	`listReleases()`
`PagedIterable<GHUser>`	`listStargazers()` Lists all the users who have starred this repo based on the old version of the API.
`PagedIterable<GHStargazer>`	`listStargazers2()` Lists all the users who have starred this repo based on new version of the API, having extended information like the time when the repository was starred.
`PagedIterable<GHUser>`	`listSubscribers()` Lists all the subscribers (aka watchers.) https://developer.github.com/v3/activity/watching/
`PagedIterable<GHTag>`	`listTags()`
`GHCommitQueryBuilder`	`queryCommits()` Search commits by specifying filters through a builder pattern.
`GHPullRequestQueryBuilder`	`queryPullRequests()` Retrieves pull requests.
`InputStream`	`readBlob(String blobSha)` Reads the content of a blob as a stream for better efficiency.
`void`	`removeCollaborators(Collection<GHUser> users)`
`void`	`removeCollaborators(GHUser... users)`
`void`	`renameTo(String name)` Rename this repository.
`Reader`	`renderMarkdown(String text, MarkdownMode mode)` Render a Markdown document.
`void`	`setDefaultBranch(String value)`
`void`	`setDescription(String value)`
`void`	`setEmailServiceHook(String address)`
`void`	`setHomepage(String value)`
`GHSubscription`	`subscribe(boolean subscribed, boolean ignored)` Subscribes to this repository to get notifications.

Methods inherited from class org.kohsuke.github.GHObject
getCreatedAt, getId, getResponseHeaderFields, getUpdatedAt, getUrl, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail
- GHRepository
```
public GHRepository()
```

Method Detail

createDeployment

public GHDeploymentBuilder createDeployment(String ref)

getDeploymentStatuses

public PagedIterable<GHDeploymentStatus> getDeploymentStatuses(int id)
                                                        throws IOException

Deprecated. Use getDeployment(id).listStatuses()

Throws:: IOException

listDeployments

public PagedIterable<GHDeployment> listDeployments(String sha,
                                                   String ref,
                                                   String task,
                                                   String environment)

getDeployment

public GHDeployment getDeployment(long id)
                           throws IOException

Obtains a single GHDeployment by its ID.

Throws:: IOException

createDeployStatus

public GHDeploymentStatusBuilder createDeployStatus(int deploymentId,
                                                    GHDeploymentState ghDeploymentState)
                                             throws IOException

Deprecated. Use getDeployment(deploymentId).createStatus(ghDeploymentState)

Throws:: IOException

getDescription
```
public String getDescription()
```

getHomepage
```
public String getHomepage()
```

getGitTransportUrl
```
public String getGitTransportUrl()
```
Gets the git:// URL to this repository, such as "git://github.com/kohsuke/jenkins.git" This URL is read-only.

getHttpTransportUrl
```
public String getHttpTransportUrl()
```
Gets the HTTPS URL to this repository, such as "https://github.com/kohsuke/jenkins.git" This URL is read-only.

gitHttpTransportUrl
```
public String gitHttpTransportUrl()
```
Deprecated. Typo of getHttpTransportUrl()

getSvnUrl
```
public String getSvnUrl()
```
Gets the Subversion URL to access this repository: https://github.com/rails/rails

getMirrorUrl
```
public String getMirrorUrl()
```
Gets the Mirror URL to access this repository: https://github.com/apache/tomee mirrored from git://git.apache.org/tomee.git

getSshUrl
```
public String getSshUrl()
```
Gets the SSH URL to access this repository, such as [email protected]:rails/rails.git

getHtmlUrl
```
public URL getHtmlUrl()
```
Description copied from class: GHObject

URL of this object for humans, which renders some HTML.

Specified by:

getHtmlUrl in class GHObject

getName
```
public String getName()
```
Short repository name without the owner. For example 'jenkins' in case of http://github.com/jenkinsci/jenkins

getFullName
```
public String getFullName()
```
Full repository name including the owner or organization. For example 'jenkinsci/jenkins' in case of http://github.com/jenkinsci/jenkins

hasPullAccess
```
public boolean hasPullAccess()
```

hasPushAccess
```
public boolean hasPushAccess()
```

hasAdminAccess
```
public boolean hasAdminAccess()
```

getLanguage
```
public String getLanguage()
```
Gets the primary programming language.

getOwner

public GHUser getOwner()
                throws IOException

Throws:: IOException

getIssue

public GHIssue getIssue(int id)
                 throws IOException

Throws:: IOException

createIssue

public GHIssueBuilder createIssue(String title)

getIssues

public List<GHIssue> getIssues(GHIssueState state)
                        throws IOException

Throws:: IOException

getIssues

public List<GHIssue> getIssues(GHIssueState state,
                               GHMilestone milestone)
                        throws IOException

Throws:: IOException

listIssues

public PagedIterable<GHIssue> listIssues(GHIssueState state)

Lists up all the issues in this repository.

createRelease

public GHReleaseBuilder createRelease(String tag)

createRef
```
public GHRef createRef(String name,
                       String sha)
                throws IOException
```
Creates a named ref, such as tag, branch, etc.

Parameters:

name - The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.

sha - The SHA1 value to set this reference to

Throws:

IOException

getReleases

public List<GHRelease> getReleases()
                            throws IOException

Deprecated. use listReleases()

Throws:: IOException

getLatestRelease

public GHRelease getLatestRelease()
                           throws IOException

Throws:: IOException

listReleases

public PagedIterable<GHRelease> listReleases()
                                      throws IOException

Throws:: IOException

listTags

public PagedIterable<GHTag> listTags()
                              throws IOException

Throws:: IOException

listLanguages
```
public Map<String,Long> listLanguages()
                               throws IOException
```
List languages for the specified repository. The value on the right of a language is the number of bytes of code written in that language. { "C": 78769, "Python": 7769 }

Throws:

IOException

getOwnerName
```
public String getOwnerName()
```

hasIssues
```
public boolean hasIssues()
```

hasWiki
```
public boolean hasWiki()
```

isFork
```
public boolean isFork()
```

getForks
```
public int getForks()
```
Returns the number of all forks of this repository. This not only counts direct forks, but also forks of forks, and so on.

getStargazersCount
```
public int getStargazersCount()
```

isPrivate
```
public boolean isPrivate()
```

hasDownloads
```
public boolean hasDownloads()
```

hasPages
```
public boolean hasPages()
```

getWatchers
```
public int getWatchers()
```

getOpenIssueCount
```
public int getOpenIssueCount()
```

getNetworkCount
```
public int getNetworkCount()
```
Deprecated. This no longer exists in the official API documentation. Use getForks()

getSubscribersCount
```
public int getSubscribersCount()
```

getPushedAt
```
public Date getPushedAt()
```
Returns:

null if the repository was never pushed at.

getDefaultBranch
```
public String getDefaultBranch()
```
Returns the primary branch you'll configure in the "Admin > Options" config page.

Returns:

This field is null until the user explicitly configures the master branch.

getMasterBranch
```
public String getMasterBranch()
```
Deprecated. Renamed to getDefaultBranch()

getSize
```
public int getSize()
```

getCollaborators

@WithBridgeMethods(value=java.util.Set.class)
public GHPersonSet<GHUser> getCollaborators()
                                                                                   throws IOException

Gets the collaborators on this repository. This set always appear to include the owner.

Throws:: IOException

listCollaborators

public PagedIterable<GHUser> listCollaborators()
                                        throws IOException

Lists up the collaborators on this repository.

Returns:: Users
Throws:: IOException

listAssignees

public PagedIterable<GHUser> listAssignees()
                                    throws IOException

Lists all the available assignees to which issues may be assigned.

Throws:: IOException

hasAssignee
```
public boolean hasAssignee(GHUser u)
                    throws IOException
```
Checks if the given user is an assignee for this repository.

Throws:

IOException

getCollaboratorNames
```
public Set<String> getCollaboratorNames()
                                 throws IOException
```
Gets the names of the collaborators on this repository. This method deviates from the principle of this library but it works a lot faster than getCollaborators().

Throws:

IOException

getPermission
```
public GHPermissionType getPermission(String user)
                               throws IOException
```
Obtain permission for a given user in this repository.

Parameters:

user - a GHPerson.getLogin()

Throws:

FileNotFoundException - under some conditions (e.g., private repo you can see but are not an admin of); treat as unknown

HttpException - with a 403 under other conditions (e.g., public repo you have no special rights to); treat as unknown

IOException

getPermission
```
public GHPermissionType getPermission(GHUser u)
                               throws IOException
```
Obtain permission for a given user in this repository.

Throws:

FileNotFoundException - under some conditions (e.g., private repo you can see but are not an admin of); treat as unknown

HttpException - with a 403 under other conditions (e.g., public repo you have no special rights to); treat as unknown

IOException

getTeams
```
public Set<GHTeam> getTeams()
                     throws IOException
```
If this repository belongs to an organization, return a set of teams.

Throws:

IOException

addCollaborators

public void addCollaborators(GHUser... users)
                      throws IOException

Throws:: IOException

addCollaborators

public void addCollaborators(Collection<GHUser> users)
                      throws IOException

Throws:: IOException

removeCollaborators

public void removeCollaborators(GHUser... users)
                         throws IOException

Throws:: IOException

removeCollaborators

public void removeCollaborators(Collection<GHUser> users)
                         throws IOException

Throws:: IOException

setEmailServiceHook

public void setEmailServiceHook(String address)
                         throws IOException

Throws:: IOException

enableIssueTracker
```
public void enableIssueTracker(boolean v)
                        throws IOException
```
Enables or disables the issue tracker for this repository.

Throws:

IOException

enableWiki
```
public void enableWiki(boolean v)
                throws IOException
```
Enables or disables Wiki for this repository.

Throws:

IOException

enableDownloads

public void enableDownloads(boolean v)
                     throws IOException

Throws:: IOException

renameTo

public void renameTo(String name)
              throws IOException

Rename this repository.

Throws:: IOException

setDescription

public void setDescription(String value)
                    throws IOException

Throws:: IOException

setHomepage

public void setHomepage(String value)
                 throws IOException

Throws:: IOException

setDefaultBranch

public void setDefaultBranch(String value)
                      throws IOException

Throws:: IOException

delete

public void delete()
            throws IOException

Deletes this repository.

Throws:: IOException

listForks
```
public PagedIterable<GHRepository> listForks()
```
Lists all the direct forks of this repository, sorted by github api default, currently ForkSort.NEWEST.

listForks
```
public PagedIterable<GHRepository> listForks(GHRepository.ForkSort sort)
```
Lists all the direct forks of this repository, sorted by the given sort order.

Parameters:

sort - the sort order. If null, defaults to github api default, currently ForkSort.NEWEST.

fork
```
public GHRepository fork()
                  throws IOException
```
Forks this repository as your repository.

Returns:

Newly forked repository that belong to you.

Throws:

IOException

forkTo
```
public GHRepository forkTo(GHOrganization org)
                    throws IOException
```
Forks this repository into an organization.

Returns:

Newly forked repository that belong to you.

Throws:

IOException

getPullRequest

public GHPullRequest getPullRequest(int i)
                             throws IOException

Retrieves a specified pull request.

Throws:: IOException

getPullRequests
```
public List<GHPullRequest> getPullRequests(GHIssueState state)
                                    throws IOException
```
Retrieves all the pull requests of a particular state.

Throws:

IOException

See Also:

listPullRequests(GHIssueState)

listPullRequests
```
public PagedIterable<GHPullRequest> listPullRequests(GHIssueState state)
```
Deprecated. Use queryPullRequests()

Retrieves all the pull requests of a particular state.

queryPullRequests

public GHPullRequestQueryBuilder queryPullRequests()

Retrieves pull requests.

createPullRequest
```
public GHPullRequest createPullRequest(String title,
                                       String head,
                                       String base,
                                       String body)
                                throws IOException
```
Creates a new pull request.

Parameters:

title - Required. The title of the pull request.

head - Required. The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

base - Required. The name of the branch you want your changes pulled into. This should be an existing branch on the current repository.

body - The contents of the pull request. This is the markdown description of a pull request.

Throws:

IOException

getHooks

public List<GHHook> getHooks()
                      throws IOException

Retrieves the currently configured hooks.

Throws:: IOException

getHook

public GHHook getHook(int id)
               throws IOException

Throws:: IOException

getCompare
```
public GHCompare getCompare(String id1,
                            String id2)
                     throws IOException
```
Gets a comparison between 2 points in the repository. This would be similar to calling git log id1...id2 against a local repository.

Parameters:

id1 - an identifier for the first point to compare from, this can be a sha1 ID (for a commit, tag etc) or a direct tag name

id2 - an identifier for the second point to compare to. Can be the same as the first point.

Returns:

the comparison output

Throws:

IOException - on failure communicating with GitHub

getCompare

public GHCompare getCompare(GHCommit id1,
                            GHCommit id2)
                     throws IOException

Throws:: IOException

getCompare

public GHCompare getCompare(GHBranch id1,
                            GHBranch id2)
                     throws IOException

Throws:: IOException

getRefs
```
public GHRef[] getRefs()
                throws IOException
```
Retrieves all refs for the github repository.

Returns:

an array of GHRef elements coresponding with the refs in the remote repository.

Throws:

IOException - on failure communicating with GitHub

listRefs
```
public PagedIterable<GHRef> listRefs()
                              throws IOException
```
Retrieves all refs for the github repository.

Returns:

paged iterable of all refs

Throws:

IOException - on failure communicating with GitHub, potentially due to an invalid ref type being requested

getRefs
```
public GHRef[] getRefs(String refType)
                throws IOException
```
Retrieves all refs of the given type for the current GitHub repository.

Parameters:

refType - the type of reg to search for e.g. tags or commits

Returns:

an array of all refs matching the request type

Throws:

IOException - on failure communicating with GitHub, potentially due to an invalid ref type being requested

listRefs
```
public PagedIterable<GHRef> listRefs(String refType)
                              throws IOException
```
Retrieves all refs of the given type for the current GitHub repository.

Parameters:

refType - the type of reg to search for e.g. tags or commits

Returns:

paged iterable of all refs of the specified type

Throws:

IOException - on failure communicating with GitHub, potentially due to an invalid ref type being requested

getRef
```
public GHRef getRef(String refName)
             throws IOException
```
Retrive a ref of the given type for the current GitHub repository.

Parameters:

refName - eg: heads/branch

Returns:

refs matching the request type

Throws:

IOException - on failure communicating with GitHub, potentially due to an invalid ref type being requested

getTagObject
```
public GHTagObject getTagObject(String sha)
                         throws IOException
```
Returns the annotated tag object. Only valid if the GHRef.getObject() has a GHRef.GHObject.getType() of tag.

Parameters:

sha - the sha of the tag object

Returns:

the annotated tag object

Throws:

IOException

getTree
```
public GHTree getTree(String sha)
               throws IOException
```
Retrive a tree of the given type for the current GitHub repository.

Parameters:

sha - - sha number or branch name ex: "master"

Returns:

refs matching the request type

Throws:

IOException - on failure communicating with GitHub, potentially due to an invalid tree type being requested

createTree
```
public GHTreeBuilder createTree()
```

getTreeRecursive
```
public GHTree getTreeRecursive(String sha,
                               int recursive)
                        throws IOException
```
Retrieves the tree for the current GitHub repository, recursively as described in here: https://developer.github.com/v3/git/trees/#get-a-tree-recursively

Parameters:

sha - - sha number or branch name ex: "master"

recursive - use 1

Throws:

IOException - on failure communicating with GitHub, potentially due to an invalid tree type being requested

getBlob
```
public GHBlob getBlob(String blobSha)
               throws IOException
```
Obtains the metadata & the content of a blob.
This method retrieves the whole content in memory, so beware when you are dealing with large BLOB.

Throws:

IOException

See Also:

Get a blob, readBlob(String)

createBlob
```
public GHBlobBuilder createBlob()
```

readBlob
```
public InputStream readBlob(String blobSha)
                     throws IOException
```
Reads the content of a blob as a stream for better efficiency.

Throws:

IOException

See Also:

Get a blob, getBlob(String)

getCommit

public GHCommit getCommit(String sha1)
                   throws IOException

Gets a commit object in this repository.

Throws:: IOException

createCommit
```
public GHCommitBuilder createCommit()
```

listCommits

public PagedIterable<GHCommit> listCommits()

Lists all the commits.

queryCommits
```
public GHCommitQueryBuilder queryCommits()
```
Search commits by specifying filters through a builder pattern.

listCommitComments
```
public PagedIterable<GHCommitComment> listCommitComments()
```
Lists up all the commit comments in this repository.

getLicense
```
@Preview
 @Deprecated
public GHLicense getLicense()
                                           throws IOException
```
Deprecated.

Gets the basic license details for the repository.
This is a preview item and subject to change.

Returns:

null if there's no license.

Throws:

IOException - as usual but also if you don't use the preview connector

getLicenseContent
```
@Preview
 @Deprecated
public GHContent getLicenseContent()
                                                  throws IOException
```
Deprecated.

Retrieves the contents of the repository's license file - makes an additional API call
This is a preview item and subject to change.

Returns:

details regarding the license contents, or null if there's no license.

Throws:

IOException - as usual but also if you don't use the preview connector

listCommitStatuses

public PagedIterable<GHCommitStatus> listCommitStatuses(String sha1)
                                                 throws IOException

/** Lists all the commit statues attached to the given commit, newer ones first.

Throws:: IOException

getLastCommitStatus

public GHCommitStatus getLastCommitStatus(String sha1)
                                   throws IOException

Gets the last status of this commit, which is what gets shown in the UI.

Throws:: IOException

createCommitStatus

public GHCommitStatus createCommitStatus(String sha1,
                                         GHCommitState state,
                                         String targetUrl,
                                         String description,
                                         String context)
                                  throws IOException

Creates a commit status

Parameters:: targetUrl - Optional parameter that points to the URL that has more details.; description - Optional short description.; context - Optinal commit status context.
Throws:: IOException

createCommitStatus

public GHCommitStatus createCommitStatus(String sha1,
                                         GHCommitState state,
                                         String targetUrl,
                                         String description)
                                  throws IOException

Throws:: IOException
See Also:: createCommitStatus(String, GHCommitState,String,String,String)

listEvents

public PagedIterable<GHEventInfo> listEvents()
                                      throws IOException

Lists repository events.

Throws:: IOException

listLabels
```
public PagedIterable<GHLabel> listLabels()
                                  throws IOException
```
Lists labels in this repository. https://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository

Throws:

IOException

getLabel

public GHLabel getLabel(String name)
                 throws IOException

Throws:: IOException

createLabel

public GHLabel createLabel(String name,
                           String color)
                    throws IOException

Throws:: IOException

listSubscribers
```
public PagedIterable<GHUser> listSubscribers()
```
Lists all the subscribers (aka watchers.) https://developer.github.com/v3/activity/watching/

listStargazers
```
public PagedIterable<GHUser> listStargazers()
```
Lists all the users who have starred this repo based on the old version of the API. For additional information, like date when the repository was starred, see listStargazers2()

listStargazers2
```
public PagedIterable<GHStargazer> listStargazers2()
```
Lists all the users who have starred this repo based on new version of the API, having extended information like the time when the repository was starred. For compatibility with the old API see listStargazers()

createHook
```
public GHHook createHook(String name,
                         Map<String,String> config,
                         Collection<GHEvent> events,
                         boolean active)
                  throws IOException
```
See https://api.github.com/hooks for possible names and their configuration scheme. TODO: produce type-safe binding

Parameters:

name - Type of the hook to be created. See https://api.github.com/hooks for possible names.

config - The configuration hash.

events - Can be null. Types of events to hook into.

Throws:

IOException

createWebHook

public GHHook createWebHook(URL url,
                            Collection<GHEvent> events)
                     throws IOException

Throws:: IOException

createWebHook

public GHHook createWebHook(URL url)
                     throws IOException

Throws:: IOException

getPostCommitHooks
```
public Set<URL> getPostCommitHooks()
```
Deprecated. Use getHooks() and createHook(String, Map, Collection, boolean)

Returns a set that represents the post-commit hook URLs. The returned set is live, and changes made to them are reflected to GitHub.

getBranches

public Map<String,GHBranch> getBranches()
                                 throws IOException

Gets branches by their names.

Throws:: IOException

getBranch

public GHBranch getBranch(String name)
                   throws IOException

Throws:: IOException

getMilestones

public Map<Integer,GHMilestone> getMilestones()
                                       throws IOException

Deprecated. Use listMilestones(GHIssueState)

Throws:: IOException

listMilestones

public PagedIterable<GHMilestone> listMilestones(GHIssueState state)

Lists up all the milestones in this repository.

getMilestone

public GHMilestone getMilestone(int number)
                         throws IOException

Throws:: IOException

getFileContent

public GHContent getFileContent(String path)
                         throws IOException

Throws:: IOException

getFileContent

public GHContent getFileContent(String path,
                                String ref)
                         throws IOException

Throws:: IOException

getDirectoryContent

public List<GHContent> getDirectoryContent(String path)
                                    throws IOException

Throws:: IOException

getDirectoryContent

public List<GHContent> getDirectoryContent(String path,
                                           String ref)
                                    throws IOException

Throws:: IOException

getReadme
```
public GHContent getReadme()
                    throws IOException
```
https://developer.github.com/v3/repos/contents/#get-the-readme

Throws:

IOException

createContent

public GHContentUpdateResponse createContent(String content,
                                             String commitMessage,
                                             String path)
                                      throws IOException

Throws:: IOException

createContent

public GHContentUpdateResponse createContent(String content,
                                             String commitMessage,
                                             String path,
                                             String branch)
                                      throws IOException

Throws:: IOException

createContent

public GHContentUpdateResponse createContent(byte[] contentBytes,
                                             String commitMessage,
                                             String path)
                                      throws IOException

Throws:: IOException

createContent

public GHContentUpdateResponse createContent(byte[] contentBytes,
                                             String commitMessage,
                                             String path,
                                             String branch)
                                      throws IOException

Throws:: IOException

createMilestone

public GHMilestone createMilestone(String title,
                                   String description)
                            throws IOException

Throws:: IOException

addDeployKey

public GHDeployKey addDeployKey(String title,
                                String key)
                         throws IOException

Throws:: IOException

getDeployKeys

public List<GHDeployKey> getDeployKeys()
                                throws IOException

Throws:: IOException

getSource
```
public GHRepository getSource()
                       throws IOException
```
Forked repositories have a 'source' attribute that specifies the ultimate source of the forking chain.

Returns:

GHRepository that points to the root repository where this repository is forked (indirectly or directly) from. Otherwise null.

Throws:

IOException

See Also:

getParent()

getParent
```
public GHRepository getParent()
                       throws IOException
```
Forked repositories have a 'parent' attribute that specifies the repository this repository is directly forked from. If we keep traversing getParent() until it returns null, that is getSource().

Returns:

GHRepository that points to the repository where this repository is forked directly from. Otherwise null.

Throws:

IOException

See Also:

getSource()

public GHSubscription subscribe(boolean subscribed,
                                boolean ignored)
                         throws IOException

Subscribes to this repository to get notifications.

Throws:: IOException

getSubscription
```
public GHSubscription getSubscription()
                               throws IOException
```
Returns the current subscription.

Returns:

null if no subscription exists.

Throws:

IOException

listContributors

public PagedIterable<GHRepository.Contributor> listContributors()
                                                         throws IOException

Throws:: IOException

renderMarkdown

public Reader renderMarkdown(String text,
                             MarkdownMode mode)
                      throws IOException

Render a Markdown document. In GFM mode, issue numbers and user mentions are linked accordingly.

Throws:: IOException
See Also:: GitHub.renderMarkdown(String)

listNotifications
```
public GHNotificationStream listNotifications()
```
List all the notifications in a repository for the current user.

getViewTraffic

public GHRepositoryViewTraffic getViewTraffic()
                                       throws IOException

https://developer.github.com/v3/repos/traffic/#views

Throws:: IOException

getCloneTraffic

public GHRepositoryCloneTraffic getCloneTraffic()
                                         throws IOException

https://developer.github.com/v3/repos/traffic/#clones

Throws:: IOException

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

Class GHRepository

Nested Class Summary

Field Summary

Fields inherited from class org.kohsuke.github.GHObject

Constructor Summary

Method Summary

Methods inherited from class org.kohsuke.github.GHObject

Methods inherited from class java.lang.Object

Constructor Detail

GHRepository

Method Detail

createDeployment

getDeploymentStatuses

listDeployments

getDeployment

createDeployStatus

getDescription

getHomepage

getGitTransportUrl

getHttpTransportUrl

gitHttpTransportUrl

getSvnUrl

getMirrorUrl

getSshUrl

getHtmlUrl

getName

getFullName

hasPullAccess

hasPushAccess

hasAdminAccess

getLanguage

getOwner

getIssue

createIssue

getIssues

getIssues

listIssues

createRelease

createRef

getReleases

getLatestRelease

listReleases

listTags

listLanguages

getOwnerName

hasIssues

hasWiki

isFork

getForks

getStargazersCount

isPrivate

hasDownloads

hasPages

getWatchers

getOpenIssueCount

getNetworkCount

getSubscribersCount

getPushedAt

getDefaultBranch

getMasterBranch

getSize

getCollaborators

listCollaborators

listAssignees

hasAssignee

getCollaboratorNames

getPermission

getPermission

getTeams

addCollaborators

addCollaborators

removeCollaborators

removeCollaborators

setEmailServiceHook

enableIssueTracker

enableWiki

enableDownloads

renameTo

setDescription

setHomepage