Package org.gitlab4j.api
Class ResourceStateEventsApi
java.lang.Object
org.gitlab4j.api.AbstractApi
org.gitlab4j.api.ResourceStateEventsApi
- All Implemented Interfaces:
Constants
This class provides an entry point to all the GitLab Resource state events API
- See Also:
-
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.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.ProjectOrderBy, Constants.ProjectSearchScope, Constants.SearchScope, Constants.SortOrder, Constants.SquashOption, Constants.StateEvent, 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
-
Method Summary
Modifier and TypeMethodDescriptiongetIssueStateEvents
(Object projectIdOrPath, Long issueIid) Gets a list of all state events for a single issue.getIssueStateEvents
(Object projectIdOrPath, Long issueIid, int itemsPerPage) Gets a Pager of all state events for a single issue.getIssueStateEventsStream
(Object projectIdOrPath, Long issueIid) Gets a Stream of all state events for a single issue.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
-
Constructor Details
-
ResourceStateEventsApi
-
-
Method Details
-
getIssueStateEvents
public List<IssueEvent> getIssueStateEvents(Object projectIdOrPath, Long issueIid) throws GitLabApiException Gets a list of all state events for a single issue.GitLab Endpoint: GET /projects/:id/issues/:issue_iid/resource_state_events
- Parameters:
projectIdOrPath
- id, path of the project, or a Project instance holding the project ID or pathissueIid
- the IID of the issue- Returns:
- a List of IssueEvent for the specified issue
- Throws:
GitLabApiException
- if any exception occurs
-
getIssueStateEvents
public Pager<IssueEvent> getIssueStateEvents(Object projectIdOrPath, Long issueIid, int itemsPerPage) throws GitLabApiException Gets a Pager of all state events for a single issue.GitLab Endpoint: GET /projects/:id/issues/:issue_iid/resource_state_events
- Parameters:
projectIdOrPath
- id, path of the project, or a Project instance holding the project ID or pathissueIid
- the IID of the issueitemsPerPage
- the number of LabelEvent instances that will be fetched per page- Returns:
- the Pager of IssueEvent instances for the specified issue IID
- Throws:
GitLabApiException
- if any exception occurs
-
getIssueStateEventsStream
public Stream<IssueEvent> getIssueStateEventsStream(Object projectIdOrPath, Long issueIid) throws GitLabApiException Gets a Stream of all state events for a single issue.GitLab Endpoint: GET /projects/:id/issues/:issue_iid/resource_state_events
- Parameters:
projectIdOrPath
- id, path of the project, or a Project instance holding the project ID or pathissueIid
- the IID of the issue- Returns:
- a Stream of IssueEvent for the specified issue
- Throws:
GitLabApiException
- if any exception occurs
-