org.gitlab4j.api

Class EpicsApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.EpicsApi

All Implemented Interfaces:

Constants

public class EpicsApi
extends AbstractApi

This class implements the client side API for the GitLab Epics and Epic Issues API calls. NOTE: - If a user is not a member of a group and the group is private, a GET request on that group will result to a 404 status code. - Epics are available only in Ultimate. If epics feature is not available a 403 status code will be returned.

See Also:

GitLab Epics API Documentaion, GitLab Epic Issues API Documentation

Nested Class Summary

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

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

Field Summary

Fields inherited from class org.gitlab4j.api.AbstractApi

gitLabApi

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
EpicsApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method and Description
ChildEpic	assignChildEpic(java.lang.Object groupIdOrPath, java.lang.Long epicIid, java.lang.Long childEpicId) Creates an association between two epics, designating one as the parent epic and the other as the child epic.
EpicIssue	assignIssue(java.lang.Object groupIdOrPath, java.lang.Long epicIid, java.lang.Long issueId) Creates an epic - issue association.
CreatedChildEpic	createAndAssignChildEpic(java.lang.Object groupIdOrPath, java.lang.Long epicIid, java.lang.String title, java.lang.Boolean confidential) Creates a new epic and associates it with provided parent epic.
Epic	createEpic(java.lang.Object groupIdOrPath, Epic epic) Creates a new epic using the information contained in the provided Epic instance.
Epic	createEpic(java.lang.Object groupIdOrPath, java.lang.String title, java.lang.String labels, java.lang.String description, java.util.Date startDate, java.util.Date endDate) Creates a new epic.
RelatedEpicLink	createRelatedEpicLink(java.lang.Object groupIdOrPath, java.lang.Long epicIid, java.lang.Object targetGroupIdOrPath, java.lang.Long targetEpicIid, LinkType linkType) Create a two-way relation between two epics.
void	deleteEpic(java.lang.Object groupIdOrPath, java.lang.Long epicIid) Deletes an epic.
RelatedEpicLink	deleteRelatedEpicLink(java.lang.Object groupIdOrPath, java.lang.Long epicIid, java.lang.Long relatedEpicLinkId) Delete a two-way relation between two epics.
java.util.List<ChildEpic>	getChildEpics(java.lang.Object groupIdOrPath, java.lang.Long epicIid) Gets all child epics of an epic and the authenticated user has access to.
Pager<ChildEpic>	getChildEpics(java.lang.Object groupIdOrPath, java.lang.Long epicIid, int itemsPerPage) Get a Pager of all child epics of an epic and the authenticated user has access to.
java.util.stream.Stream<ChildEpic>	getChildEpicsStream(java.lang.Object groupIdOrPath, java.lang.Long epicIid) Gets all child epics of an epic and the authenticated user has access to as a Stream.
Epic	getEpic(java.lang.Object groupIdOrPath, java.lang.Long epicIid) Get a single epic for the specified group.
java.util.List<EpicIssue>	getEpicIssues(java.lang.Object groupIdOrPath, java.lang.Long epicIid) Gets all issues that are assigned to an epic and the authenticated user has access to.
Pager<EpicIssue>	getEpicIssues(java.lang.Object groupIdOrPath, java.lang.Long epicIid, int itemsPerPage) Get a Pager of all issues that are assigned to an epic and the authenticated user has access to.
java.util.List<EpicIssue>	getEpicIssues(java.lang.Object groupIdOrPath, java.lang.Long epicIid, int page, int perPage) Gets all issues that are assigned to an epic and the authenticated user has access to using the specified page and per page setting.
java.util.stream.Stream<EpicIssue>	getEpicIssuesStream(java.lang.Object groupIdOrPath, java.lang.Long epicIid) Gets all issues that are assigned to an epic and the authenticated user has access to as a Stream.
java.util.List<Epic>	getEpics(java.lang.Object groupIdOrPath) Gets all epics of the requested group and its subgroups.
java.util.List<Epic>	getEpics(java.lang.Object groupIdOrPath, EpicFilter filter) Gets all epics of the requested group and its subgroups using the specified page and per page setting.
Pager<Epic>	getEpics(java.lang.Object groupIdOrPath, int itemsPerPage) Get a Pager of all epics of the requested group and its subgroups.
Pager<Epic>	getEpics(java.lang.Object groupIdOrPath, int itemsPerPage, EpicFilter filter) Gets all epics of the requested group and its subgroups using the specified page and per page setting.
java.util.List<Epic>	getEpics(java.lang.Object groupIdOrPath, int page, int perPage) Gets all epics of the requested group and its subgroups using the specified page and per page setting.
java.util.List<Epic>	getEpics(java.lang.Object groupIdOrPath, java.lang.Long authorId, java.lang.String labels, Constants.EpicOrderBy orderBy, Constants.SortOrder sortOrder, java.lang.String search) Gets all epics of the requested group and its subgroups.
Pager<Epic>	getEpics(java.lang.Object groupIdOrPath, java.lang.Long authorId, java.lang.String labels, Constants.EpicOrderBy orderBy, Constants.SortOrder sortOrder, java.lang.String search, int itemsPerPage) Get a Pager of all epics of the requested group and its subgroups.
java.util.List<Epic>	getEpics(java.lang.Object groupIdOrPath, java.lang.Long authorId, java.lang.String labels, Constants.EpicOrderBy orderBy, Constants.SortOrder sortOrder, java.lang.String search, int page, int perPage) Gets all epics of the requested group and its subgroups using the specified page and per page setting.
java.util.stream.Stream<Epic>	getEpicsStream(java.lang.Object groupIdOrPath) Gets all epics of the requested group and its subgroups as a Stream.
java.util.stream.Stream<Epic>	getEpicsStream(java.lang.Object groupIdOrPath, java.lang.Long authorId, java.lang.String labels, Constants.EpicOrderBy orderBy, Constants.SortOrder sortOrder, java.lang.String search) Gets all epics of the requested group and its subgroups as a Stream.
java.util.Optional<Epic>	getOptionalEpic(java.lang.Object groupIdOrPath, java.lang.Long epicIid) Get an Optional instance with the value for the specific Epic.
java.util.List<RelatedEpic>	getRelatedEpics(java.lang.Object groupIdOrPath, java.lang.Long epicIid) Gets all linked epics of an epic filtered according to the user authorizations.
Pager<RelatedEpic>	getRelatedEpics(java.lang.Object groupIdOrPath, java.lang.Long epicIid, int itemsPerPage) Get a Pager of all linked epics of an epic filtered according to the user authorizations.
java.util.stream.Stream<RelatedEpic>	getRelatedEpicsStream(java.lang.Object groupIdOrPath, java.lang.Long epicIid) Gets all linked epics of an epic filtered according to the user authorizations to as a Stream.
EpicIssueLink	removeIssue(java.lang.Object groupIdOrPath, java.lang.Long epicIid, java.lang.Long epicIssueId) Remove an epic - issue association.
java.util.List<ChildEpic>	reOrderChildEpic(java.lang.Object groupIdOrPath, java.lang.Long epicIid, java.lang.Long childEpicId, java.lang.Long moveBeforeId, java.lang.Long moveAfterId) Re-order a child epic
ChildEpic	unassignChildEpic(java.lang.Object groupIdOrPath, java.lang.Long epicIid, java.lang.Long childEpicId) Unassigns a child epic from a parent epic.
Epic	updateEpic(java.lang.Object groupIdOrPath, java.lang.Long epicIid, Epic epic) Updates an epic using the information contained in the provided Epic instance.
Epic	updateEpic(java.lang.Object groupIdOrPath, java.lang.Long epicIid, java.lang.String title, java.lang.String labels, java.lang.String description, java.util.Date startDate, java.util.Date endDate) Updates an existing epic.
java.util.List<EpicIssue>	updateIssue(java.lang.Object groupIdOrPath, java.lang.Long epicIid, java.lang.Long epicIssueId, java.lang.Long moveBeforeId, java.lang.Long moveAfterId) Updates an epic - issue association.

Methods inherited from class org.gitlab4j.api.AbstractApi

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

Methods inherited from class java.lang.Object

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

Constructor Detail

EpicsApi

public EpicsApi(GitLabApi gitLabApi)

Method Detail

getEpics

public java.util.List<Epic> getEpics(java.lang.Object groupIdOrPath)
                              throws GitLabApiException

Gets all epics of the requested group and its subgroups.

GitLab Endpoint: GET /groups/:id/epics

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

Returns:

a list of all epics of the requested group and its subgroups

Throws:

GitLabApiException - if any exception occurs

getEpics

public java.util.List<Epic> getEpics(java.lang.Object groupIdOrPath,
                                     int page,
                                     int perPage)
                              throws GitLabApiException

Gets all epics of the requested group and its subgroups using the specified page and per page setting.

GitLab Endpoint: GET /groups/:id/epics

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

page - the page to get

perPage - the number of epics per page

Returns:

a list of all epics of the requested group and its subgroups in the specified range

Throws:

GitLabApiException - if any exception occurs

getEpics

public Pager<Epic> getEpics(java.lang.Object groupIdOrPath,
                            int itemsPerPage)
                     throws GitLabApiException

Get a Pager of all epics of the requested group and its subgroups.

GitLab Endpoint: GET /groups/:id/epics

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

itemsPerPage - the number of epics per page

Returns:

the Pager of all epics of the requested group and its subgroups

Throws:

GitLabApiException - if any exception occurs

getEpicsStream

public java.util.stream.Stream<Epic> getEpicsStream(java.lang.Object groupIdOrPath)
                                             throws GitLabApiException

Gets all epics of the requested group and its subgroups as a Stream.

GitLab Endpoint: GET /groups/:id/epics

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

Returns:

a Stream of all epics of the requested group and its subgroups

Throws:

GitLabApiException - if any exception occurs

getEpics

public java.util.List<Epic> getEpics(java.lang.Object groupIdOrPath,
                                     java.lang.Long authorId,
                                     java.lang.String labels,
                                     Constants.EpicOrderBy orderBy,
                                     Constants.SortOrder sortOrder,
                                     java.lang.String search)
                              throws GitLabApiException

Gets all epics of the requested group and its subgroups.

GitLab Endpoint: GET /groups/:id/epics

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

authorId - returns epics created by the given user id

labels - return epics matching a comma separated list of labels names. Label names from the epic group or a parent group can be used

orderBy - return epics ordered by CREATED_AT or UPDATED_AT. Default is CREATED_AT

sortOrder - return epics sorted in ASC or DESC order. Default is DESC

search - search epics against their title and description

Returns:

a list of matching epics of the requested group and its subgroups

Throws:

GitLabApiException - if any exception occurs

getEpics

public java.util.List<Epic> getEpics(java.lang.Object groupIdOrPath,
                                     java.lang.Long authorId,
                                     java.lang.String labels,
                                     Constants.EpicOrderBy orderBy,
                                     Constants.SortOrder sortOrder,
                                     java.lang.String search,
                                     int page,
                                     int perPage)
                              throws GitLabApiException

Gets all epics of the requested group and its subgroups using the specified page and per page setting.

GitLab Endpoint: GET /groups/:id/epics

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

authorId - returns epics created by the given user id

labels - return epics matching a comma separated list of labels names Label names from the epic group or a parent group can be used

orderBy - return epics ordered by CREATED_AT or UPDATED_AT. Default is CREATED_AT

sortOrder - return epics sorted in ASC or DESC order. Default is DESC

search - search epics against their title and description

page - the page to get

perPage - the number of epics per page

Returns:

a list of matching epics of the requested group and its subgroups in the specified range

Throws:

GitLabApiException - if any exception occurs

getEpics

public java.util.List<Epic> getEpics(java.lang.Object groupIdOrPath,
                                     EpicFilter filter)
                              throws GitLabApiException

Gets all epics of the requested group and its subgroups using the specified page and per page setting.

GitLab Endpoint: GET /groups/:id/epics

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

filter - epic filter

Returns:

a list of matching epics of the requested group and its subgroups in the specified range

Throws:

GitLabApiException - if any exception occurs

getEpics

public Pager<Epic> getEpics(java.lang.Object groupIdOrPath,
                            java.lang.Long authorId,
                            java.lang.String labels,
                            Constants.EpicOrderBy orderBy,
                            Constants.SortOrder sortOrder,
                            java.lang.String search,
                            int itemsPerPage)
                     throws GitLabApiException

Get a Pager of all epics of the requested group and its subgroups.

GitLab Endpoint: GET /groups/:id/epics

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

authorId - returns epics created by the given user id

labels - return epics matching a comma separated list of labels names. Label names from the epic group or a parent group can be used

itemsPerPage - the number of epics per page

orderBy - return epics ordered by CREATED_AT or UPDATED_AT. Default is CREATED_AT

sortOrder - return epics sorted in ASC or DESC order. Default is DESC

search - search epics against their title and description

Returns:

the Pager of matching epics of the requested group and its subgroups

Throws:

GitLabApiException - if any exception occurs

getEpics

public Pager<Epic> getEpics(java.lang.Object groupIdOrPath,
                            int itemsPerPage,
                            EpicFilter filter)
                     throws GitLabApiException

Gets all epics of the requested group and its subgroups using the specified page and per page setting.

GitLab Endpoint: GET /groups/:id/epics

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

filter - epic filter

itemsPerPage - the number of epics per page

Returns:

a list of matching epics of the requested group and its subgroups in the specified range

Throws:

GitLabApiException - if any exception occurs

getEpicsStream

public java.util.stream.Stream<Epic> getEpicsStream(java.lang.Object groupIdOrPath,
                                                    java.lang.Long authorId,
                                                    java.lang.String labels,
                                                    Constants.EpicOrderBy orderBy,
                                                    Constants.SortOrder sortOrder,
                                                    java.lang.String search)
                                             throws GitLabApiException

Gets all epics of the requested group and its subgroups as a Stream.

GitLab Endpoint: GET /groups/:id/epics

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

authorId - returns epics created by the given user id

labels - return epics matching a comma separated list of labels names. Label names from the epic group or a parent group can be used

orderBy - return epics ordered by CREATED_AT or UPDATED_AT. Default is CREATED_AT

sortOrder - return epics sorted in ASC or DESC order. Default is DESC

search - search epics against their title and description

Returns:

a Stream of matching epics of the requested group and its subgroups

Throws:

GitLabApiException - if any exception occurs

getEpic

public Epic getEpic(java.lang.Object groupIdOrPath,
                    java.lang.Long epicIid)
             throws GitLabApiException

Get a single epic for the specified group.

GitLab Endpoint: GET /groups/:id/epics/:epic_iid

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

epicIid - the IID of the epic to get

Returns:

an Epic instance for the specified Epic

Throws:

GitLabApiException - if any exception occurs

getOptionalEpic

public java.util.Optional<Epic> getOptionalEpic(java.lang.Object groupIdOrPath,
                                                java.lang.Long epicIid)

Get an Optional instance with the value for the specific Epic.

GitLab Endpoint: GET /groups/:id/epics/:epic_iid

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

epicIid - the IID of the epic to get

Returns:

an Optional instance with the specified Epic as a value

createEpic

public Epic createEpic(java.lang.Object groupIdOrPath,
                       java.lang.String title,
                       java.lang.String labels,
                       java.lang.String description,
                       java.util.Date startDate,
                       java.util.Date endDate)
                throws GitLabApiException

Creates a new epic.

GitLab Endpoint: POST /groups/:id/epics

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

title - the title of the epic (required)

labels - comma separated list of labels (optional)

description - the description of the epic (optional)

startDate - the start date of the epic (optional)

endDate - the end date of the epic (optional)

Returns:

an Epic instance containing info on the newly created epic

Throws:

GitLabApiException - if any exception occurs

createEpic

public Epic createEpic(java.lang.Object groupIdOrPath,
                       Epic epic)
                throws GitLabApiException

Creates a new epic using the information contained in the provided Epic instance. Only the following fields from the Epic instance are used:

      title - the title of the epic (required)
      labels - comma separated list of labels (optional)
      description - the description of the epic (optional)
      startDate - the start date of the epic (optional)
      endDate - the end date of the epic (optional)
 

GitLab Endpoint: POST /groups/:id/epics

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

epic - the Epic instance with information for the new epic

Returns:

an Epic instance containing info on the newly created epic

Throws:

GitLabApiException - if any exception occurs

updateEpic

public Epic updateEpic(java.lang.Object groupIdOrPath,
                       java.lang.Long epicIid,
                       java.lang.String title,
                       java.lang.String labels,
                       java.lang.String description,
                       java.util.Date startDate,
                       java.util.Date endDate)
                throws GitLabApiException

Updates an existing epic.

GitLab Endpoint: PUT /groups/:id/epics/:epic_iid

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

epicIid - the IID of the epic to update

title - the title of the epic (optional)

labels - comma separated list of labels (optional)

description - the description of the epic (optional)

startDate - the start date of the epic (optional)

endDate - the end date of the epic (optional)

Returns:

an Epic instance containing info on the newly created epic

Throws:

GitLabApiException - if any exception occurs

updateEpic

public Epic updateEpic(java.lang.Object groupIdOrPath,
                       java.lang.Long epicIid,
                       Epic epic)
                throws GitLabApiException

Updates an epic using the information contained in the provided Epic instance. Only the following fields from the Epic instance are used:

      title - the title of the epic (optional)
      labels - comma separated list of labels (optional)
      description - the description of the epic (optional)
      startDate - the start date of the epic (optional)
      endDate - the end date of the epic (optional)
 

GitLab Endpoint: PUT /groups/:id/epics/:epic_iid

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

epicIid - the IID of the epic to update

epic - the Epic instance with update information

Returns:

an Epic instance containing info on the updated epic

Throws:

GitLabApiException - if any exception occurs

deleteEpic

public void deleteEpic(java.lang.Object groupIdOrPath,
                       java.lang.Long epicIid)
                throws GitLabApiException

Deletes an epic.

GitLab Endpoint: DELETE /groups/:id/epics/:epic_iid

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

epicIid - the IID of the epic to delete

Throws:

GitLabApiException - if any exception occurs

getEpicIssues

public java.util.List<EpicIssue> getEpicIssues(java.lang.Object groupIdOrPath,
                                               java.lang.Long epicIid)
                                        throws GitLabApiException

Gets all issues that are assigned to an epic and the authenticated user has access to.

GitLab Endpoint: GET /groups/:id/epics/:epic_iid/issues

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

epicIid - the IID of the epic to get issues for

Returns:

a list of all issues belonging to the specified epic

Throws:

GitLabApiException - if any exception occurs

getEpicIssues

public java.util.List<EpicIssue> getEpicIssues(java.lang.Object groupIdOrPath,
                                               java.lang.Long epicIid,
                                               int page,
                                               int perPage)
                                        throws GitLabApiException

Gets all issues that are assigned to an epic and the authenticated user has access to using the specified page and per page setting.

GitLab Endpoint: GET /groups/:id/epics/:epic_iid/issues

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

epicIid - the IID of the epic to get issues for

page - the page to get

perPage - the number of epics per page

Returns:

a list of all issues belonging to the specified epic in the specified range

Throws:

GitLabApiException - if any exception occurs

getEpicIssues

public Pager<EpicIssue> getEpicIssues(java.lang.Object groupIdOrPath,
                                      java.lang.Long epicIid,
                                      int itemsPerPage)
                               throws GitLabApiException

Get a Pager of all issues that are assigned to an epic and the authenticated user has access to.

GitLab Endpoint: GET /groups/:id/epics/:epic_iid/issues

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

epicIid - the IID of the epic to get issues for

itemsPerPage - the number of epics per page

Returns:

the Pager of all issues belonging to the specified epic

Throws:

GitLabApiException - if any exception occurs

getEpicIssuesStream

public java.util.stream.Stream<EpicIssue> getEpicIssuesStream(java.lang.Object groupIdOrPath,
                                                              java.lang.Long epicIid)
                                                       throws GitLabApiException

Gets all issues that are assigned to an epic and the authenticated user has access to as a Stream.

GitLab Endpoint: GET /groups/:id/epics/:epic_iid/issues

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

epicIid - the IID of the epic to get issues for

Returns:

a Stream of all issues belonging to the specified epic

Throws:

GitLabApiException - if any exception occurs

assignIssue

public EpicIssue assignIssue(java.lang.Object groupIdOrPath,
                             java.lang.Long epicIid,
                             java.lang.Long issueId)
                      throws GitLabApiException

Creates an epic - issue association. If the issue in question belongs to another epic it is unassigned from that epic.

GitLab Endpoint: POST /groups/:id/epics/:epic_iid/issues/:issue_id

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

epicIid - the Epic IID to assign the issue to

issueId - the issue ID of the issue to assign to the epic

Returns:

an EpicIssue instance containing info on the newly assigned epic issue

Throws:

GitLabApiException - if any exception occurs

removeIssue

public EpicIssueLink removeIssue(java.lang.Object groupIdOrPath,
                                 java.lang.Long epicIid,
                                 java.lang.Long epicIssueId)
                          throws GitLabApiException

Remove an epic - issue association.

GitLab Endpoint: DELETE /groups/:id/epics/:epic_iid/issues/:epic_issue_id

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

epicIid - the Epic IID to remove the issue from

epicIssueId - the ID of the "issue - epic" association of the issue to remove from the epic

Returns:

an EpicIssueLink instance containing info on the removed issue

Throws:

GitLabApiException - if any exception occurs

updateIssue

public java.util.List<EpicIssue> updateIssue(java.lang.Object groupIdOrPath,
                                             java.lang.Long epicIid,
                                             java.lang.Long epicIssueId,
                                             java.lang.Long moveBeforeId,
                                             java.lang.Long moveAfterId)
                                      throws GitLabApiException

Updates an epic - issue association.

GitLab Endpoint: PUT /groups/:id/epics/:epic_iid/issues/:epic_issue_id

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

epicIid - the Epic IID that the issue is assigned to

epicIssueId - the ID of the "issue - epic" association

moveBeforeId - the ID of the "issue - epic" association that should be placed before the link in the question (optional)

moveAfterId - the ID of the "issue - epic" association that should be placed after the link in the question (optional)

Returns:

a list of all issues belonging to the specified epic

Throws:

GitLabApiException - if any exception occurs

getChildEpics

public java.util.List<ChildEpic> getChildEpics(java.lang.Object groupIdOrPath,
                                               java.lang.Long epicIid)
                                        throws GitLabApiException

Gets all child epics of an epic and the authenticated user has access to.

GitLab Endpoint: GET /groups/:id/epics/:epic_iid/epics

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

epicIid - the IID of the epic to get child epics for

Returns:

a list of all child epics of the specified epic

Throws:

GitLabApiException - if any exception occurs

getChildEpics

public Pager<ChildEpic> getChildEpics(java.lang.Object groupIdOrPath,
                                      java.lang.Long epicIid,
                                      int itemsPerPage)
                               throws GitLabApiException

Get a Pager of all child epics of an epic and the authenticated user has access to.

GitLab Endpoint: GET /groups/:id/epics/:epic_iid/epics

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

epicIid - the IID of the epic to get child epics for

itemsPerPage - the number of child epics per page

Returns:

the Pager of all child epics of the specified epic

Throws:

GitLabApiException - if any exception occurs

getChildEpicsStream

public java.util.stream.Stream<ChildEpic> getChildEpicsStream(java.lang.Object groupIdOrPath,
                                                              java.lang.Long epicIid)
                                                       throws GitLabApiException

Gets all child epics of an epic and the authenticated user has access to as a Stream.

GitLab Endpoint: GET /groups/:id/epics/:epic_iid/epics

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

epicIid - the IID of the epic to get child epics for

Returns:

a Stream of all child epics of the specified epic

Throws:

GitLabApiException - if any exception occurs

assignChildEpic

public ChildEpic assignChildEpic(java.lang.Object groupIdOrPath,
                                 java.lang.Long epicIid,
                                 java.lang.Long childEpicId)
                          throws GitLabApiException

Creates an association between two epics, designating one as the parent epic and the other as the child epic. A parent epic can have multiple child epics. If the new child epic already belonged to another epic, it is unassigned from that previous parent.

GitLab Endpoint: POST /groups/:id/epics/:epic_iid/epics/:child_epic_id

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

epicIid - the Epic IID to assign the child epic to

childEpicId - the global ID of the child epic. Epic IID can’t be used because they can conflict with epics from other groups.

Returns:

an ChildEpic instance containing info on the newly assigned child epic

Throws:

GitLabApiException - if any exception occurs

createAndAssignChildEpic

public CreatedChildEpic createAndAssignChildEpic(java.lang.Object groupIdOrPath,
                                                 java.lang.Long epicIid,
                                                 java.lang.String title,
                                                 java.lang.Boolean confidential)
                                          throws GitLabApiException

Creates a new epic and associates it with provided parent epic.

GitLab Endpoint: POST /groups/:id/epics/:epic_iid/epics

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

epicIid - the Epic IID to assign the child epic to (of the future parent epic)

title - the title of a newly created epic

confidential - whether the epic should be confidential (optional)

Returns:

an ChildEpic instance containing info on the newly created and assigned child epic

Throws:

GitLabApiException - if any exception occurs

reOrderChildEpic

public java.util.List<ChildEpic> reOrderChildEpic(java.lang.Object groupIdOrPath,
                                                  java.lang.Long epicIid,
                                                  java.lang.Long childEpicId,
                                                  java.lang.Long moveBeforeId,
                                                  java.lang.Long moveAfterId)
                                           throws GitLabApiException

Re-order a child epic

GitLab Endpoint: PUT /groups/:id/epics/:epic_iid/epics/:child_epic_id

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

epicIid - the Epic IID that the child epic is assigned to

childEpicId - the ID of the child epic. Epic IID can’t be used because they can conflict with epics from other groups.

moveBeforeId - the ID of a sibling epic that should be placed before the child epic (optional)

moveAfterId - the ID of a sibling epic that should be placed after the child epic (optional)

Returns:

a list of all child epics of the specified epic

Throws:

GitLabApiException - if any exception occurs

unassignChildEpic

public ChildEpic unassignChildEpic(java.lang.Object groupIdOrPath,
                                   java.lang.Long epicIid,
                                   java.lang.Long childEpicId)
                            throws GitLabApiException

Unassigns a child epic from a parent epic.

GitLab Endpoint: DELETE /groups/:id/epics/:epic_iid/epics/:child_epic_id

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

epicIid - the Epic IID to remove the child epic from

childEpicId - the ID of the child epic. Epic IID can’t be used because they can conflict with epics from other groups.

Returns:

an ChildEpic instance containing info on the removed child epic

Throws:

GitLabApiException - if any exception occurs

getRelatedEpics

public java.util.List<RelatedEpic> getRelatedEpics(java.lang.Object groupIdOrPath,
                                                   java.lang.Long epicIid)
                                            throws GitLabApiException

Gets all linked epics of an epic filtered according to the user authorizations.

GitLab Endpoint: GET /groups/:id/epics/:epic_iid/related_epics

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

epicIid - the IID of the epic to get child epics for

Returns:

a list of all related epics of the specified epic

Throws:

GitLabApiException - if any exception occurs

getRelatedEpics

public Pager<RelatedEpic> getRelatedEpics(java.lang.Object groupIdOrPath,
                                          java.lang.Long epicIid,
                                          int itemsPerPage)
                                   throws GitLabApiException

Get a Pager of all linked epics of an epic filtered according to the user authorizations.

GitLab Endpoint: GET /groups/:id/epics/:epic_iid/related_epics

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

epicIid - the IID of the epic to get child epics for

itemsPerPage - the number of child epics per page

Returns:

the Pager of all related epics of the specified epic

Throws:

GitLabApiException - if any exception occurs

getRelatedEpicsStream

public java.util.stream.Stream<RelatedEpic> getRelatedEpicsStream(java.lang.Object groupIdOrPath,
                                                                  java.lang.Long epicIid)
                                                           throws GitLabApiException

Gets all linked epics of an epic filtered according to the user authorizations to as a Stream.

GitLab Endpoint: GET /groups/:id/epics/:epic_iid/related_epics

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

epicIid - the IID of the epic to get child epics for

Returns:

a Stream of all related epics of the specified epic

Throws:

GitLabApiException - if any exception occurs

createRelatedEpicLink

public RelatedEpicLink createRelatedEpicLink(java.lang.Object groupIdOrPath,
                                             java.lang.Long epicIid,
                                             java.lang.Object targetGroupIdOrPath,
                                             java.lang.Long targetEpicIid,
                                             LinkType linkType)
                                      throws GitLabApiException

Create a two-way relation between two epics. The user must have at least the Guest role for both groups.

GitLab Endpoint: POST /groups/:id/epics/:epic_iid/related_epics

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

epicIid - the Epic IID to assign the child epic to

targetGroupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path of the target group’s epic

targetEpicIid - the Epic IID of the target group’s epic.

linkType - the type of the relation (optional), defaults to LinkType.RELATES_TO.

Returns:

an RelatedEpic instance containing info on the newly assigned child epic

Throws:

GitLabApiException - if any exception occurs

deleteRelatedEpicLink

public RelatedEpicLink deleteRelatedEpicLink(java.lang.Object groupIdOrPath,
                                             java.lang.Long epicIid,
                                             java.lang.Long relatedEpicLinkId)
                                      throws GitLabApiException

Delete a two-way relation between two epics. The user must have at least the Guest role for both groups.

GitLab Endpoint: DELETE /groups/:id/epics/:epic_iid/related_epics/:related_epic_link_id

Parameters:

groupIdOrPath - the group ID, path of the group, or a Group instance holding the group ID or path

epicIid - the Epic IID to remove the child epic from

relatedEpicLinkId - the ID a related epic link.

Returns:

an RelatedEpicLink instance containing info on the removed related epic

Throws:

GitLabApiException - if any exception occurs