org.gitlab4j.api

Class ProjectApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.ProjectApi

All Implemented Interfaces:

Constants

public class ProjectApi
extends AbstractApi
implements Constants

This class provides an entry point to all the GitLab API project calls.

Nested Class Summary

Nested classes/interfaces inherited from interface org.gitlab4j.api.Constants

Constants.ActionType, Constants.IssueScope, Constants.IssueState, Constants.JobScope, Constants.LineType, Constants.PipelineOrderBy, Constants.PipelineScope, Constants.ProjectOrderBy, Constants.SortOrder, Constants.StateEvent, Constants.TargetType, Constants.TokenType

Field Summary

Fields inherited from interface org.gitlab4j.api.Constants

NEXT_PAGE_HEADER, PAGE_HEADER, PAGE_PARAM, PER_PAGE, PER_PAGE_PARAM, PREV_PAGE_HEADER, TOTAL_HEADER, TOTAL_PAGES_HEADER

Constructor Summary

Constructors

Constructor and Description
ProjectApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method and Description
ProjectHook	addHook(Integer projectId, String url, boolean doPushEvents, boolean doIssuesEvents, boolean doMergeRequestsEvents) Adds a hook to project.
ProjectHook	addHook(Integer projectId, String url, ProjectHook enabledHooks, boolean enableSslVerification, String secretToken) Adds a hook to project.
ProjectHook	addHook(Project project, String url, boolean doPushEvents, boolean doIssuesEvents, boolean doMergeRequestsEvents) Adds a hook to project.
ProjectHook	addHook(Project project, String url, ProjectHook enabledHooks, boolean enableSslVerification, String secretToken) Adds a hook to project.
ProjectHook	addHook(String projectName, String url, ProjectHook enabledHooks, boolean enableSslVerification, String secretToken) Adds a hook to project.
Member	addMember(Integer projectId, Integer userId, Integer accessLevel) Adds a user to a project team.
Project	createProject(Integer groupId, String projectName) Create a new project in the specified group.
Project	createProject(Project project) Creates new project owned by the current user.
Project	createProject(Project project, String importUrl) Creates new project owned by the current user.
Project	createProject(String projectName) Create a new project with the current user's namespace.
Project	createProject(String name, Integer namespaceId, String description, Boolean issuesEnabled, Boolean mergeRequestsEnabled, Boolean wikiEnabled, Boolean snippetsEnabled, Boolean isPublic, Integer visibilityLevel, String importUrl) Deprecated. As of release 4.2.0, replaced by createProject(String, Integer, String, Boolean, Boolean, Boolean, Boolean, Visibility, Integer, String)
Project	createProject(String name, Integer namespaceId, String description, Boolean issuesEnabled, Boolean mergeRequestsEnabled, Boolean wikiEnabled, Boolean snippetsEnabled, Visibility visibility, Integer visibilityLevel, String importUrl) Creates a Project
Snippet	createSnippet(Integer projectId, String title, String filename, String description, String code, Visibility visibility) Creates a new project snippet.
void	deleteHook(Integer projectId, Integer hookId) Deletes a hook from the project.
void	deleteHook(ProjectHook hook) Deletes a hook from the project.
void	deleteIssue(Integer projectId, Integer issueId) Deprecated. Will be removed in version 5.0, replaced by IssuesApi.deleteIssue(Integer, Integer)
void	deleteProject(Integer projectId) Removes project with all resources(issues, merge requests etc).
void	deleteProject(Project project) Removes project with all resources(issues, merge requests etc).
void	deleteSnippet(Integer projectId, Integer snippetId)
List<Project>	getAllProjects() Deprecated. Will be removed, no longer supported by the GitLab API
ProjectHook	getHook(Integer projectId, Integer hookId) Get a specific hook for project.
List<ProjectHook>	getHooks(Integer projectId) Get list of project hooks.
Pager<ProjectHook>	getHooks(Integer projectId, int itemsPerPage) Get Pager of project hooks.
List<ProjectHook>	getHooks(Integer projectId, int page, int perPage) Get list of project hooks in the specified page range.
Issue	getIssue(Integer projectId, Integer issueId) Deprecated. Will be removed in version 5.0, replaced by IssuesApi.getIssue(Integer, Integer)
List<Issue>	getIssues(Integer projectId) Deprecated. Will be removed in version 5.0, replaced by IssuesApi.getIssues(Integer)
Pager<Issue>	getIssues(Integer projectId, int itemsPerPage) Deprecated. Will be removed in version 5.0, replaced by IssuesApi.getIssues(Integer, int)
List<Issue>	getIssues(Integer projectId, int page, int perPage) Deprecated. Will be removed in version 5.0, replaced by IssuesApi.getIssues(Integer, int, int)
Member	getMember(Integer projectId, Integer userId) Gets a project team member.
List<Project>	getMemberProjects() Get a list of projects that the authenticated user is a member of.
Pager<Project>	getMemberProjects(int itemsPerPage) Get a Pager of projects that the authenticated user is a member of.
List<Project>	getMemberProjects(int page, int perPage) Get a list of projects that the authenticated user is a member of in the specified page range.
List<Member>	getMembers(Integer projectId) Get a list of project team members.
Pager<Member>	getMembers(Integer projectId, int itemsPerPage) Get a Pager of project team members.
List<Member>	getMembers(Integer projectId, int page, int perPage) Get a list of project team members in the specified page range.
List<Project>	getOwnedProjects() Get a list of projects owned by the authenticated user.
Pager<Project>	getOwnedProjects(int itemsPerPage) Get a Pager of projects owned by the authenticated user.
List<Project>	getOwnedProjects(int page, int perPage) Get a list of projects owned by the authenticated user in the specified page range.
Project	getProject(Integer projectId) Get a specific project, which is owned by the authentication user.
Project	getProject(String namespace, String project) Get a specific project, which is owned by the authentication user.
List<Event>	getProjectEvents(Integer projectId) Get the project events for specific project.
Pager<Event>	getProjectEvents(Integer projectId, int itemsPerPage) Get a Pager of project events for specific project.
List<Event>	getProjectEvents(Integer projectId, int page, int perPage) Get the project events for specific project.
List<Project>	getProjects() Get a list of projects accessible by the authenticated user.
List<Project>	getProjects(Boolean archived, Visibility visibility, Constants.ProjectOrderBy orderBy, Constants.SortOrder sort, String search, Boolean simple, Boolean owned, Boolean membership, Boolean starred, Boolean statistics) Get a list of projects accessible by the authenticated user and matching the supplied filter parameters.
Pager<Project>	getProjects(Boolean archived, Visibility visibility, Constants.ProjectOrderBy orderBy, Constants.SortOrder sort, String search, Boolean simple, Boolean owned, Boolean membership, Boolean starred, Boolean statistics, int itemsPerPage) Get a Pager of projects accessible by the authenticated user and matching the supplied filter parameters.
List<Project>	getProjects(Boolean archived, Visibility visibility, Constants.ProjectOrderBy orderBy, Constants.SortOrder sort, String search, Boolean simple, Boolean owned, Boolean membership, Boolean starred, Boolean statistics, int page, int perPage) Get a list of projects accessible by the authenticated user and matching the supplied filter parameters.
List<Project>	getProjects(Boolean archived, Visibility visibility, String orderBy, String sort, String search, Boolean simple, Boolean owned, Boolean membership, Boolean starred, Boolean statistics) Deprecated. Will be removed in version 5.0, replaced by getProjects(Boolean, Visibility, Constants.ProjectOrderBy, Constants.SortOrder, String, Boolean, Boolean, Boolean, Boolean, Boolean)
Pager<Project>	getProjects(int itemsPerPage) Get a Pager instance of projects accessible by the authenticated user.
List<Project>	getProjects(int page, int perPage) Get a list of projects accessible by the authenticated user and in the specified page range.
List<Project>	getProjects(String search) Get a list of projects accessible by the authenticated user that match the provided search string.
Pager<Project>	getProjects(String search, int itemsPerPage) Get a Pager of projects accessible by the authenticated user that match the provided search string.
List<Project>	getProjects(String search, int page, int perPage) Get a list of projects accessible by the authenticated user that match the provided search string.
List<ProjectUser>	getProjectUsers(Integer projectId) Get a list of project users.
List<ProjectUser>	getProjectUsers(Integer projectId, String search) Get a list of project users matching the specified search string.
String	getRawSnippetContent(Integer projectId, Integer snippetId)
Snippet	getSnippet(Integer projectId, Integer snippetId) Get a single of project snippet.
List<Snippet>	getSnippets(Integer projectId) Get a list of project snippets.
Pager<Snippet>	getSnippets(Integer projectId, int itemsPerPage) Get a Pager of project's snippets.
List<Snippet>	getSnippets(Integer projectId, int page, int perPage) Get a list of project snippets.
List<Project>	getStarredProjects() Get a list of projects starred by the authenticated user.
Pager<Project>	getStarredProjects(int itemsPerPage) Get a Pager of projects starred by the authenticated user.
List<Project>	getStarredProjects(int page, int perPage) Get a list of projects starred by the authenticated user in the specified page range.
ProjectHook	modifyHook(ProjectHook hook) Modifies a hook for project.
void	removeMember(Integer projectId, Integer userId) Removes user from project team.
Project	updateProject(Project project) Updates a project.
Snippet	updateSnippet(Integer projectId, Integer snippetId, String title, String filename, String description, String code, Visibility visibility) Updates an existing project snippet.

Methods inherited from class org.gitlab4j.api.AbstractApi

addFormParam, addFormParam, delete, delete, get, get, getApiClient, getApiVersion, getDefaultPerPage, getDefaultPerPageParam, getPageQueryParams, getWithAccepts, handle, isApiVersion, post, post, post, put, put, putWithFormData, urlEncode, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectApi

public ProjectApi(GitLabApi gitLabApi)

Method Detail

getProjects

public List<Project> getProjects()
                          throws GitLabApiException

Get a list of projects accessible by the authenticated user. GET /projects

Returns:

a list of projects accessible by the authenticated user

Throws:

GitLabApiException - if any exception occurs

getProjects

public List<Project> getProjects(int page,
                                 int perPage)
                          throws GitLabApiException

Get a list of projects accessible by the authenticated user and in the specified page range. GET /projects

Parameters:

page - the page to get

perPage - the number of projects per page

Returns:

a list of projects accessible by the authenticated user

Throws:

GitLabApiException - if any exception occurs

getProjects

public Pager<Project> getProjects(int itemsPerPage)
                           throws GitLabApiException

Get a Pager instance of projects accessible by the authenticated user. GET /projects

Parameters:

itemsPerPage - the number of Project instances that will be fetched per page

Returns:

a Pager instance of projects accessible by the authenticated user

Throws:

GitLabApiException - if any exception occurs

getProjects

public List<Project> getProjects(Boolean archived,
                                 Visibility visibility,
                                 String orderBy,
                                 String sort,
                                 String search,
                                 Boolean simple,
                                 Boolean owned,
                                 Boolean membership,
                                 Boolean starred,
                                 Boolean statistics)
                          throws GitLabApiException

Deprecated. Will be removed in version 5.0, replaced by getProjects(Boolean, Visibility, Constants.ProjectOrderBy, Constants.SortOrder, String, Boolean, Boolean, Boolean, Boolean, Boolean)

Get a list of projects accessible by the authenticated user and matching the supplied filter parameters. All filter parameters are optional. GET /projects

Parameters:

archived - limit by archived status

visibility - limit by visibility public, internal, or private

orderBy - return projects ordered by id, name, path, created_at, updated_at, or last_activity_at fields, default is created_at

sort - return projects sorted in asc or desc order. Default is desc

search - return list of projects matching the search criteria

simple - return only the ID, URL, name, and path of each project

owned - limit by projects owned by the current user

membership - limit by projects that the current user is a member of

starred - limit by projects starred by the current user

statistics - include project statistics

Returns:

a list of projects accessible by the authenticated user and matching the supplied parameters

Throws:

GitLabApiException - if any exception occurs

getProjects

public List<Project> getProjects(Boolean archived,
                                 Visibility visibility,
                                 Constants.ProjectOrderBy orderBy,
                                 Constants.SortOrder sort,
                                 String search,
                                 Boolean simple,
                                 Boolean owned,
                                 Boolean membership,
                                 Boolean starred,
                                 Boolean statistics)
                          throws GitLabApiException

Get a list of projects accessible by the authenticated user and matching the supplied filter parameters. All filter parameters are optional. GET /projects

Parameters:

archived - limit by archived status

visibility - limit by visibility public, internal, or private

orderBy - return projects ordered by ID, NAME, PATH, CREATED_AT, UPDATED_AT, or LAST_ACTIVITY_AT fields, default is CREATED_AT

sort - return projects sorted in asc or desc order. Default is desc

search - return list of projects matching the search criteria

simple - return only the ID, URL, name, and path of each project

owned - limit by projects owned by the current user

membership - limit by projects that the current user is a member of

starred - limit by projects starred by the current user

statistics - include project statistics

Returns:

a list of projects accessible by the authenticated user and matching the supplied parameters

Throws:

GitLabApiException - if any exception occurs

getProjects

public List<Project> getProjects(Boolean archived,
                                 Visibility visibility,
                                 Constants.ProjectOrderBy orderBy,
                                 Constants.SortOrder sort,
                                 String search,
                                 Boolean simple,
                                 Boolean owned,
                                 Boolean membership,
                                 Boolean starred,
                                 Boolean statistics,
                                 int page,
                                 int perPage)
                          throws GitLabApiException

Get a list of projects accessible by the authenticated user and matching the supplied filter parameters. All filter parameters are optional. GET /projects

Parameters:

archived - limit by archived status

visibility - limit by visibility public, internal, or private

orderBy - return projects ordered by ID, NAME, PATH, CREATED_AT, UPDATED_AT, or LAST_ACTIVITY_AT fields, default is CREATED_AT

sort - return projects sorted in asc or desc order. Default is desc

search - return list of projects matching the search criteria

simple - return only the ID, URL, name, and path of each project

owned - limit by projects owned by the current user

membership - limit by projects that the current user is a member of

starred - limit by projects starred by the current user

statistics - include project statistics

page - the page to get

perPage - the number of projects per page

Returns:

a list of projects accessible by the authenticated user and matching the supplied parameters

Throws:

GitLabApiException - if any exception occurs

getProjects

public Pager<Project> getProjects(Boolean archived,
                                  Visibility visibility,
                                  Constants.ProjectOrderBy orderBy,
                                  Constants.SortOrder sort,
                                  String search,
                                  Boolean simple,
                                  Boolean owned,
                                  Boolean membership,
                                  Boolean starred,
                                  Boolean statistics,
                                  int itemsPerPage)
                           throws GitLabApiException

Get a Pager of projects accessible by the authenticated user and matching the supplied filter parameters. All filter parameters are optional. GET /projects

Parameters:

archived - limit by archived status

visibility - limit by visibility public, internal, or private

orderBy - return projects ordered by ID, NAME, PATH, CREATED_AT, UPDATED_AT, or LAST_ACTIVITY_AT fields, default is CREATED_AT

sort - return projects sorted in asc or desc order. Default is desc

search - return list of projects matching the search criteria

simple - return only the ID, URL, name, and path of each project

owned - limit by projects owned by the current user

membership - limit by projects that the current user is a member of

starred - limit by projects starred by the current user

statistics - include project statistics

itemsPerPage - the number of Project instances that will be fetched per page

Returns:

a Pager of projects accessible by the authenticated user and matching the supplied parameters

Throws:

GitLabApiException - if any exception occurs

getProjects

public List<Project> getProjects(String search)
                          throws GitLabApiException

Get a list of projects accessible by the authenticated user that match the provided search string. GET /projects?search=search

Parameters:

search - the project name search criteria

Returns:

a list of projects accessible by the authenticated user that match the provided search string

Throws:

GitLabApiException - if any exception occurs

getProjects

public List<Project> getProjects(String search,
                                 int page,
                                 int perPage)
                          throws GitLabApiException

Get a list of projects accessible by the authenticated user that match the provided search string. GET /projects?search=search

Parameters:

search - the project name search criteria

page - the page to get

perPage - the number of projects per page

Returns:

a list of projects accessible by the authenticated user that match the provided search string

Throws:

GitLabApiException - if any exception occurs

getProjects

public Pager<Project> getProjects(String search,
                                  int itemsPerPage)
                           throws GitLabApiException

Get a Pager of projects accessible by the authenticated user that match the provided search string. GET /projects?search=search

Parameters:

search - the project name search criteria

itemsPerPage - the number of Project instances that will be fetched per page

Returns:

a Pager of projects accessible by the authenticated user that match the provided search string

Throws:

GitLabApiException - if any exception occurs

getMemberProjects

public List<Project> getMemberProjects()
                                throws GitLabApiException

Get a list of projects that the authenticated user is a member of. GET /projects

Returns:

a list of projects that the authenticated user is a member of

Throws:

GitLabApiException - if any exception occurs

getMemberProjects

public List<Project> getMemberProjects(int page,
                                       int perPage)
                                throws GitLabApiException

Get a list of projects that the authenticated user is a member of in the specified page range. GET /projects

Parameters:

page - the page to get

perPage - the number of projects per page

Returns:

a list of projects that the authenticated user is a member of

Throws:

GitLabApiException - if any exception occurs

getMemberProjects

public Pager<Project> getMemberProjects(int itemsPerPage)
                                 throws GitLabApiException

Get a Pager of projects that the authenticated user is a member of. GET /projects

Parameters:

itemsPerPage - the number of Project instances that will be fetched per page

Returns:

a Pager o Project instances that the authenticated user is a member of

Throws:

GitLabApiException - if any exception occurs

getAllProjects

public List<Project> getAllProjects()
                             throws GitLabApiException

Deprecated. Will be removed, no longer supported by the GitLab API

Get a list of all GitLab projects (admin only). GET /projects/all

Returns:

a list of all GitLab projects

Throws:

GitLabApiException - if any exception occurs

getOwnedProjects

public List<Project> getOwnedProjects()
                               throws GitLabApiException

Get a list of projects owned by the authenticated user. GET /projects

Returns:

a list of projects owned by the authenticated user

Throws:

GitLabApiException - if any exception occurs

getOwnedProjects

public List<Project> getOwnedProjects(int page,
                                      int perPage)
                               throws GitLabApiException

Get a list of projects owned by the authenticated user in the specified page range. GET /projects

Parameters:

page - the page to get

perPage - the number of projects per page

Returns:

a list of projects owned by the authenticated user

Throws:

GitLabApiException - if any exception occurs

getOwnedProjects

public Pager<Project> getOwnedProjects(int itemsPerPage)
                                throws GitLabApiException

Get a Pager of projects owned by the authenticated user. GET /projects

Parameters:

itemsPerPage - the number of Project instances that will be fetched per page

Returns:

a list of projects owned by the authenticated user

Throws:

GitLabApiException - if any exception occurs

getStarredProjects

public List<Project> getStarredProjects()
                                 throws GitLabApiException

Get a list of projects starred by the authenticated user. GET /projects

Returns:

a list of projects starred by the authenticated user

Throws:

GitLabApiException - if any exception occurs

getStarredProjects

public List<Project> getStarredProjects(int page,
                                        int perPage)
                                 throws GitLabApiException

Get a list of projects starred by the authenticated user in the specified page range. GET /projects

Parameters:

page - the page to get

perPage - the number of projects per page

Returns:

a list of projects starred by the authenticated user

Throws:

GitLabApiException - if any exception occurs

getStarredProjects

public Pager<Project> getStarredProjects(int itemsPerPage)
                                  throws GitLabApiException

Get a Pager of projects starred by the authenticated user. GET /projects

Parameters:

itemsPerPage - the number of Project instances that will be fetched per page

Returns:

a Pager of projects starred by the authenticated user

Throws:

GitLabApiException - if any exception occurs

getProject

public Project getProject(Integer projectId)
                   throws GitLabApiException

Get a specific project, which is owned by the authentication user. GET /projects/:id

Parameters:

projectId - the ID of the project to get

Returns:

the specified project

Throws:

GitLabApiException - if any exception occurs

getProject

public Project getProject(String namespace,
                          String project)
                   throws GitLabApiException

Get a specific project, which is owned by the authentication user. GET /projects/:id

Parameters:

namespace - the name of the project namespace or group

project - the name of the project to get

Returns:

the specified project

Throws:

GitLabApiException - if any exception occurs

createProject

public Project createProject(Integer groupId,
                             String projectName)
                      throws GitLabApiException

Create a new project in the specified group.

Parameters:

groupId - the group ID to create the project under

projectName - the name of the project top create

Returns:

the created project

Throws:

GitLabApiException - if any exception occurs

createProject

public Project createProject(String projectName)
                      throws GitLabApiException

Create a new project with the current user's namespace.

Parameters:

projectName - the name of the project top create

Returns:

the created project

Throws:

GitLabApiException - if any exception occurs

createProject

public Project createProject(Project project)
                      throws GitLabApiException

Creates new project owned by the current user.

Parameters:

project - the Project instance with the configuration for the new project

Returns:

a Project instance with the newly created project info

Throws:

GitLabApiException - if any exception occurs

createProject

public Project createProject(Project project,
                             String importUrl)
                      throws GitLabApiException

Creates new project owned by the current user. The following properties on the Project instance are utilized in the creation of the project: name (name or path are required) - new project name path (name or path are required) - new project path defaultBranch (optional) - master by default description (optional) - short project description visibility (optional) - Limit by visibility public, internal, or private visibilityLevel (optional) issuesEnabled (optional) - Enable issues for this project mergeRequestsEnabled (optional) - Enable merge requests for this project wikiEnabled (optional) - Enable wiki for this project snippetsEnabled (optional) - Enable snippets for this project jobsEnabled (optional) - Enable jobs for this project containerRegistryEnabled (optional) - Enable container registry for this project sharedRunnersEnabled (optional) - Enable shared runners for this project publicJobs (optional) - If true, jobs can be viewed by non-project-members onlyAllowMergeIfPipelineSucceeds (optional) - Set whether merge requests can only be merged with successful jobs onlyAllowMergeIfAllDiscussionsAreResolved (optional) - Set whether merge requests can only be merged when all the discussions are resolved lLfsEnabled (optional) - Enable LFS requestAccessEnabled (optional) - Allow users to request member access repositoryStorage (optional) - Which storage shard the repository is on. Available only to admins approvalsBeforeMerge (optional) - How many approvers should approve merge request by default

Parameters:

project - the Project instance with the configuration for the new project

importUrl - the URL to import the repository from

Returns:

a Project instance with the newly created project info

Throws:

GitLabApiException - if any exception occurs

createProject

public Project createProject(String name,
                             Integer namespaceId,
                             String description,
                             Boolean issuesEnabled,
                             Boolean mergeRequestsEnabled,
                             Boolean wikiEnabled,
                             Boolean snippetsEnabled,
                             Visibility visibility,
                             Integer visibilityLevel,
                             String importUrl)
                      throws GitLabApiException

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

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

visibility - The visibility of the project, 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:

GitLabApiException - if any exception occurs

createProject

@Deprecated
public Project createProject(String name,
                                          Integer namespaceId,
                                          String description,
                                          Boolean issuesEnabled,
                                          Boolean mergeRequestsEnabled,
                                          Boolean wikiEnabled,
                                          Boolean snippetsEnabled,
                                          Boolean isPublic,
                                          Integer visibilityLevel,
                                          String importUrl)
                                   throws GitLabApiException

Deprecated. As of release 4.2.0, replaced by createProject(String, Integer, String, Boolean, Boolean, Boolean, Boolean, Visibility, Integer, String)

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

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

isPublic - 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:

GitLabApiException - if any exception occurs

updateProject

public Project updateProject(Project project)
                      throws GitLabApiException

Updates a project. The following properties on the Project instance are utilized in the edit of the project, null values are not updated: id (required) - existing project id name (required) - project name path (optional) - project path defaultBranch (optional) - master by default description (optional) - short project description visibility (optional) - Limit by visibility public, internal, or private issuesEnabled (optional) - Enable issues for this project mergeRequestsEnabled (optional) - Enable merge requests for this project wikiEnabled (optional) - Enable wiki for this project snippetsEnabled (optional) - Enable snippets for this project jobsEnabled (optional) - Enable jobs for this project containerRegistryEnabled (optional) - Enable container registry for this project sharedRunnersEnabled (optional) - Enable shared runners for this project publicJobs (optional) - If true, jobs can be viewed by non-project-members onlyAllowMergeIfPipelineSucceeds (optional) - Set whether merge requests can only be merged with successful jobs onlyAllowMergeIfAllDiscussionsAreResolved (optional) - Set whether merge requests can only be merged when all the discussions are resolved lLfsEnabled (optional) - Enable LFS requestAccessEnabled (optional) - Allow users to request member access repositoryStorage (optional) - Which storage shard the repository is on. Available only to admins approvalsBeforeMerge (optional) - How many approvers should approve merge request by default NOTE: The following parameters specified by the GitLab API edit project are not supported: import_url tag_list array avatar ci_config_path

Parameters:

project - the Project instance with the configuration for the new project

Returns:

a Project instance with the newly updated project info

Throws:

GitLabApiException - if any exception occurs

deleteProject

public void deleteProject(Integer projectId)
                   throws GitLabApiException

Removes project with all resources(issues, merge requests etc). DELETE /projects/:id

Parameters:

projectId - the project ID to remove

Throws:

GitLabApiException - if any exception occurs

deleteProject

public void deleteProject(Project project)
                   throws GitLabApiException

Removes project with all resources(issues, merge requests etc). DELETE /projects/:id

Parameters:

project - the Project instance to remove

Throws:

GitLabApiException - if any exception occurs

getMembers

public List<Member> getMembers(Integer projectId)
                        throws GitLabApiException

Get a list of project team members. GET /projects/:id/members

Parameters:

projectId - the project ID to get team members for

Returns:

the members belonging to the specified project

Throws:

GitLabApiException - if any exception occurs

getMembers

public List<Member> getMembers(Integer projectId,
                               int page,
                               int perPage)
                        throws GitLabApiException

Get a list of project team members in the specified page range. GET /projects/:id/members

Parameters:

projectId - the project ID to get team members for

page - the page to get

perPage - the number of Member instances per page

Returns:

the members belonging to the specified project

Throws:

GitLabApiException - if any exception occurs

getMembers

public Pager<Member> getMembers(Integer projectId,
                                int itemsPerPage)
                         throws GitLabApiException

Get a Pager of project team members. GET /projects/:id/members

Parameters:

projectId - the project ID to get team members for

itemsPerPage - the number of Project instances that will be fetched per page

Returns:

the members belonging to the specified project

Throws:

GitLabApiException - if any exception occurs

getMember

public Member getMember(Integer projectId,
                        Integer userId)
                 throws GitLabApiException

Gets a project team member. GET /projects/:id/members/:user_id

Parameters:

projectId - the project ID to get team member for

userId - the user ID of the member

Returns:

the member specified by the project ID/user ID pair

Throws:

GitLabApiException - if any exception occurs

addMember

public Member addMember(Integer projectId,
                        Integer userId,
                        Integer accessLevel)
                 throws GitLabApiException

Adds a user to a project team. This is an idempotent method and can be called multiple times with the same parameters. Adding team membership to a user that is already a member does not affect the existing membership. POST /projects/:id/members

Parameters:

projectId - the project ID to add the team member to

userId - the user ID of the member to add

accessLevel - the access level for the new member

Returns:

the added member

Throws:

GitLabApiException - if any exception occurs

removeMember

public void removeMember(Integer projectId,
                         Integer userId)
                  throws GitLabApiException

Removes user from project team. DELETE /projects/:id/members/:user_id

Parameters:

projectId - the project ID to remove the team member from

userId - the user ID of the member to remove

Throws:

GitLabApiException - if any exception occurs

getProjectUsers

public List<ProjectUser> getProjectUsers(Integer projectId)
                                  throws GitLabApiException

Get a list of project users. This list includes all project members and all users assigned to project parent groups. GET /projects/:id/users

Parameters:

projectId - the project ID to get users for

Returns:

the users belonging to the specified project and its parent groups

Throws:

GitLabApiException - if any exception occurs

getProjectUsers

public List<ProjectUser> getProjectUsers(Integer projectId,
                                         String search)
                                  throws GitLabApiException

Get a list of project users matching the specified search string. This list includes all project members and all users assigned to project parent groups. GET /projects/:id/users

Parameters:

projectId - the project ID to get users for

search - the string to match specific users

Returns:

the users matching the search string and belonging to the specified project and its parent groups

Throws:

GitLabApiException - if any exception occurs

getProjectEvents

public List<Event> getProjectEvents(Integer projectId)
                             throws GitLabApiException

Get the project events for specific project. Sorted from newest to latest. GET /projects/:id/events

Parameters:

projectId - the project ID to get events for

Returns:

the project events for the specified project

Throws:

GitLabApiException - if any exception occurs

getProjectEvents

public List<Event> getProjectEvents(Integer projectId,
                                    int page,
                                    int perPage)
                             throws GitLabApiException

Get the project events for specific project. Sorted from newest to latest in the specified page range. GET /projects/:id/events

Parameters:

projectId - the project ID to get events for

page - the page to get

perPage - the number of Event instances per page

Returns:

the project events for the specified project

Throws:

GitLabApiException - if any exception occurs

getProjectEvents

public Pager<Event> getProjectEvents(Integer projectId,
                                     int itemsPerPage)
                              throws GitLabApiException

Get a Pager of project events for specific project. Sorted from newest to latest. GET /projects/:id/events

Parameters:

projectId - the project ID to get events for

itemsPerPage - the number of Project instances that will be fetched per page

Returns:

a Pager of project events for the specified project

Throws:

GitLabApiException - if any exception occurs

getHooks

public List<ProjectHook> getHooks(Integer projectId)
                           throws GitLabApiException

Get list of project hooks. GET /projects/:id/hooks

Parameters:

projectId - the project ID to get project hooks for

Returns:

a list of project hooks for the specified project

Throws:

GitLabApiException - if any exception occurs

getHooks

public List<ProjectHook> getHooks(Integer projectId,
                                  int page,
                                  int perPage)
                           throws GitLabApiException

Get list of project hooks in the specified page range. GET /projects/:id/hooks

Parameters:

projectId - the project ID to get project hooks for

page - the page to get

perPage - the number of ProjectHook instances per page

Returns:

a list of project hooks for the specified project in the specified page range

Throws:

GitLabApiException - if any exception occurs

getHooks

public Pager<ProjectHook> getHooks(Integer projectId,
                                   int itemsPerPage)
                            throws GitLabApiException

Get Pager of project hooks. GET /projects/:id/hooks

Parameters:

projectId - the project ID to get project hooks for

itemsPerPage - the number of Project instances that will be fetched per page

Returns:

a Pager of project hooks for the specified project

Throws:

GitLabApiException - if any exception occurs

getHook

public ProjectHook getHook(Integer projectId,
                           Integer hookId)
                    throws GitLabApiException

Get a specific hook for project. GET /projects/:id/hooks/:hook_id

Parameters:

projectId - the project ID to get the hook for

hookId - the ID of the hook to get

Returns:

the project hook for the specified project ID/hook ID pair

Throws:

GitLabApiException - if any exception occurs

addHook

public ProjectHook addHook(String projectName,
                           String url,
                           ProjectHook enabledHooks,
                           boolean enableSslVerification,
                           String secretToken)
                    throws GitLabApiException

Adds a hook to project. POST /projects/:id/hooks

Parameters:

projectName - the name of the project

url - the callback URL for the hook

enabledHooks - a ProjectHook instance specifying which hooks to enable

enableSslVerification - enable SSL verification

secretToken - the secret token to pass back to the hook

Returns:

the added ProjectHook instance

Throws:

GitLabApiException - if any exception occurs

addHook

public ProjectHook addHook(Integer projectId,
                           String url,
                           ProjectHook enabledHooks,
                           boolean enableSslVerification,
                           String secretToken)
                    throws GitLabApiException

Adds a hook to project. POST /projects/:id/hooks

Parameters:

projectId - the project ID to add the project hook to

url - the callback URL for the hook

enabledHooks - a ProjectHook instance specifying which hooks to enable

enableSslVerification - enable SSL verification

secretToken - the secret token to pass back to the hook

Returns:

the added ProjectHook instance

Throws:

GitLabApiException - if any exception occurs

addHook

public ProjectHook addHook(Project project,
                           String url,
                           ProjectHook enabledHooks,
                           boolean enableSslVerification,
                           String secretToken)
                    throws GitLabApiException

Adds a hook to project. POST /projects/:id/hooks

Parameters:

project - the Project instance to add the project hook to

url - the callback URL for the hook

enabledHooks - a ProjectHook instance specifying which hooks to enable

enableSslVerification - enable SSL verification

secretToken - the secret token to pass back to the hook

Returns:

the added ProjectHook instance

Throws:

GitLabApiException - if any exception occurs

addHook

public ProjectHook addHook(Project project,
                           String url,
                           boolean doPushEvents,
                           boolean doIssuesEvents,
                           boolean doMergeRequestsEvents)
                    throws GitLabApiException

Adds a hook to project. POST /projects/:id/hooks

Parameters:

project - the Project instance to add the project hook to

url - the callback URL for the hook

doPushEvents - flag specifying whether to do push events

doIssuesEvents - flag specifying whether to do issues events

doMergeRequestsEvents - flag specifying whether to do merge requests events

Returns:

the added ProjectHook instance

Throws:

GitLabApiException - if any exception occurs

addHook

public ProjectHook addHook(Integer projectId,
                           String url,
                           boolean doPushEvents,
                           boolean doIssuesEvents,
                           boolean doMergeRequestsEvents)
                    throws GitLabApiException

Adds a hook to project. POST /projects/:id/hooks

Parameters:

projectId - the project ID to add the project hook to

url - the callback URL for the hook

doPushEvents - flag specifying whether to do push events

doIssuesEvents - flag specifying whether to do issues events

doMergeRequestsEvents - flag specifying whether to do merge requests events

Returns:

the added ProjectHook instance

Throws:

GitLabApiException - if any exception occurs

deleteHook

public void deleteHook(Integer projectId,
                       Integer hookId)
                throws GitLabApiException

Deletes a hook from the project. DELETE /projects/:id/hooks/:hook_id

Parameters:

projectId - the project ID to delete the project hook from

hookId - the project hook ID to delete

Throws:

GitLabApiException - if any exception occurs

deleteHook

public void deleteHook(ProjectHook hook)
                throws GitLabApiException

Deletes a hook from the project. DELETE /projects/:id/hooks/:hook_id

Parameters:

hook - the ProjectHook instance to remove

Throws:

GitLabApiException - if any exception occurs

modifyHook

public ProjectHook modifyHook(ProjectHook hook)
                       throws GitLabApiException

Modifies a hook for project. PUT /projects/:id/hooks/:hook_id

Parameters:

hook - the ProjectHook instance that contains the project hook info to modify

Returns:

the modified project hook

Throws:

GitLabApiException - if any exception occurs

getIssues

public List<Issue> getIssues(Integer projectId)
                      throws GitLabApiException

Deprecated. Will be removed in version 5.0, replaced by IssuesApi.getIssues(Integer)

Get a list of project's issues. Only returns the first page GET /projects/:id/issues

Parameters:

projectId - the project ID to get the issues for

Returns:

a list of project's issues

Throws:

GitLabApiException - if any exception occurs

getIssues

public List<Issue> getIssues(Integer projectId,
                             int page,
                             int perPage)
                      throws GitLabApiException

Deprecated. Will be removed in version 5.0, replaced by IssuesApi.getIssues(Integer, int, int)

Get a list of project's issues using the specified page and per page settings. GET /projects/:id/issues

Parameters:

projectId - the project ID to get the issues for

page - the page to get

perPage - the number of issues per page

Returns:

the list of issues in the specified range

Throws:

GitLabApiException - if any exception occurs

getIssues

public Pager<Issue> getIssues(Integer projectId,
                              int itemsPerPage)
                       throws GitLabApiException

Deprecated. Will be removed in version 5.0, replaced by IssuesApi.getIssues(Integer, int)

Get a Pager of project's issues. GET /projects/:id/issues

Parameters:

projectId - the project ID to get the issues for

itemsPerPage - the number of issues per page

Returns:

the list of issues in the specified range

Throws:

GitLabApiException - if any exception occurs

getIssue

public Issue getIssue(Integer projectId,
                      Integer issueId)
               throws GitLabApiException

Deprecated. Will be removed in version 5.0, replaced by IssuesApi.getIssue(Integer, Integer)

Get a single project issues. GET /projects/:id/issues/:issue_iid

Parameters:

projectId - the project ID to get the issue for

issueId - the internal ID of a project's issue

Returns:

the specified Issue instance

Throws:

GitLabApiException - if any exception occurs

deleteIssue

public void deleteIssue(Integer projectId,
                        Integer issueId)
                 throws GitLabApiException

Deprecated. Will be removed in version 5.0, replaced by IssuesApi.deleteIssue(Integer, Integer)

Delete a project issue. DELETE /projects/:id/issues/:issue_iid

Parameters:

projectId - the project ID to delete the issue from

issueId - the internal ID of a project's issue

Throws:

GitLabApiException - if any exception occurs

getSnippets

public List<Snippet> getSnippets(Integer projectId)
                          throws GitLabApiException

Get a list of project snippets. This only returns the first page of snippets. GET /projects/:id/snippets

Parameters:

projectId - the project ID to get the snippets for

Returns:

a list of project's snippets

Throws:

GitLabApiException - if any exception occurs

getSnippets

public List<Snippet> getSnippets(Integer projectId,
                                 int page,
                                 int perPage)
                          throws GitLabApiException

Get a list of project snippets. This only returns the first page of snippets. GET /projects/:id/snippets

Parameters:

projectId - the project ID to get the snippets for

page - the page to get

perPage - the number of snippets per page

Returns:

a list of project's snippets for the specified range

Throws:

GitLabApiException - if any exception occurs

getSnippets

public Pager<Snippet> getSnippets(Integer projectId,
                                  int itemsPerPage)
                           throws GitLabApiException

Get a Pager of project's snippets. GET /projects/:id/snippets

Parameters:

projectId - the project ID to get the issues for

itemsPerPage - the number of snippets per page

Returns:

the Pager of snippets

Throws:

GitLabApiException - if any exception occurs

getSnippet

public Snippet getSnippet(Integer projectId,
                          Integer snippetId)
                   throws GitLabApiException

Get a single of project snippet. GET /projects/:id/snippets/:snippet_id

Parameters:

projectId - the project ID to get the snippet for

snippetId - the ID of the project's snippet

Returns:

the specified project Snippet

Throws:

GitLabApiException - if any exception occurs

createSnippet

public Snippet createSnippet(Integer projectId,
                             String title,
                             String filename,
                             String description,
                             String code,
                             Visibility visibility)
                      throws GitLabApiException

Creates a new project snippet. The user must have permission to create new snippets. POST /projects/:id/snippets

Parameters:

projectId - the ID of the project owned by the authenticated user, required

title - the title of a snippet, required

filename - the name of a snippet file, required

description - the description of a snippet, optional

code - the content of a snippet, required

visibility - the snippet's visibility, required

Returns:

a Snippet instance with info on the created snippet

Throws:

GitLabApiException - if any exception occurs

updateSnippet

public Snippet updateSnippet(Integer projectId,
                             Integer snippetId,
                             String title,
                             String filename,
                             String description,
                             String code,
                             Visibility visibility)
                      throws GitLabApiException

Updates an existing project snippet. The user must have permission to change an existing snippet. PUT /projects/:id/snippets/:snippet_id

Parameters:

projectId - the ID of the project owned by the authenticated user, required

snippetId - the ID of a project's snippet, required

title - the title of a snippet, optional

filename - the name of a snippet file, optional

description - the description of a snippet, optioptionalonal

code - the content of a snippet, optional

visibility - the snippet's visibility, reqoptionaluired

Returns:

a Snippet instance with info on the updated snippet

Throws:

GitLabApiException - if any exception occurs

deleteSnippet

public void deleteSnippet(Integer projectId,
                          Integer snippetId)
                   throws GitLabApiException

Throws:

GitLabApiException

getRawSnippetContent

public String getRawSnippetContent(Integer projectId,
                                   Integer snippetId)
                            throws GitLabApiException

Throws:

GitLabApiException