Package org.kohsuke.github
Class GHProject
- java.lang.Object
-
- org.kohsuke.github.GHObject
-
- org.kohsuke.github.GHProject
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GHProject.ProjectState
The enum ProjectState.static class
GHProject.ProjectStateFilter
The enum ProjectStateFilter.
-
Field Summary
Fields Modifier and Type Field Description protected GHObject
owner
The owner.-
Fields inherited from class org.kohsuke.github.GHObject
responseHeaderFields
-
-
Constructor Summary
Constructors Constructor Description GHProject()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description GHProjectColumn
createColumn(String name)
Create column gh project column.void
delete()
Delete.protected String
getApiRoute()
Gets api route.String
getBody()
Gets body.GHUser
getCreator()
Gets creator.URL
getHtmlUrl()
Gets the html url.String
getName()
Gets name.String
getNode_id()
Deprecated.int
getNumber()
Gets number.GHObject
getOwner()
Gets owner.URL
getOwnerUrl()
Gets owner url.GitHub
getRoot()
Deprecated.For access to theGitHub
instance, use a local copy instead of pulling it out of objects.GHProject.ProjectState
getState()
Gets state.PagedIterable<GHProjectColumn>
listColumns()
List columns paged iterable.void
setBody(String body)
Sets body.void
setName(String name)
Sets name.void
setOrganizationPermission(GHPermissionType permission)
Set the permission level that all members of the project's organization will have on this project.void
setPublic(boolean isPublic)
Sets visibility of the project within the organization.void
setState(GHProject.ProjectState state)
Sets state.GHProject
wrap(GHRepository repo)
Deprecated.GHProject
wrap(GitHub root)
Deprecated.-
Methods inherited from class org.kohsuke.github.GHObject
getCreatedAt, getId, getNodeId, getResponseHeaderFields, getUpdatedAt, getUrl, setResponseHeaderFields, toString
-
-
-
-
Field Detail
-
owner
protected GHObject owner
The owner.
-
-
Method Detail
-
getHtmlUrl
public URL getHtmlUrl() throws IOException
Gets the html url.- Specified by:
getHtmlUrl
in classGHObject
- Returns:
- the html url
- Throws:
IOException
- Signals that an I/O exception has occurred.
-
getOwner
public GHObject getOwner() throws IOException
Gets owner.- Returns:
- the owner
- Throws:
IOException
- the io exception
-
getOwnerUrl
public URL getOwnerUrl()
Gets owner url.- Returns:
- the owner url
-
getNode_id
@Deprecated public String getNode_id()
Deprecated.Gets node id.- Returns:
- the node id
-
getName
public String getName()
Gets name.- Returns:
- the name
-
getBody
public String getBody()
Gets body.- Returns:
- the body
-
getNumber
public int getNumber()
Gets number.- Returns:
- the number
-
getState
public GHProject.ProjectState getState()
Gets state.- Returns:
- the state
-
getCreator
public GHUser getCreator()
Gets creator.- Returns:
- the creator
-
wrap
@Deprecated public GHProject wrap(GitHub root)
Deprecated.Wrap gh project.- Parameters:
root
- the root- Returns:
- the gh project
-
wrap
@Deprecated public GHProject wrap(GHRepository repo)
Deprecated.Wrap gh project.- Parameters:
repo
- the repo- Returns:
- the gh project
-
getApiRoute
protected String getApiRoute()
Gets api route.- Returns:
- the api route
-
setName
public void setName(String name) throws IOException
Sets name.- Parameters:
name
- the name- Throws:
IOException
- the io exception
-
setBody
public void setBody(String body) throws IOException
Sets body.- Parameters:
body
- the body- Throws:
IOException
- the io exception
-
setState
public void setState(GHProject.ProjectState state) throws IOException
Sets state.- Parameters:
state
- the state- Throws:
IOException
- the io exception
-
setOrganizationPermission
public void setOrganizationPermission(GHPermissionType permission) throws IOException
Set the permission level that all members of the project's organization will have on this project. Only applicable for organization-owned projects.- Parameters:
permission
- the permission- Throws:
IOException
- the io exception
-
setPublic
public void setPublic(boolean isPublic) throws IOException
Sets visibility of the project within the organization. Only applicable for organization-owned projects.- Parameters:
isPublic
- the is public- Throws:
IOException
- the io exception
-
delete
public void delete() throws IOException
Delete.- Throws:
IOException
- the io exception
-
listColumns
public PagedIterable<GHProjectColumn> listColumns() throws IOException
List columns paged iterable.- Returns:
- the paged iterable
- Throws:
IOException
- the io exception
-
createColumn
public GHProjectColumn createColumn(String name) throws IOException
Create column gh project column.- Parameters:
name
- the name- Returns:
- the gh project column
- Throws:
IOException
- the io exception
-
getRoot
@Deprecated public GitHub getRoot()
Deprecated.For access to theGitHub
instance, use a local copy instead of pulling it out of objects.Get the rootGitHub
instance for this object.- Returns:
- the root
GitHub
instance
-
-