public class GroupApi extends AbstractApi
Constants.ActionType, Constants.ApplicationScope, Constants.ArchiveFormat, Constants.AutoDevopsDeployStrategy, Constants.BuildGitStrategy, Constants.CommitBuildState, Constants.ContributorOrderBy, Constants.DefaultBranchProtectionLevel, Constants.DeploymentOrderBy, Constants.DeploymentStatus, Constants.DeployTokenScope, Constants.Encoding, Constants.EpicOrderBy, Constants.EventScope, Constants.GroupOrderBy, Constants.GroupSearchScope, Constants.ImpersonationState, Constants.IssueOrderBy, Constants.IssueScope, Constants.IssueState, Constants.JobScope, Constants.LineType, Constants.MergeRequestOrderBy, Constants.MergeRequestScope, Constants.MergeRequestSearchIn, Constants.MergeRequestState, Constants.MilestoneState, Constants.PackageOrderBy, Constants.PackageStatus, Constants.PipelineOrderBy, Constants.PipelineScope, Constants.ProjectAccessTokenScope, Constants.ProjectCreationLevel, Constants.ProjectOrderBy, Constants.ProjectSearchScope, Constants.SearchScope, Constants.SortOrder, Constants.SquashOption, Constants.StateEvent, Constants.SubgroupCreationLevel, Constants.TagOrderBy, Constants.TargetType, Constants.TodoAction, Constants.TodoState, Constants.TodoType, Constants.TokenType
gitLabApi
NEXT_PAGE_HEADER, PAGE_HEADER, PAGE_PARAM, PER_PAGE, PER_PAGE_PARAM, PREV_PAGE_HEADER, TOTAL_HEADER, TOTAL_PAGES_HEADER
Modifier and Type | Method and Description |
---|---|
Badge |
addBadge(java.lang.Object groupIdOrPath,
java.lang.String linkUrl,
java.lang.String imageUrl)
Add a badge to a group.
|
Badge |
addBadge(java.lang.Object groupIdOrPath,
java.lang.String name,
java.lang.String linkUrl,
java.lang.String imageUrl)
Add a badge to a group.
|
Group |
addGroup(Group group) |
Group |
addGroup(java.lang.String name,
java.lang.String path)
Creates a new project group.
|
Group |
addGroup(java.lang.String name,
java.lang.String path,
java.lang.String description,
java.lang.Boolean membershipLock,
java.lang.Boolean shareWithGroupLock,
Visibility visibility,
java.lang.Boolean lfsEnabled,
java.lang.Boolean requestAccessEnabled,
java.lang.Long parentId,
java.lang.Integer sharedRunnersMinutesLimit)
Deprecated.
Will be removed in version 6.0, replaced by
addGroup(String, String, String, Visibility,
Boolean, Boolean, Long) |
Group |
addGroup(java.lang.String name,
java.lang.String path,
java.lang.String description,
Visibility visibility,
java.lang.Boolean lfsEnabled,
java.lang.Boolean requestAccessEnabled,
java.lang.Long parentId)
Creates a new project group.
|
void |
addLdapGroupLink(java.lang.Object groupIdOrPath,
java.lang.String cn,
AccessLevel groupAccess,
java.lang.String provider)
Adds an LDAP group link.
|
void |
addLdapGroupLink(java.lang.Object groupIdOrPath,
java.lang.String cn,
java.lang.Integer groupAccess,
java.lang.String provider)
Adds an LDAP group link.
|
Member |
addMember(java.lang.Object groupIdOrPath,
java.lang.Long userId,
AccessLevel accessLevel)
Adds a user to the list of group members.
|
Member |
addMember(java.lang.Object groupIdOrPath,
java.lang.Long userId,
AccessLevel accessLevel,
java.util.Date expiresAt)
Adds a user to the list of group members.
|
Member |
addMember(java.lang.Object groupIdOrPath,
java.lang.Long userId,
java.lang.Integer accessLevel)
Adds a user to the list of group members.
|
Member |
addMember(java.lang.Object groupIdOrPath,
java.lang.Long userId,
java.lang.Integer accessLevel,
java.util.Date expiresAt)
Adds a user to the list of group members.
|
void |
addSamlGroupLink(java.lang.Object groupIdOrPath,
java.lang.String samlGroupName,
AccessLevel groupAccess)
Adds an SAML group link.
|
void |
addSamlGroupLink(java.lang.Object groupIdOrPath,
java.lang.String samlGroupName,
java.lang.Integer groupAccess)
Adds an SAML group link.
|
AccessRequest |
approveAccessRequest(java.lang.Object groupIdOrPath,
java.lang.Long userId,
AccessLevel accessLevel)
Approve access for the specified user to the specified group.
|
Group |
createGroup(GroupParams params)
Creates a new project group.
|
GroupAccessToken |
createGroupAccessToken(java.lang.Object groupIdOrPath,
java.lang.String name,
java.util.Date expiresAt,
ImpersonationToken.Scope[] scopes,
AccessLevel accessLevel)
Create a group access token.
|
Variable |
createVariable(java.lang.Object groupIdOrPath,
java.lang.String key,
java.lang.String value,
java.lang.Boolean isProtected)
Create a new group variable.
|
Variable |
createVariable(java.lang.Object groupIdOrPath,
java.lang.String key,
java.lang.String value,
java.lang.Boolean isProtected,
java.lang.Boolean masked)
Create a new group variable.
|
void |
deleteCustomAttribute(java.lang.Object groupIdOrPath,
java.lang.String key)
Delete a custom attribute for the specified group.
|
void |
deleteGroup(java.lang.Object groupIdOrPath)
Removes group with all projects inside.
|
void |
deleteLdapGroupLink(java.lang.Object groupIdOrPath,
java.lang.String cn)
Deletes an LDAP group link.
|
void |
deleteLdapGroupLink(java.lang.Object groupIdOrPath,
java.lang.String cn,
java.lang.String provider)
Deletes an LDAP group link for a specific LDAP provider.
|
void |
deleteSamlGroupLink(java.lang.Object groupIdOrPath,
java.lang.String samlGroupName)
Deletes an SAML group link.
|
void |
deleteVariable(java.lang.Object groupIdOrPath,
java.lang.String key)
Deletes a group variable.
|
void |
denyAccessRequest(java.lang.Object groupIdOrPath,
java.lang.Long userId)
Deny access for the specified user to the specified group.
|
Badge |
editBadge(java.lang.Object groupIdOrPath,
java.lang.Long badgeId,
java.lang.String linkUrl,
java.lang.String imageUrl)
Edit a badge of a group.
|
Badge |
editBadge(java.lang.Object groupIdOrPath,
java.lang.Long badgeId,
java.lang.String name,
java.lang.String linkUrl,
java.lang.String imageUrl)
Edit a badge of a group.
|
java.util.Optional<CustomAttribute> |
geOptionalCustomAttribute(java.lang.Object groupIdOrPath,
java.lang.String key)
Get an Optional instance with the value for a single custom attribute for the specified group.
|
java.util.List<AccessRequest> |
getAccessRequests(java.lang.Object groupIdOrPath)
Get a List of the group access requests viewable by the authenticated user.
|
Pager<AccessRequest> |
getAccessRequests(java.lang.Object groupIdOrPath,
int itemsPerPage)
Get a Pager of the group access requests viewable by the authenticated user.
|
java.util.stream.Stream<AccessRequest> |
getAccessRequestsStream(java.lang.Object groupIdOrPath)
Get a Stream of the group access requests viewable by the authenticated user.
|
java.util.List<Member> |
getAllMembers(java.lang.Object groupIdOrPath)
Gets a list of group members viewable by the authenticated user, including inherited members
through ancestor groups.
|
Pager<Member> |
getAllMembers(java.lang.Object groupIdOrPath,
int itemsPerPage)
Gets a Pager of group members viewable by the authenticated user, including inherited members
through ancestor groups.
|
java.util.List<Member> |
getAllMembers(java.lang.Object groupIdOrPath,
int page,
int perPage)
Deprecated.
Will be removed in version 6.0
|
java.util.List<Member> |
getAllMembers(java.lang.Object groupIdOrPath,
java.lang.String query,
java.util.List<java.lang.Long> userIds)
Gets a list of group members viewable by the authenticated user, including inherited members
through ancestor groups.
|
Pager<Member> |
getAllMembers(java.lang.Object groupIdOrPath,
java.lang.String query,
java.util.List<java.lang.Long> userIds,
int itemsPerPage)
Gets a Pager of group members viewable by the authenticated user, including inherited members
through ancestor groups.
|
java.util.stream.Stream<Member> |
getAllMembersStream(java.lang.Object groupIdOrPath)
Gets a Stream of group members viewable by the authenticated user, including inherited members
through ancestor groups.
|
java.util.stream.Stream<Member> |
getAllMembersStream(java.lang.Object groupIdOrPath,
java.lang.String query,
java.util.List<java.lang.Long> userIds)
Gets a Stream of group members viewable by the authenticated user, including inherited members
through ancestor groups.
|
AuditEvent |
getAuditEvent(java.lang.Object groupIdOrPath,
java.lang.Long auditEventId)
Get a specific audit event of a group.
|
java.util.List<AuditEvent> |
getAuditEvents(java.lang.Object groupIdOrPath,
java.util.Date created_after,
java.util.Date created_before)
Get a List of the group audit events viewable by Maintainer or an Owner of the group.
|
Pager<AuditEvent> |
getAuditEvents(java.lang.Object groupIdOrPath,
java.util.Date created_after,
java.util.Date created_before,
int itemsPerPage)
Get a Pager of the group audit events viewable by Maintainer or an Owner of the group.
|
java.util.stream.Stream<AuditEvent> |
getAuditEventsStream(java.lang.Object groupIdOrPath,
java.util.Date created_after,
java.util.Date created_before)
Get a Stream of the group audit events viewable by Maintainer or an Owner of the group.
|
Badge |
getBadge(java.lang.Object groupIdOrPath,
java.lang.Long badgeId)
Gets a badge of a group.
|
java.util.List<Badge> |
getBadges(java.lang.Object groupIdOrPath)
Gets a list of a group’s badges and its group badges.
|
java.util.List<Badge> |
getBadges(java.lang.Object groupIdOrPath,
java.lang.String badgeName)
Gets a list of a group’s badges, case-sensitively filtered on bagdeName if non-null.
|
CustomAttribute |
getCustomAttribute(java.lang.Object groupIdOrPath,
java.lang.String key)
Get a single custom attribute for the specified group.
|
java.util.List<CustomAttribute> |
getCustomAttributes(java.lang.Object groupIdOrPath)
Get all custom attributes for the specified group.
|
Pager<CustomAttribute> |
getCustomAttributes(java.lang.Object groupIdOrPath,
int itemsPerPage)
Get a Pager of custom attributes for the specified group.
|
java.util.stream.Stream<CustomAttribute> |
getCustomAttributesStream(java.lang.Object groupIdOrPath)
Get a Stream of all custom attributes for the specified group.
|
java.util.List<Group> |
getDescendantGroups(java.lang.Object groupIdOrPath,
GroupFilter filter)
Get a list of visible descendant groups of a given group for the authenticated user using the provided filter.
|
Pager<Group> |
getDescendantGroups(java.lang.Object groupIdOrPath,
GroupFilter filter,
int itemsPerPage)
Get a Pager of visible descendant groups of a given group for the authenticated user using the provided filter.
|
java.util.stream.Stream<Group> |
getDescendantGroupsStream(java.lang.Object groupIdOrPath,
GroupFilter filter)
Get a Stream of visible descendant groups of a given group for the authenticated user using the provided filter.
|
Group |
getGroup(java.lang.Object groupIdOrPath)
Get all details of a group.
|
GroupAccessToken |
getGroupAccessToken(java.lang.Object groupIdOrPath,
java.lang.Long tokenId)
Get a group access token by ID.
|
java.util.List<GroupAccessToken> |
getGroupAccessTokens(java.lang.Object groupIdOrPath)
Get a list of group access tokens.
|
java.util.List<Group> |
getGroups()
Get a list of groups.
|
java.util.List<Group> |
getGroups(GroupFilter filter)
Get a list of visible groups for the authenticated user using the provided filter.
|
Pager<Group> |
getGroups(GroupFilter filter,
int itemsPerPage)
Get a Pager of visible groups for the authenticated user using the provided filter.
|
Pager<Group> |
getGroups(int itemsPerPage)
Get a Pager of groups.
|
java.util.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.
|
java.util.List<Group> |
getGroups(java.lang.String search)
Get all groups that match your string in their name or path.
|
Pager<Group> |
getGroups(java.lang.String search,
int itemsPerPage)
Get all groups that match your string in their name or path.
|
java.util.List<Group> |
getGroups(java.lang.String search,
int page,
int perPage)
Get all groups that match your string in their name or path.
|
java.util.stream.Stream<Group> |
getGroupsStream()
Get a Stream of groups.
|
java.util.stream.Stream<Group> |
getGroupsStream(GroupFilter filter)
Get a Stream of visible groups for the authenticated user using the provided filter.
|
java.util.stream.Stream<Group> |
getGroupsStream(java.lang.String search)
Get all groups that match your string in their name or path as a Stream.
|
java.util.List<LdapGroupLink> |
getLdapGroupLinks(java.lang.Object groupIdOrPath)
Get the list of LDAP group links.
|
Member |
getMember(java.lang.Object groupIdOrPath,
long userId)
Get a group member viewable by the authenticated user.
|
Member |
getMember(java.lang.Object groupIdOrPath,
java.lang.Long userId,
java.lang.Boolean includeInherited)
Gets a group team member, optionally including inherited member.
|
java.util.List<Member> |
getMembers(java.lang.Object groupIdOrPath)
Get a list of group members viewable by the authenticated user.
|
Pager<Member> |
getMembers(java.lang.Object groupIdOrPath,
int itemsPerPage)
Get a Pager of group members viewable by the authenticated user.
|
java.util.List<Member> |
getMembers(java.lang.Object groupIdOrPath,
int page,
int perPage)
Get a list of group members viewable by the authenticated user in the specified page range.
|
java.util.stream.Stream<Member> |
getMembersStream(java.lang.Object groupIdOrPath)
Get a Stream of group members viewable by the authenticated user.
|
java.util.Optional<Badge> |
getOptionalBadge(java.lang.Object groupIdOrPath,
java.lang.Long badgeId)
Get an Optional instance with the value for the specified badge.
|
java.util.Optional<Group> |
getOptionalGroup(java.lang.Object groupIdOrPath)
Get all details of a group as an Optional instance.
|
java.util.Optional<Member> |
getOptionalMember(java.lang.Object groupIdOrPath,
long userId)
Get a group member viewable by the authenticated user as an Optional instance.
|
java.util.Optional<Member> |
getOptionalMember(java.lang.Object groupIdOrPath,
java.lang.Long userId,
java.lang.Boolean includeInherited)
Gets a group team member, optionally including inherited member.
|
java.util.Optional<Variable> |
getOptionalVariable(java.lang.Object groupIdOrPath,
java.lang.String key)
Get the details of a group variable as an Optional instance.
|
java.util.List<Project> |
getProjects(java.lang.Object groupIdOrPath)
Get a list of projects belonging to the specified group ID.
|
java.util.List<Project> |
getProjects(java.lang.Object groupIdOrPath,
GroupProjectsFilter filter)
Get a list of projects belonging to the specified group ID and filter.
|
Pager<Project> |
getProjects(java.lang.Object groupIdOrPath,
GroupProjectsFilter filter,
int itemsPerPage)
Get a Pager of projects belonging to the specified group ID and filter.
|
Pager<Project> |
getProjects(java.lang.Object groupIdOrPath,
int itemsPerPage)
Get a Pager of projects belonging to the specified group ID.
|
java.util.List<Project> |
getProjects(java.lang.Object groupIdOrPath,
int page,
int perPage)
Get a list of projects belonging to the specified group ID in the specified page range.
|
java.util.stream.Stream<Project> |
getProjectsStream(java.lang.Object groupIdOrPath)
Get a Stream of projects belonging to the specified group ID.
|
java.util.stream.Stream<Project> |
getProjectsStream(java.lang.Object groupIdOrPath,
GroupProjectsFilter filter)
Get a Stream of projects belonging to the specified group ID and filter.
|
java.util.List<SamlGroupLink> |
getSamlGroupLinks(java.lang.Object groupIdOrPath)
Get the list of SAML group links.
|
java.util.List<Group> |
getSubGroups(java.lang.Object groupIdOrPath)
Get a list of visible direct subgroups in this group.
|
Pager<Group> |
getSubGroups(java.lang.Object groupIdOrPath,
int itemsPerPage)
Get a Pager of visible direct subgroups in this group.
|
java.util.List<Group> |
getSubGroups(java.lang.Object groupIdOrPath,
java.util.List<java.lang.Integer> skipGroups,
java.lang.Boolean allAvailable,
java.lang.String search,
Constants.GroupOrderBy orderBy,
Constants.SortOrder sortOrder,
java.lang.Boolean statistics,
java.lang.Boolean owned)
Get a list of visible direct subgroups in this group.
|
Pager<Group> |
getSubGroups(java.lang.Object groupIdOrPath,
java.util.List<java.lang.Integer> skipGroups,
java.lang.Boolean allAvailable,
java.lang.String search,
Constants.GroupOrderBy orderBy,
Constants.SortOrder sortOrder,
java.lang.Boolean statistics,
java.lang.Boolean owned,
int itemsPerPage)
Get a Pager of visible direct subgroups in this group.
|
java.util.List<Group> |
getSubGroups(java.lang.Object groupIdOrPath,
java.util.List<java.lang.Integer> skipGroups,
java.lang.Boolean allAvailable,
java.lang.String search,
Constants.GroupOrderBy orderBy,
Constants.SortOrder sortOrder,
java.lang.Boolean statistics,
java.lang.Boolean owned,
int page,
int perPage)
Get a list of visible direct subgroups in this group.
|
java.util.stream.Stream<Group> |
getSubGroupsStream(java.lang.Object groupIdOrPath)
Get a Stream of visible direct subgroups in this group.
|
java.util.stream.Stream<Group> |
getSubGroupsStream(java.lang.Object groupIdOrPath,
java.util.List<java.lang.Integer> skipGroups,
java.lang.Boolean allAvailable,
java.lang.String search,
Constants.GroupOrderBy orderBy,
Constants.SortOrder sortOrder,
java.lang.Boolean statistics,
java.lang.Boolean owned)
Get a Stream of visible direct subgroups in this group.
|
Variable |
getVariable(java.lang.Object groupIdOrPath,
java.lang.String key)
Get the details of a group variable.
|
java.util.List<Variable> |
getVariables(java.lang.Object groupIdOrPath)
Get list of a group’s variables.
|
Pager<Variable> |
getVariables(java.lang.Object groupIdOrPath,
int itemsPerPage)
Get a Pager of variables belonging to the specified group.
|
java.util.List<Variable> |
getVariables(java.lang.Object groupIdOrPath,
int page,
int perPage)
Get a list of variables for the specified group in the specified page range.
|
java.util.stream.Stream<Variable> |
getVariablesStream(java.lang.Object groupIdOrPath)
Get a Stream of variables belonging to the specified group.
|
void |
ldapSync(java.lang.Object groupIdOrPath)
Syncs the group with its linked LDAP group.
|
java.util.List<Iteration> |
listGroupIterations(java.lang.Object groupIdOrPath,
IterationFilter filter)
Lists group iterations.
|
Badge |
previewBadge(java.lang.Object groupIdOrPath,
java.lang.String linkUrl,
java.lang.String imageUrl)
Returns how the link_url and image_url final URLs would be after resolving the placeholder interpolation.
|
void |
removeBadge(java.lang.Object groupIdOrPath,
java.lang.Long badgeId)
Remove a badge from a group.
|
void |
removeMember(java.lang.Object groupIdOrPath,
java.lang.Long userId)
Removes member from the group.
|
AccessRequest |
requestAccess(java.lang.Object groupIdOrPath)
Requests access for the authenticated user to the specified group.
|
void |
revokeGroupAccessToken(java.lang.Object groupIdOrPath,
java.lang.Long tokenId)
Revoke a group access token.
|
GroupAccessToken |
rotateGroupAccessToken(java.lang.Object groupIdOrPath,
java.lang.Long tokenId)
Rotate a group access token.
|
CustomAttribute |
setCustomAttribute(java.lang.Object groupIdOrPath,
java.lang.String key,
java.lang.String value)
Set a custom attribute for the specified group.
|
Group |
setGroupAvatar(java.lang.Object groupIdOrPath,
java.io.File avatarFile)
Uploads and sets the project avatar for the specified group.
|
Group |
shareGroup(java.lang.Object groupIdOrPath,
java.lang.Long shareWithGroupId,
AccessLevel groupAccess,
java.util.Date expiresAt)
Share group with another group.
|
Project |
transferProject(java.lang.Object groupIdOrPath,
java.lang.Object projectIdOrPath)
Transfer a project to the Group namespace.
|
void |
unshareGroup(java.lang.Object groupIdOrPath,
java.lang.Long sharedWithGroupId)
Unshare the group from another group.
|
Group |
updateGroup(Group group)
Updates a project group.
|
Group |
updateGroup(java.lang.Object groupIdOrPath,
GroupParams params)
Updates the project group.
|
Group |
updateGroup(java.lang.Object groupIdOrPath,
java.lang.String name,
java.lang.String path,
java.lang.String description,
java.lang.Boolean membershipLock,
java.lang.Boolean shareWithGroupLock,
Visibility visibility,
java.lang.Boolean lfsEnabled,
java.lang.Boolean requestAccessEnabled,
java.lang.Long parentId,
java.lang.Integer sharedRunnersMinutesLimit)
Deprecated.
Will be removed in version 6.0, replaced by
updateGroup(Object, String, String, String,
Visibility, Boolean, Boolean, Long) |
Group |
updateGroup(java.lang.Object groupIdOrPath,
java.lang.String name,
java.lang.String path,
java.lang.String description,
Visibility visibility,
java.lang.Boolean lfsEnabled,
java.lang.Boolean requestAccessEnabled,
java.lang.Long parentId)
Updates a project group.
|
Member |
updateMember(java.lang.Object groupIdOrPath,
java.lang.Long userId,
AccessLevel accessLevel)
Updates a member of a group.
|
Member |
updateMember(java.lang.Object groupIdOrPath,
java.lang.Long userId,
AccessLevel accessLevel,
java.util.Date expiresAt)
Updates a member of a group.
|
Member |
updateMember(java.lang.Object groupIdOrPath,
java.lang.Long userId,
java.lang.Integer accessLevel)
Updates a member of a group.
|
Member |
updateMember(java.lang.Object groupIdOrPath,
java.lang.Long userId,
java.lang.Integer accessLevel,
java.util.Date expiresAt)
Updates a member of a group.
|
Variable |
updateVariable(java.lang.Object groupIdOrPath,
java.lang.String key,
java.lang.String value,
java.lang.Boolean isProtected)
Update a group variable.
|
Variable |
updateVariable(java.lang.Object groupIdOrPath,
java.lang.String key,
java.lang.String value,
java.lang.Boolean isProtected,
java.lang.Boolean masked)
Update a group variable.
|
addFormParam, addFormParam, delete, delete, get, get, getApiClient, getApiVersion, getDefaultPerPage, getDefaultPerPageParam, getDefaultPerPageParam, getGroupIdOrPath, getLabelIdOrName, getPageQueryParams, getPageQueryParams, getPerPageQueryParam, getProjectIdOrPath, getUserIdOrUsername, getWithAccepts, handle, head, isApiVersion, patch, patch, post, post, post, post, post, put, put, put, putUpload, putUpload, putWithFormData, upload, upload, upload, upload, urlEncode, validate
public GroupApi(GitLabApi gitLabApi)
public java.util.List<Group> getGroups() throws GitLabApiException
Get a list of groups. (As user: my groups, as admin: all groups)
WARNING: Do not use this method to fetch groups from https://gitlab.com, gitlab.com has many 1,000's of public groups and it will a long time to fetch all of them. Instead usegetGroups(int itemsPerPage)
which will return a Pager of Group instances.
GitLab Endpoint: GET /groups
GitLabApiException
- if any exception occurspublic java.util.List<Group> getGroups(int page, int perPage) throws GitLabApiException
GitLab Endpoint: GET /groups
page
- the page to getperPage
- the number of Group instances per pageGitLabApiException
- if any exception occurspublic Pager<Group> getGroups(int itemsPerPage) throws GitLabApiException
GitLab Endpoint: GET /groups
itemsPerPage
- the number of Group instances that will be fetched per pageGitLabApiException
- if any exception occurspublic java.util.stream.Stream<Group> getGroupsStream() throws GitLabApiException
GitLab Endpoint: GET /groups
GitLabApiException
- if any exception occurspublic java.util.List<Group> getGroups(java.lang.String search) throws GitLabApiException
search
- the group name or path search criteriaGitLabApiException
- if any exception occurspublic java.util.List<Group> getGroups(java.lang.String search, int page, int perPage) throws GitLabApiException
search
- the group name or path search criteriapage
- the page to getperPage
- the number of Group instances per pageGitLabApiException
- if any exception occurspublic Pager<Group> getGroups(java.lang.String search, int itemsPerPage) throws GitLabApiException
search
- the group name or path search criteriaitemsPerPage
- the number of Group instances that will be fetched per pageGitLabApiException
- if any exception occurspublic java.util.stream.Stream<Group> getGroupsStream(java.lang.String search) throws GitLabApiException
search
- the group name or path search criteriaGitLabApiException
- if any exception occurspublic java.util.List<Group> getGroups(GroupFilter filter) throws GitLabApiException
GitLab Endpoint: GET /groups
filter
- the GroupFilter to match againstGitLabApiException
- if any exception occurspublic Pager<Group> getGroups(GroupFilter filter, int itemsPerPage) throws GitLabApiException
GitLab Endpoint: GET /groups
filter
- the GroupFilter to match againstitemsPerPage
- the number of Group instances that will be fetched per pageGitLabApiException
- if any exception occurspublic java.util.stream.Stream<Group> getGroupsStream(GroupFilter filter) throws GitLabApiException
GitLab Endpoint: GET /groups
filter
- the GroupFilter to match againstGitLabApiException
- if any exception occurspublic java.util.List<Group> getSubGroups(java.lang.Object groupIdOrPath) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/subgroups
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or path, requiredGitLabApiException
- if any exception occurspublic Pager<Group> getSubGroups(java.lang.Object groupIdOrPath, int itemsPerPage) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/subgroups
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or path, requireditemsPerPage
- the number of Group instances that will be fetched per pageGitLabApiException
- if any exception occurspublic java.util.stream.Stream<Group> getSubGroupsStream(java.lang.Object groupIdOrPath) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/subgroups
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or path, requiredGitLabApiException
- if any exception occurspublic java.util.List<Group> getSubGroups(java.lang.Object groupIdOrPath, java.util.List<java.lang.Integer> skipGroups, java.lang.Boolean allAvailable, java.lang.String search, Constants.GroupOrderBy orderBy, Constants.SortOrder sortOrder, java.lang.Boolean statistics, java.lang.Boolean owned) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/subgroups
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or path, requiredskipGroups
- skip the group IDs passedallAvailable
- show all the groups you have access to (defaults to false for authenticated users)search
- return the list of authorized groups matching the search criteriaorderBy
- order groups by NAME or PATH. Default is NAMEsortOrder
- order groups in ASC or DESC order. Default is ASCstatistics
- include group statistics (admins only)owned
- limit to groups owned by the current userGitLabApiException
- if any exception occurspublic java.util.List<Group> getSubGroups(java.lang.Object groupIdOrPath, java.util.List<java.lang.Integer> skipGroups, java.lang.Boolean allAvailable, java.lang.String search, Constants.GroupOrderBy orderBy, Constants.SortOrder sortOrder, java.lang.Boolean statistics, java.lang.Boolean owned, int page, int perPage) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/subgroups
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or path, requiredskipGroups
- skip the group IDs passedallAvailable
- show all the groups you have access to (defaults to false for authenticated users)search
- return the list of authorized groups matching the search criteriaorderBy
- order groups by NAME or PATH. Default is NAMEsortOrder
- order groups in ASC or DESC order. Default is ASCstatistics
- include group statistics (admins only)owned
- limit to groups owned by the current userpage
- the page to getperPage
- the number of Group instances per pageGitLabApiException
- if any exception occurspublic Pager<Group> getSubGroups(java.lang.Object groupIdOrPath, java.util.List<java.lang.Integer> skipGroups, java.lang.Boolean allAvailable, java.lang.String search, Constants.GroupOrderBy orderBy, Constants.SortOrder sortOrder, java.lang.Boolean statistics, java.lang.Boolean owned, int itemsPerPage) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/subgroups
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or path, requiredskipGroups
- skip the group IDs passedallAvailable
- show all the groups you have access to (defaults to false for authenticated users)search
- return the list of authorized groups matching the search criteriaorderBy
- order groups by NAME or PATH. Default is NAMEsortOrder
- order groups in ASC or DESC order. Default is ASCstatistics
- include group statistics (admins only)owned
- limit to groups owned by the current useritemsPerPage
- the number of Group instances that will be fetched per pageGitLabApiException
- if any exception occurspublic java.util.stream.Stream<Group> getSubGroupsStream(java.lang.Object groupIdOrPath, java.util.List<java.lang.Integer> skipGroups, java.lang.Boolean allAvailable, java.lang.String search, Constants.GroupOrderBy orderBy, Constants.SortOrder sortOrder, java.lang.Boolean statistics, java.lang.Boolean owned) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/subgroups
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or path, requiredskipGroups
- skip the group IDs passedallAvailable
- show all the groups you have access to (defaults to false for authenticated users)search
- return the list of authorized groups matching the search criteriaorderBy
- order groups by NAME or PATH. Default is NAMEsortOrder
- order groups in ASC or DESC order. Default is ASCstatistics
- include group statistics (admins only)owned
- limit to groups owned by the current userGitLabApiException
- if any exception occurspublic java.util.List<Group> getDescendantGroups(java.lang.Object groupIdOrPath, GroupFilter filter) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/descendant_groups
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or path, requiredfilter
- the GroupFilter to match againstGitLabApiException
- if any exception occurspublic Pager<Group> getDescendantGroups(java.lang.Object groupIdOrPath, GroupFilter filter, int itemsPerPage) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/descendant_groups
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or path, requiredfilter
- the GroupFilter to match againstitemsPerPage
- the number of Group instances that will be fetched per pageGitLabApiException
- if any exception occurspublic java.util.stream.Stream<Group> getDescendantGroupsStream(java.lang.Object groupIdOrPath, GroupFilter filter) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/descendant_groups
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or path, requiredfilter
- the GroupFilter to match againstGitLabApiException
- if any exception occurspublic java.util.List<Project> getProjects(java.lang.Object groupIdOrPath, GroupProjectsFilter filter) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/projects
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathfilter
- the GroupProjectsFilter instance holding the filter values for the queryGitLabApiException
- if any exception occurspublic Pager<Project> getProjects(java.lang.Object groupIdOrPath, GroupProjectsFilter filter, int itemsPerPage) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/projects
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathfilter
- the GroupProjectsFilter instance holding the filter values for the queryitemsPerPage
- the number of Project instances that will be fetched per pageGitLabApiException
- if any exception occurspublic java.util.stream.Stream<Project> getProjectsStream(java.lang.Object groupIdOrPath, GroupProjectsFilter filter) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/projects
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathfilter
- the GroupProjectsFilter instance holding the filter values for the queryGitLabApiException
- if any exception occurspublic java.util.List<Project> getProjects(java.lang.Object groupIdOrPath) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/projects
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathGitLabApiException
- if any exception occurspublic java.util.List<Project> getProjects(java.lang.Object groupIdOrPath, int page, int perPage) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/projects
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathpage
- the page to getperPage
- the number of Project instances per pageGitLabApiException
- if any exception occurspublic Pager<Project> getProjects(java.lang.Object groupIdOrPath, int itemsPerPage) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/projects
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathitemsPerPage
- the number of Project instances that will be fetched per pageGitLabApiException
- if any exception occurspublic java.util.stream.Stream<Project> getProjectsStream(java.lang.Object groupIdOrPath) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/projects
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathGitLabApiException
- if any exception occurspublic Group getGroup(java.lang.Object groupIdOrPath) throws GitLabApiException
GitLab Endpoint: GET /groups/:id
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathGitLabApiException
- if any exception occurspublic java.util.Optional<Group> getOptionalGroup(java.lang.Object groupIdOrPath)
GitLab Endpoint: GET /groups/:id
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathpublic Group createGroup(GroupParams params) throws GitLabApiException
GitLab Endpoint: POST /groups
params
- a GroupParams instance holding the parameters for the group creationGitLabApiException
- if any exception occurspublic Group updateGroup(java.lang.Object groupIdOrPath, GroupParams params) throws GitLabApiException
GitLab Endpoint: PUT /groups
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathparams
- the GroupParams instance holding the properties to updateGitLabApiException
- at any exceptionpublic Group addGroup(java.lang.String name, java.lang.String path) throws GitLabApiException
GitLab Endpoint: POST /groups
name
- the name of the group to addpath
- the path for the groupGitLabApiException
- if any exception occurspublic Group addGroup(Group group) throws GitLabApiException
GitLabApiException
public Group addGroup(java.lang.String name, java.lang.String path, java.lang.String description, Visibility visibility, java.lang.Boolean lfsEnabled, java.lang.Boolean requestAccessEnabled, java.lang.Long parentId) throws GitLabApiException
GitLab Endpoint: POST /groups
name
- the name of the group to addpath
- the path for the groupdescription
- (optional) - The group's descriptionvisibility
- (optional) - The group's visibility. Can be private, internal, or public.lfsEnabled
- (optional) - Enable/disable Large File Storage (LFS) for the projects in this grouprequestAccessEnabled
- (optional) - Allow users to request member accessparentId
- (optional) - The parent group id for creating nested groupGitLabApiException
- if any exception occurspublic Group updateGroup(Group group) throws GitLabApiException
GitLab Endpoint: PUT /groups
group
- to updateGitLabApiException
- at any exceptionpublic Group updateGroup(java.lang.Object groupIdOrPath, java.lang.String name, java.lang.String path, java.lang.String description, Visibility visibility, java.lang.Boolean lfsEnabled, java.lang.Boolean requestAccessEnabled, java.lang.Long parentId) throws GitLabApiException
GitLab Endpoint: PUT /groups
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathname
- the name of the group to addpath
- the path for the groupdescription
- (optional) - The group's descriptionvisibility
- (optional) - The group's visibility. Can be private, internal, or public.lfsEnabled
- (optional) - Enable/disable Large File Storage (LFS) for the projects in this grouprequestAccessEnabled
- (optional) - Allow users to request member accessparentId
- (optional) - The parent group id for creating nested groupGitLabApiException
- if any exception occurs@Deprecated public Group addGroup(java.lang.String name, java.lang.String path, java.lang.String description, java.lang.Boolean membershipLock, java.lang.Boolean shareWithGroupLock, Visibility visibility, java.lang.Boolean lfsEnabled, java.lang.Boolean requestAccessEnabled, java.lang.Long parentId, java.lang.Integer sharedRunnersMinutesLimit) throws GitLabApiException
addGroup(String, String, String, Visibility,
Boolean, Boolean, Long)
GitLab Endpoint: POST /groups
name
- the name of the group to addpath
- the path for the groupdescription
- (optional) - The group's descriptionmembershipLock
- (optional, boolean) - Prevent adding new members to project membership within this groupshareWithGroupLock
- (optional, boolean) - Prevent sharing a project with another group within this groupvisibility
- (optional) - The group's visibility. Can be private, internal, or public.lfsEnabled
- (optional) - Enable/disable Large File Storage (LFS) for the projects in this grouprequestAccessEnabled
- (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 groupGitLabApiException
- if any exception occurs@Deprecated public Group updateGroup(java.lang.Object groupIdOrPath, java.lang.String name, java.lang.String path, java.lang.String description, java.lang.Boolean membershipLock, java.lang.Boolean shareWithGroupLock, Visibility visibility, java.lang.Boolean lfsEnabled, java.lang.Boolean requestAccessEnabled, java.lang.Long parentId, java.lang.Integer sharedRunnersMinutesLimit) throws GitLabApiException
updateGroup(Object, String, String, String,
Visibility, Boolean, Boolean, Long)
GitLab Endpoint: PUT /groups
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathname
- the name of the group to addpath
- the path for the groupdescription
- (optional) - The group's descriptionmembershipLock
- (optional, boolean) - Prevent adding new members to project membership within this groupshareWithGroupLock
- (optional, boolean) - Prevent sharing a project with another group within this groupvisibility
- (optional) - The group's visibility. Can be private, internal, or public.lfsEnabled
- (optional) - Enable/disable Large File Storage (LFS) for the projects in this grouprequestAccessEnabled
- (optional) - Allow users to request member accessparentId
- (optional) - The parent group id for creating nested groupsharedRunnersMinutesLimit
- (optional) - (admin-only) Pipeline minutes quota for this groupGitLabApiException
- if any exception occurspublic void deleteGroup(java.lang.Object groupIdOrPath) throws GitLabApiException
GitLab Endpoint: DELETE /groups/:id
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathGitLabApiException
- if any exception occurspublic java.util.List<Member> getMembers(java.lang.Object groupIdOrPath) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/members
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathGitLabApiException
- if any exception occurspublic java.util.List<Member> getMembers(java.lang.Object groupIdOrPath, int page, int perPage) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/members
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathpage
- the page to getperPage
- the number of Member instances per pageGitLabApiException
- if any exception occurspublic Pager<Member> getMembers(java.lang.Object groupIdOrPath, int itemsPerPage) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/members
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathitemsPerPage
- the number of Member instances that will be fetched per pageGitLabApiException
- if any exception occurspublic java.util.stream.Stream<Member> getMembersStream(java.lang.Object groupIdOrPath) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/members
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathGitLabApiException
- if any exception occurspublic Member getMember(java.lang.Object groupIdOrPath, long userId) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/members/:id
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathuserId
- the member ID of the member to getGitLabApiException
- if any exception occurspublic java.util.Optional<Member> getOptionalMember(java.lang.Object groupIdOrPath, long userId)
GitLab Endpoint: GET /groups/:id/members/:id
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathuserId
- the member ID of the member to getpublic Member getMember(java.lang.Object groupIdOrPath, java.lang.Long userId, java.lang.Boolean includeInherited) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/members/all/:user_id
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathuserId
- the user ID of the memberincludeInherited
- if true will the member even if inherited thru an ancestor groupGitLabApiException
- if any exception occurspublic java.util.Optional<Member> getOptionalMember(java.lang.Object groupIdOrPath, java.lang.Long userId, java.lang.Boolean includeInherited)
GitLab Endpoint: GET /groups/:id/members/all/:user_id
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathuserId
- the user ID of the memberincludeInherited
- if true will the member even if inherited thru an ancestor grouppublic java.util.List<Member> getAllMembers(java.lang.Object groupIdOrPath) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/members/all
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathGitLabApiException
- if any exception occurs@Deprecated public java.util.List<Member> getAllMembers(java.lang.Object groupIdOrPath, int page, int perPage) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/members/all
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathpage
- the page to getperPage
- the number of Member instances per pageGitLabApiException
- if any exception occurspublic Pager<Member> getAllMembers(java.lang.Object groupIdOrPath, int itemsPerPage) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/members/all
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathitemsPerPage
- the number of Member instances that will be fetched per pageGitLabApiException
- if any exception occurspublic java.util.stream.Stream<Member> getAllMembersStream(java.lang.Object groupIdOrPath) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/members/all
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathGitLabApiException
- if any exception occurspublic java.util.List<Member> getAllMembers(java.lang.Object groupIdOrPath, java.lang.String query, java.util.List<java.lang.Long> userIds) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/members/all
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathquery
- a query string to search for membersuserIds
- filter the results on the given user IDsGitLabApiException
- if any exception occurspublic Pager<Member> getAllMembers(java.lang.Object groupIdOrPath, java.lang.String query, java.util.List<java.lang.Long> userIds, int itemsPerPage) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/members/all
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathquery
- a query string to search for membersuserIds
- filter the results on the given user IDsitemsPerPage
- the number of Project instances that will be fetched per pageGitLabApiException
- if any exception occurspublic java.util.stream.Stream<Member> getAllMembersStream(java.lang.Object groupIdOrPath, java.lang.String query, java.util.List<java.lang.Long> userIds) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/members/all
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathquery
- a query string to search for membersuserIds
- filter the results on the given user IDsGitLabApiException
- if any exception occurspublic Member addMember(java.lang.Object groupIdOrPath, java.lang.Long userId, java.lang.Integer accessLevel) throws GitLabApiException
GitLab Endpoint: POST /groups/:id/members
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathuserId
- the user ID of the member to add, requiredaccessLevel
- the access level for the new member, requiredGitLabApiException
- if any exception occurspublic Member addMember(java.lang.Object groupIdOrPath, java.lang.Long userId, AccessLevel accessLevel) throws GitLabApiException
GitLab Endpoint: POST /groups/:id/members
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathuserId
- the user ID of the member to add, requiredaccessLevel
- the access level for the new member, requiredGitLabApiException
- if any exception occurspublic Member addMember(java.lang.Object groupIdOrPath, java.lang.Long userId, AccessLevel accessLevel, java.util.Date expiresAt) throws GitLabApiException
GitLab Endpoint: POST /groups/:id/members
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or path, requireduserId
- the user ID of the member to add, requiredaccessLevel
- the access level for the new member, requiredexpiresAt
- the date the membership in the group will expire, optionalGitLabApiException
- if any exception occurspublic Member addMember(java.lang.Object groupIdOrPath, java.lang.Long userId, java.lang.Integer accessLevel, java.util.Date expiresAt) throws GitLabApiException
GitLab Endpoint: POST /groups/:id/members
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or path, requireduserId
- the user ID of the member to add, requiredaccessLevel
- the access level for the new member, requiredexpiresAt
- the date the membership in the group will expire, optionalGitLabApiException
- if any exception occurspublic Member updateMember(java.lang.Object groupIdOrPath, java.lang.Long userId, java.lang.Integer accessLevel) throws GitLabApiException
GitLab Endpoint: PUT /groups/:groupId/members/:userId
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or path, requireduserId
- the user ID of the member to update, requiredaccessLevel
- the new access level for the member, requiredGitLabApiException
- if any exception occurspublic Member updateMember(java.lang.Object groupIdOrPath, java.lang.Long userId, AccessLevel accessLevel) throws GitLabApiException
GitLab Endpoint: PUT /groups/:groupId/members/:userId
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or path, requireduserId
- the user ID of the member to update, requiredaccessLevel
- the new access level for the member, requiredGitLabApiException
- if any exception occurspublic Member updateMember(java.lang.Object groupIdOrPath, java.lang.Long userId, AccessLevel accessLevel, java.util.Date expiresAt) throws GitLabApiException
GitLab Endpoint: PUT /groups/:groupId/members/:userId
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or path, requireduserId
- the user ID of the member to update, requiredaccessLevel
- the new access level for the member, requiredexpiresAt
- the date the membership in the group will expire, optionalGitLabApiException
- if any exception occurspublic Member updateMember(java.lang.Object groupIdOrPath, java.lang.Long userId, java.lang.Integer accessLevel, java.util.Date expiresAt) throws GitLabApiException
GitLab Endpoint: PUT /groups/:groupId/members/:userId
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or path, requireduserId
- the user ID of the member to update, requiredaccessLevel
- the new access level for the member, requiredexpiresAt
- the date the membership in the group will expire, optionalGitLabApiException
- if any exception occurspublic void removeMember(java.lang.Object groupIdOrPath, java.lang.Long userId) throws GitLabApiException
GitLab Endpoint: DELETE /groups/:id/members/:user_id
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or path, requireduserId
- the user ID of the member to removeGitLabApiException
- if any exception occurspublic void ldapSync(java.lang.Object groupIdOrPath) throws GitLabApiException
GitLab Endpoint: POST /groups/:id/ldap_sync
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathGitLabApiException
- if any exception occurspublic java.util.List<LdapGroupLink> getLdapGroupLinks(java.lang.Object groupIdOrPath) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/ldap_group_links
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathGitLabApiException
- if any exception occurspublic void addLdapGroupLink(java.lang.Object groupIdOrPath, java.lang.String cn, AccessLevel groupAccess, java.lang.String provider) throws GitLabApiException
GitLab Endpoint: POST /groups/:id/ldap_group_links
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathcn
- the CN of a LDAP groupgroupAccess
- the minimum access level for members of the LDAP groupprovider
- the LDAP provider for the LDAP groupGitLabApiException
- if any exception occurspublic void addLdapGroupLink(java.lang.Object groupIdOrPath, java.lang.String cn, java.lang.Integer groupAccess, java.lang.String provider) throws GitLabApiException
GitLab Endpoint: POST /groups/:id/ldap_group_links
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathcn
- the CN of a LDAP groupgroupAccess
- the minimum access level for members of the LDAP groupprovider
- the LDAP provider for the LDAP groupGitLabApiException
- if any exception occurspublic void deleteLdapGroupLink(java.lang.Object groupIdOrPath, java.lang.String cn) throws GitLabApiException
GitLab Endpoint: DELETE /groups/:id/ldap_group_links/:cn
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathcn
- the CN of the LDAP group link to deleteGitLabApiException
- if any exception occurspublic void deleteLdapGroupLink(java.lang.Object groupIdOrPath, java.lang.String cn, java.lang.String provider) throws GitLabApiException
GitLab Endpoint: DELETE /groups/:id/ldap_group_links/:provider/:cn
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathcn
- the CN of the LDAP group link to deleteprovider
- the name of the LDAP providerGitLabApiException
- if any exception occurspublic java.util.List<SamlGroupLink> getSamlGroupLinks(java.lang.Object groupIdOrPath) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/saml_group_links
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathGitLabApiException
- if any exception occurspublic void addSamlGroupLink(java.lang.Object groupIdOrPath, java.lang.String samlGroupName, AccessLevel groupAccess) throws GitLabApiException
GitLab Endpoint: POST /groups/:id/saml_group_links
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathsamlGroupName
- the name of the SAML groupgroupAccess
- the minimum access level for members of the SAML groupGitLabApiException
- if any exception occurspublic void addSamlGroupLink(java.lang.Object groupIdOrPath, java.lang.String samlGroupName, java.lang.Integer groupAccess) throws GitLabApiException
GitLab Endpoint: POST /groups/:id/saml_group_links
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathsamlGroupName
- the name of the SAML groupgroupAccess
- the minimum access level for members of the SAML groupGitLabApiException
- if any exception occurspublic void deleteSamlGroupLink(java.lang.Object groupIdOrPath, java.lang.String samlGroupName) throws GitLabApiException
GitLab Endpoint: DELETE /groups/:id/saml_group_links/:cn
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathsamlGroupName
- the name of the SAML group to deleteGitLabApiException
- if any exception occurspublic java.util.List<Variable> getVariables(java.lang.Object groupIdOrPath) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/variables
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathGitLabApiException
- if any exception occurspublic java.util.List<Variable> getVariables(java.lang.Object groupIdOrPath, int page, int perPage) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/variables
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathpage
- the page to getperPage
- the number of Variable instances per pageGitLabApiException
- if any exception occurspublic Pager<Variable> getVariables(java.lang.Object groupIdOrPath, int itemsPerPage) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/variables
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathitemsPerPage
- the number of Variable instances that will be fetched per pageGitLabApiException
- if any exception occurspublic java.util.stream.Stream<Variable> getVariablesStream(java.lang.Object groupIdOrPath) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/variables
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathGitLabApiException
- if any exception occurspublic Variable getVariable(java.lang.Object groupIdOrPath, java.lang.String key) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/variables/:key
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathkey
- the key of an existing variable, requiredGitLabApiException
- if any exception occurspublic java.util.Optional<Variable> getOptionalVariable(java.lang.Object groupIdOrPath, java.lang.String key)
GitLab Endpoint: GET /groups/:id/variables/:key
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathkey
- the key of an existing variable, requiredpublic Variable createVariable(java.lang.Object groupIdOrPath, java.lang.String key, java.lang.String value, java.lang.Boolean isProtected) throws GitLabApiException
GitLab Endpoint: POST /groups/:id/variables
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or path, requiredkey
- the key of a variable; must have no more than 255 characters; only A-Z, a-z, 0-9, and _ are allowed, requiredvalue
- the value for the variable, requiredisProtected
- whether the variable is protected, optionalGitLabApiException
- if any exception occurs during executionpublic Variable createVariable(java.lang.Object groupIdOrPath, java.lang.String key, java.lang.String value, java.lang.Boolean isProtected, java.lang.Boolean masked) throws GitLabApiException
GitLab Endpoint: POST /groups/:id/variables
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or path, requiredkey
- the key of a variable; must have no more than 255 characters; only A-Z, a-z, 0-9, and _ are allowed, requiredvalue
- the value for the variable, requiredisProtected
- whether the variable is protected, optionalmasked
- whether the variable is masked, optionalGitLabApiException
- if any exception occurs during executionpublic Variable updateVariable(java.lang.Object groupIdOrPath, java.lang.String key, java.lang.String value, java.lang.Boolean isProtected) throws GitLabApiException
GitLab Endpoint: PUT /groups/:id/variables/:key
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or path, requiredkey
- the key of an existing variable, requiredvalue
- the value for the variable, requiredisProtected
- whether the variable is protected, optionalGitLabApiException
- if any exception occurs during executionpublic Variable updateVariable(java.lang.Object groupIdOrPath, java.lang.String key, java.lang.String value, java.lang.Boolean isProtected, java.lang.Boolean masked) throws GitLabApiException
GitLab Endpoint: PUT /groups/:id/variables/:key
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or path, requiredkey
- the key of an existing variable, requiredvalue
- the value for the variable, requiredisProtected
- whether the variable is protected, optionalmasked
- whether the variable is masked, optionalGitLabApiException
- if any exception occurs during executionpublic void deleteVariable(java.lang.Object groupIdOrPath, java.lang.String key) throws GitLabApiException
GitLab Endpoint: DELETE /groups/:id/variables/:key
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or path, requiredkey
- the key of an existing variable, requiredGitLabApiException
- if any exception occurspublic Project transferProject(java.lang.Object groupIdOrPath, java.lang.Object projectIdOrPath) throws GitLabApiException
GitLab Endpoint: POST /groups/:id/projects/:project_id
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or path, requiredprojectIdOrPath
- the project in the form of an Long(ID), String(path), or Project instance, requiredGitLabApiException
- if any exception occurs during executionpublic java.util.List<AuditEvent> getAuditEvents(java.lang.Object groupIdOrPath, java.util.Date created_after, java.util.Date created_before) throws GitLabApiException
GET /groups/:id/audit_events
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathcreated_after
- Group audit events created on or after the given time.created_before
- Group audit events created on or before the given time.GitLabApiException
- if any exception occurspublic Pager<AuditEvent> getAuditEvents(java.lang.Object groupIdOrPath, java.util.Date created_after, java.util.Date created_before, int itemsPerPage) throws GitLabApiException
GET /groups/:id/audit_events
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathcreated_after
- Group audit events created on or after the given time.created_before
- Group audit events created on or before the given time.itemsPerPage
- the number of Audit Event instances that will be fetched per pageGitLabApiException
- if any exception occurspublic java.util.stream.Stream<AuditEvent> getAuditEventsStream(java.lang.Object groupIdOrPath, java.util.Date created_after, java.util.Date created_before) throws GitLabApiException
GET /groups/:id/audit_events
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathcreated_after
- Group audit events created on or after the given time.created_before
- Group audit events created on or before the given time.GitLabApiException
- if any exception occurspublic AuditEvent getAuditEvent(java.lang.Object groupIdOrPath, java.lang.Long auditEventId) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/audit_events/:id_audit_event
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathauditEventId
- the auditEventId, requiredGitLabApiException
- if any exception occurspublic java.util.List<AccessRequest> getAccessRequests(java.lang.Object groupIdOrPath) throws GitLabApiException
GET /group/:id/access_requests
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathGitLabApiException
- if any exception occurspublic Pager<AccessRequest> getAccessRequests(java.lang.Object groupIdOrPath, int itemsPerPage) throws GitLabApiException
GET /groups/:id/access_requests
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathitemsPerPage
- the number of AccessRequest instances that will be fetched per pageGitLabApiException
- if any exception occurspublic java.util.stream.Stream<AccessRequest> getAccessRequestsStream(java.lang.Object groupIdOrPath) throws GitLabApiException
GET /groups/:id/access_requests
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathGitLabApiException
- if any exception occurspublic AccessRequest requestAccess(java.lang.Object groupIdOrPath) throws GitLabApiException
POST /groups/:id/access_requests
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathGitLabApiException
- if any exception occurspublic AccessRequest approveAccessRequest(java.lang.Object groupIdOrPath, java.lang.Long userId, AccessLevel accessLevel) throws GitLabApiException
PUT /groups/:id/access_requests/:user_id/approve
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathuserId
- the user ID to approve access foraccessLevel
- the access level the user is approved for, if null will be developer (30)GitLabApiException
- if any exception occurspublic void denyAccessRequest(java.lang.Object groupIdOrPath, java.lang.Long userId) throws GitLabApiException
DELETE /groups/:id/access_requests/:user_id
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathuserId
- the user ID to deny access forGitLabApiException
- if any exception occurspublic java.util.List<Badge> getBadges(java.lang.Object groupIdOrPath) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/badges
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathGitLabApiException
- if any exception occurspublic java.util.List<Badge> getBadges(java.lang.Object groupIdOrPath, java.lang.String badgeName) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/badges?name=:name
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathbadgeName
- The name to filter on (case-sensitive), ignored if null.GitLabApiException
- If any problem is encounteredpublic Badge getBadge(java.lang.Object groupIdOrPath, java.lang.Long badgeId) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/badges/:badge_id
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathbadgeId
- the ID of the badge to getGitLabApiException
- if any exception occurspublic java.util.Optional<Badge> getOptionalBadge(java.lang.Object groupIdOrPath, java.lang.Long badgeId)
GitLab Endpoint: GET /groups/:id/badges/:badge_id
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathbadgeId
- the ID of the badge to getpublic Badge addBadge(java.lang.Object groupIdOrPath, java.lang.String linkUrl, java.lang.String imageUrl) throws GitLabApiException
GitLab Endpoint: POST /groups/:id/badges
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathlinkUrl
- the URL of the badge linkimageUrl
- the URL of the image linkGitLabApiException
- if any exception occurspublic Badge addBadge(java.lang.Object groupIdOrPath, java.lang.String name, java.lang.String linkUrl, java.lang.String imageUrl) throws GitLabApiException
GitLab Endpoint: POST /groups/:id/badges
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathname
- The name to give the badge (may be null)linkUrl
- the URL of the badge linkimageUrl
- the URL of the image linkGitLabApiException
- if any exception occurspublic Badge editBadge(java.lang.Object groupIdOrPath, java.lang.Long badgeId, java.lang.String linkUrl, java.lang.String imageUrl) throws GitLabApiException
GitLab Endpoint: PUT /groups/:id/badges
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathbadgeId
- the ID of the badge to getlinkUrl
- the URL of the badge linkimageUrl
- the URL of the image linkGitLabApiException
- if any exception occurspublic Badge editBadge(java.lang.Object groupIdOrPath, java.lang.Long badgeId, java.lang.String name, java.lang.String linkUrl, java.lang.String imageUrl) throws GitLabApiException
GitLab Endpoint: PUT /groups/:id/badges
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathbadgeId
- the ID of the badge to editname
- The name of the badge to edit (may be null)linkUrl
- the URL of the badge linkimageUrl
- the URL of the image linkGitLabApiException
- if any exception occurspublic void removeBadge(java.lang.Object groupIdOrPath, java.lang.Long badgeId) throws GitLabApiException
GitLab Endpoint: DELETE /groups/:id/badges/:badge_id
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathbadgeId
- the ID of the badge to removeGitLabApiException
- if any exception occurspublic Badge previewBadge(java.lang.Object groupIdOrPath, java.lang.String linkUrl, java.lang.String imageUrl) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/badges/render
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathlinkUrl
- the URL of the badge linkimageUrl
- the URL of the image linkGitLabApiException
- if any exception occurspublic Group setGroupAvatar(java.lang.Object groupIdOrPath, java.io.File avatarFile) throws GitLabApiException
GitLab Endpoint: PUT /groups/:id
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathavatarFile
- the File instance of the avatar file to uploadGitLabApiException
- if any exception occurspublic Group shareGroup(java.lang.Object groupIdOrPath, java.lang.Long shareWithGroupId, AccessLevel groupAccess, java.util.Date expiresAt) throws GitLabApiException
GitLab Endpoint: POST /groups/:id/share
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathshareWithGroupId
- the ID of the group to share with, requiredgroupAccess
- the access level to grant the group, requiredexpiresAt
- expiration date of the share, optionalGitLabApiException
- if any exception occurspublic void unshareGroup(java.lang.Object groupIdOrPath, java.lang.Long sharedWithGroupId) throws GitLabApiException
GitLab Endpoint: DELETE /groups/:id/share/:group_id
groupIdOrPath
- the group ID, path of the group, or a Group instance holding the group ID or pathsharedWithGroupId
- the ID of the group to unshare with, requiredGitLabApiException
- if any exception occurspublic java.util.List<CustomAttribute> getCustomAttributes(java.lang.Object groupIdOrPath) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/custom_attributes
groupIdOrPath
- the group in the form of an Long(ID), String(path), or Group instanceGitLabApiException
- if any exception occurspublic Pager<CustomAttribute> getCustomAttributes(java.lang.Object groupIdOrPath, int itemsPerPage) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/custom_attributes
groupIdOrPath
- the group in the form of an Long(ID), String(path), or Group instanceitemsPerPage
- the number of items per pageGitLabApiException
- if any exception occurspublic java.util.stream.Stream<CustomAttribute> getCustomAttributesStream(java.lang.Object groupIdOrPath) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/custom_attributes
groupIdOrPath
- the group in the form of an Long(ID), String(path), or Group instanceGitLabApiException
- if any exception occurspublic CustomAttribute getCustomAttribute(java.lang.Object groupIdOrPath, java.lang.String key) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/custom_attributes/:key
groupIdOrPath
- the group in the form of an Long(ID), String(path), or Group instancekey
- the key for the custom attributeGitLabApiException
- if any exception occurspublic java.util.Optional<CustomAttribute> geOptionalCustomAttribute(java.lang.Object groupIdOrPath, java.lang.String key)
GitLab Endpoint: GET /groups/:id/custom_attributes/:key
groupIdOrPath
- the group in the form of an Long(ID), String(path), or Group instance, requiredkey
- the key for the custom attribute, requiredpublic CustomAttribute setCustomAttribute(java.lang.Object groupIdOrPath, java.lang.String key, java.lang.String value) throws GitLabApiException
GitLab Endpoint: PUT /groups/:id/custom_attributes/:key
groupIdOrPath
- the group in the form of an Long(ID), String(path), or Group instancekey
- the key for the custom attributevalue
- the value for the customAttributeGitLabApiException
- if any exception occurspublic void deleteCustomAttribute(java.lang.Object groupIdOrPath, java.lang.String key) throws GitLabApiException
GitLab Endpoint: DELETE /groups/:id/custom_attributes/:key
groupIdOrPath
- the group in the form of an Long(ID), String(path), or Group instancekey
- the key of the custom attribute to deleteGitLabApiException
- if any exception occurspublic java.util.List<Iteration> listGroupIterations(java.lang.Object groupIdOrPath, IterationFilter filter) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/iterations
groupIdOrPath
- the group in the form of an Long(ID), String(path), or Group instancefilter
- the iteration filterGitLabApiException
- if any exception occurspublic java.util.List<GroupAccessToken> getGroupAccessTokens(java.lang.Object groupIdOrPath) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/access_tokens
groupIdOrPath
- the group in the form of an Long(ID), String(path), or Group instanceGitLabApiException
- if any exception occurspublic GroupAccessToken getGroupAccessToken(java.lang.Object groupIdOrPath, java.lang.Long tokenId) throws GitLabApiException
GitLab Endpoint: GET /groups/:id/access_tokens/:token_id
groupIdOrPath
- the group in the form of an Long(ID), String(path), or Group instancetokenId
- ID of the group access tokenGitLabApiException
- if any exception occurspublic GroupAccessToken createGroupAccessToken(java.lang.Object groupIdOrPath, java.lang.String name, java.util.Date expiresAt, ImpersonationToken.Scope[] scopes, AccessLevel accessLevel) throws GitLabApiException
GitLab Endpoint: POST /groups/:id/access_tokens
groupIdOrPath
- the group in the form of an Long(ID), String(path), or Group instancename
- the name of the group access token, requiredexpiresAt
- the expiration date of the group access token, optionalscopes
- an array of scopes of the group access tokenaccessLevel
- Access level. Valid values are AccessLevel.GUEST
, AccessLevel.REPORTER
, AccessLevel.DEVELOPER
, AccessLevel.MAINTAINER
, and AccessLevel.OWNER
.GitLabApiException
- if any exception occurspublic GroupAccessToken rotateGroupAccessToken(java.lang.Object groupIdOrPath, java.lang.Long tokenId) throws GitLabApiException
GitLab Endpoint: POST /groups/:id/access_tokens/:token_id/rotate
groupIdOrPath
- the group in the form of an Long(ID), String(path), or Group instancetokenId
- ID of the group access tokenGitLabApiException
- if any exception occurspublic void revokeGroupAccessToken(java.lang.Object groupIdOrPath, java.lang.Long tokenId) throws GitLabApiException
GitLab Endpoint: DELETE /groups/:id/access_tokens/:token_id
groupIdOrPath
- the group in the form of an Long(ID), String(path), or Group instancetokenId
- ID of the group access tokenGitLabApiException
- if any exception occurs