Skip to content
GitLab
Switch branch/tag
Find file BlameHistoryPermalink
IssuesApi.java 43.44 KiB
Open in Web IDE
1 
package org.gitlab4j.api;
2
3 
import java.util.Date;
4 
import java.util.List;
5 
import java.util.Optional;
6 
import java.util.stream.Stream;
7
8 
import javax.ws.rs.core.GenericType;
9 
import javax.ws.rs.core.Response;
10
11 
import org.gitlab4j.api.GitLabApi.ApiVersion;
12 
import org.gitlab4j.api.models.Duration;
13 
import org.gitlab4j.api.models.Issue;
14 
import org.gitlab4j.api.models.IssueFilter;
15 
import org.gitlab4j.api.models.IssueLink;
16 
import org.gitlab4j.api.models.IssuesStatistics;
17 
import org.gitlab4j.api.models.IssuesStatisticsFilter;
18 
import org.gitlab4j.api.models.MergeRequest;
19 
import org.gitlab4j.api.models.Participant;
20 
import org.gitlab4j.api.models.TimeStats;
21 
import org.gitlab4j.api.utils.DurationUtils;
22
23 
/**
24 
 * This class provides an entry point to all the GitLab API Issue calls.
25 
 * @see <a href="https://docs.gitlab.com/ce/api/issues.html">Issues API at GitLab</a>
26 
 * @see <a href="https://docs.gitlab.com/ce/api/issue_links.html">Issue Links API at GitLab</a>
27 
 * @see <a href="https://docs.gitlab.com/ce/api/issues_statistics.html">Issues Statistics API at GitLab</a>
28 
 */
29 
public class IssuesApi extends AbstractApi implements Constants {
30
31 
    public IssuesApi(GitLabApi gitLabApi) {
32 
        super(gitLabApi);
33 
    }
34
35 
    /**
36 
     * Get all issues the authenticated user has access to. Only returns issues created by the current user.
37 
     *
38 
     * <pre><code>GitLab Endpoint: GET /issues</code></pre>
39 
     *
40 
     * @return a list of user's issues
41 
     * @throws GitLabApiException if any exception occurs
42 
     */
43 
    public List<Issue> getIssues() throws GitLabApiException {
44 
        return (getIssues(getDefaultPerPage()).all());
45 
    }
46
47 
    /**
48 
     * Get all issues the authenticated user has access to using the specified page and per page setting. Only returns issues created by the current user.
49 
     *
50 
     * <pre><code>GitLab Endpoint: GET /issues</code></pre>
51 
     *
52 
     * @param page the page to get
53 
     * @param perPage the number of issues per page
54 
     * @return the list of issues in the specified range
55 
     * @throws GitLabApiException if any exception occurs
56 
     */
57 
    public List<Issue> getIssues(int page, int perPage) throws GitLabApiException {
58 
        Response response = get(Response.Status.OK, getPageQueryParams(page, perPage), "issues");
59 
        return (response.readEntity(new GenericType<List<Issue>>() {}));
60 
    }
61
62 
    /**
63 
     * Get a Pager of all issues the authenticated user has access to. Only returns issues created by the current user.
64 
     *
65 
     * <pre><code>GitLab Endpoint: GET /issues</code></pre>
66 
     *r
67 
     * @param itemsPerPage the number of issues per page
68 
     * @return the Pager of issues in the specified range
69 
     * @throws GitLabApiException if any exception occurs
70 
     */
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
public Pager<Issue> getIssues(int itemsPerPage) throws GitLabApiException { return (new Pager<Issue>(this, Issue.class, itemsPerPage, null, "issues")); } /** * Get all issues the authenticated user has access to as a Stream. Only returns issues created by the current user. * * <pre><code>GitLab Endpoint: GET /issues</code></pre> * * @return a Stream of user's issues * @throws GitLabApiException if any exception occurs */ public Stream<Issue> getIssuesStream() throws GitLabApiException { return (getIssues(getDefaultPerPage()).stream()); } /** * Get a list of project's issues. * * <pre><code>GitLab Endpoint: GET /projects/:id/issues</code></pre> * * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @return a list of project's issues * @throws GitLabApiException if any exception occurs */ public List<Issue> getIssues(Object projectIdOrPath) throws GitLabApiException { return (getIssues(projectIdOrPath, getDefaultPerPage()).all()); } /** * Get a list of project's issues using the specified page and per page settings. * * <pre><code>GitLab Endpoint: GET /projects/:id/issues</code></pre> * * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param page the page to get * @param perPage the number of issues per page * @return the list of issues in the specified range * @throws GitLabApiException if any exception occurs */ public List<Issue> getIssues(Object projectIdOrPath, int page, int perPage) throws GitLabApiException { Response response = get(Response.Status.OK, getPageQueryParams(page, perPage), "projects", getProjectIdOrPath(projectIdOrPath), "issues"); return (response.readEntity(new GenericType<List<Issue>>() {})); } /** * Get a Pager of project's issues. * * <pre><code>GitLab Endpoint: GET /projects/:id/issues</code></pre> * * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @param itemsPerPage the number of issues per page * @return the Pager of issues in the specified range * @throws GitLabApiException if any exception occurs */ public Pager<Issue> getIssues(Object projectIdOrPath, int itemsPerPage) throws GitLabApiException { return (new Pager<Issue>(this, Issue.class, itemsPerPage, null, "projects", getProjectIdOrPath(projectIdOrPath), "issues")); } /** * Get a Stream of project's issues. Only returns the first page * * <pre><code>GitLab Endpoint: GET /projects/:id/issues</code></pre> * * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance * @return a Stream of project's issues * @throws GitLabApiException if any exception occurs */ public Stream<Issue> getIssuesStream(Object projectIdOrPath) throws GitLabApiException { return (getIssues(projectIdOrPath, getDefaultPerPage()).stream());