org.gitlab4j.api

Class CommitsApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.CommitsApi

public class CommitsApi
extends AbstractApi

This class implements the client side API for the GitLab commits calls.

Constructor Summary

Constructors

Constructor and Description
CommitsApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method and Description
List<Commit>	getCommits(int projectId) Get a list of repository commits in a project.
Commit	getCommits(int projectId, String sha) Get a specific commit identified by the commit hash or name of a branch or tag.
Diff	getDiff(int projectId, String sha) Get the diff of a commit in a project.

Methods inherited from class org.gitlab4j.api.AbstractApi

addFormParam, addFormParam, delete, delete, get, get, getApiClient, handle, post, post, post, put, put, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

CommitsApi

public CommitsApi(GitLabApi gitLabApi)

Method Detail

getCommits

public List<Commit> getCommits(int projectId)
                        throws GitLabApiException

Get a list of repository commits in a project. GET /projects/:id/repository/commits

Parameters:

projectId - the project ID to get the list of commits for

Returns:

a list containing the commits for the specified project ID

Throws:

GitLabApiException - GitLabApiException if any exception occurs during execution

getCommits

public Commit getCommits(int projectId,
                         String sha)
                  throws GitLabApiException

Get a specific commit identified by the commit hash or name of a branch or tag. GET /projects/:id/repository/commits/:sha

Parameters:

projectId - the project ID that the commit belongs to

sha - a commit hash or name of a branch or tag

Returns:

the Commit instance for the specified project ID/sha pair

Throws:

GitLabApiException - GitLabApiException if any exception occurs during execution

getDiff

public Diff getDiff(int projectId,
                    String sha)
             throws GitLabApiException

Get the diff of a commit in a project. GET /projects/:id/repository/commits/:sha/diff

Parameters:

projectId - the project ID that the commit belongs to

sha - a commit hash or name of a branch or tag

Returns:

the Diff instance for the specified project ID/sha pair

Throws:

GitLabApiException - GitLabApiException if any exception occurs during execution