GitlabAPI (Gitlab Java API Wrapper 1.2.8 API)

java.lang.Object
- org.gitlab.api.GitlabAPI

```
public class GitlabAPI
extends Object
```
Gitlab API Wrapper class

Author:

@timols (Tim O)

Field Summary

Fields
Modifier and Type Field and Description

static com.fasterxml.jackson.databind.ObjectMapper MAPPER

Fields
Modifier and Type	Field and Description
`static com.fasterxml.jackson.databind.ObjectMapper`	`MAPPER`

Method Summary

Methods
Modifier and Type	Method and Description
`GitlabMergeRequest`	`acceptMergeRequest(GitlabProject project, Integer mergeRequestId, String mergeCommitMessage)`
`GitlabGroupMember`	`addGroupMember(GitlabGroup group, GitlabUser user, GitlabAccessLevel accessLevel)` Add a group member.
`GitlabGroupMember`	`addGroupMember(Integer groupId, Integer userId, GitlabAccessLevel accessLevel)` Add a group member.
`GitlabProjectHook`	`addProjectHook(GitlabProject project, String url)`
`GitlabProjectHook`	`addProjectHook(GitlabProject project, String url, String token)`
`GitlabProjectHook`	`addProjectHook(Serializable projectId, String url, boolean pushEvents, boolean issuesEvents, boolean mergeRequestEvents, boolean tagPushEvents, boolean sslVerification)`
`GitlabProjectMember`	`addProjectMember(GitlabProject project, GitlabUser user, GitlabAccessLevel accessLevel)` Add a project member.
`GitlabProjectMember`	`addProjectMember(Integer projectId, Integer userId, GitlabAccessLevel accessLevel)` Add a project member.
`GitlabSystemHook`	`addSystemHook(String url)` Add new system hook hook
`GitlabTag`	`addTag(GitlabProject project, String tagName, String ref, String message, String releaseDescription)` Create tag in specific project
`GitlabTag`	`addTag(Serializable projectId, String tagName, String ref, String message, String releaseDescription)` Create tag in specific project
`void`	`blockUser(Integer targetUserId)` Block a user
`GitlabCommitComparison`	`compareCommits(Serializable projectId, String commitHash1, String commitHash2)`
`GitlabCommitComparison`	`compareCommits(Serializable projectId, String commitHash1, String commitHash2, Pagination pagination)`
`static GitlabAPI`	`connect(String hostUrl, String apiToken)`
`static GitlabSession`	`connect(String hostUrl, String username, String password)`
`static GitlabAPI`	`connect(String hostUrl, String apiToken, TokenType tokenType)`
`static GitlabAPI`	`connect(String hostUrl, String apiToken, TokenType tokenType, AuthMethod method)`
`GitlabAward`	`createAward(GitlabIssue issue, Integer noteId, String awardName)` Create an award for an issue note
`GitlabAward`	`createAward(GitlabIssue issue, String awardName)` Create an award for an issue
`GitlabAward`	`createAward(GitlabMergeRequest mergeRequest, String awardName)` Create an award for a merge request
`void`	`createBranch(GitlabProject project, String branchName, String ref)` Create Branch.
`void`	`createBranch(Serializable projectId, String branchName, String ref)` Create Branch.
`GitlabBuildVariable`	`createBuildVariable(Integer projectId, GitlabBuildVariable variable)` Creates a new variable.
`GitlabBuildVariable`	`createBuildVariable(Integer projectId, String key, String value)` Creates a new build variable.
`CommitComment`	`createCommitComment(Integer projectId, String sha, String note, String path, String line, String line_type)` Post comment to commit
`GitlabCommitStatus`	`createCommitStatus(GitlabProject project, String commitHash, String state, String ref, String name, String targetUrl, String description)`
`GitlabSSHKey`	`createDeployKey(Integer targetProjectId, String title, String key)` Create a new deploy key for the project
`GitlabGroup`	`createGroup(String name)` Creates a Group
`GitlabGroup`	`createGroup(String name, String path)` Creates a Group
`GitlabGroup`	`createGroup(String name, String path, String ldapCn, GitlabAccessLevel ldapAccess)` Creates a Group
`GitlabGroup`	`createGroup(String name, String path, String ldapCn, GitlabAccessLevel ldapAccess, GitlabUser sudoUser)` Creates a Group
`GitlabGroup`	`createGroupViaSudo(String name, String path, GitlabUser sudoUser)` Creates a Group
`GitlabIssue`	`createIssue(int projectId, int assigneeId, Integer milestoneId, String labels, String description, String title)`
`GitlabLabel`	`createLabel(Serializable projectId, GitlabLabel label)` Creates a new label.
`GitlabLabel`	`createLabel(Serializable projectId, String name, String color)` Creates a new label.
`GitlabMergeRequest`	`createMergeRequest(Serializable projectId, String sourceBranch, String targetBranch, Integer assigneeId, String title)` Create a new MergeRequest
`GitlabMilestone`	`createMilestone(Serializable projectId, GitlabMilestone milestone)` Creates a new project milestone.
`GitlabMilestone`	`createMilestone(Serializable projectId, String title, String description, Date dueDate)` Cretaes a new project milestone.
`GitlabNote`	`createNote(GitlabIssue issue, String message)`
`GitlabNote`	`createNote(GitlabMergeRequest mergeRequest, String body)`
`GitlabNote`	`createNote(Serializable projectId, Integer issueId, String message)`
`GitlabProject`	`createProject(String name)` Creates a private Project
`GitlabProject`	`createProject(String name, Integer namespaceId, String description, Boolean issuesEnabled, Boolean wallEnabled, Boolean mergeRequestsEnabled, Boolean wikiEnabled, Boolean snippetsEnabled, Boolean publik, Integer visibilityLevel, String importUrl)` Deprecated.
`GitlabProject`	`createProjectForGroup(String name, GitlabGroup group)` Creates a group Project
`GitlabProject`	`createProjectForGroup(String name, GitlabGroup group, String description)` Creates a group Project
`GitlabProject`	`createProjectForGroup(String name, GitlabGroup group, String description, Integer visibilityLevel)` Creates a group Project
`GitlabSSHKey`	`createSSHKey(Integer targetUserId, String title, String key)` Create a new ssh key for the user
`GitlabUser`	`createUser(String email, String password, String username, String fullName, String skypeId, String linkedIn, String twitter, String website_url, Integer projects_limit, String extern_uid, String extern_provider_name, String bio, Boolean isAdmin, Boolean can_create_group, Boolean skip_confirmation)` Create a new User
`GitlabProject`	`createUserProject(Integer userId, String name)` Creates a Project for a specific User
`GitlabProject`	`createUserProject(Integer userId, String name, String description, String defaultBranch, Boolean issuesEnabled, Boolean wallEnabled, Boolean mergeRequestsEnabled, Boolean wikiEnabled, Boolean snippetsEnabled, Boolean publik, Integer visibilityLevel, String importUrl)` Deprecated.
`void`	`deleteAward(GitlabIssue issue, GitlabAward award)` Delete an award for an issue
`void`	`deleteAward(GitlabIssue issue, Integer noteId, GitlabAward award)` Delete an award for an issue note
`void`	`deleteAward(GitlabMergeRequest mergeRequest, GitlabAward award)` Delete an award for a merge request
`void`	`deleteBranch(Serializable projectId, String branchName)` Delete Branch.
`void`	`deleteBuildVariable(Integer projectId, GitlabBuildVariable variable)` Deletes an existing variable.
`void`	`deleteBuildVariable(Integer projectId, String key)` Deletes an existing variable.
`void`	`deleteDeployKey(Integer targetProjectId, Integer targetKeyId)` Delete a deploy key for a project
`void`	`deleteGroup(Integer groupId)` Delete a group.
`void`	`deleteGroupMember(GitlabGroup group, GitlabUser user)` Delete a group member.
`void`	`deleteGroupMember(Integer groupId, Integer userId)` Delete a group member.
`void`	`deleteLabel(Serializable projectId, GitlabLabel label)` Deletes an existing label.
`void`	`deleteLabel(Serializable projectId, String name)` Deletes an existing label.
`void`	`deleteNote(GitlabIssue issue, GitlabNote noteToDelete)` Delete an Issue Note
`void`	`deleteNote(GitlabMergeRequest mergeRequest, GitlabNote noteToDelete)` Delete a Merge Request Note
`void`	`deleteNote(Serializable projectId, Integer issueId, GitlabNote noteToDelete)` Delete an Issue Note
`void`	`deleteProject(Serializable projectId)` Delete a Project.
`void`	`deleteProjectHook(GitlabProjectHook hook)`
`void`	`deleteProjectHook(GitlabProject project, String hookId)`
`void`	`deleteProjectMember(GitlabProject project, GitlabUser user)` Delete a project team member.
`void`	`deleteProjectMember(Integer projectId, Integer userId)` Delete a project team member.
`void`	`deleteSSHKey(Integer targetUserId, Integer targetKeyId)` Delete user's ssh key
`GitlabSystemHook`	`deleteSystemHook(Integer hookId)` Delete system hook
`void`	`deleteTag(GitlabProject project, String tagName)` Delete tag in specific project
`void`	`deleteTag(Serializable projectId, String tagName)` Delete tag in specific project
`void`	`deleteUser(Integer targetUserId)` Delete a user
`GitlabHTTPRequestor`	`dispatch()`
`GitlabIssue`	`editIssue(int projectId, int issueId, int assigneeId, int milestoneId, String labels, String description, String title, GitlabIssue.Action action)`
`GitlabProjectHook`	`editProjectHook(GitlabProject project, String hookId, String url)`
`List<GitlabUser>`	`findUsers(String emailOrUsername)` Finds users by email address or username.
`List<GitlabAward>`	`getAllAwards(GitlabIssue issue)` Get all awards for an issue
`List<GitlabAward>`	`getAllAwards(GitlabIssue issue, Integer noteId)` Get all awards for an issue note
`List<GitlabAward>`	`getAllAwards(GitlabMergeRequest mergeRequest)` Get all awards for a merge request
`List<GitlabCommit>`	`getAllCommits(Serializable projectId)`
`List<GitlabCommit>`	`getAllCommits(Serializable projectId, Pagination pagination, String branchOrTag)`
`List<GitlabCommit>`	`getAllCommits(Serializable projectId, String branchOrTag)`
`List<GitlabMergeRequest>`	`getAllMergeRequests(GitlabProject project)`
`List<GitlabNote>`	`getAllNotes(GitlabMergeRequest mergeRequest)`
`List<GitlabProject>`	`getAllProjects()` Get's all projects in Gitlab, requires sudo user
`URL`	`getAPIUrl(String tailAPIUrl)`
`GitlabAward`	`getAward(GitlabIssue issue, Integer awardId)` Get a specific award for an issue
`GitlabAward`	`getAward(GitlabIssue issue, Integer noteId, Integer awardId)` Get a specific award for an issue note
`GitlabAward`	`getAward(GitlabMergeRequest mergeRequest, Integer awardId)` Get a specific award for a merge request
`GitlabBranch`	`getBranch(GitlabProject project, String branchName)`
`GitlabBranch`	`getBranch(Serializable projectId, String branchName)`
`List<GitlabBranch>`	`getBranches(GitlabProject project)`
`List<GitlabBranch>`	`getBranches(Serializable projectId)`
`byte[]`	`getBuildArtifact(GitlabProject project, GitlabBuild build)` Get build artifacts of a project build
`byte[]`	`getBuildArtifact(Integer projectId, Integer buildId)` Get build artifacts of a project build
`List<GitlabTrigger>`	`getBuildTriggers(GitlabProject project)` Returns the list of build triggers for a project.
`GitlabBuildVariable`	`getBuildVariable(GitlabProject project, String key)` Gets build variable associated with a project and key.
`GitlabBuildVariable`	`getBuildVariable(Integer projectId, String key)` Gets build variable associated with a project and key.
`List<GitlabBuildVariable>`	`getBuildVariables(GitlabProject project)` Gets build variables associated with a project.
`List<GitlabBuildVariable>`	`getBuildVariables(Integer projectId)` Gets build variables associated with a project.
`GitlabCommit`	`getCommit(Serializable projectId, String commitHash)`
`List<GitlabBuild>`	`getCommitBuilds(GitlabProject projectId, String commitHash)`
`List<GitlabBuild>`	`getCommitBuilds(Serializable projectId, String commitHash)`
`List<CommitComment>`	`getCommitComments(Integer projectId, String sha)` Get the comments of a commit
`List<GitlabCommitDiff>`	`getCommitDiffs(Serializable projectId, String commitHash)`
`List<GitlabCommitDiff>`	`getCommitDiffs(Serializable projectId, String commitHash, Pagination pagination)`
`List<GitlabCommit>`	`getCommits(GitlabMergeRequest mergeRequest)`
`List<GitlabCommit>`	`getCommits(GitlabMergeRequest mergeRequest, Pagination pagination)`
`List<GitlabCommit>`	`getCommits(Serializable projectId, Pagination pagination, String branchOrTag)`
`List<GitlabCommitStatus>`	`getCommitStatuses(GitlabProject project, String commitHash)`
`List<GitlabCommitStatus>`	`getCommitStatuses(GitlabProject project, String commitHash, Pagination pagination)`
`GitlabSession`	`getCurrentSession()`
`List<GitlabSSHKey>`	`getDeployKeys(Integer targetProjectId)` Gets all deploy keys for a project
`GitlabServiceEmailOnPush`	`getEmailsOnPush(Integer projectId)` Gets email-on-push service setup for a projectId.
`byte[]`	`getFileArchive(GitlabProject project)` Get an archive of the repository
`GitlabGroup`	`getGroup(Integer groupId)`
`GitlabGroup`	`getGroup(String path)` Get a group by path
`List<GitlabGroupMember>`	`getGroupMembers(GitlabGroup group)` Gets all members of a Group
`List<GitlabGroupMember>`	`getGroupMembers(Integer groupId)` Gets all members of a Group
`List<GitlabProject>`	`getGroupProjects(GitlabGroup group)` Get all the projects for a group.
`List<GitlabProject>`	`getGroupProjects(Integer groupId)` Get all the projects for a group.
`List<GitlabGroup>`	`getGroups()`
`List<GitlabGroup>`	`getGroupsViaSudo(String username, Pagination pagination)`
`GitlabIssue`	`getIssue(Serializable projectId, Integer issueId)`
`List<GitlabIssue>`	`getIssues(GitlabProject project)`
`List<GitlabLabel>`	`getLabels(GitlabProject project)` Gets labels associated with a project.
`List<GitlabLabel>`	`getLabels(Serializable projectId)` Gets labels associated with a project.
`List<GitlabCommit>`	`getLastCommits(Serializable projectId)`
`List<GitlabCommit>`	`getLastCommits(Serializable projectId, String branchOrTag)`
`GitlabMergeRequest`	`getMergeRequest(GitlabProject project, Integer mergeRequestId)`
`GitlabMergeRequest`	`getMergeRequestByIid(Serializable projectId, Integer mergeRequestIid)` Return Merge Request.
`GitlabMergeRequest`	`getMergeRequestChanges(Serializable projectId, Integer mergeRequestId)` Return a Merge Request including its changes.
`List<GitlabMergeRequest>`	`getMergeRequests(GitlabProject project)`
`List<GitlabMergeRequest>`	`getMergeRequests(Serializable projectId)`
`List<GitlabMilestone>`	`getMilestones(GitlabProject project)`
`List<GitlabMilestone>`	`getMilestones(Serializable projectId)`
`List<GitlabProjectMember>`	`getNamespaceMembers(GitlabNamespace namespace)` This will fail, if the given namespace is a user and not a group
`List<GitlabProjectMember>`	`getNamespaceMembers(Integer namespaceId)` This will fail, if the given namespace is a user and not a group
`GitlabNote`	`getNote(GitlabIssue issue, Integer noteId)`
`GitlabNote`	`getNote(GitlabMergeRequest mergeRequest, Integer noteId)` Get a Note from a Merge Request.
`List<GitlabNote>`	`getNotes(GitlabIssue issue)`
`List<GitlabNote>`	`getNotes(GitlabMergeRequest mergeRequest)`
`List<GitlabMergeRequest>`	`getOpenMergeRequests(GitlabProject project)`
`List<GitlabMergeRequest>`	`getOpenMergeRequests(Serializable projectId)`
`List<GitlabProject>`	`getOwnedProjects()` Get a list of projects owned by the authenticated user.
`GitlabProject`	`getProject(Serializable projectId)`
`GitlabProject`	`getProject(String namespace, String projectName)` use namespace & project name to get project
`GitlabBuild`	`getProjectBuild(Integer projectId, Integer buildId)` Gets a build for a project
`List<GitlabBuild>`	`getProjectBuilds(GitlabProject project)` Gets a list of a project's builds in Gitlab
`List<GitlabBuild>`	`getProjectBuilds(Integer projectId)` Gets a list of a project's builds in Gitlab
`GitlabProjectHook`	`getProjectHook(GitlabProject project, String hookId)`
`List<GitlabProjectHook>`	`getProjectHooks(GitlabProject project)`
`List<GitlabProjectHook>`	`getProjectHooks(Serializable projectId)`
`List<GitlabProjectMember>`	`getProjectMembers(GitlabProject project)`
`List<GitlabProjectMember>`	`getProjectMembers(GitlabProject project, Pagination pagination)`
`List<GitlabProjectMember>`	`getProjectMembers(Serializable projectId)`
`List<GitlabProjectMember>`	`getProjectMembers(Serializable projectId, Pagination pagination)`
`List<GitlabProject>`	`getProjects()` Get a list of projects accessible by the authenticated user.
`List<GitlabProject>`	`getProjectsViaSudo(GitlabUser user)` Get a list of projects accessible by the authenticated user.
`Proxy`	`getProxy()`
`byte[]`	`getRawBlobContent(GitlabProject project, String sha)` Get the raw file contents for a blob by blob SHA.
`byte[]`	`getRawFileContent(GitlabProject project, String sha, String filepath)` Get raw file content
`byte[]`	`getRawFileContent(Integer projectId, String sha, String filepath)` Get raw file content
`GitlabRepositoryFile`	`getRepositoryFile(GitlabProject project, String path, String ref)`
`List<GitlabRepositoryTree>`	`getRepositoryTree(GitlabProject project, String path, String ref_name, boolean recursive)` Get an archive of the repository
`int`	`getRequestTimeout()`
`GitlabSSHKey`	`getSSHKey(Integer keyId)` Get key with user information by ID of an SSH key.
`List<GitlabSSHKey>`	`getSSHKeys(Integer targetUserId)` Gets all ssh keys for a user
`List<GitlabSystemHook>`	`getSystemHooks()` Get list of system hooks
`List<GitlabTag>`	`getTags(GitlabProject project)` Get a list of tags in specific project
`List<GitlabTag>`	`getTags(Serializable projectId)` Get a list of tags in specific project
`URL`	`getUrl(String tailAPIUrl)`
`GitlabUser`	`getUser()` Return API User
`GitlabUser`	`getUser(Integer userId)`
`String`	`getUserAgent()`
`List<GitlabUser>`	`getUsers()`
`GitlabUser`	`getUserViaSudo(String username)`
`GitlabVersion`	`getVersion()`
`GitlabAPI`	`ignoreCertificateErrors(boolean ignoreCertificateErrors)`
`boolean`	`isIgnoreCertificateErrors()`
`GitlabIssue`	`moveIssue(Integer projectId, Integer issueId, Integer toProjectId)`
`void`	`protectBranch(GitlabProject project, String branchName)`
`GitlabAPI`	`proxy(Proxy proxy)`
`GitlabHTTPRequestor`	`retrieve()`
`List<GitlabProject>`	`searchProjects(String query)` Get a list of projects accessible by the authenticated user by search.
`GitlabAPI`	`setRequestTimeout(int requestTimeout)`
`void`	`setUserAgent(String userAgent)` Set the User-Agent header for the requests.
`void`	`testSystemHook(Integer hookId)` Test system hook
`void`	`transfer(Integer namespaceId, Integer projectId)` Transfer a project to the given namespace
`void`	`unblockUser(Integer targetUserId)` Unblock a user
`void`	`unprotectBranch(GitlabProject project, String branchName)`
`GitlabBuildVariable`	`updateBuildVariable(Integer projectId, String key, String newValue)` Updates an existing variable.
`boolean`	`updateEmailsOnPush(Integer projectId, String emailAddress)` Update recipients for email-on-push service for a projectId.
`GitlabLabel`	`updateLabel(Serializable projectId, String name, String newName, String newColor)` Updates an existing label.
`GitlabMergeRequest`	`updateMergeRequest(Serializable projectId, Integer mergeRequestId, String targetBranch, Integer assigneeId, String title, String description, String stateEvent, String labels)` Updates a Merge Request
`GitlabMilestone`	`updateMilestone(GitlabMilestone edited, String stateEvent)` Updates an existing project milestone.
`GitlabMilestone`	`updateMilestone(Serializable projectId, GitlabMilestone edited, String stateEvent)` Updates an existing project milestone.
`GitlabMilestone`	`updateMilestone(Serializable projectId, int milestoneId, String title, String description, Date dueDate, String stateEvent)` Updates an existing project milestone.
`GitlabNote`	`updateNote(GitlabMergeRequest mergeRequest, Integer noteId, String body)` Update a Merge Request Note
`GitlabProject`	`updateProject(Integer projectId, String name, String description, String defaultBranch, Boolean issuesEnabled, Boolean wallEnabled, Boolean mergeRequestsEnabled, Boolean wikiEnabled, Boolean snippetsEnabled, Boolean publik, Integer visibilityLevel)` Deprecated.
`GitlabUser`	`updateUser(Integer targetUserId, String email, String password, String username, String fullName, String skypeId, String linkedIn, String twitter, String website_url, Integer projects_limit, String extern_uid, String extern_provider_name, String bio, Boolean isAdmin, Boolean can_create_group)` Update a user
`GitlabUpload`	`uploadFile(GitlabProject project, File file)` Uploads a file to a project

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

Field Detail

MAPPER

public static final com.fasterxml.jackson.databind.ObjectMapper MAPPER

Method Detail

connect

public static GitlabSession connect(String hostUrl,
                    String username,
                    String password)
                             throws IOException

Throws:: IOException

connect

public static GitlabAPI connect(String hostUrl,
                String apiToken)

connect

public static GitlabAPI connect(String hostUrl,
                String apiToken,
                TokenType tokenType)

connect

public static GitlabAPI connect(String hostUrl,
                String apiToken,
                TokenType tokenType,
                AuthMethod method)

ignoreCertificateErrors

public GitlabAPI ignoreCertificateErrors(boolean ignoreCertificateErrors)

proxy
```
public GitlabAPI proxy(Proxy proxy)
```

getRequestTimeout
```
public int getRequestTimeout()
```

setRequestTimeout

public GitlabAPI setRequestTimeout(int requestTimeout)

retrieve
```
public GitlabHTTPRequestor retrieve()
```

dispatch
```
public GitlabHTTPRequestor dispatch()
```

isIgnoreCertificateErrors

public boolean isIgnoreCertificateErrors()

getProxy
```
public Proxy getProxy()
```

getAPIUrl

public URL getAPIUrl(String tailAPIUrl)
              throws IOException

Throws:: IOException

getUrl

public URL getUrl(String tailAPIUrl)
           throws IOException

Throws:: IOException

getUsers

public List<GitlabUser> getUsers()
                          throws IOException

Throws:: IOException

findUsers
```
public List<GitlabUser> findUsers(String emailOrUsername)
                           throws IOException
```
Finds users by email address or username.

Parameters:
emailOrUsername - Some portion of the email address or username

Returns:
A non-null List of GitlabUser instances. If the search term is null or empty a List with zero GitlabUsers is returned.

Throws:

IOException

getUser

public GitlabUser getUser()
                   throws IOException

Return API User

Throws:: IOException

getUser

public GitlabUser getUser(Integer userId)
                   throws IOException

Throws:: IOException

getUserViaSudo

public GitlabUser getUserViaSudo(String username)
                          throws IOException

Throws:: IOException

createUser

public GitlabUser createUser(String email,
                    String password,
                    String username,
                    String fullName,
                    String skypeId,
                    String linkedIn,
                    String twitter,
                    String website_url,
                    Integer projects_limit,
                    String extern_uid,
                    String extern_provider_name,
                    String bio,
                    Boolean isAdmin,
                    Boolean can_create_group,
                    Boolean skip_confirmation)
                      throws IOException

Create a new User

Parameters:: email - User email; password - Password; username - User name; fullName - Full name; skypeId - Skype Id; linkedIn - LinkedIn; twitter - Twitter; website_url - Website URL; projects_limit - Projects limit; extern_uid - External User ID; extern_provider_name - External Provider Name; bio - Bio; isAdmin - Is Admin; can_create_group - Can Create Group; skip_confirmation - Skip Confirmation
Returns:: A GitlabUser
Throws:: IOException - on gitlab api call error
See Also:: http://doc.gitlab.com/ce/api/users.html

updateUser

public GitlabUser updateUser(Integer targetUserId,
                    String email,
                    String password,
                    String username,
                    String fullName,
                    String skypeId,
                    String linkedIn,
                    String twitter,
                    String website_url,
                    Integer projects_limit,
                    String extern_uid,
                    String extern_provider_name,
                    String bio,
                    Boolean isAdmin,
                    Boolean can_create_group)
                      throws IOException

Update a user

Parameters:: targetUserId - User ID; email - User email; password - Password; username - User name; fullName - Full name; skypeId - Skype Id; linkedIn - LinkedIn; twitter - Twitter; website_url - Website URL; projects_limit - Projects limit; extern_uid - External User ID; extern_provider_name - External Provider Name; bio - Bio; isAdmin - Is Admin; can_create_group - Can Create Group
Returns:: The Updated User
Throws:: IOException - on gitlab api call error

blockUser
```
public void blockUser(Integer targetUserId)
               throws IOException
```
Block a user

Parameters:
targetUserId - The id of the Gitlab user

Throws:

IOException - on gitlab api call error

unblockUser
```
public void unblockUser(Integer targetUserId)
                 throws IOException
```
Unblock a user

Parameters:
targetUserId - The id of the Gitlab user

Throws:

IOException - on gitlab api call error

createSSHKey

public GitlabSSHKey createSSHKey(Integer targetUserId,
                        String title,
                        String key)
                          throws IOException

Create a new ssh key for the user

Parameters:: targetUserId - The id of the Gitlab user; title - The title of the ssh key; key - The public key
Returns:: The new GitlabSSHKey
Throws:: IOException - on gitlab api call error

deleteSSHKey
```
public void deleteSSHKey(Integer targetUserId,
                Integer targetKeyId)
                  throws IOException
```
Delete user's ssh key

Parameters:
targetUserId - The id of the Gitlab user
targetKeyId - The id of the Gitlab ssh key

Throws:

IOException - on gitlab api call error

getSSHKeys
```
public List<GitlabSSHKey> getSSHKeys(Integer targetUserId)
                              throws IOException
```
Gets all ssh keys for a user

Parameters:
targetUserId - The id of the GitLab User

Returns:
The list of user ssh keys

Throws:

IOException - on gitlab api call error

getSSHKey
```
public GitlabSSHKey getSSHKey(Integer keyId)
                       throws IOException
```
Get key with user information by ID of an SSH key.

Parameters:
keyId - The ID of an SSH key

Returns:
The SSH key with user information

Throws:

IOException - on gitlab api call error

deleteUser
```
public void deleteUser(Integer targetUserId)
                throws IOException
```
Delete a user

Parameters:
targetUserId - The target User ID

Throws:

IOException - on gitlab api call error

getGroup

public GitlabGroup getGroup(Integer groupId)
                     throws IOException

Throws:: IOException

getGroup

public GitlabGroup getGroup(String path)
                     throws IOException

Get a group by path

Parameters:: path - Path of the group
Returns:
Throws:: IOException

getGroups

public List<GitlabGroup> getGroups()
                            throws IOException

Throws:: IOException

getGroupsViaSudo

public List<GitlabGroup> getGroupsViaSudo(String username,
                                 Pagination pagination)
                                   throws IOException

Throws:: IOException

getGroupProjects
```
public List<GitlabProject> getGroupProjects(GitlabGroup group)
                                     throws IOException
```
Get all the projects for a group.

Parameters:
group - the target group

Returns:
a list of projects for the group

Throws:

IOException

getGroupProjects
```
public List<GitlabProject> getGroupProjects(Integer groupId)
                                     throws IOException
```
Get all the projects for a group.

Parameters:
groupId - the target group's id.

Returns:
a list of projects for the group

Throws:

IOException

getGroupMembers
```
public List<GitlabGroupMember> getGroupMembers(GitlabGroup group)
                                        throws IOException
```
Gets all members of a Group

Parameters:
group - The GitLab Group

Returns:
The Group Members

Throws:

IOException - on gitlab api call error

getGroupMembers
```
public List<GitlabGroupMember> getGroupMembers(Integer groupId)
                                        throws IOException
```
Gets all members of a Group

Parameters:
groupId - The id of the GitLab Group

Returns:
The Group Members

Throws:

IOException - on gitlab api call error

createGroup
```
public GitlabGroup createGroup(String name)
                        throws IOException
```
Creates a Group

Parameters:
name - The name of the group. The name will also be used as the path of the group.

Returns:
The GitLab Group

Throws:

IOException - on gitlab api call error

createGroup
```
public GitlabGroup createGroup(String name,
                      String path)
                        throws IOException
```
Creates a Group

Parameters:
name - The name of the group
path - The path for the group

Returns:
The GitLab Group

Throws:

IOException - on gitlab api call error

createGroupViaSudo

public GitlabGroup createGroupViaSudo(String name,
                             String path,
                             GitlabUser sudoUser)
                               throws IOException

Creates a Group

Parameters:: name - The name of the group; path - The path for the group; sudoUser - The user to create the group on behalf of
Returns:: The GitLab Group
Throws:: IOException - on gitlab api call error

createGroup

public GitlabGroup createGroup(String name,
                      String path,
                      String ldapCn,
                      GitlabAccessLevel ldapAccess)
                        throws IOException

Creates a Group

Parameters:: name - The name of the group; path - The path for the group; ldapCn - LDAP Group Name to sync with, null otherwise; ldapAccess - Access level for LDAP group members, null otherwise
Returns:: The GitLab Group
Throws:: IOException - on gitlab api call error

createGroup

public GitlabGroup createGroup(String name,
                      String path,
                      String ldapCn,
                      GitlabAccessLevel ldapAccess,
                      GitlabUser sudoUser)
                        throws IOException

Creates a Group

Parameters:: name - The name of the group; path - The path for the group; ldapCn - LDAP Group Name to sync with, null otherwise; ldapAccess - Access level for LDAP group members, null otherwise; sudoUser - The user to create the group on behalf of
Returns:: The GitLab Group
Throws:: IOException - on gitlab api call error

addGroupMember

public GitlabGroupMember addGroupMember(GitlabGroup group,
                               GitlabUser user,
                               GitlabAccessLevel accessLevel)
                                 throws IOException

Add a group member.

Parameters:: group - the GitlabGroup; user - the GitlabUser; accessLevel - the GitlabAccessLevel
Returns:: the GitlabGroupMember
Throws:: IOException - on gitlab api call error

addGroupMember

public GitlabGroupMember addGroupMember(Integer groupId,
                               Integer userId,
                               GitlabAccessLevel accessLevel)
                                 throws IOException

Add a group member.

Parameters:: groupId - the group id; userId - the user id; accessLevel - the GitlabAccessLevel
Returns:: the GitlabGroupMember
Throws:: IOException - on gitlab api call error

deleteGroupMember

public void deleteGroupMember(GitlabGroup group,
                     GitlabUser user)
                       throws IOException

Delete a group member.

Parameters:: group - the GitlabGroup; user - the GitlabUser
Throws:: IOException - on gitlab api call error

deleteGroupMember

public void deleteGroupMember(Integer groupId,
                     Integer userId)
                       throws IOException

Delete a group member.

Parameters:: groupId - the group id; userId - the user id
Throws:: IOException - on gitlab api call error

deleteGroup
```
public void deleteGroup(Integer groupId)
                 throws IOException
```
Delete a group.

Parameters:
groupId - the group id

Throws:

IOException - on gitlab api call error

getProject

public GitlabProject getProject(Serializable projectId)
                         throws IOException

Throws:: IOException

getProject

public GitlabProject getProject(String namespace,
                       String projectName)
                         throws IOException

use namespace & project name to get project

Throws:: IOException

getProjects
```
public List<GitlabProject> getProjects()
                                throws IOException
```
Get a list of projects accessible by the authenticated user.

Returns:
A list of gitlab projects

Throws:

IOException

getOwnedProjects
```
public List<GitlabProject> getOwnedProjects()
                                     throws IOException
```
Get a list of projects owned by the authenticated user.

Returns:
A list of gitlab projects

Throws:

IOException

getProjectsViaSudo
```
public List<GitlabProject> getProjectsViaSudo(GitlabUser user)
                                       throws IOException
```
Get a list of projects accessible by the authenticated user.

Returns:
A list of gitlab projects

Throws:

IOException

getAllProjects
```
public List<GitlabProject> getAllProjects()
                                   throws IOException
```
Get's all projects in Gitlab, requires sudo user

Returns:
A list of gitlab projects

Throws:

IOException

uploadFile

public GitlabUpload uploadFile(GitlabProject project,
                      File file)
                        throws IOException

Uploads a file to a project

Parameters:: project -; file -
Returns:
Throws:: IOException

getProjectBuilds
```
public List<GitlabBuild> getProjectBuilds(GitlabProject project)
                                   throws IOException
```
Gets a list of a project's builds in Gitlab

Parameters:
project - the project

Returns:
A list of project builds

Throws:

IOException

getProjectBuilds
```
public List<GitlabBuild> getProjectBuilds(Integer projectId)
                                   throws IOException
```
Gets a list of a project's builds in Gitlab

Parameters:
projectId - the project id

Returns:
A list of project builds

Throws:

IOException

getProjectBuild

public GitlabBuild getProjectBuild(Integer projectId,
                          Integer buildId)
                            throws IOException

Gets a build for a project

Parameters:: projectId - the project id; buildId - the build id
Returns:: A list of project builds
Throws:: IOException

getBuildArtifact

public byte[] getBuildArtifact(GitlabProject project,
                      GitlabBuild build)
                        throws IOException

Get build artifacts of a project build

Parameters:: project - The Project; build - The build
Throws:: IOException - on gitlab api call error

getBuildArtifact

public byte[] getBuildArtifact(Integer projectId,
                      Integer buildId)
                        throws IOException

Get build artifacts of a project build

Parameters:: projectId - The Project's Id; buildId - The build's Id
Throws:: IOException - on gitlab api call error

createProject
```
public GitlabProject createProject(String name)
                            throws IOException
```
Creates a private Project

Parameters:
name - The name of the project

Returns:
The GitLab Project

Throws:

IOException - on gitlab api call error

createProjectForGroup

public GitlabProject createProjectForGroup(String name,
                                  GitlabGroup group)
                                    throws IOException

Creates a group Project

Parameters:: name - The name of the project; group - The group for which the project should be crated
Returns:: The GitLab Project
Throws:: IOException - on gitlab api call error

createProjectForGroup

public GitlabProject createProjectForGroup(String name,
                                  GitlabGroup group,
                                  String description)
                                    throws IOException

Creates a group Project

Parameters:: name - The name of the project; group - The group for which the project should be crated; description - The project description
Returns:: The GitLab Project
Throws:: IOException - on gitlab api call error

createProjectForGroup

public GitlabProject createProjectForGroup(String name,
                                  GitlabGroup group,
                                  String description,
                                  Integer visibilityLevel)
                                    throws IOException

Creates a group Project

Parameters:: name - The name of the project; group - The group for which the project should be crated; description - The project description; visibilityLevel - The project visibility level (private: 0, internal: 10, public: 20)
Returns:: The GitLab Project
Throws:: IOException - on gitlab api call error

createProject

@Deprecated
public GitlabProject createProject(String name,
                                     Integer namespaceId,
                                     String description,
                                     Boolean issuesEnabled,
                                     Boolean wallEnabled,
                                     Boolean mergeRequestsEnabled,
                                     Boolean wikiEnabled,
                                     Boolean snippetsEnabled,
                                     Boolean publik,
                                     Integer visibilityLevel,
                                     String importUrl)
                            throws IOException

Deprecated.

Creates a Project

Parameters:: name - The name of the project; namespaceId - The Namespace for the new project, otherwise null indicates to use the GitLab default (user); description - A description for the project, null otherwise; issuesEnabled - Whether Issues should be enabled, otherwise null indicates to use GitLab default; wallEnabled - Whether The Wall should be enabled, otherwise null indicates to use GitLab default; mergeRequestsEnabled - Whether Merge Requests should be enabled, otherwise null indicates to use GitLab default; wikiEnabled - Whether a Wiki should be enabled, otherwise null indicates to use GitLab default; snippetsEnabled - Whether Snippets should be enabled, otherwise null indicates to use GitLab default; publik - Whether the project is public or private, if true same as setting visibilityLevel = 20, otherwise null indicates to use GitLab default; visibilityLevel - The visibility level of the project, otherwise null indicates to use GitLab default; importUrl - The Import URL for the project, otherwise null
Returns:: the Gitlab Project
Throws:: IOException - on gitlab api call error

createUserProject
```
public GitlabProject createUserProject(Integer userId,
                              String name)
                                throws IOException
```
Creates a Project for a specific User

Parameters:
userId - The id of the user to create the project for
name - The name of the project

Returns:
The GitLab Project

Throws:

IOException - on gitlab api call error

createUserProject

@Deprecated
public GitlabProject createUserProject(Integer userId,
                                         String name,
                                         String description,
                                         String defaultBranch,
                                         Boolean issuesEnabled,
                                         Boolean wallEnabled,
                                         Boolean mergeRequestsEnabled,
                                         Boolean wikiEnabled,
                                         Boolean snippetsEnabled,
                                         Boolean publik,
                                         Integer visibilityLevel,
                                         String importUrl)
                                throws IOException

Deprecated.

Creates a Project for a specific User

Parameters:: userId - The id of the user to create the project for; name - The name of the project; description - A description for the project, null otherwise; defaultBranch - The default branch for the project, otherwise null indicates to use GitLab default (master); issuesEnabled - Whether Issues should be enabled, otherwise null indicates to use GitLab default; wallEnabled - Whether The Wall should be enabled, otherwise null indicates to use GitLab default; mergeRequestsEnabled - Whether Merge Requests should be enabled, otherwise null indicates to use GitLab default; wikiEnabled - Whether a Wiki should be enabled, otherwise null indicates to use GitLab default; snippetsEnabled - Whether Snippets should be enabled, otherwise null indicates to use GitLab default; publik - Whether the project is public or private, if true same as setting visibilityLevel = 20, otherwise null indicates to use GitLab default; visibilityLevel - The visibility level of the project, otherwise null indicates to use GitLab default; importUrl - The Import URL for the project, otherwise null
Returns:: The GitLab Project
Throws:: IOException - on gitlab api call error

updateProject

@Deprecated
public GitlabProject updateProject(Integer projectId,
                                     String name,
                                     String description,
                                     String defaultBranch,
                                     Boolean issuesEnabled,
                                     Boolean wallEnabled,
                                     Boolean mergeRequestsEnabled,
                                     Boolean wikiEnabled,
                                     Boolean snippetsEnabled,
                                     Boolean publik,
                                     Integer visibilityLevel)
                            throws IOException

Deprecated.

Updates a Project

Parameters:: projectId - The id of the project to update; name - The name of the project; description - A description for the project, null otherwise; defaultBranch - The branch displayed in the Gitlab UI when a user navigates to the project; issuesEnabled - Whether Issues should be enabled, otherwise null indicates to use GitLab default; wallEnabled - Whether The Wall should be enabled, otherwise null indicates to use GitLab default; mergeRequestsEnabled - Whether Merge Requests should be enabled, otherwise null indicates to use GitLab default; wikiEnabled - Whether a Wiki should be enabled, otherwise null indicates to use GitLab default; snippetsEnabled - Whether Snippets should be enabled, otherwise null indicates to use GitLab default; publik - Whether the project is public or private, if true same as setting visibilityLevel = 20, otherwise null indicates to use GitLab default; visibilityLevel - The visibility level of the project, otherwise null indicates to use GitLab default
Returns:: the Gitlab Project
Throws:: IOException - on gitlab api call error

deleteProject
```
public void deleteProject(Serializable projectId)
                   throws IOException
```
Delete a Project.

Parameters:
projectId - The id of the project to delete

Throws:

IOException - on gitlab api call error

getOpenMergeRequests

public List<GitlabMergeRequest> getOpenMergeRequests(Serializable projectId)
                                              throws IOException

Throws:: IOException

getOpenMergeRequests

public List<GitlabMergeRequest> getOpenMergeRequests(GitlabProject project)
                                              throws IOException

Throws:: IOException

getMergeRequests

public List<GitlabMergeRequest> getMergeRequests(Serializable projectId)
                                          throws IOException

Throws:: IOException

getMergeRequests

public List<GitlabMergeRequest> getMergeRequests(GitlabProject project)
                                          throws IOException

Throws:: IOException

getAllMergeRequests

public List<GitlabMergeRequest> getAllMergeRequests(GitlabProject project)
                                             throws IOException

Throws:: IOException

getMergeRequestByIid

public GitlabMergeRequest getMergeRequestByIid(Serializable projectId,
                                      Integer mergeRequestIid)
                                        throws IOException

Return Merge Request.

Parameters:: projectId - The id of the project; mergeRequestIid - The iid of the merge request
Returns:: the Gitlab Merge Request
Throws:: IOException - on gitlab api call error

getMergeRequestChanges

public GitlabMergeRequest getMergeRequestChanges(Serializable projectId,
                                        Integer mergeRequestId)
                                          throws IOException

Return a Merge Request including its changes.

Parameters:: projectId - The id of the project; mergeRequestId - The id of the merge request
Returns:: the Gitlab Merge Request
Throws:: IOException - on gitlab api call error

getMergeRequest

public GitlabMergeRequest getMergeRequest(GitlabProject project,
                                 Integer mergeRequestId)
                                   throws IOException

Throws:: IOException

createMergeRequest

public GitlabMergeRequest createMergeRequest(Serializable projectId,
                                    String sourceBranch,
                                    String targetBranch,
                                    Integer assigneeId,
                                    String title)
                                      throws IOException

Create a new MergeRequest

Parameters:: projectId -; sourceBranch -; targetBranch -; assigneeId -; title -
Returns:: GitlabMergeRequest
Throws:: IOException - on gitlab api call error

updateMergeRequest

public GitlabMergeRequest updateMergeRequest(Serializable projectId,
                                    Integer mergeRequestId,
                                    String targetBranch,
                                    Integer assigneeId,
                                    String title,
                                    String description,
                                    String stateEvent,
                                    String labels)
                                      throws IOException

Updates a Merge Request

Parameters:: projectId - The id of the project; mergeRequestId - The id of the merge request to update; targetBranch - The target branch of the merge request, otherwise null to leave it untouched; assigneeId - The id of the assignee, otherwise null to leave it untouched; title - The title of the merge request, otherwise null to leave it untouched; description - The description of the merge request, otherwise null to leave it untouched; stateEvent - The state (close|reopen|merge) of the merge request, otherwise null to leave it untouched; labels - A comma separated list of labels, otherwise null to leave it untouched
Returns:: the Merge Request
Throws:: IOException - on gitlab api call error

acceptMergeRequest

public GitlabMergeRequest acceptMergeRequest(GitlabProject project,
                                    Integer mergeRequestId,
                                    String mergeCommitMessage)
                                      throws IOException

Parameters:: project - The Project; mergeRequestId - Merge Request ID; mergeCommitMessage - optional merge commit message. Null if not set
Returns:: new merge request status
Throws:: IOException - on gitlab api call error

getNote
```
public GitlabNote getNote(GitlabMergeRequest mergeRequest,
                 Integer noteId)
                   throws IOException
```
Get a Note from a Merge Request.

Parameters:
mergeRequest - The merge request
noteId - The id of the note

Returns:
the Gitlab Note

Throws:

IOException - on gitlab api call error

getNotes

public List<GitlabNote> getNotes(GitlabMergeRequest mergeRequest)
                          throws IOException

Throws:: IOException

getAllNotes

public List<GitlabNote> getAllNotes(GitlabMergeRequest mergeRequest)
                             throws IOException

Throws:: IOException

getCommit

public GitlabCommit getCommit(Serializable projectId,
                     String commitHash)
                       throws IOException

Throws:: IOException

getCommitBuilds

public List<GitlabBuild> getCommitBuilds(GitlabProject projectId,
                                String commitHash)
                                  throws IOException

Throws:: IOException

getCommitBuilds

public List<GitlabBuild> getCommitBuilds(Serializable projectId,
                                String commitHash)
                                  throws IOException

Throws:: IOException

getCommits

public List<GitlabCommit> getCommits(GitlabMergeRequest mergeRequest)
                              throws IOException

Throws:: IOException

getCommits

public List<GitlabCommit> getCommits(GitlabMergeRequest mergeRequest,
                            Pagination pagination)
                              throws IOException

Throws:: IOException

getLastCommits

public List<GitlabCommit> getLastCommits(Serializable projectId)
                                  throws IOException

Throws:: IOException

getLastCommits

public List<GitlabCommit> getLastCommits(Serializable projectId,
                                String branchOrTag)
                                  throws IOException

Throws:: IOException

getCommits

public List<GitlabCommit> getCommits(Serializable projectId,
                            Pagination pagination,
                            String branchOrTag)
                              throws IOException

Throws:: IOException

getAllCommits

public List<GitlabCommit> getAllCommits(Serializable projectId)
                                 throws IOException

Throws:: IOException

getAllCommits

public List<GitlabCommit> getAllCommits(Serializable projectId,
                               String branchOrTag)
                                 throws IOException

Throws:: IOException

getAllCommits

public List<GitlabCommit> getAllCommits(Serializable projectId,
                               Pagination pagination,
                               String branchOrTag)
                                 throws IOException

Throws:: IOException

getCommitDiffs

public List<GitlabCommitDiff> getCommitDiffs(Serializable projectId,
                                    String commitHash)
                                      throws IOException

Throws:: IOException

getCommitDiffs

public List<GitlabCommitDiff> getCommitDiffs(Serializable projectId,
                                    String commitHash,
                                    Pagination pagination)
                                      throws IOException

Throws:: IOException

compareCommits

public GitlabCommitComparison compareCommits(Serializable projectId,
                                    String commitHash1,
                                    String commitHash2)
                                      throws IOException

Throws:: IOException

compareCommits

public GitlabCommitComparison compareCommits(Serializable projectId,
                                    String commitHash1,
                                    String commitHash2,
                                    Pagination pagination)
                                      throws IOException

Throws:: IOException

getCommitStatuses

public List<GitlabCommitStatus> getCommitStatuses(GitlabProject project,
                                         String commitHash)
                                           throws IOException

Throws:: IOException

getCommitStatuses

public List<GitlabCommitStatus> getCommitStatuses(GitlabProject project,
                                         String commitHash,
                                         Pagination pagination)
                                           throws IOException

Throws:: IOException

createCommitStatus

public GitlabCommitStatus createCommitStatus(GitlabProject project,
                                    String commitHash,
                                    String state,
                                    String ref,
                                    String name,
                                    String targetUrl,
                                    String description)
                                      throws IOException

Throws:: IOException

getRawFileContent

public byte[] getRawFileContent(GitlabProject project,
                       String sha,
                       String filepath)
                         throws IOException

Get raw file content

Parameters:: project - The Project; sha - The commit or branch name; filepath - The path of the file
Throws:: IOException - on gitlab api call error

getRawFileContent

public byte[] getRawFileContent(Integer projectId,
                       String sha,
                       String filepath)
                         throws IOException

Get raw file content

Parameters:: projectId - The Project; sha - The commit or branch name; filepath - The path of the file
Throws:: IOException - on gitlab api call error

getRawBlobContent
```
public byte[] getRawBlobContent(GitlabProject project,
                       String sha)
                         throws IOException
```
Get the raw file contents for a blob by blob SHA.

Parameters:
project - The Project
sha - The commit or branch name

Throws:

IOException - on gitlab api call error

getFileArchive
```
public byte[] getFileArchive(GitlabProject project)
                      throws IOException
```
Get an archive of the repository

Parameters:
project - The Project

Throws:

IOException - on gitlab api call error

getRepositoryTree

public List<GitlabRepositoryTree> getRepositoryTree(GitlabProject project,
                                           String path,
                                           String ref_name,
                                           boolean recursive)
                                             throws IOException

Get an archive of the repository

Parameters:: project - The Project; path - The path inside the repository. Used to get content of subdirectories (optional); ref_name - The name of a repository branch or tag or if not given the default branch (optional)
Throws:: IOException - on gitlab api call error

getRepositoryFile

public GitlabRepositoryFile getRepositoryFile(GitlabProject project,
                                     String path,
                                     String ref)
                                       throws IOException

Throws:: IOException

updateNote

public GitlabNote updateNote(GitlabMergeRequest mergeRequest,
                    Integer noteId,
                    String body)
                      throws IOException

Update a Merge Request Note

Parameters:: mergeRequest - The merge request; noteId - The id of the note; body - The content of the note
Returns:: the Gitlab Note
Throws:: IOException - on gitlab api call error

createNote

public GitlabNote createNote(GitlabMergeRequest mergeRequest,
                    String body)
                      throws IOException

Throws:: IOException

deleteNote
```
public void deleteNote(GitlabMergeRequest mergeRequest,
              GitlabNote noteToDelete)
                throws IOException
```
Delete a Merge Request Note

Parameters:
mergeRequest - The merge request
noteToDelete - The note to delete

Throws:

IOException - on gitlab api call error

getBranches

public List<GitlabBranch> getBranches(Serializable projectId)
                               throws IOException

Throws:: IOException

getBranches

public List<GitlabBranch> getBranches(GitlabProject project)
                               throws IOException

Throws:: IOException

createBranch
```
public void createBranch(GitlabProject project,
                String branchName,
                String ref)
                  throws IOException
```
Create Branch. Create Repository Branch Documentation

Parameters:
project - The gitlab project
branchName - The name of the branch to create
ref - The branch name or commit SHA to create branch from

Throws:

IOException - on gitlab api call error

createBranch
```
public void createBranch(Serializable projectId,
                String branchName,
                String ref)
                  throws IOException
```
Create Branch. Create Repository Branch Documentation

Parameters:
projectId - The id of the project
branchName - The name of the branch to create
ref - The branch name or commit SHA to create branch from

Throws:

IOException - on gitlab api call error

deleteBranch
```
public void deleteBranch(Serializable projectId,
                String branchName)
                  throws IOException
```
Delete Branch.

Parameters:
projectId - The id of the project
branchName - The name of the branch to delete

Throws:

IOException - on gitlab api call error

getBranch

public GitlabBranch getBranch(Serializable projectId,
                     String branchName)
                       throws IOException

Throws:: IOException

getBranch

public GitlabBranch getBranch(GitlabProject project,
                     String branchName)
                       throws IOException

Throws:: IOException

protectBranch

public void protectBranch(GitlabProject project,
                 String branchName)
                   throws IOException

Throws:: IOException

unprotectBranch

public void unprotectBranch(GitlabProject project,
                   String branchName)
                     throws IOException

Throws:: IOException

getProjectHooks

public List<GitlabProjectHook> getProjectHooks(Serializable projectId)
                                        throws IOException

Throws:: IOException

getProjectHooks

public List<GitlabProjectHook> getProjectHooks(GitlabProject project)
                                        throws IOException

Throws:: IOException

getProjectHook

public GitlabProjectHook getProjectHook(GitlabProject project,
                               String hookId)
                                 throws IOException

Throws:: IOException

addProjectHook

public GitlabProjectHook addProjectHook(GitlabProject project,
                               String url)
                                 throws IOException

Throws:: IOException

addProjectHook

public GitlabProjectHook addProjectHook(GitlabProject project,
                               String url,
                               String token)
                                 throws IOException

Throws:: IOException

addProjectHook

public GitlabProjectHook addProjectHook(Serializable projectId,
                               String url,
                               boolean pushEvents,
                               boolean issuesEvents,
                               boolean mergeRequestEvents,
                               boolean tagPushEvents,
                               boolean sslVerification)
                                 throws IOException

Throws:: IOException

editProjectHook

public GitlabProjectHook editProjectHook(GitlabProject project,
                                String hookId,
                                String url)
                                  throws IOException

Throws:: IOException

deleteProjectHook

public void deleteProjectHook(GitlabProjectHook hook)
                       throws IOException

Throws:: IOException

deleteProjectHook

public void deleteProjectHook(GitlabProject project,
                     String hookId)
                       throws IOException

Throws:: IOException

getIssues

public List<GitlabIssue> getIssues(GitlabProject project)
                            throws IOException

Throws:: IOException

getIssue

public GitlabIssue getIssue(Serializable projectId,
                   Integer issueId)
                     throws IOException

Throws:: IOException

createIssue

public GitlabIssue createIssue(int projectId,
                      int assigneeId,
                      Integer milestoneId,
                      String labels,
                      String description,
                      String title)
                        throws IOException

Throws:: IOException

moveIssue

public GitlabIssue moveIssue(Integer projectId,
                    Integer issueId,
                    Integer toProjectId)
                      throws IOException

Throws:: IOException

editIssue

public GitlabIssue editIssue(int projectId,
                    int issueId,
                    int assigneeId,
                    int milestoneId,
                    String labels,
                    String description,
                    String title,
                    GitlabIssue.Action action)
                      throws IOException

Throws:: IOException

getNote

public GitlabNote getNote(GitlabIssue issue,
                 Integer noteId)
                   throws IOException

Throws:: IOException

getNotes

public List<GitlabNote> getNotes(GitlabIssue issue)
                          throws IOException

Throws:: IOException

createNote

public GitlabNote createNote(Serializable projectId,
                    Integer issueId,
                    String message)
                      throws IOException

Throws:: IOException

createNote

public GitlabNote createNote(GitlabIssue issue,
                    String message)
                      throws IOException

Throws:: IOException

deleteNote

public void deleteNote(Serializable projectId,
              Integer issueId,
              GitlabNote noteToDelete)
                throws IOException

Delete an Issue Note

Parameters:: projectId - The project id; issueId - The issue id; noteToDelete - The note to delete
Throws:: IOException - on gitlab api call error

deleteNote

public void deleteNote(GitlabIssue issue,
              GitlabNote noteToDelete)
                throws IOException

Delete an Issue Note

Parameters:: issue - The issue; noteToDelete - The note to delete
Throws:: IOException - on gitlab api call error

getLabels
```
public List<GitlabLabel> getLabels(Serializable projectId)
                            throws IOException
```
Gets labels associated with a project.

Parameters:
projectId - The ID of the project.

Returns:
A non-null list of labels.

Throws:

IOException

getLabels
```
public List<GitlabLabel> getLabels(GitlabProject project)
                            throws IOException
```
Gets labels associated with a project.

Parameters:
project - The project associated with labels.

Returns:
A non-null list of labels.

Throws:

IOException

createLabel

public GitlabLabel createLabel(Serializable projectId,
                      String name,
                      String color)
                        throws IOException

Creates a new label.

Parameters:: projectId - The ID of the project containing the new label.; name - The name of the label.; color - The color of the label (eg #ff0000).
Returns:: The newly created label.
Throws:: IOException

createLabel

public GitlabLabel createLabel(Serializable projectId,
                      GitlabLabel label)
                        throws IOException

Creates a new label.

Parameters:: projectId - The ID of the project containing the label.; label - The label to create.
Returns:: The newly created label.
Throws:: IOException

deleteLabel
```
public void deleteLabel(Serializable projectId,
               String name)
                 throws IOException
```
Deletes an existing label.

Parameters:
projectId - The ID of the project containing the label.
name - The name of the label to delete.

Throws:

IOException

deleteLabel
```
public void deleteLabel(Serializable projectId,
               GitlabLabel label)
                 throws IOException
```
Deletes an existing label.

Parameters:
projectId - The ID of the project containing the label.
label - The label to delete.

Throws:

IOException

updateLabel

public GitlabLabel updateLabel(Serializable projectId,
                      String name,
                      String newName,
                      String newColor)
                        throws IOException

Updates an existing label.

Parameters:: projectId - The ID of the project containing the label.; name - The name of the label to update.; newName - The updated name.; newColor - The updated color.
Returns:: The updated, deserialized label.
Throws:: IOException

getMilestones

public List<GitlabMilestone> getMilestones(GitlabProject project)
                                    throws IOException

Throws:: IOException

getMilestones

public List<GitlabMilestone> getMilestones(Serializable projectId)
                                    throws IOException

Throws:: IOException

createMilestone

public GitlabMilestone createMilestone(Serializable projectId,
                              String title,
                              String description,
                              Date dueDate)
                                throws IOException

Cretaes a new project milestone.

Parameters:: projectId - The ID of the project.; title - The title of the milestone.; description - The description of the milestone. (Optional); dueDate - The date the milestone is due. (Optional)
Returns:: The newly created, de-serialized milestone.
Throws:: IOException

createMilestone

public GitlabMilestone createMilestone(Serializable projectId,
                              GitlabMilestone milestone)
                                throws IOException

Creates a new project milestone.

Parameters:: projectId - The ID of the project.; milestone - The milestone to create.
Returns:: The newly created, de-serialized milestone.
Throws:: IOException

updateMilestone

public GitlabMilestone updateMilestone(Serializable projectId,
                              int milestoneId,
                              String title,
                              String description,
                              Date dueDate,
                              String stateEvent)
                                throws IOException

Updates an existing project milestone.

Parameters:: projectId - The ID of the project.; milestoneId - The ID of the milestone.; title - The title of the milestone. (Optional); description - The description of the milestone. (Optional); dueDate - The date the milestone is due. (Optional); stateEvent - A value used to update the state of the milestone. (Optional) (activate | close)
Returns:: The updated, de-serialized milestone.
Throws:: IOException

updateMilestone
```
public GitlabMilestone updateMilestone(Serializable projectId,
                              GitlabMilestone edited,
                              String stateEvent)
                                throws IOException
```
Updates an existing project milestone.

Parameters:
projectId - The ID of the project.
edited - The already edited milestone.
stateEvent - A value used to update the state of the milestone. (Optional) (activate | close)

Returns:
The updated, de-serialized milestone.

Throws:

IOException

updateMilestone
```
public GitlabMilestone updateMilestone(GitlabMilestone edited,
                              String stateEvent)
                                throws IOException
```
Updates an existing project milestone.

Parameters:
edited - The already edited milestone.
stateEvent - A value used to update the state of the milestone. (Optional) (activate | close)

Returns:
The updated, de-serialized milestone.

Throws:

IOException

addProjectMember

public GitlabProjectMember addProjectMember(GitlabProject project,
                                   GitlabUser user,
                                   GitlabAccessLevel accessLevel)
                                     throws IOException

Add a project member.

Parameters:: project - the GitlabProject; user - the GitlabUser; accessLevel - the GitlabAccessLevel
Returns:: the GitlabProjectMember
Throws:: IOException - on gitlab api call error

addProjectMember

public GitlabProjectMember addProjectMember(Integer projectId,
                                   Integer userId,
                                   GitlabAccessLevel accessLevel)
                                     throws IOException

Add a project member.

Parameters:: projectId - the project id; userId - the user id; accessLevel - the GitlabAccessLevel
Returns:: the GitlabProjectMember
Throws:: IOException - on gitlab api call error

deleteProjectMember

public void deleteProjectMember(GitlabProject project,
                       GitlabUser user)
                         throws IOException

Delete a project team member.

Parameters:: project - the GitlabProject; user - the GitlabUser
Throws:: IOException - on gitlab api call error

deleteProjectMember

public void deleteProjectMember(Integer projectId,
                       Integer userId)
                         throws IOException

Delete a project team member.

Parameters:: projectId - the project id; userId - the user id
Throws:: IOException - on gitlab api call error

getProjectMembers

public List<GitlabProjectMember> getProjectMembers(GitlabProject project)
                                            throws IOException

Throws:: IOException

getProjectMembers

public List<GitlabProjectMember> getProjectMembers(GitlabProject project,
                                          Pagination pagination)
                                            throws IOException

Throws:: IOException

getProjectMembers

public List<GitlabProjectMember> getProjectMembers(Serializable projectId)
                                            throws IOException

Throws:: IOException

getProjectMembers

public List<GitlabProjectMember> getProjectMembers(Serializable projectId,
                                          Pagination pagination)
                                            throws IOException

Throws:: IOException

getNamespaceMembers
```
public List<GitlabProjectMember> getNamespaceMembers(GitlabNamespace namespace)
                                              throws IOException
```
This will fail, if the given namespace is a user and not a group

Parameters:
namespace - The namespace

Returns:
A list of Gitlab Project members

Throws:

IOException - on gitlab api call error

getNamespaceMembers
```
public List<GitlabProjectMember> getNamespaceMembers(Integer namespaceId)
                                              throws IOException
```
This will fail, if the given namespace is a user and not a group

Parameters:
namespaceId - Namespace ID

Returns:
A list of Gitlab Project members

Throws:

IOException - on gitlab api call error

transfer
```
public void transfer(Integer namespaceId,
            Integer projectId)
              throws IOException
```
Transfer a project to the given namespace

Parameters:
namespaceId - Namespace ID
projectId - Project ID

Throws:

IOException - on gitlab api call error

createDeployKey

public GitlabSSHKey createDeployKey(Integer targetProjectId,
                           String title,
                           String key)
                             throws IOException

Create a new deploy key for the project

Parameters:: targetProjectId - The id of the Gitlab project; title - The title of the ssh key; key - The public key
Returns:: The new GitlabSSHKey
Throws:: IOException - on gitlab api call error

deleteDeployKey
```
public void deleteDeployKey(Integer targetProjectId,
                   Integer targetKeyId)
                     throws IOException
```
Delete a deploy key for a project

Parameters:
targetProjectId - The id of the Gitlab project
targetKeyId - The id of the Gitlab ssh key

Throws:

IOException - on gitlab api call error

getDeployKeys
```
public List<GitlabSSHKey> getDeployKeys(Integer targetProjectId)
                                 throws IOException
```
Gets all deploy keys for a project

Parameters:
targetProjectId - The id of the Gitlab project

Returns:
The list of project deploy keys

Throws:

IOException - on gitlab api call error

getCurrentSession

public GitlabSession getCurrentSession()
                                throws IOException

Throws:: IOException

getSystemHooks
```
public List<GitlabSystemHook> getSystemHooks()
                                      throws IOException
```
Get list of system hooks

Returns:
The system hooks list

Throws:

IOException - on gitlab api call error

addSystemHook
```
public GitlabSystemHook addSystemHook(String url)
                               throws IOException
```
Add new system hook hook

Parameters:
url - System hook url

Throws:

IOException - on gitlab api call error

testSystemHook

public void testSystemHook(Integer hookId)
                    throws IOException

Test system hook

Throws:: IOException - on gitlab api call error

deleteSystemHook

public GitlabSystemHook deleteSystemHook(Integer hookId)
                                  throws IOException

Delete system hook

Throws:: IOException - on gitlab api call error

createCommitComment

public CommitComment createCommitComment(Integer projectId,
                                String sha,
                                String note,
                                String path,
                                String line,
                                String line_type)
                                  throws IOException

Post comment to commit

Parameters:: projectId - (required) - The ID of a project; sha - (required) - The name of a repository branch or tag or if not given the default branch; note - (required) - Text of comment; path - (optional) - The file path; line - (optional) - The line number; line_type - (optional) - The line type (new or old)
Returns:: A CommitComment
Throws:: IOException - on gitlab api call error
See Also:: http://doc.gitlab.com/ce/api/commits.html#post-comment-to-commit

getCommitComments
```
public List<CommitComment> getCommitComments(Integer projectId,
                                    String sha)
                                      throws IOException
```
Get the comments of a commit

Parameters:
projectId - (required) - The ID of a project
sha - (required) - The name of a repository branch or tag or if not given the default branch

Returns:
A CommitComment

Throws:

IOException - on gitlab api call error
See Also:
http://doc.gitlab.com/ce/api/commits.html#post-comment-to-commit

getTags
```
public List<GitlabTag> getTags(Serializable projectId)
                        throws IOException
```
Get a list of tags in specific project

Parameters:
projectId -

Returns:

Throws:

IOException - on gitlab api call error

getTags
```
public List<GitlabTag> getTags(GitlabProject project)
                        throws IOException
```
Get a list of tags in specific project

Parameters:
project -

Returns:

Throws:

IOException - on gitlab api call error

addTag

public GitlabTag addTag(Serializable projectId,
               String tagName,
               String ref,
               String message,
               String releaseDescription)
                 throws IOException

Create tag in specific project

Parameters:: projectId -; tagName -; ref -; message -; releaseDescription -
Returns:
Throws:: IOException - on gitlab api call error

addTag

public GitlabTag addTag(GitlabProject project,
               String tagName,
               String ref,
               String message,
               String releaseDescription)
                 throws IOException

Create tag in specific project

Parameters:: project -; tagName -; ref -; message -; releaseDescription -
Returns:
Throws:: IOException - on gitlab api call error

deleteTag

public void deleteTag(Serializable projectId,
             String tagName)
               throws IOException

Delete tag in specific project

Parameters:: projectId -; tagName -
Throws:: IOException - on gitlab api call error

deleteTag

public void deleteTag(GitlabProject project,
             String tagName)
               throws IOException

Delete tag in specific project

Parameters:: project -; tagName -
Throws:: IOException - on gitlab api call error

getAllAwards

public List<GitlabAward> getAllAwards(GitlabMergeRequest mergeRequest)
                               throws IOException

Get all awards for a merge request

Parameters:: mergeRequest -
Throws:: IOException - on gitlab api call error

getAward

public GitlabAward getAward(GitlabMergeRequest mergeRequest,
                   Integer awardId)
                     throws IOException

Get a specific award for a merge request

Parameters:: mergeRequest -; awardId -
Throws:: IOException - on gitlab api call error

createAward

public GitlabAward createAward(GitlabMergeRequest mergeRequest,
                      String awardName)
                        throws IOException

Create an award for a merge request

Parameters:: mergeRequest -; awardName -
Throws:: IOException - on gitlab api call error

deleteAward

public void deleteAward(GitlabMergeRequest mergeRequest,
               GitlabAward award)
                 throws IOException

Delete an award for a merge request

Parameters:: mergeRequest -; award -
Throws:: IOException - on gitlab api call error

getAllAwards

public List<GitlabAward> getAllAwards(GitlabIssue issue)
                               throws IOException

Get all awards for an issue

Parameters:: issue -
Throws:: IOException - on gitlab api call error

getAward

public GitlabAward getAward(GitlabIssue issue,
                   Integer awardId)
                     throws IOException

Get a specific award for an issue

Parameters:: issue -; awardId -
Throws:: IOException - on gitlab api call error

createAward

public GitlabAward createAward(GitlabIssue issue,
                      String awardName)
                        throws IOException

Create an award for an issue

Parameters:: issue -; awardName -
Throws:: IOException - on gitlab api call error

deleteAward

public void deleteAward(GitlabIssue issue,
               GitlabAward award)
                 throws IOException

Delete an award for an issue

Parameters:: issue -; award -
Throws:: IOException - on gitlab api call error

getAllAwards

public List<GitlabAward> getAllAwards(GitlabIssue issue,
                             Integer noteId)
                               throws IOException

Get all awards for an issue note

Parameters:: issue -; noteId -
Throws:: IOException - on gitlab api call error

getAward

public GitlabAward getAward(GitlabIssue issue,
                   Integer noteId,
                   Integer awardId)
                     throws IOException

Get a specific award for an issue note

Parameters:: issue -; noteId -; awardId -
Throws:: IOException - on gitlab api call error

createAward

public GitlabAward createAward(GitlabIssue issue,
                      Integer noteId,
                      String awardName)
                        throws IOException

Create an award for an issue note

Parameters:: issue -; noteId -; awardName -
Throws:: IOException - on gitlab api call error

deleteAward

public void deleteAward(GitlabIssue issue,
               Integer noteId,
               GitlabAward award)
                 throws IOException

Delete an award for an issue note

Parameters:: issue -; noteId -; award -
Throws:: IOException - on gitlab api call error

getBuildVariables
```
public List<GitlabBuildVariable> getBuildVariables(Integer projectId)
                                            throws IOException
```
Gets build variables associated with a project.

Parameters:
projectId - The ID of the project.

Returns:
A non-null list of variables.

Throws:

IOException

getBuildVariables
```
public List<GitlabBuildVariable> getBuildVariables(GitlabProject project)
                                            throws IOException
```
Gets build variables associated with a project.

Parameters:
project - The project associated with variables.

Returns:
A non-null list of variables.

Throws:

IOException

getBuildVariable

public GitlabBuildVariable getBuildVariable(Integer projectId,
                                   String key)
                                     throws IOException

Gets build variable associated with a project and key.

Parameters:: projectId - The ID of the project.; key - The key of the variable.
Returns:: A variable.
Throws:: IOException

getBuildVariable

public GitlabBuildVariable getBuildVariable(GitlabProject project,
                                   String key)
                                     throws IOException

Gets build variable associated with a project and key.

Parameters:: project - The project associated with the variable.
Returns:: A variable.
Throws:: IOException

createBuildVariable

public GitlabBuildVariable createBuildVariable(Integer projectId,
                                      String key,
                                      String value)
                                        throws IOException

Creates a new build variable.

Parameters:: projectId - The ID of the project containing the new variable.; key - The key of the variable.; value - The value of the variable
Returns:: The newly created variable.
Throws:: IOException

createBuildVariable

public GitlabBuildVariable createBuildVariable(Integer projectId,
                                      GitlabBuildVariable variable)
                                        throws IOException

Creates a new variable.

Parameters:: projectId - The ID of the project containing the variable.; variable - The variable to create.
Returns:: The newly created variable.
Throws:: IOException

deleteBuildVariable
```
public void deleteBuildVariable(Integer projectId,
                       String key)
                         throws IOException
```
Deletes an existing variable.

Parameters:
projectId - The ID of the project containing the variable.
key - The key of the variable to delete.

Throws:

IOException

deleteBuildVariable

public void deleteBuildVariable(Integer projectId,
                       GitlabBuildVariable variable)
                         throws IOException

Deletes an existing variable.

Parameters:: projectId - The ID of the project containing the variable.; variable - The variable to delete.
Throws:: IOException

updateBuildVariable

public GitlabBuildVariable updateBuildVariable(Integer projectId,
                                      String key,
                                      String newValue)
                                        throws IOException

Updates an existing variable.

Parameters:: projectId - The ID of the project containing the variable.; key - The key of the variable to update.; newValue - The updated value.
Returns:: The updated, deserialized variable.
Throws:: IOException

getBuildTriggers
```
public List<GitlabTrigger> getBuildTriggers(GitlabProject project)
                                     throws IOException
```
Returns the list of build triggers for a project.

Parameters:
project - the project

Returns:
list of build triggers

Throws:

IllegalStateException - if builds are not enabled for the project

IOException

getEmailsOnPush
```
public GitlabServiceEmailOnPush getEmailsOnPush(Integer projectId)
                                         throws IOException
```
Gets email-on-push service setup for a projectId.

Parameters:
projectId - The ID of the project containing the variable.

Throws:

IOException

updateEmailsOnPush
```
public boolean updateEmailsOnPush(Integer projectId,
                         String emailAddress)
                           throws IOException
```
Update recipients for email-on-push service for a projectId.

Parameters:
projectId - The ID of the project containing the variable.
emailAddress - The emailaddress of the recipent who is going to receive push notification.

Returns:

Throws:

IOException

searchProjects
```
public List<GitlabProject> searchProjects(String query)
                                   throws IOException
```
Get a list of projects accessible by the authenticated user by search.

Returns:
A list of gitlab projects

Throws:

IOException

setUserAgent
```
public void setUserAgent(String userAgent)
```
Set the User-Agent header for the requests.

Parameters:
userAgent -

getUserAgent
```
public String getUserAgent()
```

getVersion

public GitlabVersion getVersion()
                         throws IOException

Throws:: IOException

Class GitlabAPI

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAPPER

Method Detail

connect

connect

connect

connect

ignoreCertificateErrors

proxy

getRequestTimeout

setRequestTimeout

retrieve

dispatch

isIgnoreCertificateErrors

getProxy

getAPIUrl

getUrl

getUsers

findUsers

getUser

getUser

getUserViaSudo

createUser

updateUser

blockUser

unblockUser

createSSHKey

deleteSSHKey

getSSHKeys

getSSHKey

deleteUser

getGroup

getGroup

getGroups

getGroupsViaSudo

getGroupProjects

getGroupProjects

getGroupMembers

getGroupMembers

createGroup

createGroup

createGroupViaSudo

createGroup

createGroup

addGroupMember

addGroupMember

deleteGroupMember

deleteGroupMember

deleteGroup

getProject

getProject

getProjects

getOwnedProjects

getProjectsViaSudo

getAllProjects

uploadFile

getProjectBuilds

getProjectBuilds

getProjectBuild

getBuildArtifact

getBuildArtifact

createProject

createProjectForGroup

createProjectForGroup

createProjectForGroup

createProject

createUserProject

createUserProject

updateProject

deleteProject

getOpenMergeRequests

getOpenMergeRequests

getMergeRequests

getMergeRequests

getAllMergeRequests

getMergeRequestByIid