org.gitlab4j.api

Class ResourceLabelEventsApi

java.lang.Object

org.gitlab4j.api.AbstractApi

org.gitlab4j.api.ResourceLabelEventsApi

All Implemented Interfaces:

Constants

public class ResourceLabelEventsApi
extends AbstractApi

This class provides an entry point to all the GitLab Resource label events API

See Also:

Resource label events API at GitLab

Nested Class Summary

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

Constants.ActionType, Constants.ApplicationScope, Constants.ArchiveFormat, Constants.CommitBuildState, Constants.DeploymentStatus, Constants.DeployTokenScope, Constants.Encoding, Constants.EpicOrderBy, 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.PipelineOrderBy, Constants.PipelineScope, Constants.ProjectOrderBy, Constants.ProjectSearchScope, Constants.SearchScope, Constants.SortOrder, 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

Constructors

Constructor and Description
ResourceLabelEventsApi(GitLabApi gitLabApi)

Method Summary

Modifier and Type	Method and Description
LabelEvent	getEpicLabelEvent(Object projectIdOrPath, Integer epicId, Integer resourceLabelEventId) Get a single label event for a specific epic label event.
List<LabelEvent>	getEpicLabelEvents(Object projectIdOrPath, Integer epicId) Gets a list of all label events for an epic.
Pager<LabelEvent>	getEpicLabelEvents(Object projectIdOrPath, Integer epicId, int itemsPerPage) Gets a Pager of all label events for the specified epic.
Stream<LabelEvent>	getEpicLabelEventsStream(Object projectIdOrPath, Integer epicId) Gets a Stream of all label events for he specified epic.
LabelEvent	getIssueLabelEvent(Object projectIdOrPath, Integer issueIid, Integer resourceLabelEventId) Get a single label event for a specific project issue.
List<LabelEvent>	getIssueLabelEvents(Object projectIdOrPath, Integer issueIid) Gets a list of all label events for a single issue.
Pager<LabelEvent>	getIssueLabelEvents(Object projectIdOrPath, Integer issueIid, int itemsPerPage) Gets a Pager of all label events for a single issue.
Stream<LabelEvent>	getIssueLabelEventsStream(Object projectIdOrPath, Integer issueIid) Gets a Stream of all label events for a single issue.
LabelEvent	getMergeRequestLabelEvent(Object projectIdOrPath, Integer mergeRequestIid, Integer resourceLabelEventId) Get a single label event for a specific merge request label event.
List<LabelEvent>	getMergeRequestLabelEvents(Object projectIdOrPath, Integer mergeRequestIid) Gets a list of all label events for a merge request.
Pager<LabelEvent>	getMergeRequestLabelEvents(Object projectIdOrPath, Integer mergeRequestIid, int itemsPerPage) Gets a Pager of all label events for the specified merge request.
Stream<LabelEvent>	getMergeRequestLabelEventsStream(Object projectIdOrPath, Integer mergeRequestIid) Gets a Stream of all label events for he specified merge request.
Optional<LabelEvent>	getOptionalEpicLabelEvent(Object projectIdOrPath, Integer epicId, Integer resourceLabelEventId) Get an Optional instance holding a LabelEvent for a specific epic label event.
Optional<LabelEvent>	getOptionalIssueLabelEvent(Object projectIdOrPath, Integer issueIid, Integer resourceLabelEventId) Get an Optional instance holding a LabelEvent for a specific project issue
Optional<LabelEvent>	getOptionalMergeRequestLabelEvent(Object projectIdOrPath, Integer mergeRequestIid, Integer resourceLabelEventId) Get an Optional instance holding a LabelEvent for a specific merge request label event.

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, post, post, post, post, post, put, put, put, putUpload, putUpload, putWithFormData, 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

ResourceLabelEventsApi

public ResourceLabelEventsApi(GitLabApi gitLabApi)

Method Detail

getIssueLabelEvents

public List<LabelEvent> getIssueLabelEvents(Object projectIdOrPath,
                                            Integer issueIid)
                                     throws GitLabApiException

Gets a list of all label events for a single issue.

GitLab Endpoint: GET /projects/:id/issues/:issue_iid/resource_label_events

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

issueIid - the IID of the issue

Returns:

a List of LabelEvent for the specified issue

Throws:

GitLabApiException - if any exception occurs

getIssueLabelEvents

public Pager<LabelEvent> getIssueLabelEvents(Object projectIdOrPath,
                                             Integer issueIid,
                                             int itemsPerPage)
                                      throws GitLabApiException

Gets a Pager of all label events for a single issue.

GitLab Endpoint: GET /projects/:id/issues/:issue_iid/resource_label_events

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

issueIid - the IID of the issue

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

Returns:

the Pager of LabelEvent instances for the specified issue IID

Throws:

GitLabApiException - if any exception occurs

getIssueLabelEventsStream

public Stream<LabelEvent> getIssueLabelEventsStream(Object projectIdOrPath,
                                                    Integer issueIid)
                                             throws GitLabApiException

Gets a Stream of all label events for a single issue.

GitLab Endpoint: GET /projects/:id/issues/:issue_iid/resource_label_events

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

issueIid - the IID of the issue

Returns:

a Stream of LabelEvent for the specified issue

Throws:

GitLabApiException - if any exception occurs

getIssueLabelEvent

public LabelEvent getIssueLabelEvent(Object projectIdOrPath,
                                     Integer issueIid,
                                     Integer resourceLabelEventId)
                              throws GitLabApiException

Get a single label event for a specific project issue.

GitLab Endpoint: GET /projects/:id/issues/:issue_iid/resource_label_events/:resource_label_event_id

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

issueIid - the IID of the issue

resourceLabelEventId - the ID of a label event

Returns:

LabelEvent instance for the specified project issue

Throws:

GitLabApiException - if any exception occurs

getOptionalIssueLabelEvent

public Optional<LabelEvent> getOptionalIssueLabelEvent(Object projectIdOrPath,
                                                       Integer issueIid,
                                                       Integer resourceLabelEventId)
                                                throws GitLabApiException

Get an Optional instance holding a LabelEvent for a specific project issue

GitLab Endpoint: GET /projects/:id/issues/:issue_iid/resource_label_events/:resource_label_event_id

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

issueIid - the IID of the issue

resourceLabelEventId - the ID of a label event

Returns:

an Optional instance with the specified LabelEvent as the value

Throws:

GitLabApiException - if any exception occurs

getEpicLabelEvents

public List<LabelEvent> getEpicLabelEvents(Object projectIdOrPath,
                                           Integer epicId)
                                    throws GitLabApiException

Gets a list of all label events for an epic.

GitLab Endpoint: GET /projects/:id/epics/:epic_id/resource_label_events

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

epicId - the ID of the epic

Returns:

a List of LabelEvent for the specified epic

Throws:

GitLabApiException - if any exception occurs

getEpicLabelEvents

public Pager<LabelEvent> getEpicLabelEvents(Object projectIdOrPath,
                                            Integer epicId,
                                            int itemsPerPage)
                                     throws GitLabApiException

Gets a Pager of all label events for the specified epic.

GitLab Endpoint: GET /projects/:id/epics/:epic_id/resource_label_events

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

epicId - the ID of the epic

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

Returns:

the Pager of LabelEvent instances for the specified epic

Throws:

GitLabApiException - if any exception occurs

getEpicLabelEventsStream

public Stream<LabelEvent> getEpicLabelEventsStream(Object projectIdOrPath,
                                                   Integer epicId)
                                            throws GitLabApiException

Gets a Stream of all label events for he specified epic.

GitLab Endpoint: GET /projects/:id/epics/:epic_id/resource_label_events

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

epicId - the ID of the epic

Returns:

a Stream of LabelEvent for the specified epic

Throws:

GitLabApiException - if any exception occurs

getEpicLabelEvent

public LabelEvent getEpicLabelEvent(Object projectIdOrPath,
                                    Integer epicId,
                                    Integer resourceLabelEventId)
                             throws GitLabApiException

Get a single label event for a specific epic label event.

GitLab Endpoint: GET /projects/:id/epics/:epic_id/resource_label_events/:resource_label_event_id

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

epicId - the ID of the epic

resourceLabelEventId - the ID of a label event

Returns:

LabelEvent instance for the specified epic label event

Throws:

GitLabApiException - if any exception occurs

getOptionalEpicLabelEvent

public Optional<LabelEvent> getOptionalEpicLabelEvent(Object projectIdOrPath,
                                                      Integer epicId,
                                                      Integer resourceLabelEventId)
                                               throws GitLabApiException

Get an Optional instance holding a LabelEvent for a specific epic label event.

GitLab Endpoint: GET /projects/:id/epics/:epic_id/resource_label_events/:resource_label_event_id

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

epicId - the ID of the epic

resourceLabelEventId - the ID of a label event

Returns:

an Optional instance with the specified LabelEvent as the value

Throws:

GitLabApiException - if any exception occurs

getMergeRequestLabelEvents

public List<LabelEvent> getMergeRequestLabelEvents(Object projectIdOrPath,
                                                   Integer mergeRequestIid)
                                            throws GitLabApiException

Gets a list of all label events for a merge request.

GitLab Endpoint: GET /projects/:id/merge_requests/:epic_id/resource_label_events

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

mergeRequestIid - the IID of the merge request

Returns:

a List of LabelEvent for the specified merge request

Throws:

GitLabApiException - if any exception occurs

getMergeRequestLabelEvents

public Pager<LabelEvent> getMergeRequestLabelEvents(Object projectIdOrPath,
                                                    Integer mergeRequestIid,
                                                    int itemsPerPage)
                                             throws GitLabApiException

Gets a Pager of all label events for the specified merge request.

GitLab Endpoint: GET /projects/:id/merge_requests/:epic_id/resource_label_events

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

mergeRequestIid - the IID of the merge request

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

Returns:

the Pager of LabelEvent instances for the specified merge request

Throws:

GitLabApiException - if any exception occurs

getMergeRequestLabelEventsStream

public Stream<LabelEvent> getMergeRequestLabelEventsStream(Object projectIdOrPath,
                                                           Integer mergeRequestIid)
                                                    throws GitLabApiException

Gets a Stream of all label events for he specified merge request.

GitLab Endpoint: GET /projects/:id/merge_requests/:issue_iid/resource_label_events

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

mergeRequestIid - the IID of the merge request

Returns:

a Stream of LabelEvent for the specified merge request

Throws:

GitLabApiException - if any exception occurs

getMergeRequestLabelEvent

public LabelEvent getMergeRequestLabelEvent(Object projectIdOrPath,
                                            Integer mergeRequestIid,
                                            Integer resourceLabelEventId)
                                     throws GitLabApiException

Get a single label event for a specific merge request label event.

GitLab Endpoint: GET /projects/:id/merge_requests/:epic_id/resource_label_events/:resource_label_event_id

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

mergeRequestIid - the IID of the merge request

resourceLabelEventId - the ID of a label event

Returns:

LabelEvent instance for the specified epic label event

Throws:

GitLabApiException - if any exception occurs

getOptionalMergeRequestLabelEvent

public Optional<LabelEvent> getOptionalMergeRequestLabelEvent(Object projectIdOrPath,
                                                              Integer mergeRequestIid,
                                                              Integer resourceLabelEventId)
                                                       throws GitLabApiException

Get an Optional instance holding a LabelEvent for a specific merge request label event.

GitLab Endpoint: GET /projects/:id/merge_requests/:issue_iid/resource_label_events/:resource_label_event_id

Parameters:

projectIdOrPath - id, path of the project, or a Project instance holding the project ID or path

mergeRequestIid - the IID of the merge request

resourceLabelEventId - the ID of a label event

Returns:

an Optional instance with the specified LabelEvent as the value

Throws:

GitLabApiException - if any exception occurs