org.gitlab4j.api

Class GroupApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.GroupApi

All Implemented Interfaces:

Constants

public class GroupApi
extends AbstractApi

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

Nested Class Summary

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

Constants.ActionType, Constants.ImpersonationState, Constants.IssueScope, Constants.IssueState, Constants.JobScope, Constants.LineType, Constants.MilestoneState, 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
GroupApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method and Description
Group	addGroup(String name, String path) Creates a new project group.
Group	addGroup(String name, String path, String description, Boolean membershipLock, Boolean shareWithGroupLock, Visibility visibility, Boolean lfsEnabled, Boolean requestAccessEnabled, Integer parentId, Integer sharedRunnersMinutesLimit) Deprecated. Will be removed in version 5.0, replaced by addGroup(String, String, String, Visibility, Boolean, Boolean, Integer)
Group	addGroup(String name, String path, String description, Visibility visibility, Boolean lfsEnabled, Boolean requestAccessEnabled, Integer parentId) Creates a new project group.
Member	addMember(Integer groupId, Integer userId, AccessLevel accessLevel) Adds a user to the list of group members.
Member	addMember(Integer groupId, Integer userId, AccessLevel accessLevel, Date expiresAt) Adds a user to the list of group members.
Member	addMember(Integer groupId, Integer userId, Integer accessLevel) Adds a user to the list of group members.
Member	addMember(Integer groupId, Integer userId, Integer accessLevel, Date expiresAt) Adds a user to the list of group members.
void	deleteGroup(Group group) Removes group with all projects inside.
void	deleteGroup(Integer groupId) Removes group with all projects inside.
Group	getGroup(Integer groupId) Get all details of a group.
Group	getGroup(String groupPath) Get all details of a group.
List<Group>	getGroups() Get a list of groups.
Pager<Group>	getGroups(int itemsPerPage) Get a Pager of groups.
List<Group>	getGroups(int page, int perPage) Get a list of groups (As user: my groups, as admin: all groups) and in the specified page range.
List<Group>	getGroups(String search) Get all groups that match your string in their name or path.
Pager<Group>	getGroups(String search, int itemsPerPage) Get all groups that match your string in their name or path.
List<Group>	getGroups(String search, int page, int perPage) Get all groups that match your string in their name or path.
Member	getMember(int groupId, int userId) Get a group member viewable by the authenticated user.
List<Member>	getMembers(int groupId) Get a list of group members viewable by the authenticated user.
Pager<Member>	getMembers(int groupId, int itemsPerPage) Get a Pager of group members viewable by the authenticated user.
List<Member>	getMembers(int groupId, int page, int perPage) Get a list of group members viewable by the authenticated user in the specified page range.
List<Project>	getProjects(int groupId) Get a list of projects belonging to the specified group ID.
Pager<Project>	getProjects(int groupId, int itemsPerPage) Get a Pager of projects belonging to the specified group ID.
List<Project>	getProjects(int groupId, int page, int perPage) Get a list of projects belonging to the specified group ID in the specified page range.
void	removeMember(Integer groupId, Integer userId) Removes member from the group.
Group	updateGroup(Integer groupId, String name, String path, String description, Boolean membershipLock, Boolean shareWithGroupLock, Visibility visibility, Boolean lfsEnabled, Boolean requestAccessEnabled, Integer parentId, Integer sharedRunnersMinutesLimit) Deprecated. Will be removed in version 5.0, replaced by updateGroup(Integer, String, String, String, Visibility, Boolean, Boolean, Integer)
Group	updateGroup(Integer groupId, String name, String path, String description, Visibility visibility, Boolean lfsEnabled, Boolean requestAccessEnabled, Integer parentId) Updates a project group.
Member	updateMember(Integer groupId, Integer userId, AccessLevel accessLevel) Updates a member of a group.
Member	updateMember(Integer groupId, Integer userId, AccessLevel accessLevel, Date expiresAt) Updates a member of a group.
Member	updateMember(Integer groupId, Integer userId, Integer accessLevel) Updates a member of a group.
Member	updateMember(Integer groupId, Integer userId, Integer accessLevel, Date expiresAt) Updates a member of a group.

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

GroupApi

public GroupApi(GitLabApi gitLabApi)

Method Detail

getGroups

public List<Group> getGroups()
                      throws GitLabApiException

Get a list of groups. (As user: my groups, as admin: all groups) GET /groups

Returns:

the list of groups viewable by the authenticated user

Throws:

GitLabApiException - if any exception occurs

getGroups

public List<Group> getGroups(int page,
                             int perPage)
                      throws GitLabApiException

Get a list of groups (As user: my groups, as admin: all groups) and in the specified page range. GET /groups

Parameters:

page - the page to get

perPage - the number of Group instances per page

Returns:

the list of groups viewable by the authenticated userin the specified page range

Throws:

GitLabApiException - if any exception occurs

getGroups

public Pager<Group> getGroups(int itemsPerPage)
                       throws GitLabApiException

Get a Pager of groups. (As user: my groups, as admin: all groups) GET /groups

Parameters:

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

Returns:

the list of groups viewable by the authenticated user

Throws:

GitLabApiException - if any exception occurs

getGroups

public List<Group> getGroups(String search)
                      throws GitLabApiException

Get all groups that match your string in their name or path.

Parameters:

search - the group name or path search criteria

Returns:

a List containing matching Group instances

Throws:

GitLabApiException - if any exception occurs

getGroups

public List<Group> getGroups(String search,
                             int page,
                             int perPage)
                      throws GitLabApiException

Get all groups that match your string in their name or path.

Parameters:

search - the group name or path search criteria

page - the page to get

perPage - the number of Group instances per page

Returns:

a List containing matching Group instances

Throws:

GitLabApiException - if any exception occurs

getGroups

public Pager<Group> getGroups(String search,
                              int itemsPerPage)
                       throws GitLabApiException

Get all groups that match your string in their name or path.

Parameters:

search - the group name or path search criteria

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

Returns:

a List containing matching Group instances

Throws:

GitLabApiException - if any exception occurs

getProjects

public List<Project> getProjects(int groupId)
                          throws GitLabApiException

Get a list of projects belonging to the specified group ID. GET /groups/:id/projects

Parameters:

groupId - the group ID to list the projects for

Returns:

a list of projects belonging to the specified group ID

Throws:

GitLabApiException - if any exception occurs

getProjects

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

Get a list of projects belonging to the specified group ID in the specified page range. GET /groups/:id/projects

Parameters:

groupId - the group ID to list the projects for

page - the page to get

perPage - the number of Project instances per page

Returns:

a list of projects belonging to the specified group ID in the specified page range

Throws:

GitLabApiException - if any exception occurs

getProjects

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

Get a Pager of projects belonging to the specified group ID. GET /groups/:id/projects

Parameters:

groupId - the group ID to list the projects for

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

Returns:

a Pager of projects belonging to the specified group ID

Throws:

GitLabApiException - if any exception occurs

getGroup

public Group getGroup(Integer groupId)
               throws GitLabApiException

Get all details of a group. GET /groups/:id

Parameters:

groupId - the group ID to get

Returns:

the Group instance for the specified group ID

Throws:

GitLabApiException - if any exception occurs

getGroup

public Group getGroup(String groupPath)
               throws GitLabApiException

Get all details of a group. GET /groups/:id

Parameters:

groupPath - the path of the group to get details for

Returns:

the Group instance for the specified group path

Throws:

GitLabApiException - if any exception occurs

addGroup

public Group addGroup(String name,
                      String path)
               throws GitLabApiException

Creates a new project group. Available only for users who can create groups. POST /groups

Parameters:

name - the name of the group to add

path - the path for the group

Returns:

the created Group instance

Throws:

GitLabApiException - if any exception occurs

addGroup

public Group addGroup(String name,
                      String path,
                      String description,
                      Visibility visibility,
                      Boolean lfsEnabled,
                      Boolean requestAccessEnabled,
                      Integer parentId)
               throws GitLabApiException

Creates a new project group. Available only for users who can create groups. POST /groups

Parameters:

name - the name of the group to add

path - the path for the group

description - (optional) - The group's description

visibility - (optional) - The group's visibility. Can be private, internal, or public.

lfsEnabled - (optional) - Enable/disable Large File Storage (LFS) for the projects in this group

requestAccessEnabled - (optional) - Allow users to request member access

parentId - (optional) - The parent group id for creating nested group

Returns:

the created Group instance

Throws:

GitLabApiException - if any exception occurs

updateGroup

public Group updateGroup(Integer groupId,
                         String name,
                         String path,
                         String description,
                         Visibility visibility,
                         Boolean lfsEnabled,
                         Boolean requestAccessEnabled,
                         Integer parentId)
                  throws GitLabApiException

Updates a project group. Available only for users who can create groups. PUT /groups

Parameters:

groupId - the ID of the group to update

name - the name of the group to add

path - the path for the group

description - (optional) - The group's description

visibility - (optional) - The group's visibility. Can be private, internal, or public.

lfsEnabled - (optional) - Enable/disable Large File Storage (LFS) for the projects in this group

requestAccessEnabled - (optional) - Allow users to request member access

parentId - (optional) - The parent group id for creating nested group

Returns:

the updated Group instance

Throws:

GitLabApiException - if any exception occurs

addGroup

public Group addGroup(String name,
                      String path,
                      String description,
                      Boolean membershipLock,
                      Boolean shareWithGroupLock,
                      Visibility visibility,
                      Boolean lfsEnabled,
                      Boolean requestAccessEnabled,
                      Integer parentId,
                      Integer sharedRunnersMinutesLimit)
               throws GitLabApiException

Deprecated. Will be removed in version 5.0, replaced by addGroup(String, String, String, Visibility, Boolean, Boolean, Integer)

Creates a new project group. Available only for users who can create groups. POST /groups

Parameters:

name - the name of the group to add

path - the path for the group

description - (optional) - The group's description

membershipLock - (optional, boolean) - Prevent adding new members to project membership within this group

shareWithGroupLock - (optional, boolean) - Prevent sharing a project with another group within this group

visibility - (optional) - The group's visibility. Can be private, internal, or public.

lfsEnabled - (optional) - Enable/disable Large File Storage (LFS) for the projects in this group

requestAccessEnabled - (optional) - Allow users to request member access.

parentId - (optional) - The parent group id for creating nested group.

sharedRunnersMinutesLimit - (optional) - (admin-only) Pipeline minutes quota for this group

Returns:

the created Group instance

Throws:

GitLabApiException - if any exception occurs

updateGroup

public Group updateGroup(Integer groupId,
                         String name,
                         String path,
                         String description,
                         Boolean membershipLock,
                         Boolean shareWithGroupLock,
                         Visibility visibility,
                         Boolean lfsEnabled,
                         Boolean requestAccessEnabled,
                         Integer parentId,
                         Integer sharedRunnersMinutesLimit)
                  throws GitLabApiException

Deprecated. Will be removed in version 5.0, replaced by updateGroup(Integer, String, String, String, Visibility, Boolean, Boolean, Integer)

Updates a project group. Available only for users who can create groups. PUT /groups

Parameters:

groupId - the ID of the group to update

name - the name of the group to add

path - the path for the group

description - (optional) - The group's description

membershipLock - (optional, boolean) - Prevent adding new members to project membership within this group

shareWithGroupLock - (optional, boolean) - Prevent sharing a project with another group within this group

visibility - (optional) - The group's visibility. Can be private, internal, or public.

lfsEnabled - (optional) - Enable/disable Large File Storage (LFS) for the projects in this group

requestAccessEnabled - (optional) - Allow users to request member access

parentId - (optional) - The parent group id for creating nested group

sharedRunnersMinutesLimit - (optional) - (admin-only) Pipeline minutes quota for this group

Returns:

the updated Group instance

Throws:

GitLabApiException - if any exception occurs

deleteGroup

public void deleteGroup(Integer groupId)
                 throws GitLabApiException

Removes group with all projects inside. DELETE /groups/:id

Parameters:

groupId - the group ID to delete

Throws:

GitLabApiException - if any exception occurs

deleteGroup

public void deleteGroup(Group group)
                 throws GitLabApiException

Removes group with all projects inside. DELETE /groups/:id

Parameters:

group - the Group instance to delete

Throws:

GitLabApiException - if any exception occurs

getMembers

public List<Member> getMembers(int groupId)
                        throws GitLabApiException

Get a list of group members viewable by the authenticated user. GET /groups/:id/members

Parameters:

groupId - the group ID to list the members for

Returns:

a list of group members viewable by the authenticated user

Throws:

GitLabApiException - if any exception occurs

getMembers

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

Get a list of group members viewable by the authenticated user in the specified page range. GET /groups/:id/members

Parameters:

groupId - the group ID to list the members for

page - the page to get

perPage - the number of Member instances per page

Returns:

a list of group members viewable by the authenticated user in the specified page range

Throws:

GitLabApiException - if any exception occurs

getMembers

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

Get a Pager of group members viewable by the authenticated user. GET /groups/:id/members

Parameters:

groupId - the group ID to list the members for

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

Returns:

a list of group members viewable by the authenticated user

Throws:

GitLabApiException - if any exception occurs

getMember

public Member getMember(int groupId,
                        int userId)
                 throws GitLabApiException

Get a group member viewable by the authenticated user. GET /groups/:id/members/:id

Parameters:

groupId - the group ID to get the member for

userId - the member ID of the member to get

Returns:

a member viewable by the authenticated user

Throws:

GitLabApiException - if any exception occurs

addMember

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

Adds a user to the list of group members. POST /groups/:id/members

Parameters:

groupId - the project ID to add the member to, required

userId - the user ID of the member to add, required

accessLevel - the access level for the new member, required

Returns:

a Member instance for the added user

Throws:

GitLabApiException - if any exception occurs

addMember

public Member addMember(Integer groupId,
                        Integer userId,
                        AccessLevel accessLevel)
                 throws GitLabApiException

Adds a user to the list of group members. POST /groups/:id/members

Parameters:

groupId - the project ID to add the member to, required

userId - the user ID of the member to add, required

accessLevel - the access level for the new member, required

Returns:

a Member instance for the added user

Throws:

GitLabApiException - if any exception occurs

addMember

public Member addMember(Integer groupId,
                        Integer userId,
                        AccessLevel accessLevel,
                        Date expiresAt)
                 throws GitLabApiException

Adds a user to the list of group members. POST /groups/:id/members

Parameters:

groupId - the project ID to add the member to, required

userId - the user ID of the member to add, required

accessLevel - the access level for the new member, required

expiresAt - the date the membership in the group will expire, optional

Returns:

a Member instance for the added user

Throws:

GitLabApiException - if any exception occurs

addMember

public Member addMember(Integer groupId,
                        Integer userId,
                        Integer accessLevel,
                        Date expiresAt)
                 throws GitLabApiException

Adds a user to the list of group members. POST /groups/:id/members

Parameters:

groupId - the project ID to add the member to, required

userId - the user ID of the member to add, required

accessLevel - the access level for the new member, required

expiresAt - the date the membership in the group will expire, optional

Returns:

a Member instance for the added user

Throws:

GitLabApiException - if any exception occurs

updateMember

public Member updateMember(Integer groupId,
                           Integer userId,
                           Integer accessLevel)
                    throws GitLabApiException

Updates a member of a group. PUT /groups/:groupId/members/:userId

Parameters:

groupId - the group ID the member belongs to, required

userId - the user ID of the member to update, required

accessLevel - the new access level for the member, required

Returns:

the updated member

Throws:

GitLabApiException - if any exception occurs

updateMember

public Member updateMember(Integer groupId,
                           Integer userId,
                           AccessLevel accessLevel)
                    throws GitLabApiException

Updates a member of a group. PUT /groups/:groupId/members/:userId

Parameters:

groupId - the group ID the member belongs to, required

userId - the user ID of the member to update, required

accessLevel - the new access level for the member, required

Returns:

the updated member

Throws:

GitLabApiException - if any exception occurs

updateMember

public Member updateMember(Integer groupId,
                           Integer userId,
                           AccessLevel accessLevel,
                           Date expiresAt)
                    throws GitLabApiException

Updates a member of a group. PUT /groups/:groupId/members/:userId

Parameters:

groupId - the group ID the member belongs to, required

userId - the user ID of the member to update, required

accessLevel - the new access level for the member, required

expiresAt - the date the membership in the group will expire, optional

Returns:

the updated member

Throws:

GitLabApiException - if any exception occurs

updateMember

public Member updateMember(Integer groupId,
                           Integer userId,
                           Integer accessLevel,
                           Date expiresAt)
                    throws GitLabApiException

Updates a member of a group. PUT /groups/:groupId/members/:userId

Parameters:

groupId - the group ID the member belongs to, required

userId - the user ID of the member to update, required

accessLevel - the new access level for the member, required

expiresAt - the date the membership in the group will expire, optional

Returns:

the updated member

Throws:

GitLabApiException - if any exception occurs

removeMember

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

Removes member from the group. DELETE /groups/:id/members/:user_id

Parameters:

groupId - the group ID to remove the member from

userId - the user ID of the member to remove

Throws:

GitLabApiException - if any exception occurs