org.gitlab4j.api

Class ProjectApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.ProjectApi

public class ProjectApi
extends AbstractApi

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

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) Creates a Project
void	deleteHook(Integer projectId, Integer hookId) Deletes a hook from the project.
void	deleteHook(ProjectHook hook) Deletes a hook from the project.
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).
List<Project>	getAllProjects() Get a list of all GitLab projects (admin only).
ProjectHook	getHook(Integer projectId, Integer hookId) Get a specific hook for project.
List<ProjectHook>	getHooks(Integer projectId) Get list of project hooks.
List<Issue>	getIssues(Integer projectId) Get a list of project's issues.
Member	getMember(Integer projectId, Integer userId) Gets a project team member.
List<Member>	getMembers(Integer projectId) Get a list of project team members.
List<Project>	getOwnedProjects() Get a list of projects owned by the authenticated user.
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 a project events for specific project.
List<Project>	getProjects() Get a list of projects accessible by the authenticated user.
ProjectHook	modifyHook(ProjectHook hook) Modifies a hook for project.
void	removeMember(Integer projectId, Integer userId) Removes user from project team.

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

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

getAllProjects

public List<Project> getAllProjects()
                             throws GitLabApiException

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/owned

Returns:

a list of projects owned 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 public (optional) - if true same as setting visibility_level = 20 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,
                             Boolean isPublic,
                             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

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

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

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

getProjectEvents

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

Get a 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

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

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

Get a list of project's issues. 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