com.talanlabs.gitlab.api.v3.services

Class GitLabAPICommits

java.lang.Object

com.talanlabs.gitlab.api.v3.services.GitLabAPICommits

public class GitLabAPICommits
extends Object

Commits API

http://doc.gitlab.com/ce/api/commits.html

Constructor Summary

Constructors

Constructor and Description
GitLabAPICommits(GitLabAPI gitLabAPI)

Method Summary

Modifier and Type	Method and Description
Paged<GitLabCommit>	getAllCommits(Serializable projectId, Pagination pagination) List repository commits
GitLabCommit	getCommit(Serializable projectId, String commitHash) Get a single commit
Paged<GitLabCommitComments>	getCommitComments(Serializable projectId, String commitHash, Pagination pagination) Get the comments of a commit
Paged<GitLabCommitDiff>	getCommitDiffs(Serializable projectId, String commitHash, Pagination pagination) Get the diff of a commit
Paged<GitLabCommitStatus>	getCommitStatuses(Serializable projectId, String commitHash, Pagination pagination) Get the status of a commit
GitLabCommitComments	postCommitComments(Serializable projectId, String commitHash, String note, String path, Integer line, String lineType) Post comment to commit
GitLabCommitStatus	postCommitStatus(Serializable projectId, String commitHash, String state, String ref, String name, String targetUrl, String description) Post the status to commit

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GitLabAPICommits

public GitLabAPICommits(GitLabAPI gitLabAPI)

Method Detail

getAllCommits

public Paged<GitLabCommit> getAllCommits(Serializable projectId,
                                         Pagination pagination)
                                  throws IOException

List repository commits

Get a list of repository commits in a project.

GET /projects/:id/repository/commits

Parameters:

projectId - (required) - The ID of a project

pagination - (optional) - number of projects to return per page

Returns:

Throws:

IOException

getCommit

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

Get a single commit

Get a specific commit identified by the commit hash or name of a branch or tag.

GET /projects/:id/repository/commits/:sha

Parameters:

projectId - (required) - The ID of a project

commitHash - (required) - The commit SHA

Returns:

Throws:

IOException

getCommitDiffs

public Paged<GitLabCommitDiff> getCommitDiffs(Serializable projectId,
                                              String commitHash,
                                              Pagination pagination)
                                       throws IOException

Get the diff of a commit

Get the diff of a commit in a project.

GET /projects/:id/repository/commits/:sha/diff

Parameters:

projectId - (required) - The ID of a project

commitHash - (required) - The commit SHA

pagination - (optional) - number of projects to return per page

Returns:

Throws:

IOException

getCommitComments

public Paged<GitLabCommitComments> getCommitComments(Serializable projectId,
                                                     String commitHash,
                                                     Pagination pagination)
                                              throws IOException

Get the comments of a commit

Get the comments of a commit in a project.

GET /projects/:id/repository/commits/:sha/comments

Parameters:

projectId - (required) - The ID of a project

commitHash - (required) - The commit SHA

pagination - (optional) - number of projects to return per page

Returns:

Throws:

IOException

postCommitComments

public GitLabCommitComments postCommitComments(Serializable projectId,
                                               String commitHash,
                                               String note,
                                               String path,
                                               Integer line,
                                               String lineType)
                                        throws IOException

Post comment to commit

Adds a comment to a commit. Optionally you can post comments on a specific line of a commit. Therefor both path, line_new and line_old are required.

POST /projects/:id/repository/commits/:sha/comments

Parameters:

projectId - (required) - The ID of a project

commitHash - (required) - The commit SHA

note - (required) - Text of comment

path - (optional) - The file path

line - (optional) - The line number

lineType - (optional) - The line type (new or old)

Returns:

Throws:

IOException

getCommitStatuses

public Paged<GitLabCommitStatus> getCommitStatuses(Serializable projectId,
                                                   String commitHash,
                                                   Pagination pagination)
                                            throws IOException

Get the status of a commit

Get the statuses of a commit in a project.

GET /projects/:id/repository/commits/:sha/statuses

Parameters:

projectId - (required) - The ID of a project

commitHash - (required) - The commit SHA

pagination - (optional) - number of projects to return per page

Returns:

Throws:

IOException

postCommitStatus

public GitLabCommitStatus postCommitStatus(Serializable projectId,
                                           String commitHash,
                                           String state,
                                           String ref,
                                           String name,
                                           String targetUrl,
                                           String description)
                                    throws IOException

Post the status to commit

Adds or updates a status of a commit.

POST /projects/:id/statuses/:sha

Parameters:

projectId - (required) - The ID of a project

commitHash - (required) - The commit SHA

state - (required) - The state of the status. Can be: pending, running, success, failed, canceled

ref - (optional) - The ref (branch or tag) to which the status refers

name - (optional) - The label to differentiate this status from the status of other systems. Default: "default"

targetUrl - (optional) - The target URL to associate with this status

description - (optional) - The short description of the status

Returns:

Throws:

IOException